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 & 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 > 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 > test/hb-install-about.html</i> - -<comment>(or the easy way)</comment> - $ <i>xsltproc test/guide.xsl hb-install-about.xml > 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. -- [email protected] mailing list
