From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from lists.gentoo.org ([140.105.134.102] helo=robin.gentoo.org) by nuthatch.gentoo.org with esmtp (Exim 4.54) id 1FOBe8-00025M-H0 for garchives@archives.gentoo.org; Tue, 28 Mar 2006 10:41:57 +0000 Received: from robin.gentoo.org (localhost [127.0.0.1]) by robin.gentoo.org (8.13.6/8.13.5) with SMTP id k2SAgAaa005213; Tue, 28 Mar 2006 10:42:10 GMT Received: from smtp.gentoo.org (smtp.gentoo.org [134.68.220.30]) by robin.gentoo.org (8.13.6/8.13.5) with ESMTP id k2SAg9Rr021399 for ; Tue, 28 Mar 2006 10:42:10 GMT Message-Id: <200603281042.k2SAg9Rr021399@robin.gentoo.org> Received: from lark.gentoo.osuosl.org ([140.211.166.177] helo=lark) by smtp.gentoo.org with smtp (Exim 4.54) id 1FOBeL-00055k-5q for gentoo-doc-cvs@lists.gentoo.org; Tue, 28 Mar 2006 10:42:09 +0000 Received: by lark (sSMTP sendmail emulation); Tue, 28 Mar 2006 10:42:08 +0000 From: "Xavier Neys" Date: Tue, 28 Mar 2006 10:42:08 +0000 To: gentoo-doc-cvs@lists.gentoo.org Subject: [gentoo-doc-cvs] cvs commit: doc-tipsntricks.xml Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-doc-cvs@gentoo.org Reply-to: docs-team@lists.gentoo.org X-Archives-Salt: 67b9a4f1-eff7-4159-ac6d-06664e00f38f X-Archives-Hash: 2239d60b81b541f8cf6f325780e89fbb 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 @@ - + Documentation Development Tips & Tricks @@ -20,8 +20,8 @@ -0.20 -2006-03-24 +0.21 +2006-03-28 Setting up your local environment @@ -56,7 +56,7 @@

-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:

@@ -223,26 +223,29 @@

-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 handbook-x86.xml file as the required -hb- file (such as hb-install-about.xml). Then you -must pass xsltproc the same parameters that are used while browsing the -online handbook, namely part and chap. For instance, to validate -hb-install-about.xml. 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 +handbook-x86.xml file as the required hb- file (such +as hb-install-about.xml). Then you must pass xsltproc the +same parameters that are used while browsing the online handbook, namely +part and chap. Follows an example of how you can validate +hb-install-about.xml. Please note that you need all the files that +the hanbook includes.

+
+$ xmllint --valid --noout handbook-x86.xml
+$ xmllint --valid --noout hb-install-about.xml
+$ xsltproc --stringparam part 1 --stringparam chap 1 test/guide.xsl handbook-x86.xml > test/hb-install-about.html
+
+

Alternatively, you can also process a handbook chapter like any other guide document, but links to other chapters will not be generated.

-
-$ xmllint --valid --noout handbook-x86.xml
+
 $ xmllint --valid --noout hb-install-about.xml
-$ xsltproc --stringparam part 1 --stringparam chap 1 test/guide.xsl handbook-x86.xml > test/hb-install-about.html
-
-(or the easy way)
-
 $ xsltproc test/guide.xsl hb-install-about.xml > test/hb-install-about.html
 
@@ -263,8 +266,8 @@

Some doc developers prefer to use an axkit setup similar to the one running on -http://www.gentoo.org. Here are a few pointers to help you setup a similar -configuration. +http://www.gentoo.org. Here are a few pointers to help you setup a +similar configuration.

@@ -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 Doc -Translations component for your bugs. Also, include a helpful summary +Translations 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 [fr] with the two-letter code for your language. -- gentoo-doc-cvs@gentoo.org mailing list