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 & 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 > 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> </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 -- [email protected] mailing list
