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 & Tricks</title> + <author title="Author"> <mail link="[EMAIL PROTECTED]">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><your nick></comment><i>@cvs.gentoo.org:/var/cvsroot</i> -# <i>cvs co doc</i> +$ <i>mkdir cvs; cd cvs/</i> +$ <i>export CVSROOT=</i><comment><your nick></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"> -<rewriteURI uriStartString="/dtd" rewritePrefix="<i>/usr/portage/metadata/dtd/</i>"/> +<rewriteURI uriStartString="/dtd/" rewritePrefix="<i>/usr/portage/metadata/dtd/</i>"/> +</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><rewriteURI></c> element <e>inside</e> +the <c><catalog></c> element: +</p> + +<pre caption="Minimal /etc/xml/catalog"> +<?xml version="1.0"?> +<DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"> +<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"> + <rewriteURI uriStartString="/dtd/" rewritePrefix="<i>/usr/portage/metadata/dtd/</i>"/> +<catalog> +</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"> +<rewriteURI uriStartString="http://www.gentoo.org/dtd/"; rewritePrefix="<i>/usr/portage/metadata/dtd/</i>"/> </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 > test/alsa-guide.html</i> +$ <i>xsltproc --novalid test/guide.xsl alsa-guide.xml > 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 > 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 > test/hb-install-about.html</i> </pre> </body> -- [email protected] mailing list
