[gentoo-doc-cvs] cvs commit: doc-tipsntricks.xml

[gentoo-doc-cvs] cvs commit: doc-tipsntricks.xml

[Xavier Neys]

neysx       05/09/06 13:57:15

  Modified:    xml/htdocs/proj/en/gdp/doc doc-tipsntricks.xml
  Log:
  Fixed prompts & added a word about rewriteURI

Revision  Changes    Path
1.11      +51 -26    xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml

file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.11&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.11&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml.diff?r1=1.10&r2=1.11&cvsroot=gentoo

Index: doc-tipsntricks.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- doc-tipsntricks.xml	8 Apr 2005 09:52:49 -0000	1.10
+++ doc-tipsntricks.xml	6 Sep 2005 13:57:15 -0000	1.11
@@ -1,10 +1,11 @@
 <?xml version='1.0' encoding="UTF-8"?>
 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
 
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.10 2005/04/08 09:52:49 swift Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.11 2005/09/06 13:57:15 neysx Exp $ -->
 
 <guide link="doc-tipsntricks.xml">
 <title>Documentation Development Tips &amp; Tricks</title>
+
 <author title="Author">
     <mail link="swift@gentoo.org">Sven Vermeulen</mail>
 </author>
@@ -19,8 +20,8 @@
 
 <license/>
 
-<version>0.15</version>
-<date>2005-04-08</date>
+<version>0.16</version>
+<date>2005-09-06</date>
 
 <chapter>
 <title>Setting up your local environment</title>
@@ -40,7 +41,7 @@
 </p>
 
 <pre caption="Downloading the English documentation">
-# <i>wget http://www.gentoo.org/dyn/doc-snapshots/docs-latest-en.tar.bz2</i>
+$ <i>wget http://www.gentoo.org/dyn/doc-snapshots/docs-latest-en.tar.bz2</i>
 </pre>
 
 <p>
@@ -51,7 +52,7 @@
 </p>
 
 <pre caption="Updating an English document">
-# <i>wget http://www.gentoo.org/doc/en/alsa-guide.xml?passthru=1 -O alsa-guide.xml</i>
+$ <i>wget http://www.gentoo.org/doc/en/alsa-guide.xml?passthru=1 -O alsa-guide.xml</i>
 </pre>
 
 <p>
@@ -60,10 +61,10 @@
 </p>
 
 <pre caption="Downloading the snapshot for your language">
-# <i>mkdir </i><comment>${LANG}</comment>
-# <i>cd </i><comment>${LANG}</comment>
-# <i>wget http://www.gentoo.org/dyn/doc-snapshots/docs-latest-</i><comment>${LANG}</comment><i>.tar.bz2</i>
-# <i>tar xvjf docs-latest-*.tar.bz2</i>
+$ <i>mkdir </i><comment>${LANG}</comment>
+$ <i>cd </i><comment>${LANG}</comment>
+$ <i>wget http://www.gentoo.org/dyn/doc-snapshots/docs-latest-</i><comment>${LANG}</comment><i>.tar.bz2</i>
+$ <i>tar xvjf docs-latest-*.tar.bz2</i>
 </pre>
 
 <p>
@@ -74,7 +75,7 @@
 </p>
 
 <pre caption="Creating a patch for an update">
-# <i>diff -uNt </i><comment>${LANG}</comment><i>/alsa-guide.xml alsa-guide.xml</i> > alsa-guide.diff
+$ <i>diff -uNt </i><comment>${LANG}</comment><i>/alsa-guide.xml alsa-guide.xml</i> > alsa-guide.diff
 </pre>
 
 </body>
@@ -104,9 +105,9 @@
 </p>
 
 <pre caption="Getting the CVS snapshot">
-# <i>mkdir cvs; cd cvs/</i>
-# <i>export CVSROOT=</i><comment>&lt;your nick&gt;</comment><i>@cvs.gentoo.org:/var/cvsroot</i>
-# <i>cvs co doc</i>
+$ <i>mkdir cvs; cd cvs/</i>
+$ <i>export CVSROOT=</i><comment>&lt;your nick&gt;</comment><i>@cvs.gentoo.org:/var/cvsroot</i>
+$ <i>cvs co doc</i>
 </pre>
 
 <p>
@@ -129,11 +130,11 @@
 </p>
 
 <pre caption="Creating the test environment">
-# <i>mkdir test</i>
-# <i>cd test</i>
-# <i>mkdir css images</i>
-# <i>wget -P css/ http://www.gentoo.org/css/main.css</i>
-# <i>wget -P images/ http://www.gentoo.org/images/gbot-s.gif \
+$ <i>mkdir test</i>
+$ <i>cd test</i>
+$ <i>mkdir css images</i>
+$ <i>wget -P css/ http://www.gentoo.org/css/main.css</i>
+$ <i>wget -P images/ http://www.gentoo.org/images/gbot-s.gif \
   http://www.gentoo.org/images/gridtest.gif \
   http://www.gentoo.org/images/gtop-s.jpg \
   http://www.gentoo.org/images/line.gif \
@@ -148,15 +149,39 @@
 </p>
 
 <pre caption="Downloading guide.xsl">
-# <i>wget http://dev.gentoo.org/~swift/gentoo/downloads/guide.xsl</i>
+$ <i>wget http://dev.gentoo.org/~swift/gentoo/downloads/guide.xsl</i>
 </pre>
 
 <p>
-Finally, edit <path>/etc/xml/catalog</path> and add the following line:
+Finally, edit <path>/etc/xml/catalog</path> as root and add the following line:
 </p>
 
 <pre caption="/etc/xml/catalog addendum">
-&lt;rewriteURI uriStartString="/dtd" rewritePrefix="<i>/usr/portage/metadata/dtd/</i>"/&gt;
+&lt;rewriteURI uriStartString="/dtd/" rewritePrefix="<i>/usr/portage/metadata/dtd/</i>"/&gt;
+</pre>
+
+<p>
+If your <path>/etc/xml/catalog</path> is empty or does not contain any entry,
+you need to <e>insert</e> the <c>&lt;rewriteURI&gt;</c> element <e>inside</e>
+the <c>&lt;catalog&gt;</c> element:
+</p>
+
+<pre caption="Minimal /etc/xml/catalog">
+&lt;?xml version="1.0"?&gt;
+&lt;DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
+&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"&gt;
+  &lt;rewriteURI uriStartString="/dtd/" rewritePrefix="<i>/usr/portage/metadata/dtd/</i>"/&gt;
+&lt;catalog&gt;
+</pre>
+
+<p>
+Besides, some files may specify the on-line DTD with an uri like
+<path>http://www.gentoo.org/dtd/guide.dtd</path>. You can also rewrite those
+references and avoid slow accesses to the net:
+</p>
+
+<pre caption="Extra /etc/xml/catalog addendum">
+&lt;rewriteURI uriStartString="http://www.gentoo.org/dtd/" rewritePrefix="<i>/usr/portage/metadata/dtd/</i>"/&gt;
 </pre>
 
 </body>
@@ -170,7 +195,7 @@
 </p>
 
 <pre caption="Using xmllint to verify guides">
-# <i>xmllint --valid --noout alsa-guide.xml</i>
+$ <i>xmllint --valid --noout alsa-guide.xml</i>
 </pre>
 
 <p>
@@ -180,7 +205,7 @@
 </p>
 
 <pre caption="Converting to HTML">
-# <i>xsltproc --novalid test/guide.xsl alsa-guide.xml &gt; test/alsa-guide.html</i>
+$ <i>xsltproc --novalid test/guide.xsl alsa-guide.xml &gt; test/alsa-guide.html</i>
 </pre>
 
 <p>
@@ -205,9 +230,9 @@
 </p>
 
 <pre caption="Validating hb-install-about.xml">
-# <i>xmllint --valid --noout handbook-x86.xml</i>
-# <i>xmllint --valid --noout hb-install-about.xml</i>
-# <i>xsltproc --stringparam part 1 --stringparam chap 1 test/guide.xsl handbook-x86.xml &gt; test/hb-install-about.html</i>
+$ <i>xmllint --valid --noout handbook-x86.xml</i>
+$ <i>xmllint --valid --noout hb-install-about.xml</i>
+$ <i>xsltproc --stringparam part 1 --stringparam chap 1 test/guide.xsl handbook-x86.xml &gt; test/hb-install-about.html</i>
 </pre>
 
 </body>



-- 
gentoo-doc-cvs@gentoo.org mailing list

[gentoo-doc-cvs] cvs commit: doc-tipsntricks.xml

[Xavier Neys]

neysx       05/10/08 13:34:33

  Modified:    xml/htdocs/proj/en/gdp/doc doc-tipsntricks.xml
  Log:
  #108488 fixed bad xml in catalog example.

Revision  Changes    Path
1.12      +5 -5      xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml

file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.12&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.12&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml.diff?r1=1.11&r2=1.12&cvsroot=gentoo

Index: doc-tipsntricks.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- doc-tipsntricks.xml	6 Sep 2005 13:57:15 -0000	1.11
+++ doc-tipsntricks.xml	8 Oct 2005 13:34:33 -0000	1.12
@@ -1,7 +1,7 @@
 <?xml version='1.0' encoding="UTF-8"?>
 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
 
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.11 2005/09/06 13:57:15 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.12 2005/10/08 13:34:33 neysx Exp $ -->
 
 <guide link="doc-tipsntricks.xml">
 <title>Documentation Development Tips &amp; Tricks</title>
@@ -20,8 +20,8 @@
 
 <license/>
 
-<version>0.16</version>
-<date>2005-09-06</date>
+<version>0.17</version>
+<date>2005-10-08</date>
 
 <chapter>
 <title>Setting up your local environment</title>
@@ -168,10 +168,10 @@
 
 <pre caption="Minimal /etc/xml/catalog">
 &lt;?xml version="1.0"?&gt;
-&lt;DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
+&lt;!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
 &lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"&gt;
   &lt;rewriteURI uriStartString="/dtd/" rewritePrefix="<i>/usr/portage/metadata/dtd/</i>"/&gt;
-&lt;catalog&gt;
+&lt;/catalog&gt;
 </pre>
 
 <p>



-- 
gentoo-doc-cvs@gentoo.org mailing list

[gentoo-doc-cvs] cvs commit: doc-tipsntricks.xml

[Xavier Neys]

neysx       06/03/21 12:17:12

  Modified:             doc-tipsntricks.xml
  Log:
  Spring clean up

Revision  Changes    Path
1.13                 xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml

file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.13&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.13&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml.diff?r1=1.12&r2=1.13&cvsroot=gentoo

Index: doc-tipsntricks.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- doc-tipsntricks.xml	8 Oct 2005 13:34:33 -0000	1.12
+++ doc-tipsntricks.xml	21 Mar 2006 12:17:12 -0000	1.13
@@ -1,9 +1,9 @@
 <?xml version='1.0' encoding="UTF-8"?>
 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
 
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.12 2005/10/08 13:34:33 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.13 2006/03/21 12:17:12 neysx Exp $ -->
 
-<guide link="doc-tipsntricks.xml">
+<guide link="/proj/en/gdp/doc/doc-tipsntricks.xml">
 <title>Documentation Development Tips &amp; Tricks</title>
 
 <author title="Author">
@@ -20,8 +20,8 @@
 
 <license/>
 
-<version>0.17</version>
-<date>2005-10-08</date>
+<version>0.18</version>
+<date>2005-03-21</date>
 
 <chapter>
 <title>Setting up your local environment</title>
@@ -75,7 +75,7 @@
 </p>
 
 <pre caption="Creating a patch for an update">
-$ <i>diff -uNt </i><comment>${LANG}</comment><i>/alsa-guide.xml alsa-guide.xml</i> > alsa-guide.diff
+$ <i>diff -U6 </i><comment>${LANG}</comment><i>/alsa-guide.xml alsa-guide.xml</i> > alsa-guide.diff
 </pre>
 
 </body>
@@ -134,22 +134,24 @@
 $ <i>cd test</i>
 $ <i>mkdir css images</i>
 $ <i>wget -P css/ http://www.gentoo.org/css/main.css</i>
-$ <i>wget -P images/ http://www.gentoo.org/images/gbot-s.gif \
-  http://www.gentoo.org/images/gridtest.gif \
-  http://www.gentoo.org/images/gtop-s.jpg \
-  http://www.gentoo.org/images/line.gif \
-  http://www.gentoo.org/images/netraverse-gentoo.gif</i>
+$ <i>wget -P images/ http://www.gentoo.org/images/gridtest.gif \
+  http://www.gentoo.org/images/gtop-new.gif \
+  http://www.gentoo.org/images/gtop-www.jpg</i>
 </pre>
 
 <p>
 Now download a special version of <path>guide.xsl</path> available on <uri
-link="http://dev.gentoo.org/~swift/gentoo/downloads/guide.xsl">SwifT's 
-webspace</uri>. This version is adapted to transform GuideXML to HTML on 
-local systems.
+link="http://dev.gentoo.org/~neysx/guide.xsl">neysx's webspace</uri>. This
+version is adapted to transform GuideXML to HTML on local systems and supports
+quite a few languages. A <uri
+link="http://dev.gentoo.org/~neysx/guide-en.xsl">much shorter version</uri>
+that supports only English is also available.
 </p>
 
 <pre caption="Downloading guide.xsl">
-$ <i>wget http://dev.gentoo.org/~swift/gentoo/downloads/guide.xsl</i>
+$ <i>wget http://dev.gentoo.org/~neysx/guide.xsl</i>
+<comment>( <b>Or</b>, if English is all you need)</comment>
+$ <i>wget -O guide.xsl http://dev.gentoo.org/~neysx/guide-en.xsl</i>
 </pre>
 
 <p>
@@ -221,18 +223,27 @@
 <body>
 
 <p>
-The Gentoo Handbook is divided in chapters. To process a certain chapter, you
+The Gentoo Handbook is divided in chapters. To process a certain chapter almost as it would on our web server, you
 must use both the <path>handbook-x86.xml</path> file as the required
 <path>hb-</path> file (such as <path>hb-install-about.xml</path>). Then you
 must pass <c>xsltproc</c> the same parameters that are used while browsing the
 online handbook, namely <c>part</c> and <c>chap</c>. For instance, to validate
-<path>hb-install-about.xml</path>:
+<path>hb-install-about.xml</path>. Please note that you need all the files that the hanbook includes.
+</p>
+
+<p>
+Alternatively, you can also process a handbook chapter like any other guide
+document, but links to other chapters will not be generated.
 </p>
 
 <pre caption="Validating hb-install-about.xml">
 $ <i>xmllint --valid --noout handbook-x86.xml</i>
 $ <i>xmllint --valid --noout hb-install-about.xml</i>
 $ <i>xsltproc --stringparam part 1 --stringparam chap 1 test/guide.xsl handbook-x86.xml &gt; test/hb-install-about.html</i>
+
+<comment>(or the easy way)</comment>
+
+$ <i>xsltproc test/guide.xsl hb-install-about.xml &gt; test/hb-install-about.html</i>
 </pre>
 
 </body>
@@ -244,6 +255,12 @@
 <section>
 <body>
 
+<note>
+This chapter is not actively maintained and is kept only for historical
+purposes as long as one of our web servers is still using an axkit setup.
+You might want to consider trying out <c>gorg</c>.
+</note>
+
 <p>
 Some doc developers prefer to use an axkit setup similar to the one running on
 <uri>http://www.gentoo.org</uri>.  Here are a few pointers to help you setup a similar



-- 
gentoo-doc-cvs@gentoo.org mailing list

[gentoo-doc-cvs] cvs commit: doc-tipsntricks.xml

[Xavier Neys]

neysx       06/03/21 21:55:23

  Modified:             doc-tipsntricks.xml
  Log:
  #100026 Added submitters tips. Thanks to rane for initiating it and to nightmorph for turning it into English :)

Revision  Changes    Path
1.14                 xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml

file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.14&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.14&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml.diff?r1=1.13&r2=1.14&cvsroot=gentoo

Index: doc-tipsntricks.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- doc-tipsntricks.xml	21 Mar 2006 12:17:12 -0000	1.13
+++ doc-tipsntricks.xml	21 Mar 2006 21:55:23 -0000	1.14
@@ -1,7 +1,7 @@
 <?xml version='1.0' encoding="UTF-8"?>
 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
 
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.13 2006/03/21 12:17:12 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.14 2006/03/21 21:55:23 neysx Exp $ -->
 
 <guide link="/proj/en/gdp/doc/doc-tipsntricks.xml">
 <title>Documentation Development Tips &amp; Tricks</title>
@@ -20,8 +20,8 @@
 
 <license/>
 
-<version>0.18</version>
-<date>2005-03-21</date>
+<version>0.19</version>
+<date>2006-03-21</date>
 
 <chapter>
 <title>Setting up your local environment</title>
@@ -417,6 +417,84 @@
 </chapter>
 
 <chapter>
+<title>Documentation Submission Tips</title>
+<section>
+<title>Check for correct &lt;guide&gt; tags</title>
+<body>
+
+<p>
+Make sure that the &lt;guide link&gt; attribute points to the correct location
+for the guide. This is generally <path>/doc/${LANG}/filename.xml</path>. If you
+have a translated document, always specify the absolute path to the document
+(e.g. <path>/doc/${LANG}/</path>). If you are writing a guide that uses the
+<c>guide</c> or <c>book</c> DTD, you may use either
+<path>/doc/${LANG}/filename.xml</path> or <path>filename.xml</path>. Generally,
+the GDP recommends the former specification.
+</p>
+
+</body>
+</section>
+<section>
+<title>Check links</title>
+<body>
+
+<p>
+You <e>must</e> verify that all hyperlinks in your document work. If it is a
+translated document, make sure that any links to other translated documents
+point to the existing files.
+</p>
+
+</body>
+</section>
+<section>
+<title>Check for tabs</title>
+<body>
+
+<p>
+Tabs are absolutely forbidden in GuideXML documents except when required (e.g.
+if the document instructs the user to use tabs). To check a document for tabs,
+run <c>grep "CTRL+V&lt;TAB&gt;" file.xml</c>. Fix any lines that <c>grep</c>
+prints out.
+</p>
+
+</body>
+</section>
+<section>
+<title>Bugzilla</title>
+<body>
+
+<p>
+Once you have finished your document, submit it to the Documentation Team using
+<uri
+link="http://bugs.gentoo.org/enter_bug.cgi?product=Documentation">Bugzilla</uri>.
+You don't have to mention information like platform, <c>emerge info</c>
+output, arch, steps to reproduce, etc. If you have a translated document, be
+sure to select the <uri
+link="http://bugs.gentoo.org/enter_bug.cgi?product=Doc%20Translations">Doc
+Translations</uri> component for your bugs. Also, include a helpful summary
+for your translation using the preferred format: "[fr] New translation:
+/doc/fr/gnupg-user.xml". Replace <b>[fr]</b> with the two-letter code for your
+language.
+</p>
+
+<p>
+By default, <mail>docs-team@gentoo.org</mail> is the assignee of your bug;
+there's no need to change the assignee field.
+</p>
+
+<p>
+Attach files and patches to the bug using the "plain text (text/plain)"
+selection.  Do <e>not</e> select "XML source (application/xml)", even if you
+are submitting a <path>.xml</path> file. Patches should have the "Patch" option
+checked. Do not submit tarballs full of documents; attach each document and
+patch individually.
+</p>
+
+</body>
+</section>
+</chapter>
+
+<chapter>
 <title>Commonly or Dangerous Made Mistakes</title>
 <section>
 <title>Forgetting the all-arch-aspect of the Gentoo Handbook</title>
@@ -442,10 +520,17 @@
 <body>
 
 <p>
-Conforming the policy, you <e>must</e> bump a version/date when you make certain
-changes (most actually). Although the version is less important (SwifT will
-still kill you if you forget it) the date tells our users when the document was
-altered for the last time.
+Conforming to the policy, you <e>must</e> bump a version/date when you make
+certain changes (most actually). Although the version is less important (SwifT
+will still kill you if you forget it) the date tells our users when the
+document was last modified.
+</p>
+
+<p>
+If you are making a <e>content</e> change to a document (such as instructions,
+code examples, etc.), then you must increment the version. For
+<e>non-content</e> changes (e.g. typo or GuideXML fixes), version bumping is
+usually unnecessary.
 </p>
 
 <p>



-- 
gentoo-doc-cvs@gentoo.org mailing list

[gentoo-doc-cvs] cvs commit: doc-tipsntricks.xml

[Xavier Neys]

neysx       06/03/24 16:25:13

  Modified:             doc-tipsntricks.xml
  Log:
  Fixed logo link

Revision  Changes    Path
1.15                 xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml

file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.15&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.15&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml.diff?r1=1.14&r2=1.15&cvsroot=gentoo

Index: doc-tipsntricks.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- doc-tipsntricks.xml	21 Mar 2006 21:55:23 -0000	1.14
+++ doc-tipsntricks.xml	24 Mar 2006 16:25:13 -0000	1.15
@@ -1,7 +1,7 @@
 <?xml version='1.0' encoding="UTF-8"?>
 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
 
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.14 2006/03/21 21:55:23 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.15 2006/03/24 16:25:13 neysx Exp $ -->
 
 <guide link="/proj/en/gdp/doc/doc-tipsntricks.xml">
 <title>Documentation Development Tips &amp; Tricks</title>
@@ -20,8 +20,8 @@
 
 <license/>
 
-<version>0.19</version>
-<date>2006-03-21</date>
+<version>0.20</version>
+<date>2006-03-24</date>
 
 <chapter>
 <title>Setting up your local environment</title>
@@ -135,7 +135,7 @@
 $ <i>mkdir css images</i>
 $ <i>wget -P css/ http://www.gentoo.org/css/main.css</i>
 $ <i>wget -P images/ http://www.gentoo.org/images/gridtest.gif \
-  http://www.gentoo.org/images/gtop-new.gif \
+  http://www.gentoo.org/images/gentoo-new.gif \
   http://www.gentoo.org/images/gtop-www.jpg</i>
 </pre>
 



-- 
gentoo-doc-cvs@gentoo.org mailing list

[gentoo-doc-cvs] cvs commit: doc-tipsntricks.xml

[Xavier Neys]

neysx       06/03/28 10:42:08

  Modified:             doc-tipsntricks.xml
  Log:
  #127636 Small fixes

Revision  Changes    Path
1.16                 xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml

file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.16&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.16&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml.diff?r1=1.15&r2=1.16&cvsroot=gentoo

Index: doc-tipsntricks.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- doc-tipsntricks.xml	24 Mar 2006 16:25:13 -0000	1.15
+++ doc-tipsntricks.xml	28 Mar 2006 10:42:08 -0000	1.16
@@ -1,7 +1,7 @@
 <?xml version='1.0' encoding="UTF-8"?>
 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
 
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.15 2006/03/24 16:25:13 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.16 2006/03/28 10:42:08 neysx Exp $ -->
 
 <guide link="/proj/en/gdp/doc/doc-tipsntricks.xml">
 <title>Documentation Development Tips &amp; Tricks</title>
@@ -20,8 +20,8 @@
 
 <license/>
 
-<version>0.20</version>
-<date>2006-03-24</date>
+<version>0.21</version>
+<date>2006-03-28</date>
 
 <chapter>
 <title>Setting up your local environment</title>
@@ -56,7 +56,7 @@
 </pre>
 
 <p>
-In case you want to help translating documents, create a directory for your 
+In case you want to help translating documents, create a directory for your
 language in which you keep the at that time current translations:
 </p>
 
@@ -223,26 +223,29 @@
 <body>
 
 <p>
-The Gentoo Handbook is divided in chapters. To process a certain chapter almost as it would on our web server, you
-must use both the <path>handbook-x86.xml</path> file as the required
-<path>hb-</path> file (such as <path>hb-install-about.xml</path>). Then you
-must pass <c>xsltproc</c> the same parameters that are used while browsing the
-online handbook, namely <c>part</c> and <c>chap</c>. For instance, to validate
-<path>hb-install-about.xml</path>. Please note that you need all the files that the hanbook includes.
+The Gentoo Handbook is divided in chapters. To process a certain chapter almost
+as it would on our web server, you must use both the
+<path>handbook-x86.xml</path> file as the required <path>hb-</path> file (such
+as <path>hb-install-about.xml</path>). Then you must pass <c>xsltproc</c> the
+same parameters that are used while browsing the online handbook, namely
+<c>part</c> and <c>chap</c>. Follows an example of how you can validate
+<path>hb-install-about.xml</path>. Please note that you need all the files that
+the hanbook includes.
 </p>
 
+<pre caption="Validating and converting hb-install-about.xml">
+$ <i>xmllint --valid --noout handbook-x86.xml</i>
+$ <i>xmllint --valid --noout hb-install-about.xml</i>
+$ <i>xsltproc --stringparam part 1 --stringparam chap 1 test/guide.xsl handbook-x86.xml &gt; test/hb-install-about.html</i>
+</pre>
+
 <p>
 Alternatively, you can also process a handbook chapter like any other guide
 document, but links to other chapters will not be generated.
 </p>
 
-<pre caption="Validating hb-install-about.xml">
-$ <i>xmllint --valid --noout handbook-x86.xml</i>
+<pre caption="Validating and converting hb-install-about.xml the easy way">
 $ <i>xmllint --valid --noout hb-install-about.xml</i>
-$ <i>xsltproc --stringparam part 1 --stringparam chap 1 test/guide.xsl handbook-x86.xml &gt; test/hb-install-about.html</i>
-
-<comment>(or the easy way)</comment>
-
 $ <i>xsltproc test/guide.xsl hb-install-about.xml &gt; test/hb-install-about.html</i>
 </pre>
 
@@ -263,8 +266,8 @@
 
 <p>
 Some doc developers prefer to use an axkit setup similar to the one running on
-<uri>http://www.gentoo.org</uri>.  Here are a few pointers to help you setup a similar
-configuration.
+<uri>http://www.gentoo.org</uri>.  Here are a few pointers to help you setup a
+similar configuration.
 </p>
 
 <warn>
@@ -286,12 +289,12 @@
 These are the packages that I would merge, in order:
 
 Calculating dependencies ...done!
-[ebuild   R   ] dev-libs/libxml2-2.x.17  -debug -ipv6 +python +readline  0 kB 
-[ebuild   R   ] dev-libs/libxslt-1.1.12  +crypt +python  0 kB 
-[ebuild   R   ] dev-perl/AxKit-1.6.1  +gnome  0 kB 
-[ebuild   R   ] dev-perl/XML-XPath-1.13   0 kB 
-[ebuild   R   ] dev-perl/XML-LibXML-1.58   0 kB 
-[ebuild   R   ] dev-perl/XML-LibXSLT-1.57   0 kB 
+[ebuild   R   ] dev-libs/libxml2-2.x.17  -debug -ipv6 +python +readline  0 kB
+[ebuild   R   ] dev-libs/libxslt-1.1.12  +crypt +python  0 kB
+[ebuild   R   ] dev-perl/AxKit-1.6.1  +gnome  0 kB
+[ebuild   R   ] dev-perl/XML-XPath-1.13   0 kB
+[ebuild   R   ] dev-perl/XML-LibXML-1.58   0 kB
+[ebuild   R   ] dev-perl/XML-LibXSLT-1.57   0 kB
 [ebuild   R   ] dev-perl/XML-Parser-2.34   0 kB
 [ebuild   R   ] net-www/apache-1.3.33  +pam  0 kB
 
@@ -471,7 +474,7 @@
 output, arch, steps to reproduce, etc. If you have a translated document, be
 sure to select the <uri
 link="http://bugs.gentoo.org/enter_bug.cgi?product=Doc%20Translations">Doc
-Translations</uri> component for your bugs. Also, include a helpful summary
+Translations</uri> component for your bug. Also, include a helpful summary
 for your translation using the preferred format: "[fr] New translation:
 /doc/fr/gnupg-user.xml". Replace <b>[fr]</b> with the two-letter code for your
 language.



-- 
gentoo-doc-cvs@gentoo.org mailing list

[gentoo-doc-cvs] cvs commit: doc-tipsntricks.xml

[Xavier Neys]

neysx       06/05/11 09:14:57

  Modified:             doc-tipsntricks.xml
  Log:
  #132963 #132962 Do not use --novalid with xsltproc

Revision  Changes    Path
1.17                 xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml

file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.17&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.17&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml.diff?r1=1.16&r2=1.17&cvsroot=gentoo

Index: doc-tipsntricks.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- doc-tipsntricks.xml	28 Mar 2006 10:42:08 -0000	1.16
+++ doc-tipsntricks.xml	11 May 2006 09:14:57 -0000	1.17
@@ -1,7 +1,7 @@
 <?xml version='1.0' encoding="UTF-8"?>
 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
 
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.16 2006/03/28 10:42:08 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.17 2006/05/11 09:14:57 neysx Exp $ -->
 
 <guide link="/proj/en/gdp/doc/doc-tipsntricks.xml">
 <title>Documentation Development Tips &amp; Tricks</title>
@@ -20,8 +20,8 @@
 
 <license/>
 
-<version>0.21</version>
-<date>2006-03-28</date>
+<version>0.22</version>
+<date>2006-05-11</date>
 
 <chapter>
 <title>Setting up your local environment</title>
@@ -207,7 +207,7 @@
 </p>
 
 <pre caption="Converting to HTML">
-$ <i>xsltproc --novalid test/guide.xsl alsa-guide.xml &gt; test/alsa-guide.html</i>
+$ <i>xsltproc test/guide.xsl alsa-guide.xml &gt; test/alsa-guide.html</i>
 </pre>
 
 <p>



-- 
gentoo-doc-cvs@gentoo.org mailing list

[gentoo-doc-cvs] cvs commit: doc-tipsntricks.xml

[Josh Saddler]

nightmorph    06/05/25 19:23:34

  Modified:             doc-tipsntricks.xml
  Log:
  Simplified test dir additions; thanks to tcort (tcort at gentoo dot org) for the patch, bug 134349

Revision  Changes    Path
1.18                 xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml

file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.18&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.18&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml.diff?r1=1.17&r2=1.18&cvsroot=gentoo

Index: doc-tipsntricks.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- doc-tipsntricks.xml	11 May 2006 09:14:57 -0000	1.17
+++ doc-tipsntricks.xml	25 May 2006 19:23:34 -0000	1.18
@@ -1,7 +1,7 @@
 <?xml version='1.0' encoding="UTF-8"?>
 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
 
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.17 2006/05/11 09:14:57 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.18 2006/05/25 19:23:34 nightmorph Exp $ -->
 
 <guide link="/proj/en/gdp/doc/doc-tipsntricks.xml">
 <title>Documentation Development Tips &amp; Tricks</title>
@@ -20,8 +20,8 @@
 
 <license/>
 
-<version>0.22</version>
-<date>2006-05-11</date>
+<version>0.23</version>
+<date>2006-05-25</date>
 
 <chapter>
 <title>Setting up your local environment</title>
@@ -130,9 +130,8 @@
 </p>
 
 <pre caption="Creating the test environment">
-$ <i>mkdir test</i>
+$ <i>mkdir -p test/{css,images}</i>
 $ <i>cd test</i>
-$ <i>mkdir css images</i>
 $ <i>wget -P css/ http://www.gentoo.org/css/main.css</i>
 $ <i>wget -P images/ http://www.gentoo.org/images/gridtest.gif \
   http://www.gentoo.org/images/gentoo-new.gif \



-- 
gentoo-doc-cvs@gentoo.org mailing list

[gentoo-doc-cvs] cvs commit: doc-tipsntricks.xml

[Xavier Neys]

neysx       06/07/19 19:24:39

  Modified:             doc-tipsntricks.xml
  Log:
  Link to sources.g.o

Revision  Changes    Path
1.19                 xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml

file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.19&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.19&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml.diff?r1=1.18&r2=1.19&cvsroot=gentoo

Index: doc-tipsntricks.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -r1.18 -r1.19
--- doc-tipsntricks.xml	25 May 2006 19:23:34 -0000	1.18
+++ doc-tipsntricks.xml	19 Jul 2006 19:24:39 -0000	1.19
@@ -1,7 +1,7 @@
 <?xml version='1.0' encoding="UTF-8"?>
 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
 
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.18 2006/05/25 19:23:34 nightmorph Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.19 2006/07/19 19:24:39 neysx Exp $ -->
 
 <guide link="/proj/en/gdp/doc/doc-tipsntricks.xml">
 <title>Documentation Development Tips &amp; Tricks</title>
@@ -20,8 +20,8 @@
 
 <license/>
 
-<version>0.23</version>
-<date>2006-05-25</date>
+<version>0.24</version>
+<date>2006-07-19</date>
 
 <chapter>
 <title>Setting up your local environment</title>
@@ -85,11 +85,11 @@
 <body>
 
 <p>
-You can request our <uri link="/cgi-bin/viewcvs.cgi">Online CVS
+You can request our <uri link="http://sources.gentoo.org/">Online CVS
 Repository</uri> to provide the differences between individual versions. The
 main English repository is <uri
-link="/cgi-bin/viewcvs.cgi/en/?root=doc&amp;sortby=date">fully
-available</uri>.  Also, the online CVS repository is updated every hour.
+link="http://sources.gentoo.org/gentoo/xml/htdocs/doc/en/">fully
+available</uri>. Also, the online CVS repository is updated every hour.
 </p>
 
 </body>
@@ -354,8 +354,7 @@
 <path>doc/</path>, <path>dtd/</path>, <path>images/</path> and
 <path>xsl/</path> directories. Gentoo developers can copy from or symlink to
 their CVS local copy. Other contributors will need to download the files from
-our <uri
-link="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/?root=gentoo">viewCVS</uri>
+our <uri link="http://sources.gentoo.org/gentoo/xml/htdocs/">viewCVS</uri>
 interface.
 </p>
 



-- 
gentoo-doc-cvs@gentoo.org mailing list

[gentoo-doc-cvs] cvs commit: doc-tipsntricks.xml

[Lukasz Damentko]

rane        06/07/21 04:38:47

  Modified:             doc-tipsntricks.xml
  Log:
  #141220, adding information about packages xmllint and xsltproc belong to

Revision  Changes    Path
1.20                 xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml

file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.20&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.20&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml.diff?r1=1.19&r2=1.20&cvsroot=gentoo

Index: doc-tipsntricks.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -r1.19 -r1.20
--- doc-tipsntricks.xml	19 Jul 2006 19:24:39 -0000	1.19
+++ doc-tipsntricks.xml	21 Jul 2006 04:38:47 -0000	1.20
@@ -1,7 +1,7 @@
 <?xml version='1.0' encoding="UTF-8"?>
 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
 
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.19 2006/07/19 19:24:39 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.20 2006/07/21 04:38:47 rane Exp $ -->
 
 <guide link="/proj/en/gdp/doc/doc-tipsntricks.xml">
 <title>Documentation Development Tips &amp; Tricks</title>
@@ -20,8 +20,8 @@
 
 <license/>
 
-<version>0.24</version>
-<date>2006-07-19</date>
+<version>0.25</version>
+<date>2006-07-20</date>
 
 <chapter>
 <title>Setting up your local environment</title>
@@ -192,7 +192,8 @@
 <body>
 
 <p>
-To test a Gentoo Guide, first check if it uses correct XML:
+To test a Gentoo Guide, first use <c>xmllint</c> (from <c>dev-libs/libxml2</c>)
+to check if it uses correct XML:
 </p>
 
 <pre caption="Using xmllint to verify guides">
@@ -202,7 +203,7 @@
 <p>
 If <c>xmllint</c> returns without showing anything,  then the file is
 error-free (or at least concerning XML-tags). Next you need to convert it to
-HTML. <c>xsltproc</c> is the tool needed for that:
+HTML, using <c>xsltproc</c> (from <c>dev-libs/libxslt</c>):
 </p>
 
 <pre caption="Converting to HTML">



-- 
gentoo-doc-cvs@gentoo.org mailing list

[gentoo-doc-cvs] cvs commit: doc-tipsntricks.xml

[Xavier Neys]

neysx       06/11/03 16:53:07

  Modified:             doc-tipsntricks.xml
  Log:
  #153938 We do not use/support axkit anymore

Revision  Changes    Path
1.21                 xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml

file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.21&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.21&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?r1=1.20&r2=1.21

Index: doc-tipsntricks.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -r1.20 -r1.21
--- doc-tipsntricks.xml	21 Jul 2006 04:38:47 -0000	1.20
+++ doc-tipsntricks.xml	3 Nov 2006 16:53:07 -0000	1.21
@@ -1,16 +1,16 @@
 <?xml version='1.0' encoding="UTF-8"?>
 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
 
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.20 2006/07/21 04:38:47 rane Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.21 2006/11/03 16:53:07 neysx Exp $ -->
 
 <guide link="/proj/en/gdp/doc/doc-tipsntricks.xml">
 <title>Documentation Development Tips &amp; Tricks</title>
 
 <author title="Author">
-    <mail link="swift@gentoo.org">Sven Vermeulen</mail>
+  <mail link="neysx@gentoo.org">Xavier Neys</mail>
 </author>
-<author title="Editor">
-    <mail link="neysx@gentoo.org">Xavier Neys</mail>
+<author title="Author">
+  <mail link="swift@gentoo.org">Sven Vermeulen</mail>
 </author>
 
 <abstract>
@@ -20,8 +20,8 @@
 
 <license/>
 
-<version>0.25</version>
-<date>2006-07-20</date>
+<version>0.26</version>
+<date>2006-11-03</date>
 
 <chapter>
 <title>Setting up your local environment</title>
@@ -254,139 +254,6 @@
 </chapter>
 
 <chapter>
-<title>Using an axkit setup</title>
-<section>
-<body>
-
-<note>
-This chapter is not actively maintained and is kept only for historical
-purposes as long as one of our web servers is still using an axkit setup.
-You might want to consider trying out <c>gorg</c>.
-</note>
-
-<p>
-Some doc developers prefer to use an axkit setup similar to the one running on
-<uri>http://www.gentoo.org</uri>.  Here are a few pointers to help you setup a
-similar configuration.
-</p>
-
-<warn>
-It seems that axkit is very sensitive to the versions of the packages it uses,
-especially libxml2. The configuration described below is known to work. Any
-other combination of packages might break.
-</warn>
-
-<p>
-First, install the required packages:
-</p>
-
-<pre caption="emerging specific versions on required packages">
-<comment>(Test if packages are available to portage)</comment>
-# <i>emerge -vp =dev-libs/libxml2-2.6.17 =dev-libs/libxslt-1.1.12 \
-=dev-perl/AxKit-1.6.1 =dev-perl/XML-XPath-1.13 =dev-perl/XML-LibXML-1.58 \
-=dev-perl/XML-LibXSLT-1.57 =dev-perl/XML-Parser-2.34 =net-www/apache-1.3.33</i>
-
-These are the packages that I would merge, in order:
-
-Calculating dependencies ...done!
-[ebuild   R   ] dev-libs/libxml2-2.x.17  -debug -ipv6 +python +readline  0 kB
-[ebuild   R   ] dev-libs/libxslt-1.1.12  +crypt +python  0 kB
-[ebuild   R   ] dev-perl/AxKit-1.6.1  +gnome  0 kB
-[ebuild   R   ] dev-perl/XML-XPath-1.13   0 kB
-[ebuild   R   ] dev-perl/XML-LibXML-1.58   0 kB
-[ebuild   R   ] dev-perl/XML-LibXSLT-1.57   0 kB
-[ebuild   R   ] dev-perl/XML-Parser-2.34   0 kB
-[ebuild   R   ] net-www/apache-1.3.33  +pam  0 kB
-
-<comment>(Install packages)</comment>
-# <i>emerge =dev-libs/libxml2-2.6.17 =dev-libs/libxslt-1.1.12 \
-=dev-perl/AxKit-1.6.1 =dev-perl/XML-XPath-1.13 =dev-perl/XML-LibXML-1.58 \
-=dev-perl/XML-LibXSLT-1.57 =dev-perl/XML-Parser-2.34 =net-www/apache-1.3.33</i>
-</pre>
-
-<p>
-Then, edit the following config files:
-</p>
-
-<pre caption="/etc/apache/conf/commonapache.conf">
-<comment>(Inside)</comment>
-&lt;IfModule mod_dir.c&gt;
-  <comment>(Add index.xml to the list)</comment>
-  DirectoryIndex index.xml index.html index.php index.php3 index.shtml index.cgi index.pl index.htm Default.htm default.htm
-&lt;/IfModule&gt;
-
-<comment>(Add the following lines)</comment>
-&lt;IfDefine PERL&gt;
-  LoadModule perl_module extramodules/libperl.so
-#  AddModule mod_perl.c
-  PerlModule AxKit
-  SetHandler perl-script
-  PerlHandler Apache::AxKit::StyleChooser::PathInfo AxKit
-  AddHandler axkit .xml .xsp
-  AxAddPlugin Apache::AxKit::StyleChooser::QueryString
-  AxAddXSPTaglib AxKit::XSP::Util
-  AxAddXSPTaglib AxKit::XSP::IfParam
-  AxAddXSPTaglib AxKit::XSP::Param
-  AxAddStyleMap application/x-xsp Apache::AxKit::Language::XSP
-  AxAddStyleMap text/xsl Apache::AxKit::Language::LibXSLT
-  &lt;AxStyleName "#default"&gt;
-    AxAddProcessor text/xsl /xsl/guide.xsl
-  &lt;/AxStyleName&gt;
-  &lt;AxStyleName printable&gt;
-    AxAddProcessor text/xsl /xsl/guide-print.xsl
-  &lt;/AxStyleName&gt;
-&lt;/IfDefine&gt;
-
-<comment>(Inside)</comment>
-&lt;IfModule mod_alias.c&gt;
-    Alias /icons/ /var/www/localhost/icons/
-<comment>(Comment out the following line)</comment>
-    #Alias /doc /usr/share/doc
-</pre>
-
-<pre caption="/etc/conf.d/apache">
-<comment>(Add -D PERL to the list of options)</comment>
-APACHE_OPTS="-D PERL"
-</pre>
-
-<p>
-Then, copy the documentation files including the DTDs and stylesheets to
-<path>/var/www/localhost/htdocs/</path>. You need the <path>css/</path>,
-<path>doc/</path>, <path>dtd/</path>, <path>images/</path> and
-<path>xsl/</path> directories. Gentoo developers can copy from or symlink to
-their CVS local copy. Other contributors will need to download the files from
-our <uri link="http://sources.gentoo.org/gentoo/xml/htdocs/">viewCVS</uri>
-interface.
-</p>
-
-<p>
-All there is left to do is start your apache server with:
-</p>
-
-<pre caption="Launching apache">
-# <i>/etc/init.d/apache start</i>
-# <comment>(Add it to your runlevel if you want to start it automatically at boot time)</comment>
-# <i>rc-update add apache default</i>
-</pre>
-
-<p>
-Point now your browser to <uri>http://your_server/doc/en/</uri> or simply
-<uri>http://localhost/doc/en/</uri> if you installed axkit on your workstation.
-You can check <path>/var/log/apache/access_log</path> for accesses and
-<path>/var/log/apache/error_log</path> for errors.
-</p>
-
-<note>
-Mozilla users might need to set <c>keyword.enabled</c> to <c>false</c> in their
-<uri>about:config</uri> page when using localhost.
-</note>
-
-</body>
-</section>
-
-</chapter>
-
-<chapter>
 <title>Frequently Asked Questions</title>
 <section>
 <title>How do I convert a file to UTF-8?</title>



-- 
gentoo-doc-cvs@gentoo.org mailing list

[gentoo-doc-cvs] cvs commit: doc-tipsntricks.xml

[Josh Saddler]

nightmorph    07/03/13 15:31:01

  Modified:             doc-tipsntricks.xml
  Log:
  typo fix, no content change

Revision  Changes    Path
1.24                 xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml

file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.24&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.24&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?r1=1.23&r2=1.24

Index: doc-tipsntricks.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -r1.23 -r1.24
--- doc-tipsntricks.xml	8 Mar 2007 10:35:24 -0000	1.23
+++ doc-tipsntricks.xml	13 Mar 2007 15:31:01 -0000	1.24
@@ -1,7 +1,7 @@
 <?xml version='1.0' encoding="UTF-8"?>
 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
 
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.23 2007/03/08 10:35:24 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.24 2007/03/13 15:31:01 nightmorph Exp $ -->
 
 <guide link="/proj/en/gdp/doc/doc-tipsntricks.xml">
 <title>Documentation Development Tips &amp; Tricks</title>
@@ -45,7 +45,7 @@
 </pre>
 
 <p>
-To update our copy of the repository, run <c>cvs update -dP</c> in the
+To update your copy of the repository, run <c>cvs update -dP</c> in the
 <path>gentoo/xml</path> directory.
 </p>
 



-- 
gentoo-doc-cvs@gentoo.org mailing list

[gentoo-doc-cvs] cvs commit: doc-tipsntricks.xml

[Josh Saddler]

nightmorph    07/07/17 17:57:25

  Modified:             doc-tipsntricks.xml
  Log:
  a typo! how shameful. fixed, no content change.

Revision  Changes    Path
1.25                 xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml

file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.25&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.25&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?r1=1.24&r2=1.25

Index: doc-tipsntricks.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v
retrieving revision 1.24
retrieving revision 1.25
diff -u -r1.24 -r1.25
--- doc-tipsntricks.xml	13 Mar 2007 15:31:01 -0000	1.24
+++ doc-tipsntricks.xml	17 Jul 2007 17:57:25 -0000	1.25
@@ -1,7 +1,7 @@
 <?xml version='1.0' encoding="UTF-8"?>
 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
 
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.24 2007/03/13 15:31:01 nightmorph Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.25 2007/07/17 17:57:25 nightmorph Exp $ -->
 
 <guide link="/proj/en/gdp/doc/doc-tipsntricks.xml">
 <title>Documentation Development Tips &amp; Tricks</title>
@@ -32,7 +32,7 @@
 <p>
 Contributors should use our <uri link="http://anoncvs.gentoo.org/">anonymous
 CVS server</uri>. It contains the same files as the official CVS that Gentoo
-developpers use. The anonymous CVS repository is updated every hour.
+developers use. The anonymous CVS repository is updated every hour.
 </p>
 
 <p>



-- 
gentoo-doc-cvs@gentoo.org mailing list