| 1 |
neysx 06/03/21 12:17:12 |
| 2 |
|
| 3 |
Modified: doc-tipsntricks.xml |
| 4 |
Log: |
| 5 |
Spring clean up |
| 6 |
|
| 7 |
Revision Changes Path |
| 8 |
1.13 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.13&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.13&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.12&r2=1.13&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.12 |
| 18 |
retrieving revision 1.13 |
| 19 |
diff -u -r1.12 -r1.13 |
| 20 |
--- doc-tipsntricks.xml 8 Oct 2005 13:34:33 -0000 1.12 |
| 21 |
+++ doc-tipsntricks.xml 21 Mar 2006 12:17:12 -0000 1.13 |
| 22 |
@@ -1,9 +1,9 @@ |
| 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.12 2005/10/08 13:34:33 neysx Exp $ --> |
| 27 |
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.13 2006/03/21 12:17:12 neysx Exp $ --> |
| 28 |
|
| 29 |
-<guide link="doc-tipsntricks.xml"> |
| 30 |
+<guide link="/proj/en/gdp/doc/doc-tipsntricks.xml"> |
| 31 |
<title>Documentation Development Tips & Tricks</title> |
| 32 |
|
| 33 |
<author title="Author"> |
| 34 |
@@ -20,8 +20,8 @@ |
| 35 |
|
| 36 |
<license/> |
| 37 |
|
| 38 |
-<version>0.17</version> |
| 39 |
-<date>2005-10-08</date> |
| 40 |
+<version>0.18</version> |
| 41 |
+<date>2005-03-21</date> |
| 42 |
|
| 43 |
<chapter> |
| 44 |
<title>Setting up your local environment</title> |
| 45 |
@@ -75,7 +75,7 @@ |
| 46 |
</p> |
| 47 |
|
| 48 |
<pre caption="Creating a patch for an update"> |
| 49 |
-$ <i>diff -uNt </i><comment>${LANG}</comment><i>/alsa-guide.xml alsa-guide.xml</i> > alsa-guide.diff |
| 50 |
+$ <i>diff -U6 </i><comment>${LANG}</comment><i>/alsa-guide.xml alsa-guide.xml</i> > alsa-guide.diff |
| 51 |
</pre> |
| 52 |
|
| 53 |
</body> |
| 54 |
@@ -134,22 +134,24 @@ |
| 55 |
$ <i>cd test</i> |
| 56 |
$ <i>mkdir css images</i> |
| 57 |
$ <i>wget -P css/ http://www.gentoo.org/css/main.css</i> |
| 58 |
-$ <i>wget -P images/ http://www.gentoo.org/images/gbot-s.gif \ |
| 59 |
- http://www.gentoo.org/images/gridtest.gif \ |
| 60 |
- http://www.gentoo.org/images/gtop-s.jpg \ |
| 61 |
- http://www.gentoo.org/images/line.gif \ |
| 62 |
- http://www.gentoo.org/images/netraverse-gentoo.gif</i> |
| 63 |
+$ <i>wget -P images/ http://www.gentoo.org/images/gridtest.gif \ |
| 64 |
+ http://www.gentoo.org/images/gtop-new.gif \ |
| 65 |
+ http://www.gentoo.org/images/gtop-www.jpg</i> |
| 66 |
</pre> |
| 67 |
|
| 68 |
<p> |
| 69 |
Now download a special version of <path>guide.xsl</path> available on <uri |
| 70 |
-link="http://dev.gentoo.org/~swift/gentoo/downloads/guide.xsl">SwifT's |
| 71 |
-webspace</uri>. This version is adapted to transform GuideXML to HTML on |
| 72 |
-local systems. |
| 73 |
+link="http://dev.gentoo.org/~neysx/guide.xsl">neysx's webspace</uri>. This |
| 74 |
+version is adapted to transform GuideXML to HTML on local systems and supports |
| 75 |
+quite a few languages. A <uri |
| 76 |
+link="http://dev.gentoo.org/~neysx/guide-en.xsl">much shorter version</uri> |
| 77 |
+that supports only English is also available. |
| 78 |
</p> |
| 79 |
|
| 80 |
<pre caption="Downloading guide.xsl"> |
| 81 |
-$ <i>wget http://dev.gentoo.org/~swift/gentoo/downloads/guide.xsl</i> |
| 82 |
+$ <i>wget http://dev.gentoo.org/~neysx/guide.xsl</i> |
| 83 |
+<comment>( <b>Or</b>, if English is all you need)</comment> |
| 84 |
+$ <i>wget -O guide.xsl http://dev.gentoo.org/~neysx/guide-en.xsl</i> |
| 85 |
</pre> |
| 86 |
|
| 87 |
<p> |
| 88 |
@@ -221,18 +223,27 @@ |
| 89 |
<body> |
| 90 |
|
| 91 |
<p> |
| 92 |
-The Gentoo Handbook is divided in chapters. To process a certain chapter, you |
| 93 |
+The Gentoo Handbook is divided in chapters. To process a certain chapter almost as it would on our web server, you |
| 94 |
must use both the <path>handbook-x86.xml</path> file as the required |
| 95 |
<path>hb-</path> file (such as <path>hb-install-about.xml</path>). Then you |
| 96 |
must pass <c>xsltproc</c> the same parameters that are used while browsing the |
| 97 |
online handbook, namely <c>part</c> and <c>chap</c>. For instance, to validate |
| 98 |
-<path>hb-install-about.xml</path>: |
| 99 |
+<path>hb-install-about.xml</path>. Please note that you need all the files that the hanbook includes. |
| 100 |
+</p> |
| 101 |
+ |
| 102 |
+<p> |
| 103 |
+Alternatively, you can also process a handbook chapter like any other guide |
| 104 |
+document, but links to other chapters will not be generated. |
| 105 |
</p> |
| 106 |
|
| 107 |
<pre caption="Validating hb-install-about.xml"> |
| 108 |
$ <i>xmllint --valid --noout handbook-x86.xml</i> |
| 109 |
$ <i>xmllint --valid --noout hb-install-about.xml</i> |
| 110 |
$ <i>xsltproc --stringparam part 1 --stringparam chap 1 test/guide.xsl handbook-x86.xml > test/hb-install-about.html</i> |
| 111 |
+ |
| 112 |
+<comment>(or the easy way)</comment> |
| 113 |
+ |
| 114 |
+$ <i>xsltproc test/guide.xsl hb-install-about.xml > test/hb-install-about.html</i> |
| 115 |
</pre> |
| 116 |
|
| 117 |
</body> |
| 118 |
@@ -244,6 +255,12 @@ |
| 119 |
<section> |
| 120 |
<body> |
| 121 |
|
| 122 |
+<note> |
| 123 |
+This chapter is not actively maintained and is kept only for historical |
| 124 |
+purposes as long as one of our web servers is still using an axkit setup. |
| 125 |
+You might want to consider trying out <c>gorg</c>. |
| 126 |
+</note> |
| 127 |
+ |
| 128 |
<p> |
| 129 |
Some doc developers prefer to use an axkit setup similar to the one running on |
| 130 |
<uri>http://www.gentoo.org</uri>. Here are a few pointers to help you setup a similar |
| 131 |
|
| 132 |
|
| 133 |
|
| 134 |
-- |
| 135 |
gentoo-doc-cvs@g.o mailing list |
Archives
