Gentoo Archives: gentoo-doc-cvs

From: Michael Curtis Napier <curtis119@×××××××××××.org>
To: gentoo-doc-cvs@l.g.o
Subject: [gentoo-doc-cvs] cvs commit: doc-policy.xml doc-quiz.xml doc-tipsntricks.xml metadoc-guide.xml translators-howto.xml
Date: Wed, 26 Apr 2006 18:50:09
Message-Id: 200604261850.k3QIo6LQ005884@robin.gentoo.org
1 curtis119 06/04/26 18:50:05
2
3 Modified: doc-policy.xml doc-quiz.xml doc-tipsntricks.xml
4 metadoc-guide.xml translators-howto.xml
5 Log:
6 sync with www
7
8 Revision Changes Path
9 1.4 gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/doc-policy.xml
10
11 file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/doc-policy.xml?rev=1.4&content-type=text/x-cvsweb-markup&cvsroot=gentoo
12 plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/doc-policy.xml?rev=1.4&content-type=text/plain&cvsroot=gentoo
13 diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/doc-policy.xml.diff?r1=1.3&r2=1.4&cvsroot=gentoo
14
15 Index: doc-policy.xml
16 ===================================================================
17 RCS file: /var/cvsroot/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/doc-policy.xml,v
18 retrieving revision 1.3
19 retrieving revision 1.4
20 diff -u -r1.3 -r1.4
21 --- doc-policy.xml 25 Jul 2005 21:36:09 -0000 1.3
22 +++ doc-policy.xml 26 Apr 2006 18:50:05 -0000 1.4
23 @@ -1,6 +1,5 @@
24 <?xml version='1.0' encoding="UTF-8"?>
25 -<!-- $Header: /var/cvsroot/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/doc-policy.xml,v 1.3 2005/07/25 21:36:09 curtis119 Exp $ -->
26 -
27 +<!-- $Header: /var/cvsroot/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/doc-policy.xml,v 1.4 2006/04/26 18:50:05 curtis119 Exp $ -->
28 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
29
30 <guide link="doc-policy.xml">
31 @@ -17,7 +16,7 @@
32 </author>
33
34 <!-- The content of this document is licensed under the CC-BY-SA license -->
35 -<!-- See http://creativecommons.org/licenses/by-sa/2.0 -->
36 +<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
37
38 <abstract>
39 This document contains the Gentoo Documentation Policy, which is the
40 @@ -27,8 +26,8 @@
41
42 <license/>
43
44 -<version>3.13</version>
45 -<date>2005-06-02</date>
46 +<version>3.17</version>
47 +<date>2005-12-22</date>
48
49 <chapter>
50 <title>Introduction</title>
51 @@ -76,12 +75,14 @@
52 development team of a Gentoo Documentation Subproject.
53 </p>
54
55 +<!--
56 <p>
57 The Gentoo Documentation Project is strategically led by a top-level Manager
58 as required by the <uri link="/doc/en/management-structure.xml">Gentoo
59 Management Structure</uri>. This document also describes the responsibilities
60 of the Strategic Manager with respect to Gentoo Linux.
61 </p>
62 +-->
63
64 <p>
65 For day-to-day managerial tasks, the Gentoo Documentation Project has an
66 @@ -217,7 +218,7 @@
67 <p>
68 Every document published by the Gentoo Documentation Project must be
69 licensed by the <uri
70 -link="http://creativecommons.org/licenses/by-sa/2.0/">Creative Commons
71 +link="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons
72 Attribution-ShareAlike License</uri>.
73 </p>
74
75 @@ -231,7 +232,7 @@
76 &lt;/abstract&gt;
77 <i>
78 &lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt;
79 -&lt;!-- See http://creativecommons.org/licenses/by-sa/2.0 --&gt;
80 +&lt;!-- See http://creativecommons.org/licenses/by-sa/2.5 --&gt;
81 &lt;license/&gt;
82 </i>
83 &lt;version&gt;...&lt;/version&gt;
84
85
86
87 1.4 gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/doc-quiz.xml
88
89 file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/doc-quiz.xml?rev=1.4&content-type=text/x-cvsweb-markup&cvsroot=gentoo
90 plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/doc-quiz.xml?rev=1.4&content-type=text/plain&cvsroot=gentoo
91 diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/doc-quiz.xml.diff?r1=1.3&r2=1.4&cvsroot=gentoo
92
93 Index: doc-quiz.xml
94 ===================================================================
95 RCS file: /var/cvsroot/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/doc-quiz.xml,v
96 retrieving revision 1.3
97 retrieving revision 1.4
98 diff -u -r1.3 -r1.4
99 --- doc-quiz.xml 25 Jul 2005 21:36:09 -0000 1.3
100 +++ doc-quiz.xml 26 Apr 2006 18:50:05 -0000 1.4
101 @@ -1,5 +1,5 @@
102 <?xml version='1.0' encoding="UTF-8"?>
103 -<!-- $Header: /var/cvsroot/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/doc-quiz.xml,v 1.3 2005/07/25 21:36:09 curtis119 Exp $ -->
104 +<!-- $Header: /var/cvsroot/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/doc-quiz.xml,v 1.4 2006/04/26 18:50:05 curtis119 Exp $ -->
105
106 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
107
108 @@ -117,9 +117,9 @@
109 <body>
110
111 <p>
112 -A new document is submitted through bugzilla. You have succesfully reviewed the
113 -document but have not found any issues. What is the procedure for adding it to
114 -CVS (give commands and the actions you perform)?
115 +A new document is submitted through bugzilla. You have successfully reviewed
116 +the document but have not found any issues. What is the procedure for adding it
117 +to CVS (give commands and the actions you perform)?
118 </p>
119
120 <p>
121
122
123
124 1.4 gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml
125
126 file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.4&content-type=text/x-cvsweb-markup&cvsroot=gentoo
127 plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.4&content-type=text/plain&cvsroot=gentoo
128 diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml.diff?r1=1.3&r2=1.4&cvsroot=gentoo
129
130 Index: doc-tipsntricks.xml
131 ===================================================================
132 RCS file: /var/cvsroot/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v
133 retrieving revision 1.3
134 retrieving revision 1.4
135 diff -u -r1.3 -r1.4
136 --- doc-tipsntricks.xml 25 Jul 2005 21:36:09 -0000 1.3
137 +++ doc-tipsntricks.xml 26 Apr 2006 18:50:05 -0000 1.4
138 @@ -1,10 +1,11 @@
139 <?xml version='1.0' encoding="UTF-8"?>
140 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
141
142 -<!-- $Header: /var/cvsroot/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.3 2005/07/25 21:36:09 curtis119 Exp $ -->
143 +<!-- $Header: /var/cvsroot/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.4 2006/04/26 18:50:05 curtis119 Exp $ -->
144
145 -<guide link="doc-tipsntricks.xml">
146 +<guide link="/proj/en/gdp/doc/doc-tipsntricks.xml">
147 <title>Documentation Development Tips &amp; Tricks</title>
148 +
149 <author title="Author">
150 <mail link="swift@g.o">Sven Vermeulen</mail>
151 </author>
152 @@ -19,8 +20,8 @@
153
154 <license/>
155
156 -<version>0.15</version>
157 -<date>2005-04-08</date>
158 +<version>0.21</version>
159 +<date>2006-03-28</date>
160
161 <chapter>
162 <title>Setting up your local environment</title>
163 @@ -40,7 +41,7 @@
164 </p>
165
166 <pre caption="Downloading the English documentation">
167 -# <i>wget http://www.gentoo.org/dyn/doc-snapshots/docs-latest-en.tar.bz2</i>
168 +$ <i>wget http://www.gentoo.org/dyn/doc-snapshots/docs-latest-en.tar.bz2</i>
169 </pre>
170
171 <p>
172 @@ -51,19 +52,19 @@
173 </p>
174
175 <pre caption="Updating an English document">
176 -# <i>wget http://www.gentoo.org/doc/en/alsa-guide.xml?passthru=1 -O alsa-guide.xml</i>
177 +$ <i>wget http://www.gentoo.org/doc/en/alsa-guide.xml?passthru=1 -O alsa-guide.xml</i>
178 </pre>
179
180 <p>
181 -In case you want to help translating documents, create a directory for your
182 +In case you want to help translating documents, create a directory for your
183 language in which you keep the at that time current translations:
184 </p>
185
186 <pre caption="Downloading the snapshot for your language">
187 -# <i>mkdir </i><comment>${LANG}</comment>
188 -# <i>cd </i><comment>${LANG}</comment>
189 -# <i>wget http://www.gentoo.org/dyn/doc-snapshots/docs-latest-</i><comment>${LANG}</comment><i>.tar.bz2</i>
190 -# <i>tar xvjf docs-latest-*.tar.bz2</i>
191 +$ <i>mkdir </i><comment>${LANG}</comment>
192 +$ <i>cd </i><comment>${LANG}</comment>
193 +$ <i>wget http://www.gentoo.org/dyn/doc-snapshots/docs-latest-</i><comment>${LANG}</comment><i>.tar.bz2</i>
194 +$ <i>tar xvjf docs-latest-*.tar.bz2</i>
195 </pre>
196
197 <p>
198 @@ -74,7 +75,7 @@
199 </p>
200
201 <pre caption="Creating a patch for an update">
202 -# <i>diff -uNt </i><comment>${LANG}</comment><i>/alsa-guide.xml alsa-guide.xml</i> > alsa-guide.diff
203 +$ <i>diff -U6 </i><comment>${LANG}</comment><i>/alsa-guide.xml alsa-guide.xml</i> > alsa-guide.diff
204 </pre>
205
206 </body>
207 @@ -104,9 +105,9 @@
208 </p>
209
210 <pre caption="Getting the CVS snapshot">
211 -# <i>mkdir cvs; cd cvs/</i>
212 -# <i>export CVSROOT=</i><comment>&lt;your nick&gt;</comment><i>@cvs.gentoo.org:/var/cvsroot</i>
213 -# <i>cvs co doc</i>
214 +$ <i>mkdir cvs; cd cvs/</i>
215 +$ <i>export CVSROOT=</i><comment>&lt;your nick&gt;</comment><i>@cvs.gentoo.org:/var/cvsroot</i>
216 +$ <i>cvs co doc</i>
217 </pre>
218
219 <p>
220 @@ -129,34 +130,60 @@
221 </p>
222
223 <pre caption="Creating the test environment">
224 -# <i>mkdir test</i>
225 -# <i>cd test</i>
226 -# <i>mkdir css images</i>
227 -# <i>wget -P css/ http://www.gentoo.org/css/main.css</i>
228 -# <i>wget -P images/ http://www.gentoo.org/images/gbot-s.gif \
229 - http://www.gentoo.org/images/gridtest.gif \
230 - http://www.gentoo.org/images/gtop-s.jpg \
231 - http://www.gentoo.org/images/line.gif \
232 - http://www.gentoo.org/images/netraverse-gentoo.gif</i>
233 +$ <i>mkdir test</i>
234 +$ <i>cd test</i>
235 +$ <i>mkdir css images</i>
236 +$ <i>wget -P css/ http://www.gentoo.org/css/main.css</i>
237 +$ <i>wget -P images/ http://www.gentoo.org/images/gridtest.gif \
238 + http://www.gentoo.org/images/gentoo-new.gif \
239 + http://www.gentoo.org/images/gtop-www.jpg</i>
240 </pre>
241
242 <p>
243 Now download a special version of <path>guide.xsl</path> available on <uri
244 -link="http://dev.gentoo.org/~swift/gentoo/downloads/guide.xsl">SwifT's
245 -webspace</uri>. This version is adapted to transform GuideXML to HTML on
246 -local systems.
247 +link="http://dev.gentoo.org/~neysx/guide.xsl">neysx's webspace</uri>. This
248 +version is adapted to transform GuideXML to HTML on local systems and supports
249 +quite a few languages. A <uri
250 +link="http://dev.gentoo.org/~neysx/guide-en.xsl">much shorter version</uri>
251 +that supports only English is also available.
252 </p>
253
254 <pre caption="Downloading guide.xsl">
255 -# <i>wget http://dev.gentoo.org/~swift/gentoo/downloads/guide.xsl</i>
256 +$ <i>wget http://dev.gentoo.org/~neysx/guide.xsl</i>
257 +<comment>( <b>Or</b>, if English is all you need)</comment>
258 +$ <i>wget -O guide.xsl http://dev.gentoo.org/~neysx/guide-en.xsl</i>
259 </pre>
260
261 <p>
262 -Finally, edit <path>/etc/xml/catalog</path> and add the following line:
263 +Finally, edit <path>/etc/xml/catalog</path> as root and add the following line:
264 </p>
265
266 <pre caption="/etc/xml/catalog addendum">
267 -&lt;rewriteURI uriStartString="/dtd" rewritePrefix="<i>/usr/portage/metadata/dtd/</i>"/&gt;
268 +&lt;rewriteURI uriStartString="/dtd/" rewritePrefix="<i>/usr/portage/metadata/dtd/</i>"/&gt;
269 +</pre>
270 +
271 +<p>
272 +If your <path>/etc/xml/catalog</path> is empty or does not contain any entry,
273 +you need to <e>insert</e> the <c>&lt;rewriteURI&gt;</c> element <e>inside</e>
274 +the <c>&lt;catalog&gt;</c> element:
275 +</p>
276 +
277 +<pre caption="Minimal /etc/xml/catalog">
278 +&lt;?xml version="1.0"?&gt;
279 +&lt;!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
280 +&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"&gt;
281 + &lt;rewriteURI uriStartString="/dtd/" rewritePrefix="<i>/usr/portage/metadata/dtd/</i>"/&gt;
282 +&lt;/catalog&gt;
283 +</pre>
284 +
285 +<p>
286 +Besides, some files may specify the on-line DTD with an uri like
287 +<path>http://www.gentoo.org/dtd/guide.dtd</path>. You can also rewrite those
288 +references and avoid slow accesses to the net:
289 +</p>
290 +
291 +<pre caption="Extra /etc/xml/catalog addendum">
292 +&lt;rewriteURI uriStartString="http://www.gentoo.org/dtd/" rewritePrefix="<i>/usr/portage/metadata/dtd/</i>"/&gt;
293 </pre>
294
295 </body>
296 @@ -170,7 +197,7 @@
297 </p>
298
299 <pre caption="Using xmllint to verify guides">
300 -# <i>xmllint --valid --noout alsa-guide.xml</i>
301 +$ <i>xmllint --valid --noout alsa-guide.xml</i>
302 </pre>
303
304 <p>
305 @@ -180,7 +207,7 @@
306 </p>
307
308 <pre caption="Converting to HTML">
309 -# <i>xsltproc --novalid test/guide.xsl alsa-guide.xml &gt; test/alsa-guide.html</i>
310 +$ <i>xsltproc --novalid test/guide.xsl alsa-guide.xml &gt; test/alsa-guide.html</i>
311 </pre>
312
313 <p>
314 @@ -196,18 +223,30 @@
315 <body>
316
317 <p>
318 -The Gentoo Handbook is divided in chapters. To process a certain chapter, you
319 -must use both the <path>handbook-x86.xml</path> file as the required
320 -<path>hb-</path> file (such as <path>hb-install-about.xml</path>). Then you
321 -must pass <c>xsltproc</c> the same parameters that are used while browsing the
322 -online handbook, namely <c>part</c> and <c>chap</c>. For instance, to validate
323 -<path>hb-install-about.xml</path>:
324 +The Gentoo Handbook is divided in chapters. To process a certain chapter almost
325 +as it would on our web server, you must use both the
326 +<path>handbook-x86.xml</path> file as the required <path>hb-</path> file (such
327 +as <path>hb-install-about.xml</path>). Then you must pass <c>xsltproc</c> the
328 +same parameters that are used while browsing the online handbook, namely
329 +<c>part</c> and <c>chap</c>. Follows an example of how you can validate
330 +<path>hb-install-about.xml</path>. Please note that you need all the files that
331 +the hanbook includes.
332 +</p>
333 +
334 +<pre caption="Validating and converting hb-install-about.xml">
335 +$ <i>xmllint --valid --noout handbook-x86.xml</i>
336 +$ <i>xmllint --valid --noout hb-install-about.xml</i>
337 +$ <i>xsltproc --stringparam part 1 --stringparam chap 1 test/guide.xsl handbook-x86.xml &gt; test/hb-install-about.html</i>
338 +</pre>
339 +
340 +<p>
341 +Alternatively, you can also process a handbook chapter like any other guide
342 +document, but links to other chapters will not be generated.
343 </p>
344
345 -<pre caption="Validating hb-install-about.xml">
346 -# <i>xmllint --valid --noout handbook-x86.xml</i>
347 -# <i>xmllint --valid --noout hb-install-about.xml</i>
348 -# <i>xsltproc --stringparam part 1 --stringparam chap 1 test/guide.xsl handbook-x86.xml &gt; test/hb-install-about.html</i>
349 +<pre caption="Validating and converting hb-install-about.xml the easy way">
350 +$ <i>xmllint --valid --noout hb-install-about.xml</i>
351 +$ <i>xsltproc test/guide.xsl hb-install-about.xml &gt; test/hb-install-about.html</i>
352 </pre>
353
354 </body>
355 @@ -219,10 +258,16 @@
356 <section>
357 <body>
358
359 +<note>
360 +This chapter is not actively maintained and is kept only for historical
361 +purposes as long as one of our web servers is still using an axkit setup.
362 +You might want to consider trying out <c>gorg</c>.
363 +</note>
364 +
365 <p>
366 Some doc developers prefer to use an axkit setup similar to the one running on
367 -<uri>http://www.gentoo.org</uri>. Here are a few pointers to help you setup a similar
368 -configuration.
369 +<uri>http://www.gentoo.org</uri>. Here are a few pointers to help you setup a
370 +similar configuration.
371 </p>
372
373 <warn>
374 @@ -244,12 +289,12 @@
375 These are the packages that I would merge, in order:
376
377 Calculating dependencies ...done!
378 -[ebuild R ] dev-libs/libxml2-2.x.17 -debug -ipv6 +python +readline 0 kB
379 -[ebuild R ] dev-libs/libxslt-1.1.12 +crypt +python 0 kB
380 -[ebuild R ] dev-perl/AxKit-1.6.1 +gnome 0 kB
381 -[ebuild R ] dev-perl/XML-XPath-1.13 0 kB
382 -[ebuild R ] dev-perl/XML-LibXML-1.58 0 kB
383 -[ebuild R ] dev-perl/XML-LibXSLT-1.57 0 kB
384 +[ebuild R ] dev-libs/libxml2-2.x.17 -debug -ipv6 +python +readline 0 kB
385 +[ebuild R ] dev-libs/libxslt-1.1.12 +crypt +python 0 kB
386 +[ebuild R ] dev-perl/AxKit-1.6.1 +gnome 0 kB
387 +[ebuild R ] dev-perl/XML-XPath-1.13 0 kB
388 +[ebuild R ] dev-perl/XML-LibXML-1.58 0 kB
389 +[ebuild R ] dev-perl/XML-LibXSLT-1.57 0 kB
390 [ebuild R ] dev-perl/XML-Parser-2.34 0 kB
391 [ebuild R ] net-www/apache-1.3.33 +pam 0 kB
392
393 @@ -375,6 +420,84 @@
394 </chapter>
395
396 <chapter>
397 +<title>Documentation Submission Tips</title>
398 +<section>
399 +<title>Check for correct &lt;guide&gt; tags</title>
400 +<body>
401 +
402 +<p>
403 +Make sure that the &lt;guide link&gt; attribute points to the correct location
404 +for the guide. This is generally <path>/doc/${LANG}/filename.xml</path>. If you
405 +have a translated document, always specify the absolute path to the document
406 +(e.g. <path>/doc/${LANG}/</path>). If you are writing a guide that uses the
407 +<c>guide</c> or <c>book</c> DTD, you may use either
408 +<path>/doc/${LANG}/filename.xml</path> or <path>filename.xml</path>. Generally,
409 +the GDP recommends the former specification.
410 +</p>
411 +
412 +</body>
413 +</section>
414 +<section>
415 +<title>Check links</title>
416 +<body>
417 +
418 +<p>
419 +You <e>must</e> verify that all hyperlinks in your document work. If it is a
420 +translated document, make sure that any links to other translated documents
421 +point to the existing files.
422 +</p>
423 +
424 +</body>
425 +</section>
426 +<section>
427 +<title>Check for tabs</title>
428 +<body>
429 +
430 +<p>
431 +Tabs are absolutely forbidden in GuideXML documents except when required (e.g.
432 +if the document instructs the user to use tabs). To check a document for tabs,
433 +run <c>grep "CTRL+V&lt;TAB&gt;" file.xml</c>. Fix any lines that <c>grep</c>
434 +prints out.
435 +</p>
436 +
437 +</body>
438 +</section>
439 +<section>
440 +<title>Bugzilla</title>
441 +<body>
442 +
443 +<p>
444 +Once you have finished your document, submit it to the Documentation Team using
445 +<uri
446 +link="http://bugs.gentoo.org/enter_bug.cgi?product=Documentation">Bugzilla</uri>.
447 +You don't have to mention information like platform, <c>emerge info</c>
448 +output, arch, steps to reproduce, etc. If you have a translated document, be
449 +sure to select the <uri
450 +link="http://bugs.gentoo.org/enter_bug.cgi?product=Doc%20Translations">Doc
451 +Translations</uri> component for your bug. Also, include a helpful summary
452 +for your translation using the preferred format: "[fr] New translation:
453 +/doc/fr/gnupg-user.xml". Replace <b>[fr]</b> with the two-letter code for your
454 +language.
455 +</p>
456 +
457 +<p>
458 +By default, <mail>docs-team@g.o</mail> is the assignee of your bug;
459 +there's no need to change the assignee field.
460 +</p>
461 +
462 +<p>
463 +Attach files and patches to the bug using the "plain text (text/plain)"
464 +selection. Do <e>not</e> select "XML source (application/xml)", even if you
465 +are submitting a <path>.xml</path> file. Patches should have the "Patch" option
466 +checked. Do not submit tarballs full of documents; attach each document and
467 +patch individually.
468 +</p>
469 +
470 +</body>
471 +</section>
472 +</chapter>
473 +
474 +<chapter>
475 <title>Commonly or Dangerous Made Mistakes</title>
476 <section>
477 <title>Forgetting the all-arch-aspect of the Gentoo Handbook</title>
478 @@ -400,10 +523,17 @@
479 <body>
480
481 <p>
482 -Conforming the policy, you <e>must</e> bump a version/date when you make certain
483 -changes (most actually). Although the version is less important (SwifT will
484 -still kill you if you forget it) the date tells our users when the document was
485 -altered for the last time.
486 +Conforming to the policy, you <e>must</e> bump a version/date when you make
487 +certain changes (most actually). Although the version is less important (SwifT
488 +will still kill you if you forget it) the date tells our users when the
489 +document was last modified.
490 +</p>
491 +
492 +<p>
493 +If you are making a <e>content</e> change to a document (such as instructions,
494 +code examples, etc.), then you must increment the version. For
495 +<e>non-content</e> changes (e.g. typo or GuideXML fixes), version bumping is
496 +usually unnecessary.
497 </p>
498
499 <p>
500
501
502
503 1.4 gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/metadoc-guide.xml
504
505 file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/metadoc-guide.xml?rev=1.4&content-type=text/x-cvsweb-markup&cvsroot=gentoo
506 plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/metadoc-guide.xml?rev=1.4&content-type=text/plain&cvsroot=gentoo
507 diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/metadoc-guide.xml.diff?r1=1.3&r2=1.4&cvsroot=gentoo
508
509 Index: metadoc-guide.xml
510 ===================================================================
511 RCS file: /var/cvsroot/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/metadoc-guide.xml,v
512 retrieving revision 1.3
513 retrieving revision 1.4
514 diff -u -r1.3 -r1.4
515 --- metadoc-guide.xml 25 Jul 2005 21:36:09 -0000 1.3
516 +++ metadoc-guide.xml 26 Apr 2006 18:50:05 -0000 1.4
517 @@ -1,6 +1,6 @@
518 <?xml version='1.0' encoding='UTF-8'?>
519
520 -<!-- $Header: /var/cvsroot/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/metadoc-guide.xml,v 1.3 2005/07/25 21:36:09 curtis119 Exp $ -->
521 +<!-- $Header: /var/cvsroot/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/metadoc-guide.xml,v 1.4 2006/04/26 18:50:05 curtis119 Exp $ -->
522
523 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
524
525
526
527
528 1.4 gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/translators-howto.xml
529
530 file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/translators-howto.xml?rev=1.4&content-type=text/x-cvsweb-markup&cvsroot=gentoo
531 plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/translators-howto.xml?rev=1.4&content-type=text/plain&cvsroot=gentoo
532 diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/translators-howto.xml.diff?r1=1.3&r2=1.4&cvsroot=gentoo
533
534 Index: translators-howto.xml
535 ===================================================================
536 RCS file: /var/cvsroot/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/translators-howto.xml,v
537 retrieving revision 1.3
538 retrieving revision 1.4
539 diff -u -r1.3 -r1.4
540 --- translators-howto.xml 25 Jul 2005 21:36:09 -0000 1.3
541 +++ translators-howto.xml 26 Apr 2006 18:50:05 -0000 1.4
542 @@ -1,5 +1,5 @@
543 <?xml version='1.0' encoding="UTF-8"?>
544 -<!-- $Header: /var/cvsroot/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/translators-howto.xml,v 1.3 2005/07/25 21:36:09 curtis119 Exp $ -->
545 +<!-- $Header: /var/cvsroot/gentoo-projects/www-redesign/htdocs/proj/en/gdp/doc/translators-howto.xml,v 1.4 2006/04/26 18:50:05 curtis119 Exp $ -->
546 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
547
548 <guide link="translators-howto.xml">
549
550
551
552 --
553 gentoo-doc-cvs@g.o mailing list