/[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.3 Revision 1.51
1<?xml version='1.0' encoding="UTF-8"?> 1<?xml version="1.0" encoding="UTF-8"?>
2<?xml-stylesheet href="/xsl/guide.xsl" type="text/xsl"?> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.51 2005/10/09 11:00:20 neysx Exp $ -->
3
4<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> 3<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
5 4
6<guide link="/doc/en/xml-guide.xml"> 5<guide link="/doc/en/xml-guide.xml">
7<title>Gentoo Linux Documentation Guide</title> 6<title>Gentoo XML Guide</title>
8<author title="Chief Architect"><mail link="drobbins@gentoo.org">Daniel Robbins</mail></author>
9 7
8<author title="Author">
9 <mail link="drobbins@gentoo.org">Daniel Robbins</mail>
10</author>
11<author title="Author"><!-- zhen@gentoo.org -->
12 John P. Davis
13</author>
14<author title="Editor">
15 <mail link="peesh@gentoo.org">Jorge Paulo</mail>
16</author>
17<author title="Editor">
18 <mail link="swift@gentoo.org">Sven Vermeulen</mail>
19</author>
20<author title="Editor">
21 <mail link="neysx@gentoo.org">Xavier Neys</mail>
22</author>
23
24<abstract>
10<abstract>This guide shows you how to compose web documentation using the new lightweight Gentoo guide 25This guide shows you how to compose web documentation using the new lightweight
11XML syntax. This syntax is the official format for Gentoo Linux documentation, and this document 26Gentoo GuideXML syntax. This syntax is the official format for Gentoo
12itself was created using guide XML. This guide assumes a basic working knowledge of XML and HTML. 27documentation, and this document itself was created using GuideXML. This guide
28assumes a basic working knowledge of XML and HTML.
13</abstract> 29</abstract>
14 30
31<!-- The content of this document is licensed under the CC-BY-SA license -->
32<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
33<license/>
34
15<version>1.0</version> 35<version>2.26</version>
16<date>07 Mar 2002</date> 36<date>2005-10-09</date>
17 37
18<chapter> 38<chapter>
19<title>Guide basics</title> 39<title>Guide basics</title>
20
21<section> 40<section>
22<title>Guide XML design goals</title> 41<title>Guide XML design goals</title>
23<body> 42<body>
24 43
44<p>
25<p> The guide XML syntax is lightweight yet expressive, so that it is easy to 45The guide XML syntax is lightweight yet expressive, so that it is easy to
26learn 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
27documentation. 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.
28This 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
29XML/SGML or web-ready HTML. </p> 49XML/SGML or web-ready HTML.
50</p>
30 51
52<p>
31<p>The 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> guide XML
32documents.</p> 54documents.
55</p>
33 56
34</body> 57</body>
35</section>
36
37<section> 58</section>
38<title>How to transform guide XML into HTML</title> 59<section>
60<title>Further Resources</title>
39<body> 61<body>
40 62
41<p> Before we take a look at the guide syntax itself, it's helpful to know how
42guide XML is transformed into web-ready HTML. To do this, we use a special
43file called <path>guide-main.xsl</path>, along with a command-line XSLT processing
44tool (also called an "engine"). The <path>guide-main.xsl</path> file describes
45exactly how to transform the contents of the source guide XML document to
46create the target HTML file. Two popular XSLT processors are <c>sabcmd</c>
47(included in the <path>app-text/sablotron</path> package) and <c>xsltproc</c>
48(found in the <path>dev-libs/libxslt</path> package). From experience, we've
49found that <c>xsltproc</c> is the higher-quality and more feature-rich XSLT
50processor. </p>
51
52<p> Once you have either <c>xsltproc</c> or <c>sabcmd</c> installed, you're
53ready to convert guide XML into web-ready HTML. Here's how it works. First,
54download the latest snapshot of our Web site from
55<uri>http://www.gentoo.org/projects/xml.html</uri>, found in the <uri
56link="http://www.gentoo.org/projects/guide-xml-latest.tar.gz">xml-guide-latest.tar.gz</uri>
57file. Extract the tarball. Inside it, you'll find a <path>gentoo-src</path>
58directory, as well as a <path>gentoo-src/xml</path> directory, etc. Now, find
59<path>gentoo-src/xml/install.xml</path>. (The new user installation guide).
60This will be our source XML guide document. The easiest way to perform the
61transformation is to change directories to the location of the
62<path>guide-main.xsl</path> file. Then, execute <c>xsltproc</c> as follows:
63</p> 63<p>
64 64If you are planning on contributing documentation to Gentoo, or you want to
65<pre> 65test GuideXML, please read the <uri
66# <i>cd gentoo-web/xsl</i> 66link="/proj/en/gdp/doc/doc-tipsntricks.xml">Tips and Tricks</uri> which
67# <i>xsltproc guide-main.xsl ../xml/install.xml &gt; /tmp/install.html</i> 67contains tips and tricks for documentation development.
68</pre>
69
70<p> If all went well, you should have a web-ready version of
71<path>install.xml</path> at <path>/tmp/install.html</path>. For this document
72to display properly in a web browser, you may have to copy some files from
73<path>gentoo-web</path> to <path>/tmp</path>, such
74as <path>css/main-new.css</path> and (to be safe) the entire <path>images</path>
75directory.
76</p> 68</p>
77 69
78</body> 70</body>
79</section> 71</section>
80</chapter> 72</chapter>
73
81<chapter> 74<chapter>
82 <title>Guide XML</title> 75<title>Guide XML</title>
83<section> 76<section>
84<title>Basic structure</title> 77<title>Basic structure</title>
85<body> 78<body>
86 79
87<p>Now that you know how to transform guide XML, you're ready to start learning 80<p>
88the guide XML syntax. We'll start with the the initial tags used in a guide 81Let's start learning the GuideXML syntax. We'll start with the the initial
89XML document: </p> 82tags used in a GuideXML document:
83</p>
90 84
91<pre caption="The initial part of a guide XML document"> 85<pre caption="The initial part of a guide XML document">
92&lt;?xml version='1.0'?&gt; 86&lt;?xml version="1.0" encoding="UTF-8"?&gt;
93&lt;guide&gt; 87&lt;!DOCTYPE guide SYSTEM "/dtd/guide.dtd"&gt;
88&lt;!-- &#36;Header&#36; --&gt;
89
90&lt;guide link="<i>/doc/en/guide.xml</i>" lang="<i>en</i>"&gt;
94&lt;title&gt;<i>Gentoo Linux Documentation Guide</i>&lt;/title&gt; 91&lt;title&gt;<i>Gentoo Documentation Guide</i>&lt;/title&gt;
95&lt;author title="<i>Chief Architect</i>"&gt;&lt;mail link="<i>drobbins@gentoo.org</i>"&gt; 92
96 <i>Daniel Robbins</i>&lt;/mail&gt; 93&lt;author title="<i>Author</i>"&gt;
94 &lt;mail link="<i>yourname@gentoo.org</i>"&gt;<i>Your Name</i>&lt;/mail&gt;
97&lt;/author&gt; 95&lt;/author&gt;
98&lt;author title="<i>Editor</i>"&gt;&lt;mail link="<i>thomasfl@gentoo.org</i>"&gt;
99 <i>Thomas Flavel</i>&lt;/mail&gt;
100&lt;/author&gt;
101 96
97&lt;abstract&gt;
102&lt;abstract&gt;<i>This guide shows you how to compose web documentation using 98<i>This guide shows you how to compose web documentation using
103our new lightweight Gentoo guide XML syntax. This syntax is the official 99our new lightweight Gentoo GuideXML syntax. This syntax is the official
104format for Gentoo Linux web documentation, and this document itself was created 100format for Gentoo web documentation, and this document itself was created
105using guide XML.</i> &lt;/abstract&gt; 101using GuideXML.</i>
102&lt;/abstract&gt;
103
104&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt;
105&lt;!-- See http://creativecommons.org/licenses/by-sa/2.5 --&gt;
106&lt;license/&gt;
106 107
107&lt;version&gt;<i>1.0</i>&lt;/version&gt; 108&lt;version&gt;<i>1.0</i>&lt;/version&gt;
108&lt;date&gt;<i>29 Mar 2001</i>&lt;/date&gt; 109&lt;date&gt;<i>2004-12-25</i>&lt;/date&gt;
109</pre> 110</pre>
110 111
112<p>
111<p>On the first, line, we see the requisite tag that identifies this as an XML 113On the first lines, we see the requisite tag that identifies this as an XML
112document. Following it, there's a <c>&lt;guide&gt;</c> tag -- the entire 114document 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.
116Next, there's a <c>&lt;guide&gt;</c> tag -- the entire guide document is
113guide document is enclosed within a <c>&lt;guide&gt; &lt;/guide&gt;</c> pair. 117enclosed within a <c>&lt;guide&gt; &lt;/guide&gt;</c> pair. The <c>link</c>
118attribute is compulsory and should preferably contain the absolute path to the
119document relatively to the document root even though the file name alone will
120work. It is mainly used to generate a link to a printer-friendly version of
121your document. If you use a wrong value, the link to the printable version will
122either not work or point to a wrong document. Translated documents <e>must</e>
123specify the full path because it is also used to check whether a more recent
124original document exists. The <c>lang</c> attribute should be used to specify
125the language code of your document. It is used to format the date and insert
126strings like "<e>Note</e>", "<e>Content</e>", etc. in the specified language.
127The default is English.
128</p>
129
130<p>
114Next, there's a <c>&lt;title&gt;</c> tag, used to set the title for the entire 131Next, there's a <c>&lt;title&gt;</c> tag, used to set the title for the entire
115guide document. </p> 132guide document.
133</p>
116 134
135<p>
117<p>Then, we come to the <c>&lt;author&gt;</c> tags, which contain information 136Then, we come to the <c>&lt;author&gt;</c> tags, which contain information
118about the various authors of the document. Each <c>&lt;author&gt;</c> tag 137about the various authors of the document. Each <c>&lt;author&gt;</c> tag
119allows for an optional <c>title=</c> element, used to specify the author's 138allows for an optional <c>title=</c> element, used to specify the author's
120relationship to the document (author, co-author, editor, etc.). In this 139relationship to the document (author, co-author, editor, etc.). In this
121particular example, the authors' names are enclosed in another tag -- a 140particular example, the authors' names are enclosed in another tag -- a
122<c>&lt;mail&gt;</c> tag, used to specify an email address for this particular 141<c>&lt;mail&gt;</c> tag, used to specify an email address for this particular
123person. The <c>&lt;mail&gt;</c> tag is optional and can be omitted, and no 142person. The <c>&lt;mail&gt;</c> tag is optional and can be omitted, and no
124more than one <c>&lt;author&gt;</c> element is required per guide document. 143more than one <c>&lt;author&gt;</c> element is required per guide document.
125</p> 144</p>
126 145
146<p>
127<p>Next, we come to the <c>&lt;abstract&gt;</c>, <c>&lt;version&gt;</c> and 147Next, we come to the <c>&lt;abstract&gt;</c>, <c>&lt;version&gt;</c> and
128<c>&lt;date&gt;</c> tags, used to specify a summary of the document, the 148<c>&lt;date&gt;</c> tags, used to specify a summary of the document, the
129current version number, and the current version date (in DD MMM YYYY format) 149current version number, and the current version date (in YYYY-MM-DD format)
150respectively. Dates that are invalid or not in the YYYY-MM-DD format will
151appear verbatim in the rendered document.
152</p>
153
154<p>
130respectively. This rounds out the tags that should appear at the beginning of 155This rounds out the tags that should appear at the beginning of a guide
131a guide document. Besides the <c>&lt;title&gt;</c> and <c>&lt;mail&gt;</c> 156document. Besides the <c>&lt;title&gt;</c> and <c>&lt;mail&gt;</c> tags, these
132tags, these tags shouldn't appear anywhere else except immediately inside the 157tags shouldn't appear anywhere else except immediately inside the
133<c>&lt;guide&gt;</c> tag, and for consistency it's recommended (but not 158<c>&lt;guide&gt;</c> tag, and for consistency it's recommended (but not
134required) that these tags appear before the content of the document. </p> 159required) that these tags appear before the content of the document.
160</p>
135 161
136</body> 162<p>
137</section> 163Finally we have the <c>&lt;license/&gt;</c> tag, used to publish the document
164under the <uri link="http://creativecommons.org/licenses/by-sa/2.5/">Creative
165Commons - Attribution / Share Alike</uri> license as required by the <uri
166link="/proj/en/gdp/doc/doc-policy.xml">Documentation Policy</uri>.
167</p>
138 168
169</body>
170</section>
139<section> 171<section>
140<title>Chapters and sections</title> 172<title>Chapters and sections</title>
141<body> 173<body>
174
175<p>
142<p>Once the initial tags have been specified, you're ready to start adding 176Once the initial tags have been specified, you're ready to start adding the
143the structural elements of the document. Guide documents are divided into 177structural elements of the document. Guide documents are divided into
144chapters, and each chapter can hold one or more sections. Every chapter 178chapters, and each chapter can hold one or more sections. Every chapter and
145and section has a title. Here's an example chapter with a single section, 179section has a title. Here's an example chapter with a single section,
146consisting of a paragraph. If you append this XML to the XML in the <uri link="#doc_pre2">previous 180consisting of a paragraph. If you append this XML to the XML in the <uri
181link="#doc_chap2_pre1">previous excerpt</uri> and append a
147excerpt</uri> and append a <c>&lt;/guide&gt;</c> to the end of the file, you'll have a valid 182<c>&lt;/guide&gt;</c> to the end of the file, you'll have a valid (if minimal)
148(if minimal) guide document: 183guide document:
149</p> 184</p>
150 185
151<pre> 186<pre caption="Minimal guide example">
152&lt;chapter&gt; 187&lt;chapter&gt;
153&lt;title&gt;<i>This is my chapter</i>&lt;/title&gt; 188&lt;title&gt;<i>This is my chapter</i>&lt;/title&gt;
154&lt;section&gt; 189&lt;section&gt;
155 &lt;title&gt;<i>This is section one of my chapter</i>&lt;/title&gt; 190&lt;title&gt;<i>This is section one of my chapter</i>&lt;/title&gt;
156 &lt;body&gt; 191&lt;body&gt;
192
193&lt;p&gt;
157 &lt;p&gt;<i>This is the actual text content of my section.</i>&lt;/p&gt; 194<i>This is the actual text content of my section.</i>
195&lt;/p&gt;
196
158 &lt;/body&gt; 197&lt;/body&gt;
159&lt;/section&gt; 198&lt;/section&gt;
160&lt;/chapter&gt; 199&lt;/chapter&gt;
161</pre> 200</pre>
162 201
202<p>
163<p>Above, I set the chapter title by adding a child <c>&lt;title&gt;</c> 203Above, I set the chapter title by adding a child <c>&lt;title&gt;</c>
164element to the <c>&lt;chapter&gt;</c> element. Then, I created a section by 204element to the <c>&lt;chapter&gt;</c> element. Then, I created a section by
165adding a <c>&lt;section&gt;</c> element. If you look inside the 205adding a <c>&lt;section&gt;</c> element. If you look inside the
166<c>&lt;section&gt;</c> element, you'll see that it has two child elements -- a 206<c>&lt;section&gt;</c> element, you'll see that it has two child elements -- a
167<c>&lt;title&gt;</c> and a <c>&lt;body&gt;</c>. While the <c>&lt;title&gt;</c> 207<c>&lt;title&gt;</c> and a <c>&lt;body&gt;</c>. While the <c>&lt;title&gt;</c>
168is nothing new, the <c>&lt;body&gt;</c> is -- it contains the actual text 208is nothing new, the <c>&lt;body&gt;</c> is -- it contains the actual text
169content of this particular section. We'll look at the tags that are allowed 209content of this particular section. We'll look at the tags that are allowed
170inside a <c>&lt;body&gt;</c> element in a bit. </p> 210inside a <c>&lt;body&gt;</c> element in a bit.
211</p>
171 212
213<note>
172<note>A <c>&lt;guide&gt;</c> element can contain multiple 214A <c>&lt;guide&gt;</c> element can contain multiple <c>&lt;chapter&gt;</c>
173<c>&lt;chapter&gt;</c> elements, and a <c>&lt;chapter&gt;</c> can contain 215elements, and a <c>&lt;chapter&gt;</c> can contain multiple
174multiple <c>&lt;section&gt;</c> elements. However, a <c>&lt;section&gt;</c> 216<c>&lt;section&gt;</c> elements. However, a <c>&lt;section&gt;</c>
175element can only contain one <c>&lt;body&gt;</c> element. </note> 217element can only contain one <c>&lt;body&gt;</c> element.
218</note>
176 219
177</body> 220</body>
178</section> 221</section>
179
180<section> 222<section>
181<title>An example &lt;body&gt;</title> 223<title>An example &lt;body&gt;</title>
182<body> 224<body>
183<p> 225
184Now, it's time to learn how to mark up actual content. Here's the XML code for an example <c>&lt;body&gt;</c> element:
185</p> 226<p>
186<pre> 227Now, it's time to learn how to mark up actual content. Here's the XML code for
228an example <c>&lt;body&gt;</c> element:
229</p>
230
231<pre caption="Example of a body element">
187&lt;p&gt; 232&lt;p&gt;
188This is a paragraph. &lt;path&gt;/etc/passwd&lt;/path&gt; is a file. 233This is a paragraph. &lt;path&gt;/etc/passwd&lt;/path&gt; is a file.
189&lt;uri&gt;http://www.gentoo.org&lt;/uri&gt; is my favorite website. 234&lt;uri&gt;http://forums.gentoo.org&lt;/uri&gt; is my favorite website.
190Type &lt;c&gt;ls&lt;/c&gt; if you feel like it. I &lt;e&gt;really&lt;/e&gt; want to go to sleep now. 235Type &lt;c&gt;ls&lt;/c&gt; if you feel like it. I &lt;e&gt;really&lt;/e&gt; want to go to sleep now.
191&lt;/p&gt; 236&lt;/p&gt;
192 237
193&lt;pre&gt; 238&lt;pre caption="Code Sample"&gt;
194This is text output or code. 239This is text output or code.
195# &lt;i&gt;this is user input&lt;/i&gt; 240# &lt;i&gt;this is user input&lt;/i&gt;
196 241
197Make HTML/XML easier to read by using selective emphasis: 242Make HTML/XML easier to read by using selective emphasis:
198&lt;foo&gt;&lt;i&gt;bar&lt;/i&gt;&lt;/foo&gt; 243&lt;foo&gt;&lt;i&gt;bar&lt;/i&gt;&lt;/foo&gt;
199 244
200&lt;codenote&gt;This is how to insert an inline note into the code block&lt;/codenote&gt; 245&lt;comment&gt;(This is how to insert an inline note into the code block)&lt;/comment&gt;
201&lt;/pre&gt; 246&lt;/pre&gt;
202&lt;note&gt;This is a note.&lt;/note&gt; 247
203&lt;warn&gt;This is a warning.&lt;/warn&gt; 248&lt;note&gt;
204&lt;impo&gt;This is important.&lt;/impo&gt; 249This is a note.
250&lt;/note&gt;
251
252&lt;warn&gt;
253This is a warning.
254&lt;/warn&gt;
255
256&lt;impo&gt;
257This is important.
258&lt;/impo&gt;
205</pre> 259</pre>
260
261<p>
206<p>Now, here's how this <c>&lt;body&gt;</c> element is rendered:</p> 262Now, here's how the <c>&lt;body&gt;</c> element above is rendered:
263</p>
207 264
208<p> 265<p>
209This is a paragraph. <path>/etc/passwd</path> is a file. 266This is a paragraph. <path>/etc/passwd</path> is a file.
210<uri>http://www.gentoo.org</uri> is my favorite website. 267<uri>http://forums.gentoo.org</uri> is my favorite web site.
211Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now. 268Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now.
212</p> 269</p>
213 270
214<pre> 271<pre caption="Code Sample">
215This is text output or code. 272This is text output or code.
216# <i>this is user input</i> 273# <i>this is user input</i>
217 274
218Make HTML/XML easier to read by using selective emphasis: 275Make HTML/XML easier to read by using selective emphasis:
219&lt;foo&gt;<i>bar</i>&lt;/foo&gt; 276&lt;foo&gt;<i>bar</i>&lt;/foo&gt;
220 277
221<codenote>This is how to insert an inline note into the code block</codenote> 278<comment>(This is how to insert an inline note into the code block)</comment>
222</pre> 279</pre>
223<note>This is a note.</note>
224<warn>This is a warning.</warn>
225<impo>This is important.</impo>
226</body>
227</section>
228 280
281<note>
282This is a note.
283</note>
284
285<warn>
286This is a warning.
287</warn>
288
289<impo>
290This is important.
291</impo>
292
293</body>
294</section>
229<section> 295<section>
230<title>The &lt;body&gt; tags</title> 296<title>The &lt;body&gt; tags</title>
231<body> 297<body>
232 298
299<p>
233<p> We introduced a lot of new tags in the previous section -- here's what you 300We introduced a lot of new tags in the previous section -- here's what you
234need to know. The <c>&lt;p&gt;</c> (paragraph), <c>&lt;pre&gt;</c> (code 301need to know. The <c>&lt;p&gt;</c> (paragraph), <c>&lt;pre&gt;</c> (code
235block), <c>&lt;note&gt;</c>, <c>&lt;warn&gt;</c> (warning) and 302block), <c>&lt;note&gt;</c>, <c>&lt;warn&gt;</c> (warning) and
236<c>&lt;impo&gt;</c> (important) tags all can contain one or more lines of text. 303<c>&lt;impo&gt;</c> (important) tags all can contain one or more lines of text.
237Besides the <c>&lt;table&gt;</c> element (which we'll cover in just a bit), 304Besides the <c>&lt;table&gt;</c> element (which we'll cover in just a bit),
238these are the only tags that should appear immediately inside a 305these are the only tags that should appear immediately inside a
239<c>&lt;body&gt;</c> element. Another thing -- these tags <e>should not</e> be 306<c>&lt;body&gt;</c> element. Another thing -- these tags <e>should not</e> be
240stacked -- in other words, don't put a <c>&lt;note&gt;</c> element inside a 307stacked -- in other words, don't put a <c>&lt;note&gt;</c> element inside a
241<c>&lt;p&gt;</c> element. As you might guess, the <c>&lt;pre&gt;</c> element 308<c>&lt;p&gt;</c> element. As you might guess, the <c>&lt;pre&gt;</c> element
242preserves its whitespace exactly, making it well-suited for code excerpts.</p> 309preserves its whitespace exactly, making it well-suited for code excerpts.
310You must name the <c>&lt;pre&gt;</c> tag with a caption attribute:
311</p>
243 312
313<pre caption="Named &lt;pre&gt;">
314&lt;pre caption="Output of uptime"&gt;
315# &lt;i&gt;uptime&lt;/i&gt;
31616:50:47 up 164 days, 2:06, 5 users, load average: 0.23, 0.20, 0.25
317&lt;/pre&gt;
318</pre>
319
244</body> 320</body>
245</section>
246<section> 321</section>
322<section>
247<title>&lt;path&gt;, &lt;c&gt; and &lt;e&gt;</title> 323<title>&lt;path&gt;, &lt;c&gt;, &lt;i&gt;, &lt;b&gt; and &lt;e&gt;</title>
248<body> 324<body>
249 325
326<p>
250<p>The <c>&lt;path&gt;</c>, <c>&lt;c&gt;</c> and <c>&lt;e&gt;</c> elements can 327The <c>&lt;path&gt;</c>, <c>&lt;c&gt;</c>, <c>&lt;b&gt;</c> and <c>&lt;e&gt;</c> elements can
251be used inside any child <c>&lt;body&gt;</c> tag, except for 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
252<c>&lt;pre&gt;</c>. </p> 330<c>&lt;pre&gt;</c>.
331</p>
253 332
333<p>
254<p>The <c>&lt;path&gt;</c> element is used to mark text that refers to an 334The <c>&lt;path&gt;</c> element is used to mark text that refers to an
255<e>on-disk file</e> -- either an <e>absolute or relative path</e>, or a <e>simple filename</e>. 335<e>on-disk file</e> -- either an <e>absolute or relative path</e>, or a
256This element is generally rendered with a monospaced font to offset it from the 336<e>simple filename</e>. This element is generally rendered with a mono spaced
257standard paragraph type. </p> 337font to offset it from the standard paragraph type.
338</p>
258 339
340<p>
259<p>The <c>&lt;c&gt;</c> element is used to mark up a <e>command</e> or <e>user 341The <c>&lt;c&gt;</c> element is used to mark up a <e>command</e> or <e>user
260input</e>. Think of <c>&lt;c&gt;</c> as a way to alert the reader to something 342input</e>. Think of <c>&lt;c&gt;</c> as a way to alert the reader to something
261that they can type in that will perform some kind of action. For example, all 343that they can type in that will perform some kind of action. For example, all
262the XML tags displayed in this document are enclosed in a <c>&lt;c&gt;</c> 344the XML tags displayed in this document are enclosed in a <c>&lt;c&gt;</c>
263element because they represent something that the user could type in that is 345element because they represent something that the user could type in that is
264not a path. By using <c>&lt;c&gt;</c> elements, you'll help your readers 346not a path. By using <c>&lt;c&gt;</c> elements, you'll help your readers
265quickly identify commands that they need to type in. Also, because 347quickly identify commands that they need to type in. Also, because
266<c>&lt;c&gt;</c> elements are already offset from regular text, <e>it is rarely 348<c>&lt;c&gt;</c> elements are already offset from regular text, <e>it is rarely
267necessary to surround user input with double-quotes</e>. For example, don't 349necessary to surround user input with double-quotes</e>. For example, don't
268refer to a "<c>&lt;c&gt;</c>" element like I did in this sentence. Avoiding 350refer to a "<c>&lt;c&gt;</c>" element like I did in this sentence. Avoiding
269the use of unnecessary double-quotes makes a document more readable -- and adorable!</p> 351the use of unnecessary double-quotes makes a document more readable -- and
352adorable!
353</p>
270 354
355<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
362text.
363</p>
364
365<p>
271<p><c>&lt;e&gt;</c> is used to apply emphasis to a word or phrase; for example: 366<c>&lt;e&gt;</c> is used to apply emphasis to a word or phrase; for example:
272I <e>really</e> should use semicolons more often. As you can see, this text is 367I <e>really</e> should use semicolons more often. As you can see, this text is
273offset from the regular paragraph type for emphasis. This helps to give your 368offset from the regular paragraph type for emphasis. This helps to give your
274prose more <e>punch</e>!</p> 369prose more <e>punch</e>!
370</p>
275 371
276</body> 372</body>
277</section> 373</section>
278
279<section> 374<section>
280<title>&lt;mail&gt; and &lt;uri&gt;</title> 375<title>&lt;mail&gt; and &lt;uri&gt;</title>
281<body> 376<body>
282 377
378<p>
283<p>We've taken a look at the <c>&lt;mail&gt;</c> tag earlier; it's used to link some text 379We've taken a look at the <c>&lt;mail&gt;</c> tag earlier; it's used to link
284with a particular email address, and takes the form <c>&lt;mail link="foo@bar.com"&gt;Mr. Foo Bar&lt;/mail&gt;</c>.</p> 380some 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
382email address, you can use <c>&lt;mail&gt;foo@bar.com&lt;/mail&gt;</c>, this
383would be displayed as <mail>foo@bar.com</mail>.
384</p>
285 385
386<p>
286<p>The <c>&lt;uri&gt;</c> tag is used to point to files/locations on the 387The <c>&lt;uri&gt;</c> tag is used to point to files/locations on the Internet.
287Internet. It has two forms -- the first can be used when you want to have the 388It has two forms -- the first can be used when you want to have the actual URI
288actual URI displayed in the body text, such as this link to 389displayed in the body text, such as this link to
289<uri>http://www.gentoo.org</uri>. To create this link, I typed 390<uri>http://forums.gentoo.org</uri>. To create this link, I typed
290<c>&lt;uri&gt;http://www.gentoo.org&lt;/uri&gt;</c>. The alternate form is 391<c>&lt;uri&gt;http://forums.gentoo.org&lt;/uri&gt;</c>. The alternate form is
291when you want to associate a URI with some other text -- for example, <uri 392when you want to associate a URI with some other text -- for example, <uri
292link="http://www.gentoo.org">the Gentoo Linux website</uri>. To create <e>this</e> 393link="http://forums.gentoo.org">the Gentoo Forums</uri>. To create <e>this</e>
293link, I typed <c>&lt;uri link="http://www.gentoo.org"&gt;the Gentoo Linux website&lt;/uri&gt;</c>. 394link, I typed <c>&lt;uri link="http://forums.gentoo.org"&gt;the Gentoo
395Forums&lt;/uri&gt;</c>. You don't need to write <c>http://www.gentoo.org/</c>
396to link to other parts of the Gentoo web site. For instance, a link to the <uri
397link="/doc/en/">documentation main index</uri> should be simply <c>&lt;uri
398link="/doc/en/index.xml"&gt;documentation main index&lt;/uri&gt;</c>. You can
399even omit <c>index.xml</c> when you link to a directory index, e.g. <c>&lt;uri
400link="/doc/en/"&gt;documentation main index&lt;/uri&gt;</c>.
294</p> 401</p>
295 402
296</body> 403</body>
297</section> 404</section>
298
299<section> 405<section>
300<title>Figures</title> 406<title>Figures</title>
301
302<body> 407<body>
303 408
409<p>
304<p>Here's how to insert a figure into a document -- <c>&lt;figure 410Here's how to insert a figure into a document -- <c>&lt;figure
305link="mygfx.png" short="my picture" caption="my favorite picture of all 411link="mygfx.png" short="my picture" caption="my favorite picture of all
306time"/&gt;</c>. The <c>link=</c> attribute points to the actual graphic image, 412time"/&gt;</c>. The <c>link=</c> attribute points to the actual graphic image,
307the <c>short=</c> attribute specifies a short description (currently used for 413the <c>short=</c> attribute specifies a short description (currently used for
308the image's HTML <c>alt=</c> attribute), and a caption. Not too difficult 414the image's HTML <c>alt=</c> attribute), and a caption. Not too difficult
309:) We also support the standard HTML-style &lt;img src="foo.gif"/&gt; tag 415:) We also support the standard HTML-style &lt;img src="foo.gif"/&gt; tag
310for adding images without captions, borders, etc.</p> 416for adding images without captions, borders, etc.
417</p>
311 418
312</body> 419</body>
313</section> 420</section>
314<section> 421<section>
315<title>Tables and lists</title> 422<title>Tables and lists</title>
316<body> 423<body>
317 424
425<p>
318<p>Guide supports a simplified table syntax similar to that of HTML. To start 426Guide supports a simplified table syntax similar to that of HTML. To start a
319a table, use a <c>&lt;table&gt;</c> tag. Start a row with a <c>&lt;tr&gt;</c> 427table, use a <c>&lt;table&gt;</c> tag. Start a row with a <c>&lt;tr&gt;</c>
320tag. However, for inserting actual table data, we <e>don't</e> support the 428tag. However, for inserting actual table data, we <e>don't</e> support the
321HTML &lt;td&gt; tag; instead, use the <c>&lt;th&gt;</c> if you are inserting a 429HTML &lt;td&gt; tag; instead, use the <c>&lt;th&gt;</c> if you are inserting a
322header, and <c>&lt;ti&gt;</c> if you are inserting a normal informational 430header, and <c>&lt;ti&gt;</c> if you are inserting a normal informational
323block. You can use a <c>&lt;th&gt;</c> anywhere you can use a <c>&lt;ti&gt;</c> -- 431block. You can use a <c>&lt;th&gt;</c> anywhere you can use a <c>&lt;ti&gt;</c>
324there's no requirement that <c>&lt;th&gt;</c> elements appear only in the 432-- there's no requirement that <c>&lt;th&gt;</c> elements appear only in the
325first row. Currently, these tags don't support any attributes, but some will 433first row.
326be added (such as a <c>caption=</c> attribute for <c>&lt;table&gt;</c>) soon. 434</p>
435
327</p> 436<p>
328
329<p> To create ordered or unordered lists, simply use the HTML-style 437To create ordered or unordered lists, simply use the XHTML-style
330<c>&lt;ol&gt;</c>, <c>&lt;ul&gt;</c> and <c>&lt;li&gt;</c> tags. List tags 438<c>&lt;ol&gt;</c>, <c>&lt;ul&gt;</c> and <c>&lt;li&gt;</c> tags. List tags
331should only appear inside a <c>&lt;p&gt;</c>, <c>&lt;ti&gt;</c>, 439should only appear inside a <c>&lt;body&gt;</c>, <c>&lt;ul&gt;</c> or
332<c>&lt;note&gt;</c>, <c>&lt;warn&gt;</c> or <c>&lt;impo&gt;</c> tag. </p> 440<c>&lt;ol&gt;</c> tag. You need to close the tags as well (which is a general
441XML requirement).
442</p>
333 443
334</body> 444</body>
335</section> 445</section>
336
337<section> 446<section>
338<title>Intra-document references</title> 447<title>Intra-document references</title>
339<body> 448<body>
340 449
450<p>
341<p>Guide makes it really easy to reference other parts of the document using 451Guide makes it really easy to reference other parts of the document using
342hyperlinks. You can create a link pointing to <uri link="#doc_chap1">Chapter 452hyperlinks. You can create a link pointing to <uri link="#doc_chap1">Chapter
343One</uri> by typing <c>&lt;uri link="#doc_chap1"&gt;Chapter 453One</uri> by typing <c>&lt;uri link="#doc_chap1"&gt;Chapter
344One&lt;/uri&gt;</c>. To point to <uri link="#doc_chap1_sect2">section two of 454One&lt;/uri&gt;</c>. To point to <uri link="#doc_chap1_sect2">section two of
345Chapter One</uri>, type <c>&lt;uri link="#doc_chap1_sect2"&gt;section two of 455Chapter One</uri>, type <c>&lt;uri link="#doc_chap1_sect2"&gt;section two of
346Chapter One&lt;/uri&gt;</c>. To refer to figure 3 in chapter 1, type <c>&lt;uri 456Chapter One&lt;/uri&gt;</c>. To refer to figure 3 in chapter 1, type <c>&lt;uri
347link="doc_chap1_fig3"&gt;figure 1.3&lt;/uri&gt;</c>. Or, to refer to <uri link="#doc_chap2_pre2">code listing 2 in chapter 2</uri>, 457link="#doc_chap1_fig3"&gt;figure 1.3&lt;/uri&gt;</c>. Or, to refer to <uri
458link="#doc_chap2_pre2">code listing 2 in chapter 2</uri>, type <c>&lt;uri
348type <c>&lt;uri link="doc_chap2_pre2"&gt;code listing 2.2&lt;/uri&gt;</c>. We'll be 459link="#doc_chap2_pre2"&gt;code listing 2.2&lt;/uri&gt;</c>. We'll be
349adding other auto-link abilities (such as table support) soon.</p> 460adding other auto-link abilities (such as table support) soon.
461</p>
462
463<p>
464However, 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
466<c>&lt;chapter&gt;</c>, <c>&lt;section&gt;</c> or a <c>&lt;tr&gt;</c> by using
467the <c>id</c> attribute, and then point to that attribute, like this:
468</p>
469
470<pre caption="Using the id attribute">
471&lt;chapter id="foo"&gt;
472&lt;title&gt;This is foo!&lt;/title&gt;
473...
474&lt;p&gt;
475More information can be found in the &lt;uri link="#foo"&gt;foo chapter&lt;/uri&gt;
476&lt;/p&gt;
477</pre>
478
479</body>
480</section>
481<section>
482<title>Disclaimers and obsolete documents</title>
483<body>
484
485<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:
487</p>
488
489<ul>
490 <li>
491 <b>articles</b> is used for <uri link="/doc/en/articles/">republished
492 articles</uri>
493 </li>
494 <li>
495 <b>draft</b> is used to indicate a document is still being worked on and
496 should not be considered official
497 </li>
498 <li>
499 <b>oldbook</b> is used on old handbooks to indicate they are not maintained
500 anymore
501 </li>
502 <li><b>obsolete</b> is used to mark a document as obsolete.</li>
503</ul>
504
505<p>
506When marking a document as obsolete, you might want to add a link to a new
507version. The <c>redirect</c> attribute does just that. The user might be
508automatically redirected to the new page but you should not rely on that
509behaviour.
510</p>
511
512<pre caption="Disclaimer sample">
513&lt;?xml version="1.0" encoding="UTF-8"?&gt;
514&lt;!DOCTYPE guide SYSTEM "/dtd/guide.dtd"&gt;
515&lt;!-- &#36;Header&#36; --&gt;
516
517&lt;guide link="/doc/en/gentoo-x86-install.xml" disclaimer="obsolete" redirect="/doc/en/handbook/handbook-x86.xml"&gt;
518&lt;title>Gentoo x86 Installation Guide&lt;/title&gt;
519
520&lt;author title="Author"&gt;
521...
522</pre>
350 523
351</body> 524</body>
352</section> 525</section>
353</chapter> 526</chapter>
527
528<chapter>
529<title>Coding Style</title>
530<section>
531<title>Introduction</title>
532<body>
533
534<p>
535Since all Gentoo Documentation is a joint effort and several people will
536most likely change existing documentation, a coding style is needed.
537A coding style contains two sections. The first one is regarding
538internal coding - how the XML-tags are placed. The second one is
539regarding the content - how not to confuse the reader.
540</p>
541
542<p>
543Both sections are described next.
544</p>
545
546</body>
547</section>
548<section>
549<title>Internal Coding Style</title>
550<body>
551
552<p>
553<b>Newlines</b> must be placed immediately after <e>every</e>
554GuideXML-tag (both opening as closing), except for:
555<c>&lt;version&gt;</c>, <c>&lt;date&gt;</c>, <c>&lt;title&gt;</c>,
556<c>&lt;th&gt;</c>, <c>&lt;ti&gt;</c>,
557<c>&lt;li&gt;</c>, <c>&lt;i&gt;</c>, <c>&lt;e&gt;</c>,
558<c>&lt;uri&gt;</c>, <c>&lt;path&gt;</c>, <c>&lt;b&gt;</c>, <c>&lt;c&gt;</c>,
559<c>&lt;comment&gt;</c>, <c>&lt;mail&gt;</c>.
560</p>
561
562<p>
563<b>Blank lines</b> must be placed immediately after <e>every</e>
564<c>&lt;body&gt;</c> (opening tag only) and before <e>every</e>
565<c>&lt;chapter&gt;</c>, <c>&lt;p&gt;</c>, <c>&lt;table&gt;</c>,
566<c>&lt;author&gt;</c> (set), <c>&lt;pre&gt;</c>, <c>&lt;ul&gt;</c>,
567<c>&lt;ol&gt;</c>, <c>&lt;warn&gt;</c>, <c>&lt;note&gt;</c> and
568<c>&lt;impo&gt;</c> (opening tags only).
569</p>
570
571<p>
572<b>Word-wrapping</b> must be applied at 80 characters except inside
573<c>&lt;pre&gt;</c>. You may only deviate from this rule when there is no other
574choice (for instance when a URL exceeds the maximum amount of characters). The
575editor must then wrap whenever the first whitespace occurs. You should try to
576keep the <e>rendered</e> content of <c>&lt;pre&gt;</c> elements within 80
577columns to help console users.
578</p>
579
580<p>
581<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>),
583<c>&lt;ul&gt;</c>, <c>&lt;ol&gt;</c> and <c>&lt;author&gt;</c>. If indentation
584is used, it <e>must</e> be two spaces for each indentation. That means <e>no
585tabs</e> and <e>not</e> more spaces. Besides, tabs are not allowed in GuideXML
586documents.
587</p>
588
589<p>
590In case word-wrapping happens in <c>&lt;ti&gt;</c>, <c>&lt;th&gt;</c> or
591<c>&lt;li&gt;</c> constructs, indentation must be used for the content.
592</p>
593
594<p>
595An example for indentation is:
596</p>
597
598<pre caption="Indentation Example">
599&lt;table&gt;
600&lt;tr&gt;
601 &lt;th&gt;Foo&lt;/th&gt;
602 &lt;th&gt;Bar&lt;/th&gt;
603&lt;/tr&gt;
604&lt;tr&gt;
605 &lt;ti&gt;This is an example for indentation&lt;/ti&gt;
606 &lt;ti&gt;
607 In case text cannot be shown within an 80-character wide line, you
608 must use indentation if the parent tag allows it
609 &lt;/ti&gt;
610&lt;/tr&gt;
611&lt;/table&gt;
612
613&lt;ul&gt;
614 &lt;li&gt;First option&lt;/li&gt;
615 &lt;li&gt;Second option&lt;/li&gt;
616&lt;/ul&gt;
617</pre>
618
619<p>
620<b>Attributes</b> may not have spaces in between the attribute, the
621&quot;=&quot; mark, and the attribute value. As an example:
622</p>
623
624<pre caption="Attributes">
625<comment>Wrong :</comment> &lt;pre caption = "Attributes"&gt;
626<comment>Correct:</comment> &lt;pre caption="Attributes"&gt;
627</pre>
628
629</body>
630</section>
631<section>
632<title>External Coding Style</title>
633<body>
634
635<p>
636Inside tables (<c>&lt;table&gt;</c>) and listings (<c>&lt;ul&gt;</c> and
637<c>&lt;ol&gt;</c>), periods (&quot;.&quot;) should not be used unless multiple
638sentences are used. In that case, every sentence should end with a period (or
639other reading marks).
640</p>
641
642<p>
643Every sentence, including those inside tables and listings, should start
644with a capital letter.
645</p>
646
647<pre caption="Periods and capital letters">
648&lt;ul&gt;
649 &lt;li&gt;No period&lt;/li&gt;
650 &lt;li&gt;With period. Multiple sentences, remember?&lt;/li&gt;
651&lt;/ul&gt;
652</pre>
653
654<p>
655Code Listings should <e>always</e> have a <c>caption</c>.
656</p>
657
658<p>
659Try to use <c>&lt;uri&gt;</c> with the <c>link</c> attribute as much as
660possible. In other words, the <uri link="http://forums.gentoo.org">Gentoo
661Forums</uri> is preferred over <uri>http://forums.gentoo.org</uri>.
662</p>
663
664<p>
665When you comment something inside a <c>&lt;pre&gt;</c> construct, use
666<c>&lt;comment&gt;</c> and parentheses or the comment marker for the language
667that is being used (<c>#</c> for bash scripts and many other things, <c>//</c>
668for C code, etc.) Also place the comment <e>before</e> the subject of the
669comment.
670</p>
671
672<pre caption="Comment example">
673<comment>(Substitute "john" with your user name)</comment>
674# <i>id john</i>
675</pre>
676
677</body>
678</section>
679</chapter>
680
681<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
354<chapter> 816<chapter>
355<title>Resources</title> 817<title>Resources</title>
356<section> 818<section>
357 <title>Start writing</title> 819<title>Start writing</title>
358 <body> 820<body>
821
822<p>
359 <p>Guide has been specially designed to be "lean and mean" so that developers 823Guide has been specially designed to be "lean and mean" so that developers can
360 can spend more time writing documentation and less time learning the actual XML 824spend more time writing documentation and less time learning the actual XML
361 syntax. Hopefully, this will allow developers who aren't unusually "doc-savvy" 825syntax. Hopefully, this will allow developers who aren't unusually "doc-savvy"
362 to start writing quality Gentoo Linux documentation. If you'd like to help (or have any questions about guide), please 826to start writing quality Gentoo documentation. You might be interested
363 post a message to <mail link="gentoo-dev@gentoo.org">the gentoo-dev mailing list</mail> 827in our <uri link="/proj/en/gdp/doc/doc-tipsntricks.xml">Documentation
364 stating what you'd like to tackle. 828Development Tips &amp; Tricks</uri>. If you'd like to help (or have any
365 Have fun!</p> 829questions about guide), please post a message to the <mail
830link="gentoo-doc@gentoo.org">gentoo-doc mailing list</mail> stating what you'd
831like to tackle. Have fun!
832</p>
833
366 </body> 834</body>
367</section> 835</section>
368</chapter> 836</chapter>
369</guide> 837</guide>
370

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

  ViewVC Help
Powered by ViewVC 1.1.20