/[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.14 Revision 1.15
1<?xml version='1.0' encoding="UTF-8"?> 1<?xml version='1.0' encoding="UTF-8"?>
2<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> 2<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
3 3
4<guide link="/doc/en/xml-guide.xml"> 4<guide link="/doc/en/xml-guide.xml">
5<title>Gentoo Linux XML Guide</title> 5<title>Gentoo Linux XML Guide</title>
6
7<author title="Author">
6<author title="Author"><mail link="drobbins@gentoo.org">Daniel Robbins</mail></author> 8 <mail link="drobbins@gentoo.org">Daniel Robbins</mail>
7<author title="Author"><mail link="zhen@gentoo.org">John P. Davis</mail></author> 9</author>
8<author title="Editor"><mail link="peesh@gentoo.org">Jorge Paulo</mail></author> 10<author title="Author">
11 <mail link="zhen@gentoo.org">John P. Davis</mail>
12</author>
13<author title="Editor">
14 <mail link="peesh@gentoo.org">Jorge Paulo</mail>
15</author>
9 16
10<license/> 17<license/>
11 18<abstract>
12<abstract>This guide shows you how to compose web documentation using the new lightweight Gentoo guide 19This guide shows you how to compose web documentation using the new lightweight
13XML syntax. This syntax is the official format for Gentoo Linux documentation, and this document 20Gentoo GuideXML syntax. This syntax is the official format for Gentoo Linux
14itself was created using guide XML. This guide assumes a basic working knowledge of XML and HTML. 21documentation, and this document itself was created using GuideXML. This guide
22assumes a basic working knowledge of XML and HTML.
15</abstract> 23</abstract>
16 24
17<version>2.0</version> 25<version>2.0</version>
18<date>4th of August 2003</date> 26<date>October 9, 2003</date>
19 27
20<chapter> 28<chapter>
21<title>Guide basics</title> 29<title>Guide basics</title>
22 30
23<section> 31<section>
24<title>Guide XML design goals</title> 32<title>Guide XML design goals</title>
25<body> 33<body>
26 34
35<p>
27<p> The guide XML syntax is lightweight yet expressive, so that it is easy to 36The guide XML syntax is lightweight yet expressive, so that it is easy to
28learn yet also provides all the features we need for the creation of web 37learn yet also provides all the features we need for the creation of web
29documentation. The number of tags is kept to a minimum -- just those we need. 38documentation. The number of tags is kept to a minimum -- just those we need.
30This makes it easy to transform guide into other formats, such as DocBook 39This makes it easy to transform guide into other formats, such as DocBook
31XML/SGML or web-ready HTML. </p> 40XML/SGML or web-ready HTML.
41</p>
32 42
43<p>
33<p>The goal is to make it easy to <e>create</e> and <e>transform</e> guide XML 44The goal is to make it easy to <e>create</e> and <e>transform</e> guide XML
34documents.</p> 45documents.
46</p>
35 47
36</body> 48</body>
37</section> 49</section>
38 50
39<section> 51<section>
40<title>How to transform guide XML into HTML</title> 52<title>How to transform guide XML into HTML</title>
41<body> 53<body>
42 54
55<p>
43<p> Before we take a look at the guide syntax itself, it's helpful to know how 56Before we take a look at the guide syntax itself, it's helpful to know how
44guide XML is transformed into web-ready HTML. To do this, we use a special 57guide XML is transformed into web-ready HTML. To do this, we use a special
45file called <path>guide.xsl</path>, along with a command-line XSLT processing 58file called <path>guide.xsl</path>, along with a command-line XSLT processing
46tool (also called an "engine"). The <path>guide.xsl</path> file describes 59tool (also called an "engine"). The <path>guide.xsl</path> file describes
47exactly how to transform the contents of the source guide XML document to 60exactly how to transform the contents of the source guide XML document to
48create the target HTML file. The processing tool that Gentoo Linux uses 61create the target HTML file. The processing tool that Gentoo Linux uses
49is called <c>xsltproc</c>, which is found in the <i>libxslt</i> package. </p> 62is called <c>xsltproc</c>, which is found in the <i>libxslt</i> package.
50 63</p>
51 64
52<pre caption="Installing libxslt"> 65<pre caption="Installing libxslt">
53# <c>emerge libxslt</c> 66# <c>emerge libxslt</c>
54</pre> 67</pre>
55 68
69<p>
56<p>Now that we have the way, we need the means, so to speak. In other words, 70Now that we have the way, we need the means, so to speak. In other words,
57we need some Gentoo XML documents to transform. Gentoo has two types of tarballs 71we need some Gentoo XML documents to transform. Gentoo has two types of tarballs
58that are available for download: </p> 72that are available for download:
73</p>
59 74
75<p>
60<p><b>The first type contains the entire up-to-date Gentoo Linux website</b>. 76<b>The first type contains the entire up-to-date Gentoo Linux website</b>.
61Included are our XSL templates, so if you are planning to transform any documentation, 77Included are our XSL templates, so if you are planning to transform any
62you will need this tarball. The tarball can be found 78documentation, you will need this tarball. The tarball can be found <uri
63<uri link="http://www.gentoo.org/dyn/arch/xml-guide-latest.tar.gz">here</uri>.</p> 79link="http://www.gentoo.org/dyn/arch/xml-guide-latest.tar.gz">here</uri>.
80</p>
64 81
82<p>
65<p><b>The second type contains daily snapshots our XML documentation source</b> in 83<b>The second type contains daily snapshots our XML documentation source</b>
66every language that we offer. Please note that it is impossible to transform 84in every language that we offer. Please note that it is impossible to transform
67documentation with this tarball, so please download the web tarball if you want to fully 85documentation with this tarball, so please download the web tarball if you want
68develop your own documentation. These tarballs are especially useful for translators. 86to fully develop your own documentation. These tarballs are especially useful
87for translators. These tarballs can be found <uri
69These tarballs can be found <uri link="http://www.gentoo.org/dyn/doc-snapshots">here</uri>. 88link="http://www.gentoo.org/dyn/doc-snapshots">here</uri>.
89</p>
90
70</p> 91<p>
71
72<p>After the web tarball is downloaded and extracted, go 92After the web tarball is downloaded and extracted, go to the directory where
73to the directory where the tarball was extracted, and enter the 93the tarball was extracted, and enter the <path>htdocs</path> directory. Browse
74<path>htdocs</path> directory. Browse around and get comfortable with the 94around and get comfortable with the layout, but note the <path>xsl</path> and
75layout, but note the <path>xsl</path> and <path>doc</path> directories. 95<path>doc</path> directories. As you might have guessed, the XSL stylesheets are
76As you might have guessed, the XSL stylesheets are in <path>xsl</path>,
77and our documentation is in <path>doc</path>. For testing purposes, we 96in <path>xsl</path>, and our documentation is in <path>doc</path>. For testing
78will be using the Gentoo Linux CD Installation Guide, located at 97purposes, we will be using the Gentoo Linux CD Installation Guide, located at
79<path>doc/en/gentoo-x86-install.xml</path>. Now that the locations 98<path>doc/en/gentoo-x86-install.xml</path>. Now that the locations of the XSL
80of the XSL and XML file are known, we can do some transforming with 99and XML file are known, we can do some transforming with <c>xsltproc</c>.
81<c>xsltproc</c>. </p> 100</p>
82 101
83<pre caption="Transforming gentoo-x86-install.xml"> 102<pre caption="Transforming gentoo-x86-install.xml">
84# <c>xsltproc xsl/guide.xsl doc/en/gentoo-x86-install.xml &gt; /tmp/install.html</c> 103# <c>xsltproc xsl/guide.xsl doc/en/gentoo-x86-install.xml &gt; /tmp/install.html</c>
85</pre> 104</pre>
86 105
106<p>
87<p> If all went well, you should have a web-ready version of 107If all went well, you should have a web-ready version of
88<path>gentoo-x86-install.xml</path> at <path>/tmp/install.html</path>. For this document 108<path>gentoo-x86-install.xml</path> at <path>/tmp/install.html</path>. For
89to display properly in a web browser, you may have to copy some files from 109this document to display properly in a web browser, you may have to copy some
90<path>htdocs</path> to <path>/tmp</path>, such 110files from <path>htdocs</path> to <path>/tmp</path>, such as
91as <path>css/main.css</path> and (to be safe) the entire <path>images</path> 111<path>css/main.css</path> and (to be safe) the entire <path>images</path>
92directory. 112directory.
93</p> 113</p>
94 114
95</body> 115</body>
96</section> 116</section>
97</chapter> 117</chapter>
118
98<chapter> 119<chapter>
99 <title>Guide XML</title> 120<title>Guide XML</title>
100<section> 121<section>
101<title>Basic structure</title> 122<title>Basic structure</title>
102<body> 123<body>
103 124
125<p>
104<p>Now that you know how to transform guide XML, you're ready to start learning 126Now that you know how to transform guide XML, you're ready to start learning
105the guide XML syntax. We'll start with the the initial tags used in a guide 127the GuideXML syntax. We'll start with the the initial tags used in a guide
106XML document: </p> 128XML document:
129</p>
107 130
108<pre caption="The initial part of a guide XML document"> 131<pre caption="The initial part of a guide XML document">
109&lt;?xml version='1.0' encoding="UTF-8"?&gt; 132&lt;?xml version='1.0' encoding="UTF-8"?&gt;
110&lt;guide link="relative_link_to_your_guide"&gt; 133&lt;guide link="relative_link_to_your_guide"&gt;
111&lt;title&gt;<i>Gentoo Linux Documentation Guide</i>&lt;/title&gt; 134&lt;title&gt;<i>Gentoo Linux Documentation Guide</i>&lt;/title&gt;
112&lt;author title="<i>Chief Architect</i>"&gt;&lt;mail link="<i>drobbins@gentoo.org</i>"&gt; 135&lt;author title="<i>Chief Architect</i>"&gt;
113 <i>Daniel Robbins</i>&lt;/mail&gt; 136 &lt;mail link="<i>drobbins@gentoo.org</i>"&gt;<i>Daniel Robbins</i>&lt;/mail&gt;
114&lt;/author&gt; 137&lt;/author&gt;
115&lt;author title="<i>Editor</i>"&gt;&lt;mail link="<i>thomasfl@gentoo.org</i>"&gt; 138&lt;author title="<i>Editor</i>"&gt;
116 <i>Thomas Flavel</i>&lt;/mail&gt; 139 &lt;mail link="<i>thomasfl@gentoo.org</i>"&gt;<i>Thomas Flavel</i>&lt;/mail&gt;
117&lt;/author&gt; 140&lt;/author&gt;
118 141
142&lt;abstract&gt;
119&lt;abstract&gt;<i>This guide shows you how to compose web documentation using 143<i>This guide shows you how to compose web documentation using
120our new lightweight Gentoo guide XML syntax. This syntax is the official 144our new lightweight Gentoo GuideXML syntax. This syntax is the official
121format for Gentoo Linux web documentation, and this document itself was created 145format for Gentoo Linux web documentation, and this document itself was created
122using guide XML.</i> &lt;/abstract&gt; 146using GuideXML.</i>
147&lt;/abstract&gt;
123 148
124&lt;license/&gt; 149&lt;license/&gt;
125 150
126&lt;version&gt;<i>1.0</i>&lt;/version&gt; 151&lt;version&gt;<i>1.0</i>&lt;/version&gt;
127&lt;date&gt;<i>29 Mar 2001</i>&lt;/date&gt; 152&lt;date&gt;<i>29 Mar 2001</i>&lt;/date&gt;
128</pre> 153</pre>
129 154
155<p>
130<p>On the first, line, we see the requisite tag that identifies this as an XML 156On the first, line, we see the requisite tag that identifies this as an XML
131document. Following it, there's a <c>&lt;guide&gt;</c> tag -- the entire 157document. Following it, there's a <c>&lt;guide&gt;</c> tag -- the entire
132guide document is enclosed within a <c>&lt;guide&gt; &lt;/guide&gt;</c> pair. 158guide document is enclosed within a <c>&lt;guide&gt; &lt;/guide&gt;</c> pair.
133Next, there's a <c>&lt;title&gt;</c> tag, used to set the title for the entire 159Next, there's a <c>&lt;title&gt;</c> tag, used to set the title for the entire
134guide document. </p> 160guide document.
161</p>
135 162
163<p>
136<p>Then, we come to the <c>&lt;author&gt;</c> tags, which contain information 164Then, 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 165about 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 166allows for an optional <c>title=</c> element, used to specify the author's
139relationship to the document (author, co-author, editor, etc.). In this 167relationship to the document (author, co-author, editor, etc.). In this
140particular example, the authors' names are enclosed in another tag -- a 168particular 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 169<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 170person. The <c>&lt;mail&gt;</c> tag is optional and can be omitted, and no
143more than one <c>&lt;author&gt;</c> element is required per guide document. 171more than one <c>&lt;author&gt;</c> element is required per guide document.
144</p> 172</p>
145 173
174<p>
146<p>Next, we come to the <c>&lt;abstract&gt;</c>, <c>&lt;version&gt;</c> and 175Next, we come to the <c>&lt;abstract&gt;</c>, <c>&lt;version&gt;</c> and
147<c>&lt;date&gt;</c> tags, used to specify a summary of the document, the 176<c>&lt;date&gt;</c> tags, used to specify a summary of the document, the
148current version number, and the current version date (in DD MMM YYYY format) 177current version number, and the current version date (in DD MMM YYYY format)
149respectively. This rounds out the tags that should appear at the beginning of 178respectively. This rounds out the tags that should appear at the beginning of
150a guide document. Besides the <c>&lt;title&gt;</c> and <c>&lt;mail&gt;</c> 179a guide document. Besides the <c>&lt;title&gt;</c> and <c>&lt;mail&gt;</c>
151tags, these tags shouldn't appear anywhere else except immediately inside the 180tags, these tags shouldn't appear anywhere else except immediately inside the
152<c>&lt;guide&gt;</c> tag, and for consistency it's recommended (but not 181<c>&lt;guide&gt;</c> tag, and for consistency it's recommended (but not
153required) that these tags appear before the content of the document. </p> 182required) that these tags appear before the content of the document.
183</p>
154 184
185<p>
155<p>Finally we have the <c>&lt;license/&gt;</c> tag, used to publish the 186Finally we have the <c>&lt;license/&gt;</c> tag, used to publish the
156document under the <uri link="http://creativecommons.org/licenses/by-sa/1.0/">Creative 187document under the <uri link="http://creativecommons.org/licenses/by-sa/1.0/">Creative
157Commons - Attribution / Share Alike</uri> license as required by the <uri 188Commons - Attribution / Share Alike</uri> license as required by the <uri
158link="/doc/en/doc-policy.xml">Documentation Policy</uri>. 189link="/doc/en/doc-policy.xml">Documentation Policy</uri>.
159 </p> 190</p>
160 191
161</body> 192</body>
162</section> 193</section>
163 194
164<section> 195<section>
165<title>Chapters and sections</title> 196<title>Chapters and sections</title>
166<body> 197<body>
198
199<p>
167<p>Once the initial tags have been specified, you're ready to start adding 200Once the initial tags have been specified, you're ready to start adding
168the structural elements of the document. Guide documents are divided into 201the structural elements of the document. Guide documents are divided into
169chapters, and each chapter can hold one or more sections. Every chapter 202chapters, and each chapter can hold one or more sections. Every chapter
170and section has a title. Here's an example chapter with a single section, 203and section has a title. Here's an example chapter with a single section,
171consisting of a paragraph. If you append this XML to the XML in the <uri link="#doc_pre2">previous 204consisting of a paragraph. If you append this XML to the XML in the <uri link="#doc_pre2">previous
172excerpt</uri> and append a <c>&lt;/guide&gt;</c> to the end of the file, you'll have a valid 205excerpt</uri> and append a <c>&lt;/guide&gt;</c> to the end of the file, you'll have a valid
175 208
176<pre> 209<pre>
177&lt;chapter&gt; 210&lt;chapter&gt;
178&lt;title&gt;<i>This is my chapter</i>&lt;/title&gt; 211&lt;title&gt;<i>This is my chapter</i>&lt;/title&gt;
179&lt;section&gt; 212&lt;section&gt;
180 &lt;title&gt;<i>This is section one of my chapter</i>&lt;/title&gt; 213&lt;title&gt;<i>This is section one of my chapter</i>&lt;/title&gt;
181 &lt;body&gt; 214&lt;body&gt;
215
216&lt;p&gt;
182 &lt;p&gt;<i>This is the actual text content of my section.</i>&lt;/p&gt; 217<i>This is the actual text content of my section.</i>
218&lt;/p&gt;
219
183 &lt;/body&gt; 220&lt;/body&gt;
184&lt;/section&gt; 221&lt;/section&gt;
185&lt;/chapter&gt; 222&lt;/chapter&gt;
186</pre> 223</pre>
187 224
225<p>
188<p>Above, I set the chapter title by adding a child <c>&lt;title&gt;</c> 226Above, I set the chapter title by adding a child <c>&lt;title&gt;</c>
189element to the <c>&lt;chapter&gt;</c> element. Then, I created a section by 227element to the <c>&lt;chapter&gt;</c> element. Then, I created a section by
190adding a <c>&lt;section&gt;</c> element. If you look inside the 228adding a <c>&lt;section&gt;</c> element. If you look inside the
191<c>&lt;section&gt;</c> element, you'll see that it has two child elements -- a 229<c>&lt;section&gt;</c> element, you'll see that it has two child elements -- a
192<c>&lt;title&gt;</c> and a <c>&lt;body&gt;</c>. While the <c>&lt;title&gt;</c> 230<c>&lt;title&gt;</c> and a <c>&lt;body&gt;</c>. While the <c>&lt;title&gt;</c>
193is nothing new, the <c>&lt;body&gt;</c> is -- it contains the actual text 231is nothing new, the <c>&lt;body&gt;</c> is -- it contains the actual text
194content of this particular section. We'll look at the tags that are allowed 232content of this particular section. We'll look at the tags that are allowed
195inside a <c>&lt;body&gt;</c> element in a bit. </p> 233inside a <c>&lt;body&gt;</c> element in a bit.
234</p>
196 235
236<note>
197<note>A <c>&lt;guide&gt;</c> element can contain multiple 237A <c>&lt;guide&gt;</c> element can contain multiple <c>&lt;chapter&gt;</c>
198<c>&lt;chapter&gt;</c> elements, and a <c>&lt;chapter&gt;</c> can contain 238elements, and a <c>&lt;chapter&gt;</c> can contain multiple
199multiple <c>&lt;section&gt;</c> elements. However, a <c>&lt;section&gt;</c> 239<c>&lt;section&gt;</c> elements. However, a <c>&lt;section&gt;</c>
200element can only contain one <c>&lt;body&gt;</c> element. </note> 240element can only contain one <c>&lt;body&gt;</c> element.
241</note>
201 242
202</body> 243</body>
203</section> 244</section>
204 245
205<section> 246<section>
206<title>An example &lt;body&gt;</title> 247<title>An example &lt;body&gt;</title>
207<body> 248<body>
249
208<p> 250<p>
209Now, 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: 251Now, 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:
210</p> 252</p>
253
211<pre> 254<pre>
212&lt;p&gt; 255&lt;p&gt;
213This is a paragraph. &lt;path&gt;/etc/passwd&lt;/path&gt; is a file. 256This is a paragraph. &lt;path&gt;/etc/passwd&lt;/path&gt; is a file.
214&lt;uri&gt;http://www.gentoo.org&lt;/uri&gt; is my favorite website. 257&lt;uri&gt;http://www.gentoo.org&lt;/uri&gt; is my favorite website.
215Type &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. 258Type &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.
222Make HTML/XML easier to read by using selective emphasis: 265Make HTML/XML easier to read by using selective emphasis:
223&lt;foo&gt;&lt;i&gt;bar&lt;/i&gt;&lt;/foo&gt; 266&lt;foo&gt;&lt;i&gt;bar&lt;/i&gt;&lt;/foo&gt;
224 267
225&lt;codenote&gt;This is how to insert an inline note into the code block&lt;/codenote&gt; 268&lt;codenote&gt;This is how to insert an inline note into the code block&lt;/codenote&gt;
226&lt;/pre&gt; 269&lt;/pre&gt;
227&lt;note&gt;This is a note.&lt;/note&gt; 270
228&lt;warn&gt;This is a warning.&lt;/warn&gt; 271&lt;note&gt;
229&lt;impo&gt;This is important.&lt;/impo&gt; 272This is a note.
273&lt;/note&gt;
274
275&lt;warn&gt;
276This is a warning.
277&lt;/warn&gt;
278
279&lt;impo&gt;
280This is important.
281&lt;/impo&gt;
230</pre> 282</pre>
283
284<p>
231<p>Now, here's how this <c>&lt;body&gt;</c> element is rendered:</p> 285Now, here's how this <c>&lt;body&gt;</c> element is rendered:
286</p>
232 287
233<p> 288<p>
234This is a paragraph. <path>/etc/passwd</path> is a file. 289This is a paragraph. <path>/etc/passwd</path> is a file.
235<uri>http://www.gentoo.org</uri> is my favorite website. 290<uri>http://www.gentoo.org</uri> is my favorite website.
236Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now. 291Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now.
243Make HTML/XML easier to read by using selective emphasis: 298Make HTML/XML easier to read by using selective emphasis:
244&lt;foo&gt;<i>bar</i>&lt;/foo&gt; 299&lt;foo&gt;<i>bar</i>&lt;/foo&gt;
245 300
246<codenote>This is how to insert an inline note into the code block</codenote> 301<codenote>This is how to insert an inline note into the code block</codenote>
247</pre> 302</pre>
248<note>This is a note.</note> 303
249<warn>This is a warning.</warn> 304<note>
250<impo>This is important.</impo> 305This is a note.
306</note>
307
308<warn>
309This is a warning.
310</warn>
311
312<impo>
313This is important.
314</impo>
315
251</body> 316</body>
252</section> 317</section>
253 318
254<section> 319<section>
255<title>The &lt;body&gt; tags</title> 320<title>The &lt;body&gt; tags</title>
256<body> 321<body>
257 322
323<p>
258<p> We introduced a lot of new tags in the previous section -- here's what you 324We introduced a lot of new tags in the previous section -- here's what you
259need to know. The <c>&lt;p&gt;</c> (paragraph), <c>&lt;pre&gt;</c> (code 325need to know. The <c>&lt;p&gt;</c> (paragraph), <c>&lt;pre&gt;</c> (code
260block), <c>&lt;note&gt;</c>, <c>&lt;warn&gt;</c> (warning) and 326block), <c>&lt;note&gt;</c>, <c>&lt;warn&gt;</c> (warning) and
261<c>&lt;impo&gt;</c> (important) tags all can contain one or more lines of text. 327<c>&lt;impo&gt;</c> (important) tags all can contain one or more lines of text.
262Besides the <c>&lt;table&gt;</c> element (which we'll cover in just a bit), 328Besides the <c>&lt;table&gt;</c> element (which we'll cover in just a bit),
263these are the only tags that should appear immediately inside a 329these are the only tags that should appear immediately inside a
264<c>&lt;body&gt;</c> element. Another thing -- these tags <e>should not</e> be 330<c>&lt;body&gt;</c> element. Another thing -- these tags <e>should not</e> be
265stacked -- in other words, don't put a <c>&lt;note&gt;</c> element inside a 331stacked -- in other words, don't put a <c>&lt;note&gt;</c> element inside a
266<c>&lt;p&gt;</c> element. As you might guess, the <c>&lt;pre&gt;</c> element 332<c>&lt;p&gt;</c> element. As you might guess, the <c>&lt;pre&gt;</c> element
267preserves its whitespace exactly, making it well-suited for code excerpts. 333preserves its whitespace exactly, making it well-suited for code excerpts.
268You can also name the <c>&lt;pre&gt;</c> tag:</p> 334You can also name the <c>&lt;pre&gt;</c> tag:
335</p>
269 336
270<pre caption = "Named &lt;pre&gt;"> 337<pre caption = "Named &lt;pre&gt;">
271&lt;pre caption = "Output of uptime"&gt; 338&lt;pre caption = "Output of uptime"&gt;
272# &lt;i&gt;uptime&lt;/i&gt; 339# &lt;i&gt;uptime&lt;/i&gt;
27316:50:47 up 164 days, 2:06, 5 users, load average: 0.23, 0.20, 0.25 34016:50:47 up 164 days, 2:06, 5 users, load average: 0.23, 0.20, 0.25
278</section> 345</section>
279<section> 346<section>
280<title>&lt;path&gt;, &lt;c&gt; and &lt;e&gt;</title> 347<title>&lt;path&gt;, &lt;c&gt; and &lt;e&gt;</title>
281<body> 348<body>
282 349
350<p>
283<p>The <c>&lt;path&gt;</c>, <c>&lt;c&gt;</c> and <c>&lt;e&gt;</c> elements can 351The <c>&lt;path&gt;</c>, <c>&lt;c&gt;</c> and <c>&lt;e&gt;</c> elements can
284be used inside any child <c>&lt;body&gt;</c> tag, except for 352be used inside any child <c>&lt;body&gt;</c> tag, except for
285<c>&lt;pre&gt;</c>. </p> 353<c>&lt;pre&gt;</c>.
354</p>
286 355
356<p>
287<p>The <c>&lt;path&gt;</c> element is used to mark text that refers to an 357The <c>&lt;path&gt;</c> element is used to mark text that refers to an
288<e>on-disk file</e> -- either an <e>absolute or relative path</e>, or a <e>simple filename</e>. 358<e>on-disk file</e> -- either an <e>absolute or relative path</e>, or a
289This element is generally rendered with a monospaced font to offset it from the 359<e>simple filename</e>. This element is generally rendered with a monospaced
290standard paragraph type. </p> 360font to offset it from the standard paragraph type.
361</p>
291 362
363<p>
292<p>The <c>&lt;c&gt;</c> element is used to mark up a <e>command</e> or <e>user 364The <c>&lt;c&gt;</c> element is used to mark up a <e>command</e> or <e>user
293input</e>. Think of <c>&lt;c&gt;</c> as a way to alert the reader to something 365input</e>. Think of <c>&lt;c&gt;</c> as a way to alert the reader to something
294that they can type in that will perform some kind of action. For example, all 366that they can type in that will perform some kind of action. For example, all
295the XML tags displayed in this document are enclosed in a <c>&lt;c&gt;</c> 367the XML tags displayed in this document are enclosed in a <c>&lt;c&gt;</c>
296element because they represent something that the user could type in that is 368element because they represent something that the user could type in that is
297not a path. By using <c>&lt;c&gt;</c> elements, you'll help your readers 369not a path. By using <c>&lt;c&gt;</c> elements, you'll help your readers
298quickly identify commands that they need to type in. Also, because 370quickly identify commands that they need to type in. Also, because
299<c>&lt;c&gt;</c> elements are already offset from regular text, <e>it is rarely 371<c>&lt;c&gt;</c> elements are already offset from regular text, <e>it is rarely
300necessary to surround user input with double-quotes</e>. For example, don't 372necessary to surround user input with double-quotes</e>. For example, don't
301refer to a "<c>&lt;c&gt;</c>" element like I did in this sentence. Avoiding 373refer to a "<c>&lt;c&gt;</c>" element like I did in this sentence. Avoiding
302the use of unnecessary double-quotes makes a document more readable -- and adorable!</p> 374the use of unnecessary double-quotes makes a document more readable -- and
375adorable!
376</p>
303 377
378<p>
304<p><c>&lt;e&gt;</c> is used to apply emphasis to a word or phrase; for example: 379<c>&lt;e&gt;</c> is used to apply emphasis to a word or phrase; for example:
305I <e>really</e> should use semicolons more often. As you can see, this text is 380I <e>really</e> should use semicolons more often. As you can see, this text is
306offset from the regular paragraph type for emphasis. This helps to give your 381offset from the regular paragraph type for emphasis. This helps to give your
307prose more <e>punch</e>!</p> 382prose more <e>punch</e>!
383</p>
308 384
309</body> 385</body>
310</section> 386</section>
311 387
312<section> 388<section>
313<title>&lt;mail&gt; and &lt;uri&gt;</title> 389<title>&lt;mail&gt; and &lt;uri&gt;</title>
314<body> 390<body>
315 391
392<p>
316<p>We've taken a look at the <c>&lt;mail&gt;</c> tag earlier; it's used to link some text 393We've taken a look at the <c>&lt;mail&gt;</c> tag earlier; it's used to link
317with a particular email address, and takes the form <c>&lt;mail link="foo@bar.com"&gt;Mr. Foo Bar&lt;/mail&gt;</c>.</p> 394some text with a particular email address, and takes the form <c>&lt;mail
395link="foo@bar.com"&gt;Mr. Foo Bar&lt;/mail&gt;</c>.
396</p>
318 397
398<p>
319<p>The <c>&lt;uri&gt;</c> tag is used to point to files/locations on the 399The <c>&lt;uri&gt;</c> tag is used to point to files/locations on the
320Internet. It has two forms -- the first can be used when you want to have the 400Internet. It has two forms -- the first can be used when you want to have the
321actual URI displayed in the body text, such as this link to 401actual URI displayed in the body text, such as this link to
322<uri>http://www.gentoo.org</uri>. To create this link, I typed 402<uri>http://www.gentoo.org</uri>. To create this link, I typed
323<c>&lt;uri&gt;http://www.gentoo.org&lt;/uri&gt;</c>. The alternate form is 403<c>&lt;uri&gt;http://www.gentoo.org&lt;/uri&gt;</c>. The alternate form is
324when you want to associate a URI with some other text -- for example, <uri 404when you want to associate a URI with some other text -- for example, <uri
325link="http://www.gentoo.org">the Gentoo Linux website</uri>. To create <e>this</e> 405link="http://www.gentoo.org">the Gentoo Linux website</uri>. To create
326link, I typed <c>&lt;uri link="http://www.gentoo.org"&gt;the Gentoo Linux website&lt;/uri&gt;</c>. 406<e>this</e> link, I typed <c>&lt;uri link="http://www.gentoo.org"&gt;the
407Gentoo Linux website&lt;/uri&gt;</c>.
327</p> 408</p>
328 409
329</body> 410</body>
330</section> 411</section>
331 412
332<section> 413<section>
333<title>Figures</title> 414<title>Figures</title>
334 415
335<body> 416<body>
336 417
418<p>
337<p>Here's how to insert a figure into a document -- <c>&lt;figure 419Here's how to insert a figure into a document -- <c>&lt;figure
338link="mygfx.png" short="my picture" caption="my favorite picture of all 420link="mygfx.png" short="my picture" caption="my favorite picture of all
339time"/&gt;</c>. The <c>link=</c> attribute points to the actual graphic image, 421time"/&gt;</c>. The <c>link=</c> attribute points to the actual graphic image,
340the <c>short=</c> attribute specifies a short description (currently used for 422the <c>short=</c> attribute specifies a short description (currently used for
341the image's HTML <c>alt=</c> attribute), and a caption. Not too difficult 423the image's HTML <c>alt=</c> attribute), and a caption. Not too difficult
342:) We also support the standard HTML-style &lt;img src="foo.gif"/&gt; tag 424:) We also support the standard HTML-style &lt;img src="foo.gif"/&gt; tag
343for adding images without captions, borders, etc.</p> 425for adding images without captions, borders, etc.
426</p>
344 427
345</body> 428</body>
346</section> 429</section>
347<section> 430<section>
348<title>Tables and lists</title> 431<title>Tables and lists</title>
349<body> 432<body>
350 433
434<p>
351<p>Guide supports a simplified table syntax similar to that of HTML. To start 435Guide supports a simplified table syntax similar to that of HTML. To start
352a table, use a <c>&lt;table&gt;</c> tag. Start a row with a <c>&lt;tr&gt;</c> 436a table, use a <c>&lt;table&gt;</c> tag. Start a row with a <c>&lt;tr&gt;</c>
353tag. However, for inserting actual table data, we <e>don't</e> support the 437tag. However, for inserting actual table data, we <e>don't</e> support the
354HTML &lt;td&gt; tag; instead, use the <c>&lt;th&gt;</c> if you are inserting a 438HTML &lt;td&gt; tag; instead, use the <c>&lt;th&gt;</c> if you are inserting a
355header, and <c>&lt;ti&gt;</c> if you are inserting a normal informational 439header, and <c>&lt;ti&gt;</c> if you are inserting a normal informational
356block. You can use a <c>&lt;th&gt;</c> anywhere you can use a <c>&lt;ti&gt;</c> -- 440block. You can use a <c>&lt;th&gt;</c> anywhere you can use a <c>&lt;ti&gt;</c>
357there's no requirement that <c>&lt;th&gt;</c> elements appear only in the 441-- there's no requirement that <c>&lt;th&gt;</c> elements appear only in the
358first row. Currently, these tags don't support any attributes, but some will 442first row. Currently, these tags don't support any attributes, but some will
359be added (such as a <c>caption=</c> attribute for <c>&lt;table&gt;</c>) soon. 443be added (such as a <c>caption=</c> attribute for <c>&lt;table&gt;</c>) soon.
360</p> 444</p>
361 445
446<p>
362<p> To create ordered or unordered lists, simply use the HTML-style 447To create ordered or unordered lists, simply use the HTML-style
363<c>&lt;ol&gt;</c>, <c>&lt;ul&gt;</c> and <c>&lt;li&gt;</c> tags. List tags 448<c>&lt;ol&gt;</c>, <c>&lt;ul&gt;</c> and <c>&lt;li&gt;</c> tags. List tags
364should only appear inside a <c>&lt;p&gt;</c>, <c>&lt;ti&gt;</c>, 449should only appear inside a <c>&lt;p&gt;</c>, <c>&lt;ti&gt;</c>,
365<c>&lt;note&gt;</c>, <c>&lt;warn&gt;</c> or <c>&lt;impo&gt;</c> tag. </p> 450<c>&lt;note&gt;</c>, <c>&lt;warn&gt;</c> or <c>&lt;impo&gt;</c> tag.
451</p>
366 452
367</body> 453</body>
368</section> 454</section>
369 455
370<section> 456<section>
371<title>Intra-document references</title> 457<title>Intra-document references</title>
372<body> 458<body>
373 459
460<p>
374<p>Guide makes it really easy to reference other parts of the document using 461Guide makes it really easy to reference other parts of the document using
375hyperlinks. You can create a link pointing to <uri link="#doc_chap1">Chapter 462hyperlinks. You can create a link pointing to <uri link="#doc_chap1">Chapter
376One</uri> by typing <c>&lt;uri link="#doc_chap1"&gt;Chapter 463One</uri> by typing <c>&lt;uri link="#doc_chap1"&gt;Chapter
377One&lt;/uri&gt;</c>. To point to <uri link="#doc_chap1_sect2">section two of 464One&lt;/uri&gt;</c>. To point to <uri link="#doc_chap1_sect2">section two of
378Chapter One</uri>, type <c>&lt;uri link="#doc_chap1_sect2"&gt;section two of 465Chapter One</uri>, type <c>&lt;uri link="#doc_chap1_sect2"&gt;section two of
379Chapter One&lt;/uri&gt;</c>. To refer to figure 3 in chapter 1, type <c>&lt;uri 466Chapter One&lt;/uri&gt;</c>. To refer to figure 3 in chapter 1, type <c>&lt;uri
380link="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>, 467link="doc_chap1_fig3"&gt;figure 1.3&lt;/uri&gt;</c>. Or, to refer to <uri
468link="#doc_chap2_pre2">code listing 2 in chapter 2</uri>, type <c>&lt;uri
381type <c>&lt;uri link="doc_chap2_pre2"&gt;code listing 2.2&lt;/uri&gt;</c>. We'll be 469link="doc_chap2_pre2"&gt;code listing 2.2&lt;/uri&gt;</c>. We'll be
382adding other auto-link abilities (such as table support) soon.</p> 470adding other auto-link abilities (such as table support) soon.
471</p>
383 472
384</body> 473</body>
385</section> 474</section>
386</chapter> 475</chapter>
476
387<chapter> 477<chapter>
388<title>Resources</title> 478<title>Resources</title>
389<section> 479<section>
390 <title>Start writing</title> 480<title>Start writing</title>
391 <body> 481<body>
482
483<p>
392 <p>Guide has been specially designed to be "lean and mean" so that developers 484Guide has been specially designed to be "lean and mean" so that developers
393 can spend more time writing documentation and less time learning the actual XML 485can spend more time writing documentation and less time learning the actual XML
394 syntax. Hopefully, this will allow developers who aren't unusually "doc-savvy" 486syntax. Hopefully, this will allow developers who aren't unusually "doc-savvy"
395 to start writing quality Gentoo Linux documentation. If you'd like to help (or have any questions about guide), please 487to start writing quality Gentoo Linux documentation. If you'd like to help (or
396 post a message to the <mail link="gentoo-doc@gentoo.org">gentoo-doc mailing list</mail> 488have any questions about guide), please post a message to the <mail
397 stating what you'd like to tackle. 489link="gentoo-doc@gentoo.org">gentoo-doc mailing list</mail> stating what you'd
398 Have fun!</p> 490like to tackle. Have fun!
491</p>
492
399 </body> 493</body>
400</section> 494</section>
401</chapter> 495</chapter>
402</guide> 496</guide>
403 497

Legend:
Removed from v.1.14  
changed lines
  Added in v.1.15

  ViewVC Help
Powered by ViewVC 1.1.20