| 1 |
neysx 06/03/28 10:42:08 |
| 2 |
|
| 3 |
Modified: doc-tipsntricks.xml |
| 4 |
Log: |
| 5 |
#127636 Small fixes |
| 6 |
|
| 7 |
Revision Changes Path |
| 8 |
1.16 xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml |
| 9 |
|
| 10 |
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 |
| 11 |
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 |
| 12 |
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 |
| 13 |
|
| 14 |
Index: doc-tipsntricks.xml |
| 15 |
=================================================================== |
| 16 |
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v |
| 17 |
retrieving revision 1.15 |
| 18 |
retrieving revision 1.16 |
| 19 |
diff -u -r1.15 -r1.16 |
| 20 |
--- doc-tipsntricks.xml 24 Mar 2006 16:25:13 -0000 1.15 |
| 21 |
+++ doc-tipsntricks.xml 28 Mar 2006 10:42:08 -0000 1.16 |
| 22 |
@@ -1,7 +1,7 @@ |
| 23 |
<?xml version='1.0' encoding="UTF-8"?> |
| 24 |
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
| 25 |
|
| 26 |
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.15 2006/03/24 16:25:13 neysx Exp $ --> |
| 27 |
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.16 2006/03/28 10:42:08 neysx Exp $ --> |
| 28 |
|
| 29 |
<guide link="/proj/en/gdp/doc/doc-tipsntricks.xml"> |
| 30 |
<title>Documentation Development Tips & Tricks</title> |
| 31 |
@@ -20,8 +20,8 @@ |
| 32 |
|
| 33 |
<license/> |
| 34 |
|
| 35 |
-<version>0.20</version> |
| 36 |
-<date>2006-03-24</date> |
| 37 |
+<version>0.21</version> |
| 38 |
+<date>2006-03-28</date> |
| 39 |
|
| 40 |
<chapter> |
| 41 |
<title>Setting up your local environment</title> |
| 42 |
@@ -56,7 +56,7 @@ |
| 43 |
</pre> |
| 44 |
|
| 45 |
<p> |
| 46 |
-In case you want to help translating documents, create a directory for your |
| 47 |
+In case you want to help translating documents, create a directory for your |
| 48 |
language in which you keep the at that time current translations: |
| 49 |
</p> |
| 50 |
|
| 51 |
@@ -223,26 +223,29 @@ |
| 52 |
<body> |
| 53 |
|
| 54 |
<p> |
| 55 |
-The Gentoo Handbook is divided in chapters. To process a certain chapter almost as it would on our web server, you |
| 56 |
-must use both the <path>handbook-x86.xml</path> file as the required |
| 57 |
-<path>hb-</path> file (such as <path>hb-install-about.xml</path>). Then you |
| 58 |
-must pass <c>xsltproc</c> the same parameters that are used while browsing the |
| 59 |
-online handbook, namely <c>part</c> and <c>chap</c>. For instance, to validate |
| 60 |
-<path>hb-install-about.xml</path>. Please note that you need all the files that the hanbook includes. |
| 61 |
+The Gentoo Handbook is divided in chapters. To process a certain chapter almost |
| 62 |
+as it would on our web server, you must use both the |
| 63 |
+<path>handbook-x86.xml</path> file as the required <path>hb-</path> file (such |
| 64 |
+as <path>hb-install-about.xml</path>). Then you must pass <c>xsltproc</c> the |
| 65 |
+same parameters that are used while browsing the online handbook, namely |
| 66 |
+<c>part</c> and <c>chap</c>. Follows an example of how you can validate |
| 67 |
+<path>hb-install-about.xml</path>. Please note that you need all the files that |
| 68 |
+the hanbook includes. |
| 69 |
</p> |
| 70 |
|
| 71 |
+<pre caption="Validating and converting hb-install-about.xml"> |
| 72 |
+$ <i>xmllint --valid --noout handbook-x86.xml</i> |
| 73 |
+$ <i>xmllint --valid --noout hb-install-about.xml</i> |
| 74 |
+$ <i>xsltproc --stringparam part 1 --stringparam chap 1 test/guide.xsl handbook-x86.xml > test/hb-install-about.html</i> |
| 75 |
+</pre> |
| 76 |
+ |
| 77 |
<p> |
| 78 |
Alternatively, you can also process a handbook chapter like any other guide |
| 79 |
document, but links to other chapters will not be generated. |
| 80 |
</p> |
| 81 |
|
| 82 |
-<pre caption="Validating hb-install-about.xml"> |
| 83 |
-$ <i>xmllint --valid --noout handbook-x86.xml</i> |
| 84 |
+<pre caption="Validating and converting hb-install-about.xml the easy way"> |
| 85 |
$ <i>xmllint --valid --noout hb-install-about.xml</i> |
| 86 |
-$ <i>xsltproc --stringparam part 1 --stringparam chap 1 test/guide.xsl handbook-x86.xml > test/hb-install-about.html</i> |
| 87 |
- |
| 88 |
-<comment>(or the easy way)</comment> |
| 89 |
- |
| 90 |
$ <i>xsltproc test/guide.xsl hb-install-about.xml > test/hb-install-about.html</i> |
| 91 |
</pre> |
| 92 |
|
| 93 |
@@ -263,8 +266,8 @@ |
| 94 |
|
| 95 |
<p> |
| 96 |
Some doc developers prefer to use an axkit setup similar to the one running on |
| 97 |
-<uri>http://www.gentoo.org</uri>. Here are a few pointers to help you setup a similar |
| 98 |
-configuration. |
| 99 |
+<uri>http://www.gentoo.org</uri>. Here are a few pointers to help you setup a |
| 100 |
+similar configuration. |
| 101 |
</p> |
| 102 |
|
| 103 |
<warn> |
| 104 |
@@ -286,12 +289,12 @@ |
| 105 |
These are the packages that I would merge, in order: |
| 106 |
|
| 107 |
Calculating dependencies ...done! |
| 108 |
-[ebuild R ] dev-libs/libxml2-2.x.17 -debug -ipv6 +python +readline 0 kB |
| 109 |
-[ebuild R ] dev-libs/libxslt-1.1.12 +crypt +python 0 kB |
| 110 |
-[ebuild R ] dev-perl/AxKit-1.6.1 +gnome 0 kB |
| 111 |
-[ebuild R ] dev-perl/XML-XPath-1.13 0 kB |
| 112 |
-[ebuild R ] dev-perl/XML-LibXML-1.58 0 kB |
| 113 |
-[ebuild R ] dev-perl/XML-LibXSLT-1.57 0 kB |
| 114 |
+[ebuild R ] dev-libs/libxml2-2.x.17 -debug -ipv6 +python +readline 0 kB |
| 115 |
+[ebuild R ] dev-libs/libxslt-1.1.12 +crypt +python 0 kB |
| 116 |
+[ebuild R ] dev-perl/AxKit-1.6.1 +gnome 0 kB |
| 117 |
+[ebuild R ] dev-perl/XML-XPath-1.13 0 kB |
| 118 |
+[ebuild R ] dev-perl/XML-LibXML-1.58 0 kB |
| 119 |
+[ebuild R ] dev-perl/XML-LibXSLT-1.57 0 kB |
| 120 |
[ebuild R ] dev-perl/XML-Parser-2.34 0 kB |
| 121 |
[ebuild R ] net-www/apache-1.3.33 +pam 0 kB |
| 122 |
|
| 123 |
@@ -471,7 +474,7 @@ |
| 124 |
output, arch, steps to reproduce, etc. If you have a translated document, be |
| 125 |
sure to select the <uri |
| 126 |
link="http://bugs.gentoo.org/enter_bug.cgi?product=Doc%20Translations">Doc |
| 127 |
-Translations</uri> component for your bugs. Also, include a helpful summary |
| 128 |
+Translations</uri> component for your bug. Also, include a helpful summary |
| 129 |
for your translation using the preferred format: "[fr] New translation: |
| 130 |
/doc/fr/gnupg-user.xml". Replace <b>[fr]</b> with the two-letter code for your |
| 131 |
language. |
| 132 |
|
| 133 |
|
| 134 |
|
| 135 |
-- |
| 136 |
gentoo-doc-cvs@g.o mailing list |
Archives