/[gentoo]/xml/htdocs/doc/en/xml-guide.xml
Gentoo

Diff of /xml/htdocs/doc/en/xml-guide.xml

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.51 Revision 1.68
1<?xml version="1.0" encoding="UTF-8"?> 1<?xml version="1.0" encoding="UTF-8"?>
2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.51 2005/10/09 11:00:20 neysx Exp $ --> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.68 2008/03/09 13:13:15 neysx Exp $ -->
3<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> 3<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
4 4
5<guide link="/doc/en/xml-guide.xml"> 5<guide>
6<title>Gentoo XML Guide</title> 6<title>Gentoo GuideXML Guide</title>
7 7
8<author title="Author">
9 <mail link="neysx"/>
10</author>
8<author title="Author"> 11<author title="Author">
9 <mail link="drobbins@gentoo.org">Daniel Robbins</mail> 12 <mail link="drobbins@gentoo.org">Daniel Robbins</mail>
10</author> 13</author>
11<author title="Author"><!-- zhen@gentoo.org --> 14<author title="Author"><!-- zhen@gentoo.org -->
12 John P. Davis 15 John P. Davis
15 <mail link="peesh@gentoo.org">Jorge Paulo</mail> 18 <mail link="peesh@gentoo.org">Jorge Paulo</mail>
16</author> 19</author>
17<author title="Editor"> 20<author title="Editor">
18 <mail link="swift@gentoo.org">Sven Vermeulen</mail> 21 <mail link="swift@gentoo.org">Sven Vermeulen</mail>
19</author> 22</author>
20<author title="Editor">
21 <mail link="neysx@gentoo.org">Xavier Neys</mail>
22</author>
23 23
24<abstract> 24<abstract>
25This guide shows you how to compose web documentation using the new lightweight 25This guide shows you how to compose web documentation using the new lightweight
26Gentoo GuideXML syntax. This syntax is the official format for Gentoo 26Gentoo GuideXML syntax. This syntax is the official format for Gentoo
27documentation, and this document itself was created using GuideXML. This guide 27documentation, and this document itself was created using GuideXML. This guide
30 30
31<!-- The content of this document is licensed under the CC-BY-SA license --> 31<!-- The content of this document is licensed under the CC-BY-SA license -->
32<!-- See http://creativecommons.org/licenses/by-sa/2.5 --> 32<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
33<license/> 33<license/>
34 34
35<version>2.26</version> 35<version>9</version>
36<date>2005-10-09</date> 36<date>2008-03-09</date>
37 37
38<chapter> 38<chapter>
39<title>Guide basics</title> 39<title>GuideXML basics</title>
40<section> 40<section>
41<title>Guide XML design goals</title> 41<title>GuideXML design goals</title>
42<body> 42<body>
43 43
44<p> 44<p>
45The guide XML syntax is lightweight yet expressive, so that it is easy to 45The guideXML syntax is lightweight yet expressive, so that it is easy to
46learn yet also provides all the features we need for the creation of web 46learn yet also provides all the features we need for the creation of web
47documentation. The number of tags is kept to a minimum -- just those we need. 47documentation. The number of tags is kept to a minimum -- just those we need.
48This makes it easy to transform guide into other formats, such as DocBook 48This makes it easy to transform guide into other formats, such as DocBook
49XML/SGML or web-ready HTML. 49XML/SGML or web-ready HTML.
50</p> 50</p>
51 51
52<p> 52<p>
53The goal is to make it easy to <e>create</e> and <e>transform</e> guide XML 53The goal is to make it easy to <e>create</e> and <e>transform</e> guideXML
54documents. 54documents.
55</p> 55</p>
56 56
57</body> 57</body>
58</section> 58</section>
60<title>Further Resources</title> 60<title>Further Resources</title>
61<body> 61<body>
62 62
63<p> 63<p>
64If you are planning on contributing documentation to Gentoo, or you want to 64If you are planning on contributing documentation to Gentoo, or you want to
65test GuideXML, please read the <uri 65test GuideXML, please read our <uri
66link="/proj/en/gdp/doc/doc-tipsntricks.xml">Tips and Tricks</uri> which 66link="/proj/en/gdp/doc/doc-tipsntricks.xml">Doc Tips 'n' Tricks</uri> guide
67contains tips and tricks for documentation development. 67which contains tips and tricks for documentation development.
68</p>
69
70<p>
71You may want to look at the <uri link="?passthru=1">XML source</uri> of this
72document while you read it.
68</p> 73</p>
69 74
70</body> 75</body>
71</section> 76</section>
72</chapter> 77</chapter>
73 78
74<chapter> 79<chapter>
75<title>Guide XML</title> 80<title>GuideXML</title>
76<section> 81<section>
77<title>Basic structure</title> 82<title>Basic structure</title>
78<body> 83<body>
79 84
80<p> 85<p>
112<p> 117<p>
113On the first lines, we see the requisite tag that identifies this as an XML 118On the first lines, we see the requisite tag that identifies this as an XML
114document and specifies its DTD. The <c>&lt;!-- &#36;Header&#36; --&gt;</c> line 119document and specifies its DTD. The <c>&lt;!-- &#36;Header&#36; --&gt;</c> line
115will be automatically modified by the CVS server and helps to track revisions. 120will be automatically modified by the CVS server and helps to track revisions.
116Next, there's a <c>&lt;guide&gt;</c> tag -- the entire guide document is 121Next, there's a <c>&lt;guide&gt;</c> tag -- the entire guide document is
117enclosed within a <c>&lt;guide&gt; &lt;/guide&gt;</c> pair. The <c>link</c> 122enclosed within a <c>&lt;guide&gt; &lt;/guide&gt;</c> pair.
118attribute is compulsory and should preferably contain the absolute path to the 123<br/>
119document relatively to the document root even though the file name alone will 124The <c>link</c> attribute is optional and should preferably contain the
120work. It is mainly used to generate a link to a printer-friendly version of 125absolute path to the document relatively to the document root even though the
121your document. If you use a wrong value, the link to the printable version will 126file name alone will work. It is only used to generate a link to a
122either not work or point to a wrong document. Translated documents <e>must</e> 127printer-friendly version of your document and check whether a translation is
123specify the full path because it is also used to check whether a more recent 128up-to-date. Our XSL back-engine passes the actual path to our XSL stylesheet.
124original document exists. The <c>lang</c> attribute should be used to specify 129The link attribute is only used as a fall-back value in case the XML is
125the language code of your document. It is used to format the date and insert 130processed by other means.
126strings like "<e>Note</e>", "<e>Content</e>", etc. in the specified language. 131<br/>
127The default is English. 132The <c>lang</c> attribute should be used to specify the language code of your
133document. It is used to format the date and insert strings like "<e>Note</e>",
134"<e>Content</e>", etc. in the specified language. The default is English.
128</p> 135</p>
129 136
130<p> 137<p>
131Next, there's a <c>&lt;title&gt;</c> tag, used to set the title for the entire 138Next, there's a <c>&lt;title&gt;</c> tag, used to set the title for the entire
132guide document. 139guide document.
133</p> 140</p>
134 141
135<p> 142<p>
136Then, we come to the <c>&lt;author&gt;</c> tags, which contain information 143Then, we come to the <c>&lt;author&gt;</c> tags, which contain information
137about the various authors of the document. Each <c>&lt;author&gt;</c> tag 144about the various authors of the document. Each <c>&lt;author&gt;</c> tag
138allows for an optional <c>title=</c> element, used to specify the author's 145allows for an optional <c>title</c> element, used to specify the author's
139relationship to the document (author, co-author, editor, etc.). In this 146relationship to the document (author, co-author, editor, etc.). In this
140particular example, the authors' names are enclosed in another tag -- a 147particular example, the authors' names are enclosed in another tag -- a
141<c>&lt;mail&gt;</c> tag, used to specify an email address for this particular 148<c>&lt;mail&gt;</c> tag, used to specify an email address for this particular
142person. The <c>&lt;mail&gt;</c> tag is optional and can be omitted, and no 149person. The <c>&lt;mail&gt;</c> tag is optional and can be omitted, and at
143more than one <c>&lt;author&gt;</c> element is required per guide document. 150least one <c>&lt;author&gt;</c> element is required per guide document.
144</p> 151</p>
145 152
146<p> 153<p>
147Next, we come to the <c>&lt;abstract&gt;</c>, <c>&lt;version&gt;</c> and 154Next, we come to the <c>&lt;abstract&gt;</c>, <c>&lt;version&gt;</c> and
148<c>&lt;date&gt;</c> tags, used to specify a summary of the document, the 155<c>&lt;date&gt;</c> tags, used to specify a summary of the document, the
150respectively. Dates that are invalid or not in the YYYY-MM-DD format will 157respectively. Dates that are invalid or not in the YYYY-MM-DD format will
151appear verbatim in the rendered document. 158appear verbatim in the rendered document.
152</p> 159</p>
153 160
154<p> 161<p>
155This rounds out the tags that should appear at the beginning of a guide 162This sums up the tags that should appear at the beginning of a guide document.
156document. Besides the <c>&lt;title&gt;</c> and <c>&lt;mail&gt;</c> tags, these 163Besides the <c>&lt;title&gt;</c> and <c>&lt;mail&gt;</c> tags, these tags
157tags shouldn't appear anywhere else except immediately inside the 164shouldn't appear anywhere else except immediately inside the
158<c>&lt;guide&gt;</c> tag, and for consistency it's recommended (but not 165<c>&lt;guide&gt;</c> tag, and for consistency it's recommended (but not
159required) that these tags appear before the content of the document. 166required) that these tags appear before the content of the document.
160</p> 167</p>
161 168
162<p> 169<p>
209content of this particular section. We'll look at the tags that are allowed 216content of this particular section. We'll look at the tags that are allowed
210inside a <c>&lt;body&gt;</c> element in a bit. 217inside a <c>&lt;body&gt;</c> element in a bit.
211</p> 218</p>
212 219
213<note> 220<note>
214A <c>&lt;guide&gt;</c> element can contain multiple <c>&lt;chapter&gt;</c> 221A <c>&lt;guide&gt;</c> element must contain at least one <c>&lt;chapter&gt;</c>
215elements, and a <c>&lt;chapter&gt;</c> can contain multiple 222elements, a <c>&lt;chapter&gt;</c> must contain at least one
216<c>&lt;section&gt;</c> elements. However, a <c>&lt;section&gt;</c> 223<c>&lt;section&gt;</c> elements and a <c>&lt;section&gt;</c> element must
217element can only contain one <c>&lt;body&gt;</c> element. 224contain at least one <c>&lt;body&gt;</c> element.
218</note> 225</note>
219 226
220</body> 227</body>
221</section> 228</section>
222<section> 229<section>
240# &lt;i&gt;this is user input&lt;/i&gt; 247# &lt;i&gt;this is user input&lt;/i&gt;
241 248
242Make HTML/XML easier to read by using selective emphasis: 249Make HTML/XML easier to read by using selective emphasis:
243&lt;foo&gt;&lt;i&gt;bar&lt;/i&gt;&lt;/foo&gt; 250&lt;foo&gt;&lt;i&gt;bar&lt;/i&gt;&lt;/foo&gt;
244 251
245&lt;comment&gt;(This is how to insert an inline note into the code block)&lt;/comment&gt; 252&lt;comment&gt;(This is how to insert a comment into a code block)&lt;/comment&gt;
246&lt;/pre&gt; 253&lt;/pre&gt;
247 254
248&lt;note&gt; 255&lt;note&gt;
249This is a note. 256This is a note.
250&lt;/note&gt; 257&lt;/note&gt;
273# <i>this is user input</i> 280# <i>this is user input</i>
274 281
275Make HTML/XML easier to read by using selective emphasis: 282Make HTML/XML easier to read by using selective emphasis:
276&lt;foo&gt;<i>bar</i>&lt;/foo&gt; 283&lt;foo&gt;<i>bar</i>&lt;/foo&gt;
277 284
278<comment>(This is how to insert an inline note into the code block)</comment> 285<comment>(This is how to insert a comment into a code block)</comment>
279</pre> 286</pre>
280 287
281<note> 288<note>
282This is a note. 289This is a note.
283</note> 290</note>
295<section> 302<section>
296<title>The &lt;body&gt; tags</title> 303<title>The &lt;body&gt; tags</title>
297<body> 304<body>
298 305
299<p> 306<p>
300We introduced a lot of new tags in the previous section -- here's what you 307We introduced a lot of new tags in the previous section -- here's what you need
301need to know. The <c>&lt;p&gt;</c> (paragraph), <c>&lt;pre&gt;</c> (code 308to know. The <c>&lt;p&gt;</c> (paragraph), <c>&lt;pre&gt;</c> (code block),
302block), <c>&lt;note&gt;</c>, <c>&lt;warn&gt;</c> (warning) and 309<c>&lt;note&gt;</c>, <c>&lt;warn&gt;</c> (warning) and <c>&lt;impo&gt;</c>
303<c>&lt;impo&gt;</c> (important) tags all can contain one or more lines of text. 310(important) tags all can contain one or more lines of text. Besides the
311<c>&lt;table&gt;</c>, <c>&lt;ul&gt;</c>, <c>&lt;ol&gt;</c> and
304Besides the <c>&lt;table&gt;</c> element (which we'll cover in just a bit), 312<c>&lt;dl&gt;</c> elements (which we'll cover in just a bit), these are the
305these are the only tags that should appear immediately inside a 313only tags that should appear immediately inside a <c>&lt;body&gt;</c> element.
306<c>&lt;body&gt;</c> element. Another thing -- these tags <e>should not</e> be 314Another thing -- these tags <e>should not</e> be stacked -- in other words,
307stacked -- in other words, don't put a <c>&lt;note&gt;</c> element inside a 315don't put a <c>&lt;note&gt;</c> element inside a <c>&lt;p&gt;</c> element. As
308<c>&lt;p&gt;</c> element. As you might guess, the <c>&lt;pre&gt;</c> element 316you might guess, the <c>&lt;pre&gt;</c> element preserves its whitespace
309preserves its whitespace exactly, making it well-suited for code excerpts. 317exactly, making it well-suited for code excerpts. You must name the
310You must name the <c>&lt;pre&gt;</c> tag with a caption attribute: 318<c>&lt;pre&gt;</c> tag with a <c>caption</c> attribute:
311</p> 319</p>
312 320
313<pre caption="Named &lt;pre&gt;"> 321<pre caption="Named &lt;pre&gt;">
314&lt;pre caption="Output of uptime"&gt; 322&lt;pre caption="Output of uptime"&gt;
315# &lt;i&gt;uptime&lt;/i&gt; 323# &lt;i&gt;uptime&lt;/i&gt;
318</pre> 326</pre>
319 327
320</body> 328</body>
321</section> 329</section>
322<section> 330<section>
323<title>&lt;path&gt;, &lt;c&gt;, &lt;i&gt;, &lt;b&gt; and &lt;e&gt;</title> 331<title>Epigraphs</title>
332<body>
333
334<p by="Anonymous student">
335Delegates from the original 13 states formed the Contented Congress. Thomas
336Jefferson, a Virgin, and Benjamin Franklin were two singers of the Declaration
337of Independence. Franklin discovered electricity by rubbing two cats backwards
338and declared, "A horse divided against itself cannot stand." Franklin died in
3391790 and is still dead.
340</p>
341
342<p>
343Epigraphs are sometimes used at the beginning of chapters to illustrate what is
344to follow. It is simply a paragraph with a <c>by</c> attribute that contains
345the signature.
346</p>
347
348<pre caption="Short epigraph">
349&lt;p by="Anonymous student"&gt;
350Delegates from the original 13 states formed the...
351&lt;/p&gt;
352</pre>
353
324<body> 354</body>
355</section>
356<section>
357<title>
358 &lt;path&gt;, &lt;c&gt;, &lt;b&gt;, &lt;e&gt;, &lt;sub&gt; and &lt;sup&gt;
359</title>
360<body>
325 361
326<p> 362<p>
327The <c>&lt;path&gt;</c>, <c>&lt;c&gt;</c>, <c>&lt;b&gt;</c> and <c>&lt;e&gt;</c> elements can 363The <c>&lt;path&gt;</c>, <c>&lt;c&gt;</c>, <c>&lt;b&gt;</c>, <c>&lt;e&gt;</c>,
328be used inside any child <c>&lt;body&gt;</c> tag, except for
329<c>&lt;pre&gt;</c>. The <c>&lt;i&gt;</c> element can only be used inside 364<c>&lt;sub&gt;</c> and <c>&lt;sup&gt;</c> elements can be used inside any child
330<c>&lt;pre&gt;</c>. 365<c>&lt;body&gt;</c> tag, except for <c>&lt;pre&gt;</c>.
331</p> 366</p>
332 367
333<p> 368<p>
334The <c>&lt;path&gt;</c> element is used to mark text that refers to an 369The <c>&lt;path&gt;</c> element is used to mark text that refers to an
335<e>on-disk file</e> -- either an <e>absolute or relative path</e>, or a 370<e>on-disk file</e> -- either an <e>absolute or relative path</e>, or a
351the use of unnecessary double-quotes makes a document more readable -- and 386the use of unnecessary double-quotes makes a document more readable -- and
352adorable! 387adorable!
353</p> 388</p>
354 389
355<p> 390<p>
356When you want to highlight some text as user input inside a <c>&lt;pre&gt;</c>,
357use <c>&lt;i&gt;</c> instead.
358</p>
359
360<p>
361As you might have guessed, <c>&lt;b&gt;</c> is used to <b>boldface</b> some 391As you might have guessed, <c>&lt;b&gt;</c> is used to <b>boldface</b> some
362text. 392text.
363</p> 393</p>
364 394
365<p> 395<p>
367I <e>really</e> should use semicolons more often. As you can see, this text is 397I <e>really</e> should use semicolons more often. As you can see, this text is
368offset from the regular paragraph type for emphasis. This helps to give your 398offset from the regular paragraph type for emphasis. This helps to give your
369prose more <e>punch</e>! 399prose more <e>punch</e>!
370</p> 400</p>
371 401
402<p>
403The <c>&lt;sub&gt;</c> and <c>&lt;sup&gt;</c> elements are used to specify
404<sub>subscript</sub> and <sup>superscript</sup>.
405</p>
406
407</body>
408</section>
409<section>
410<title>Code samples and colour-coding</title>
411<body>
412
413<p>
414To improve the readability of code samples, the following tags are allowed
415inside <c>&lt;pre&gt;</c> blocks:
416</p>
417
418<dl>
419 <dt><c>&lt;i&gt;</c></dt>
420 <dd>Distinguishes user input from displayed text</dd>
421 <dt><c>&lt;comment&gt;</c></dt>
422 <dd>Comments relevant to the action(s) that appear after the comment</dd>
423 <dt><c>&lt;keyword&gt;</c></dt>
424 <dd>Denotes a keyword in the language used in the code sample
425 </dd>
426 <dt><c>&lt;ident&gt;</c></dt>
427 <dd>Used for an identifier
428 </dd>
429 <dt><c>&lt;const&gt;</c></dt>
430 <dd>Used for a constant
431 </dd>
432 <dt><c>&lt;stmt&gt;</c></dt>
433 <dd>Used for a statement
434 </dd>
435 <dt><c>&lt;var&gt;</c></dt>
436 <dd>Used for a variable
437 </dd>
438</dl>
439
440<note>
441Remember that all leading and trailing spaces, and line breaks in
442<c>&lt;pre&gt;</c> blocks will appear in the displayed html page.
443</note>
444
445<p>
446Sample colour-coded <c>&lt;pre&gt;</c> block:
447</p>
448
449<pre caption="My first ebuild">
450<comment># Copyright 1999-2006 <b>Gentoo Foundation</b>
451# Distributed under the terms of the GNU General Public License v2
452# &#36;Header: $</comment>
453
454<ident>DESCRIPTION</ident>=<const>"Exuberant ctags generates tags files for quick source navigation"</const>
455<ident>HOMEPAGE</ident>=<const>"http://ctags.sourceforge.net"</const>
456<ident>SRC_URI</ident>=<const>"mirror://sourceforge/ctags/<var>${P}</var>.tar.gz"</const>
457
458<ident>LICENSE</ident>=<const>"GPL-2"</const>
459<ident>SLOT</ident>=<const>"0"</const>
460<ident>KEYWORDS</ident>=<const>"~mips ~sparc ~x86"</const>
461<ident>IUSE</ident>=<const>""</const>
462
463<stmt>src_compile()</stmt> {
464 <keyword>econf</keyword> --with-posix-regex || <keyword>die</keyword> <const>"econf failed"</const>
465 <keyword>emake</keyword> || <keyword>die</keyword> <const>"emake failed"</const>
466}
467
468<stmt>src_install()</stmt> {
469 <keyword>make</keyword> <ident>DESTDIR</ident>="<var>${D}</var>" install || <keyword>die</keyword> <const>"install failed"</const>
470
471 <keyword>dodoc</keyword> FAQ NEWS README
472 <keyword>dohtml</keyword> EXTENDING.html ctags.html
473}
474</pre>
475
372</body> 476</body>
373</section> 477</section>
374<section> 478<section>
375<title>&lt;mail&gt; and &lt;uri&gt;</title> 479<title>&lt;mail&gt; and &lt;uri&gt;</title>
376<body> 480<body>
377 481
378<p> 482<p>
379We've taken a look at the <c>&lt;mail&gt;</c> tag earlier; it's used to link 483We've taken a look at the <c>&lt;mail&gt;</c> tag earlier; it's used to link
380some text with a particular email address, and takes the form <c>&lt;mail 484some text with a particular email address, and takes the form <c>&lt;mail
381link="foo@bar.com"&gt;Mr. Foo Bar&lt;/mail&gt;</c>. If you want to display the 485link="foo.bar@example.com"&gt;Mr. Foo Bar&lt;/mail&gt;</c>. If you want to display the
382email address, you can use <c>&lt;mail&gt;foo@bar.com&lt;/mail&gt;</c>, this 486email address, you can use <c>&lt;mail&gt;foo.bar@example.com&lt;/mail&gt;</c>, this
383would be displayed as <mail>foo@bar.com</mail>. 487would be displayed as <mail>foo.bar@example.com</mail>.
488</p>
489
490<p>
491Shorter forms make it easier to use names and emails of Gentoo developers. Both
492<c>&lt;mail&gt;neysx&lt;/mail&gt;</c> and <c>&lt;mail link="neysx"/&gt;</c>
493would appear as <mail>neysx</mail>. If you want to use a Gentoo dev's email
494with a different content than his full name, use the second form with some
495content. For instance, use a dev's first name: <c>&lt;mail
496link="neysx"&gt;Xavier&lt;/mail&gt;</c> appears as <mail
497link="neysx">Xavier</mail>.
498<br/>
499This is particularly useful when you want to name a developer whose name
500contains "funny" characters that you can't type.
384</p> 501</p>
385 502
386<p> 503<p>
387The <c>&lt;uri&gt;</c> tag is used to point to files/locations on the Internet. 504The <c>&lt;uri&gt;</c> tag is used to point to files/locations on the Internet.
388It has two forms -- the first can be used when you want to have the actual URI 505It has two forms -- the first can be used when you want to have the actual URI
389displayed in the body text, such as this link to 506displayed in the body text, such as this link to
390<uri>http://forums.gentoo.org</uri>. To create this link, I typed 507<uri>http://forums.gentoo.org/</uri>. To create this link, I typed
391<c>&lt;uri&gt;http://forums.gentoo.org&lt;/uri&gt;</c>. The alternate form is 508<c>&lt;uri&gt;http://forums.gentoo.org/&lt;/uri&gt;</c>. The alternate form is
392when you want to associate a URI with some other text -- for example, <uri 509when you want to associate a URI with some other text -- for example, <uri
393link="http://forums.gentoo.org">the Gentoo Forums</uri>. To create <e>this</e> 510link="http://forums.gentoo.org/">the Gentoo Forums</uri>. To create
394link, I typed <c>&lt;uri link="http://forums.gentoo.org"&gt;the Gentoo 511<e>this</e> link, I typed <c>&lt;uri link="http://forums.gentoo.org/"&gt;the
395Forums&lt;/uri&gt;</c>. You don't need to write <c>http://www.gentoo.org/</c> 512Gentoo Forums&lt;/uri&gt;</c>. You don't need to write
396to link to other parts of the Gentoo web site. For instance, a link to the <uri 513<c>http://www.gentoo.org/</c> to link to other parts of the Gentoo web site.
397link="/doc/en/">documentation main index</uri> should be simply <c>&lt;uri 514For instance, a link to the <uri link="/doc/en/">documentation main index</uri>
398link="/doc/en/index.xml"&gt;documentation main index&lt;/uri&gt;</c>. You can 515should be simply <c>&lt;uri link="/doc/en/index.xml"&gt;documentation main
399even omit <c>index.xml</c> when you link to a directory index, e.g. <c>&lt;uri 516index&lt;/uri&gt;</c>. You can even omit <c>index.xml</c> when you link to a
400link="/doc/en/"&gt;documentation main index&lt;/uri&gt;</c>. 517directory index, e.g. <c>&lt;uri link="/doc/en/"&gt;documentation main
518index&lt;/uri&gt;</c>. Leaving the trailing slash saves an extra HTTP request.
519</p>
520
521<p>
522You should not use a <c>&lt;uri&gt;</c> tag with a <c>link</c> attribute that
523starts with <c>mailto:</c>. In this case, use a <c>&lt;mail&gt;</c> tag.
524</p>
525
526<p>
527Please avoid the <uri link="http://en.wikipedia.org/wiki/Click_here">click here
528syndrome</uri> as recommended by the <uri
529link="http://www.w3.org/QA/Tips/noClickHere">W3C</uri>.
401</p> 530</p>
402 531
403</body> 532</body>
404</section> 533</section>
405<section> 534<section>
407<body> 536<body>
408 537
409<p> 538<p>
410Here's how to insert a figure into a document -- <c>&lt;figure 539Here's how to insert a figure into a document -- <c>&lt;figure
411link="mygfx.png" short="my picture" caption="my favorite picture of all 540link="mygfx.png" short="my picture" caption="my favorite picture of all
412time"/&gt;</c>. The <c>link=</c> attribute points to the actual graphic image, 541time"/&gt;</c>. The <c>link</c> attribute points to the actual graphic image,
413the <c>short=</c> attribute specifies a short description (currently used for 542the <c>short</c> attribute specifies a short description (currently used for
414the image's HTML <c>alt=</c> attribute), and a caption. Not too difficult 543the image's HTML <c>alt</c> attribute), and a caption. Not too difficult
415:) We also support the standard HTML-style &lt;img src="foo.gif"/&gt; tag 544:) We also support the standard HTML-style &lt;img src="foo.gif"/&gt; tag
416for adding images without captions, borders, etc. 545for adding images without captions, borders, etc.
417</p> 546</p>
418 547
419</body> 548</body>
420</section> 549</section>
421<section> 550<section>
422<title>Tables and lists</title> 551<title>Tables</title>
423<body> 552<body>
424 553
425<p> 554<p>
426Guide supports a simplified table syntax similar to that of HTML. To start a 555GuideXML supports a simplified table syntax similar to that of HTML. To start a
427table, use a <c>&lt;table&gt;</c> tag. Start a row with a <c>&lt;tr&gt;</c> 556table, use a <c>&lt;table&gt;</c> tag. Start a row with a <c>&lt;tr&gt;</c>
428tag. However, for inserting actual table data, we <e>don't</e> support the 557tag. However, for inserting actual table data, we <e>don't</e> support the HTML
429HTML &lt;td&gt; tag; instead, use the <c>&lt;th&gt;</c> if you are inserting a 558&lt;td&gt; tag; instead, use the <c>&lt;th&gt;</c> if you are inserting a
430header, and <c>&lt;ti&gt;</c> if you are inserting a normal informational 559header, and <c>&lt;ti&gt;</c> if you are inserting a normal informational
431block. You can use a <c>&lt;th&gt;</c> anywhere you can use a <c>&lt;ti&gt;</c> 560block. You can use a <c>&lt;th&gt;</c> anywhere you can use a <c>&lt;ti&gt;</c>
432-- there's no requirement that <c>&lt;th&gt;</c> elements appear only in the 561-- there's no requirement that <c>&lt;th&gt;</c> elements appear only in the
433first row. 562first row.
434</p> 563</p>
435 564
436<p> 565<p>
566Besides, both table headers (<c>&lt;th&gt;</c>) and table items
567(<c>&lt;ti&gt;</c>) accept the <c>colspan</c> and <c>rowspan</c> attributes to
568span their content across rows, columns or both.
569</p>
570
571<p>
572Furthermore, table cells (<c>&lt;ti&gt;</c> &amp; <c>&lt;th&gt;</c>) can be
573right-aligned, left-aligned or centered with the <c>align</c> attribute.
574</p>
575
576<table>
577 <tr>
578 <th align="center" colspan="4">This title spans 4 columns</th>
579 </tr>
580 <tr>
581 <th rowspan="6">This title spans 6 rows</th>
582 <ti>Item A1</ti>
583 <ti>Item A2</ti>
584 <ti>Item A3</ti>
585 </tr>
586 <tr>
587 <ti align="center">Item B1</ti>
588 <th colspan="2" rowspan="2" align="right">Blocky 2x2 title</th>
589 </tr>
590 <tr>
591 <ti align="right">Item C1</ti>
592 </tr>
593 <tr>
594 <ti colspan="3" align="center">Item D1..D3</ti>
595 </tr>
596 <tr>
597 <ti rowspan="2">Item E1..F1</ti>
598 <ti colspan="2" align="right">Item E2..E3</ti>
599 </tr>
600 <tr>
601 <ti colspan="2" align="right">Item F2..F3</ti>
602 </tr>
603</table>
604
605</body>
606</section>
607<section>
608<title>Lists</title>
609<body>
610
611<p>
437To create ordered or unordered lists, simply use the XHTML-style 612To create ordered or unordered lists, simply use the XHTML-style
438<c>&lt;ol&gt;</c>, <c>&lt;ul&gt;</c> and <c>&lt;li&gt;</c> tags. List tags 613<c>&lt;ol&gt;</c>, <c>&lt;ul&gt;</c> and <c>&lt;li&gt;</c> tags. Lists may only
439should only appear inside a <c>&lt;body&gt;</c>, <c>&lt;ul&gt;</c> or 614appear inside the <c>&lt;body&gt;</c> and <c>&lt;li&gt;</c> tags which means
440<c>&lt;ol&gt;</c> tag. You need to close the tags as well (which is a general 615that you can have lists inside lists. Don't forget that you are writing XML and
441XML requirement). 616that you must close all tags including list items unlike in HTML.
617</p>
618
442</p> 619<p>
620Definition lists (<c>&lt;dl&gt;</c>) are also supported. Please note that
621neither the definition term tag (<c>&lt;dt&gt;</c>) nor the definition data tag
622(<c>&lt;dd&gt;</c>) accept any other block level tag such as paragraphs or
623admonitions. A definition list comprises:
624</p>
625
626<dl>
627 <dt><c>&lt;dl&gt;</c></dt>
628 <dd>A <b>D</b>efinition <b>L</b>ist Tag containing</dd>
629 <dt><c>&lt;dt&gt;</c></dt>
630 <dd>Pairs of <b>D</b>efinition <b>T</b>erm Tags</dd>
631 <dt><c>&lt;dd&gt;</c></dt>
632 <dd>and <b>D</b>efinition <b>D</b>ata Tags</dd>
633</dl>
634
635<p>
636The following list copied from <uri
637link="http://www.w3.org/TR/REC-html40/struct/lists.html">w3.org</uri> shows
638that a definition list can contain ordered and unordered lists. It may not
639contain another definition list though.
640</p>
641
642<dl>
643 <dt><b>The ingredients:</b></dt>
644 <dd>
645 <ul>
646 <li>100 g. flour</li>
647 <li>10 g. sugar</li>
648 <li>1 cup water</li>
649 <li>2 eggs</li>
650 <li>salt, pepper</li>
651 </ul>
652 </dd>
653 <dt><b>The procedure:</b></dt>
654 <dd>
655 <ol>
656 <li>Mix dry ingredients thoroughly</li>
657 <li>Pour in wet ingredients</li>
658 <li>Mix for 10 minutes</li>
659 <li>Bake for one hour at 300 degrees</li>
660 </ol>
661 </dd>
662 <dt><b>Notes:</b></dt>
663 <dd>The recipe may be improved by adding raisins</dd>
664</dl>
443 665
444</body> 666</body>
445</section> 667</section>
446<section> 668<section>
447<title>Intra-document references</title> 669<title>Intra-document references</title>
448<body> 670<body>
449 671
450<p> 672<p>
451Guide makes it really easy to reference other parts of the document using 673GuideXML makes it really easy to reference other parts of the document using
452hyperlinks. You can create a link pointing to <uri link="#doc_chap1">Chapter 674hyperlinks. You can create a link pointing to <uri link="#doc_chap1">Chapter
453One</uri> by typing <c>&lt;uri link="#doc_chap1"&gt;Chapter 675One</uri> by typing <c>&lt;uri link="#doc_chap1"&gt;Chapter
454One&lt;/uri&gt;</c>. To point to <uri link="#doc_chap1_sect2">section two of 676One&lt;/uri&gt;</c>. To point to <uri link="#doc_chap1_sect2">section two of
455Chapter One</uri>, type <c>&lt;uri link="#doc_chap1_sect2"&gt;section two of 677Chapter One</uri>, type <c>&lt;uri link="#doc_chap1_sect2"&gt;section two of
456Chapter One&lt;/uri&gt;</c>. To refer to figure 3 in chapter 1, type <c>&lt;uri 678Chapter One&lt;/uri&gt;</c>. To refer to figure 3 in chapter 1, type
457link="#doc_chap1_fig3"&gt;figure 1.3&lt;/uri&gt;</c>. Or, to refer to <uri 679<c>&lt;uri link="#doc_chap1_fig3"&gt;figure 1.3&lt;/uri&gt;</c>. Or, to refer
458link="#doc_chap2_pre2">code listing 2 in chapter 2</uri>, type <c>&lt;uri 680to <uri link="#doc_chap2_pre2">code listing 2 in chapter 2</uri>, type
459link="#doc_chap2_pre2"&gt;code listing 2.2&lt;/uri&gt;</c>. We'll be 681<c>&lt;uri link="#doc_chap2_pre2"&gt;code listing 2.2&lt;/uri&gt;</c>.
460adding other auto-link abilities (such as table support) soon.
461</p> 682</p>
462 683
463<p> 684<p>
464However, some guides change often and using such "counting" can lead to broken 685However, some guides change often and using such "counting" can lead to broken
465links. In order to cope with this, you can define a name for a 686links. In order to cope with this, you can define a name for a
481<section> 702<section>
482<title>Disclaimers and obsolete documents</title> 703<title>Disclaimers and obsolete documents</title>
483<body> 704<body>
484 705
485<p> 706<p>
486A disclaimer attribute can be applied to guides and handbooks to display a predefined disclaimer at the top of the document. The available disclaimers are: 707A <c>disclaimer</c> attribute can be applied to guides and handbooks to display
708a predefined disclaimer at the top of the document. The available disclaimers
709are:
487</p> 710</p>
488 711
489<ul> 712<ul>
490 <li> 713 <li>
491 <b>articles</b> is used for <uri link="/doc/en/articles/">republished 714 <b>articles</b> is used for <uri link="/doc/en/articles/">republished
512<pre caption="Disclaimer sample"> 735<pre caption="Disclaimer sample">
513&lt;?xml version="1.0" encoding="UTF-8"?&gt; 736&lt;?xml version="1.0" encoding="UTF-8"?&gt;
514&lt;!DOCTYPE guide SYSTEM "/dtd/guide.dtd"&gt; 737&lt;!DOCTYPE guide SYSTEM "/dtd/guide.dtd"&gt;
515&lt;!-- &#36;Header&#36; --&gt; 738&lt;!-- &#36;Header&#36; --&gt;
516 739
517&lt;guide link="/doc/en/gentoo-x86-install.xml" disclaimer="obsolete" redirect="/doc/en/handbook/handbook-x86.xml"&gt; 740&lt;guide disclaimer="obsolete" redirect="/doc/en/handbook/handbook-x86.xml"&gt;
518&lt;title>Gentoo x86 Installation Guide&lt;/title&gt; 741&lt;title>Gentoo x86 Installation Guide&lt;/title&gt;
519 742
520&lt;author title="Author"&gt; 743&lt;author title="Author"&gt;
521... 744...
522</pre> 745</pre>
523 746
524</body> 747</body>
525</section> 748</section>
749<section>
750<title>FAQs</title>
751<body>
752
753<p>
754FAQ documents need to start with a list of questions with links to their
755answers. Creating such a list is both time-consuming and error-prone. The list
756can be created automatically if you use a <c>faqindex</c> element as the first
757chapter of your document. This element has the same structure as a
758<c>chapter</c> to allow some introductory text. The structure of the document
759is expected to be split into chapters (at least one chapter) containing
760sections, each section containing one question specified in its <c>title</c>
761element with the answer in its <c>body</c>. The FAQ index will appear as one
762section per chapter and one link per question.
763</p>
764
765<p>
766A quick look at a <uri link="/doc/en/faq.xml">FAQ</uri> and <uri
767link="/doc/en/faq.xml?passthru=1">its source</uri> should make the above
768obvious.
769</p>
770
771</body>
772</section>
526</chapter> 773</chapter>
527 774
528<chapter> 775<chapter>
776<title>Handbook Format</title>
777<section>
778<title>Guide vs Book</title>
779<body>
780
781<p>
782For high-volume documentation, such as the <uri
783link="/doc/en/handbook/handbook-x86.xml?part=1">Installation Instructions</uri>, a
784broader format was needed. We designed a GuideXML-compatible enhancement that
785allows us to write modular and multi-page documentation.
786</p>
787
788</body>
789</section>
790<section>
791<title>Main File</title>
792<body>
793
794<p>
795The first change is the need for a "master" document. This document contains no
796real content, but links to the individual documentation modules. The syntax
797doesn't differ much from GuideXML:
798</p>
799
800<pre caption="Example book usage">
801&lt;?xml version='1.0' encoding='UTF-8'?&gt;
802&lt;!DOCTYPE book SYSTEM "/dtd/book.dtd"&gt;
803&lt;!-- &#36;Header&#36; --&gt;
804
805&lt;<i>book</i>&gt;
806&lt;title&gt;Example Book Usage&lt;/title&gt;
807
808&lt;author...&gt;
809 ...
810&lt;/author&gt;
811
812&lt;abstract&gt;
813 ...
814&lt;/abstract&gt;
815
816&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt;
817&lt;!-- See http://creativecommons.org/licenses/by-sa/2.5 --&gt;
818&lt;license/&gt;
819
820&lt;version&gt;...&lt;/version&gt;
821&lt;date&gt;...&lt;/date&gt;
822</pre>
823
824<p>
825So far no real differences (except for the <c>&lt;book&gt;</c> instead of
826<c>&lt;guide&gt;</c> tag). Instead of starting with the individual
827<c>&lt;chapter&gt;</c>s, you define a <c>&lt;part&gt;</c>, which is the
828equivalent of a separate part in a book:
829</p>
830
831<pre caption="Defining a part">
832&lt;part&gt;
833&lt;title&gt;Part One&lt;/title&gt;
834&lt;abstract&gt;
835 ...
836&lt;/abstract&gt;
837
838<comment>(Defining the several chapters)</comment>
839&lt;/part&gt;
840</pre>
841
842<p>
843Each part is accompanied by a <c>&lt;title&gt;</c> and an
844<c>&lt;abstract&gt;</c> which gives a small introduction to the part.
845</p>
846
847<p>
848Inside each part, you define the individual <c>&lt;chapter&gt;</c>s. Each
849chapter <e>must</e> be a separate document. As a result it is no surprise that
850a special tag (<c>&lt;include&gt;</c>) is added to allow including the separate
851document.
852</p>
853
854<pre caption="Defining a chapter">
855&lt;chapter&gt;
856&lt;title&gt;Chapter One&lt;/title&gt;
857
858 &lt;include href="path/to/chapter-one.xml"/&gt;
859
860&lt;/chapter&gt;
861</pre>
862
863</body>
864</section>
865<section>
866<title>Designing the Individual Chapters</title>
867<body>
868
869<p>
870The content of an individual chapter is structured as follows:
871</p>
872
873<pre caption="Chapter Syntax">
874&lt;?xml version='1.0' encoding='UTF-8'?&gt;
875&lt;!DOCTYPE sections SYSTEM "/dtd/book.dtd"&gt;
876&lt;!-- &#36;Header&#36; --&gt;
877
878&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt;
879&lt;!-- See http://creativecommons.org/licenses/by-sa/2.5 --&gt;
880
881&lt;sections&gt;
882
883&lt;abstract&gt;
884 This is a small explanation on chapter one.
885&lt;/abstract&gt;
886
887&lt;version&gt;...&lt;/version&gt;
888&lt;date&gt;...&lt;/date&gt;
889
890<comment>(Define the several &lt;section&gt; and &lt;subsection&gt;)</comment>
891
892&lt;/sections&gt;
893</pre>
894
895<p>
896Inside each chapter you can define <c>&lt;section&gt;</c>s (equivalent of
897<c>&lt;chapter&gt;</c> in a Guide) and <c>&lt;subsection&gt;</c>s (equivalent
898of <c>&lt;section&gt;</c> in a Guide).
899</p>
900
901<p>
902Each individual chapter should have its own date and version elements. The
903latest date of all chapters and master document will be displayed when a user
904browses through all parts of the book.
905</p>
906
907</body>
908</section>
909</chapter>
910
911<chapter>
912<title>Advanced Handbook Features</title>
913<section>
914<title>Global Values</title>
915<body>
916
917<p>
918Sometimes, the same values are repeated many times in several parts of a
919handbook. Global search and replace operations tend to forget some or introduce
920unwanted changes. Besides, it can be useful to define different values to be
921used in shared chapters depending on which handbook includes the chapter.
922</p>
923
924<p>
925Global values can be defined in a handbook master file and used in all included
926chapters.
927</p>
928
929<p>
930To define global values, add a <c>&lt;values&gt;</c> element to the handbook
931master file. Each value is then defined in a <c>&lt;key&gt;</c> element whose
932<c>id</c> attribute identifies the value, i.e. it is the name of your variable.
933The content of the <c>&lt;key&gt;</c> is its value.
934</p>
935
936<p>
937The following example defines three values in a handbook master file:
938</p>
939
940<pre caption="Define values in a handbook">
941&lt;?xml version='1.0' encoding='UTF-8'?&gt;
942&lt;!DOCTYPE book SYSTEM "/dtd/book.dtd"&gt;
943&lt;!-- &#36;Header&#36; --&gt;
944
945&lt;book&gt;
946&lt;title&gt;Example Book Usage&lt;/title&gt;
947
948<i>&lt;values>
949 &lt;key id="arch"&gt;x86&lt;/key&gt;
950 &lt;key id="min-cd-name"&gt;install-x86-minimal-2007.0-r1.iso&lt;/key&gt;
951 &lt;key id="min-cd-size"&gt;57&lt;/key&gt;
952&lt;/values&gt;</i>
953
954&lt;author...&gt;
955 ...
956&lt;/author&gt;
957
958...
959</pre>
960
961<p>
962The defined values can then be used throughout the handbook with the in-line
963<c>&lt;keyval id="key_id"/&gt;</c> element. Specify the name of the key in its
964<c>id</c> attribute, e.g. &lt;keyval id="min-cd-name"/&gt; would be replaced by
965"install-x86-minimal-2007.0-r1.iso" in our example.
966</p>
967
968<pre caption="Using defined values">
969&lt;p&gt;
970The Minimal Installation CD is called &lt;c&gt;<i>&lt;keyval id="min-cd-name"/&gt;</i>&lt;/c&gt;
971and takes up only <i>&lt;keyval id="min-cd-size"/&gt;</i> MB of diskspace. You can use this
972Installation CD to install Gentoo, but &lt;e&gt;only&lt;/e&gt; with a working Internet
973connection.
974&lt;/p&gt;
975</pre>
976
977<p>
978To make life easier on our translators, only use actual values, i.e. content
979that does not need to be translated. For instance, we defined the
980<c>min-cd-size</c> value to <c>57</c> and not <c>57 MB</c>.
981</p>
982
983</body>
984</section>
985<section>
986<title>Conditional Elements</title>
987<body>
988
989<p>
990Chapters that are shared by several handbooks such as our <uri
991link="/doc/en/handbook/">Installation Handbooks</uri> often have small
992differences depending on which handbook includes them. Instead of adding
993content that is irrelevant to some handbooks, authors can add a condition to
994the following elements: <c>&lt;section&gt;</c>, <c>&lt;subsection&gt;</c>,
995<c>&lt;body&gt;</c>, <c>&lt;note&gt;</c>, <c>&lt;impo&gt;</c>,
996<c>&lt;warn&gt;</c>, <c>&lt;pre&gt;</c>, <c>&lt;p&gt;</c>,
997<c>&lt;table&gt;</c>, <c>&lt;tr&gt;</c>, <c>&lt;ul&gt;</c>, <c>&lt;ol&gt;</c>
998and <c>&lt;li&gt;</c>.
999</p>
1000
1001<p>
1002The condition must be an <uri
1003link="http://en.wikipedia.org/wiki/XPath">XPATH</uri> expression that will be
1004evaluated when transforming the XML. If it evaluates to <c>true</c>, the
1005element is processed, if not, it is ignored. The condition is specified in a
1006<c>test</c> attribute.
1007</p>
1008
1009<p>
1010The following example uses the <c>arch</c> value that is defined in each
1011handbook master file to condition some content:
1012</p>
1013
1014<pre caption="Using conditional elements">
1015&lt;body test="contains('AMD64 x86',func:keyval('arch'))"&gt;
1016
1017&lt;p&gt;
1018This paragraph applies to both x86 and AMD64 architectures.
1019&lt;/p&gt;
1020
1021&lt;p test="func:keyval('arch')='x86'"&gt;
1022This paragraph only applies to the x86 architecture.
1023&lt;/p&gt;
1024
1025&lt;p test="func:keyval('arch')='AMD64'"&gt;
1026This paragraph only applies to the AMD64 architecture.
1027&lt;/p&gt;
1028
1029&lt;p test="func:keyval('arch')='PPC'"&gt;
1030This paragraph will never be seen!
1031The whole body is skipped because of the first condition.
1032&lt;/p&gt;
1033
1034&lt;/body&gt;
1035
1036&lt;body test="contains('AMD64 PPC64',func:keyval('arch'))"&gt;
1037
1038&lt;p&gt;
1039This paragraph applies to the AMD64, PPC64 <comment>and PPC</comment> architectures because
1040the 'AMD64 PPC64' string does contain 'PPC'.
1041&lt;/p&gt;
1042
1043&lt;note test="func:keyval('arch')='AMD64' or func:keyval('arch')='PPC64'"&gt;
1044This note only applies to the AMD64 and PPC64 architectures.
1045&lt;/note&gt;
1046
1047&lt;/body&gt;
1048</pre>
1049
1050</body>
1051</section>
1052</chapter>
1053
1054<chapter id="codingstyle">
529<title>Coding Style</title> 1055<title>Coding Style</title>
530<section> 1056<section>
531<title>Introduction</title> 1057<title>Introduction</title>
532<body> 1058<body>
533 1059
578</p> 1104</p>
579 1105
580<p> 1106<p>
581<b>Indentation</b> may not be used, except with the XML-constructs of which the 1107<b>Indentation</b> may not be used, except with the XML-constructs of which the
582parent XML-tags are <c>&lt;tr&gt;</c> (from <c>&lt;table&gt;</c>), 1108parent XML-tags are <c>&lt;tr&gt;</c> (from <c>&lt;table&gt;</c>),
583<c>&lt;ul&gt;</c>, <c>&lt;ol&gt;</c> and <c>&lt;author&gt;</c>. If indentation 1109<c>&lt;ul&gt;</c>, <c>&lt;ol&gt;</c>, <c>&lt;dl&gt;</c>, and
584is used, it <e>must</e> be two spaces for each indentation. That means <e>no 1110<c>&lt;author&gt;</c>. If indentation is used, it <e>must</e> be two spaces for
585tabs</e> and <e>not</e> more spaces. Besides, tabs are not allowed in GuideXML 1111each indentation. That means <e>no tabs</e> and <e>not</e> more spaces.
586documents. 1112Besides, tabs are not allowed in GuideXML documents.
587</p>
588
589<p> 1113</p>
1114
1115<p>
590In case word-wrapping happens in <c>&lt;ti&gt;</c>, <c>&lt;th&gt;</c> or 1116In case word-wrapping happens in <c>&lt;ti&gt;</c>, <c>&lt;th&gt;</c>,
591<c>&lt;li&gt;</c> constructs, indentation must be used for the content. 1117<c>&lt;li&gt;</c> or <c>&lt;dd&gt;</c> constructs, indentation must be used for
1118the content.
592</p> 1119</p>
593 1120
594<p> 1121<p>
595An example for indentation is: 1122An example for indentation is:
596</p> 1123</p>
615 &lt;li&gt;Second option&lt;/li&gt; 1142 &lt;li&gt;Second option&lt;/li&gt;
616&lt;/ul&gt; 1143&lt;/ul&gt;
617</pre> 1144</pre>
618 1145
619<p> 1146<p>
620<b>Attributes</b> may not have spaces in between the attribute, the 1147<b>Attributes</b> may not have spaces in between the attribute, the "=" mark,
621&quot;=&quot; mark, and the attribute value. As an example: 1148and the attribute value. As an example:
622</p> 1149</p>
623 1150
624<pre caption="Attributes"> 1151<pre caption="Attributes">
625<comment>Wrong :</comment> &lt;pre caption = "Attributes"&gt; 1152<comment>Wrong :</comment> &lt;pre caption = "Attributes"&gt;
626<comment>Correct:</comment> &lt;pre caption="Attributes"&gt; 1153<comment>Correct:</comment> &lt;pre caption="Attributes"&gt;
631<section> 1158<section>
632<title>External Coding Style</title> 1159<title>External Coding Style</title>
633<body> 1160<body>
634 1161
635<p> 1162<p>
636Inside tables (<c>&lt;table&gt;</c>) and listings (<c>&lt;ul&gt;</c> and 1163Inside tables (<c>&lt;table&gt;</c>) and listings (<c>&lt;ul&gt;</c>,
637<c>&lt;ol&gt;</c>), periods (&quot;.&quot;) should not be used unless multiple 1164<c>&lt;ol&gt;</c>) and <c>&lt;dl&gt;</c>, periods (".") should not be used
638sentences are used. In that case, every sentence should end with a period (or 1165unless multiple sentences are used. In that case, every sentence should end
639other reading marks). 1166with a period (or other reading marks).
640</p> 1167</p>
641 1168
642<p> 1169<p>
643Every sentence, including those inside tables and listings, should start 1170Every sentence, including those inside tables and listings, should start
644with a capital letter. 1171with a capital letter.
677</body> 1204</body>
678</section> 1205</section>
679</chapter> 1206</chapter>
680 1207
681<chapter> 1208<chapter>
682<title>Handbook Format</title>
683<section>
684<title>Guide vs Book</title>
685<body>
686
687<p>
688For high-volume documentation, such as the <uri
689link="/doc/en/handbook/handbook-x86.xml?part=1">Installation Instructions</uri>, a
690broader format was needed. We designed a GuideXML-compatible enhancement that
691allows us to write modular and multi-page documentation.
692</p>
693
694</body>
695</section>
696<section>
697<title>Main File</title>
698<body>
699
700<p>
701The first change is the need for a "master" document. This document contains no
702real content, but links to the individual documentation modules. The syntaxis
703doesn't differ much from GuideXML:
704</p>
705
706<pre caption="Example book usage">
707&lt;?xml version='1.0' encoding='UTF-8'?&gt;
708&lt;!DOCTYPE book SYSTEM "/dtd/book.dtd"&gt;
709&lt;!-- &#36;Header&#36; --&gt;
710
711&lt;<i>book</i> link="example.xml"&gt;
712&lt;title&gt;Example Book Usage&lt;/title&gt;
713
714&lt;author...&gt;
715 ...
716&lt;/author&gt;
717
718&lt;abstract&gt;
719 ...
720&lt;/abstract&gt;
721
722&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt;
723&lt;!-- See http://creativecommons.org/licenses/by-sa/2.5 --&gt;
724&lt;license/&gt;
725
726&lt;version&gt;...&lt;/version&gt;
727&lt;date&gt;...&lt;/date&gt;
728</pre>
729
730<p>
731So far no real differences (except for the <c>&lt;book&gt;</c> instead of
732<c>&lt;guide&gt;</c> tag). Instead of starting with the individual
733<c>&lt;chapter&gt;</c>'s, you define a <c>&lt;part&gt;</c>, which is the
734equivalent of a separate part in a book:
735</p>
736
737<pre caption="Defining a part">
738&lt;part&gt;
739&lt;title&gt;Part One&lt;/title&gt;
740&lt;abstract&gt;
741 ...
742&lt;/abstract&gt;
743
744<comment>(Defining the several chapters)</comment>
745&lt;/part&gt;
746</pre>
747
748<p>
749Each part is accompanied by a <c>&lt;title&gt;</c> and an
750<c>&lt;abstract&gt;</c> which gives a small introduction to the part.
751</p>
752
753<p>
754Inside each part, you define the individual <c>&lt;chapter&gt;</c>'s. Each
755chapter <e>must</e> be a separate document. As a result it is no surprise that a
756special tag (<c>&lt;include&gt;</c>) is added to allow including the separate
757document.
758</p>
759
760<pre caption="Defining a chapter">
761&lt;chapter&gt;
762&lt;title&gt;Chapter One&lt;/title&gt;
763&lt;abstract&gt;
764 This is a small explanation on chapter one.
765&lt;/abstract&gt;
766
767 &lt;include href="path/to/chapter-one.xml"/&gt;
768
769&lt;/chapter&gt;
770</pre>
771
772</body>
773</section>
774<section>
775<title>Designing the Individual Chapters</title>
776<body>
777
778<p>
779The content of an individual chapter is structured as follows:
780</p>
781
782<pre caption="Chapter Syntax">
783&lt;?xml version='1.0' encoding='UTF-8'?&gt;
784&lt;!DOCTYPE sections SYSTEM "/dtd/book.dtd"&gt;
785&lt;!-- &#36;Header&#36; --&gt;
786
787&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt;
788&lt;!-- See http://creativecommons.org/licenses/by-sa/2.5 --&gt;
789
790&lt;sections&gt;
791
792&lt;version&gt;...&lt;/version&gt;
793&lt;date&gt;...&lt;/date&gt;
794
795<comment>(Define the several &lt;section&gt; and &lt;subsection&gt;)</comment>
796
797&lt;/sections&gt;
798</pre>
799
800<p>
801Inside each chapter you can define <c>&lt;section&gt;</c>'s (equivalent of
802<c>&lt;chapter&gt;</c> in a Guide) and <c>&lt;subsection&gt;</c>'s (equivalent
803of <c>&lt;section&gt;</c> in a Guide).
804</p>
805
806<p>
807Each individual chapter should have its own date and version elements. The
808latest date of all chapters and master document will be displayed when a user
809browses through all parts of the book.
810</p>
811
812</body>
813</section>
814</chapter>
815
816<chapter>
817<title>Resources</title> 1209<title>Resources</title>
818<section> 1210<section>
819<title>Start writing</title> 1211<title>Start writing</title>
820<body> 1212<body>
821 1213
822<p> 1214<p>
823Guide has been specially designed to be "lean and mean" so that developers can 1215GuideXML has been specially designed to be "lean and mean" so that developers
824spend more time writing documentation and less time learning the actual XML 1216can spend more time writing documentation and less time learning the actual XML
825syntax. Hopefully, this will allow developers who aren't unusually "doc-savvy" 1217syntax. Hopefully, this will allow developers who aren't unusually "doc-savvy"
826to start writing quality Gentoo documentation. You might be interested 1218to start writing quality Gentoo documentation. You might be interested in our
827in our <uri link="/proj/en/gdp/doc/doc-tipsntricks.xml">Documentation 1219<uri link="/proj/en/gdp/doc/doc-tipsntricks.xml">Documentation Development Tips
828Development Tips &amp; Tricks</uri>. If you'd like to help (or have any 1220&amp; Tricks</uri>. If you'd like to help (or have any questions about
829questions about guide), please post a message to the <mail 1221GuideXML), please post a message to the <uri
830link="gentoo-doc@gentoo.org">gentoo-doc mailing list</mail> stating what you'd 1222link="/main/en/lists.xml">gentoo-doc mailing list</uri> stating what you'd like
831like to tackle. Have fun! 1223to tackle. Have fun!
832</p> 1224</p>
833 1225
834</body> 1226</body>
835</section> 1227</section>
836</chapter> 1228</chapter>

Legend:
Removed from v.1.51  
changed lines
  Added in v.1.68

  ViewVC Help
Powered by ViewVC 1.1.20