/[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.15
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"?>
3
4<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> 2<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
5 3
6<guide link="/doc/en/xml-guide.xml"> 4<guide link="/doc/en/xml-guide.xml">
7<title>Gentoo Linux Documentation Guide</title> 5<title>Gentoo Linux XML Guide</title>
8<author title="Chief Architect"><mail link="drobbins@gentoo.org">Daniel Robbins</mail></author>
9 6
7<author title="Author">
8 <mail link="drobbins@gentoo.org">Daniel Robbins</mail>
9</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>
16
17<license/>
18<abstract>
10<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
11XML 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
12itself 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.
13</abstract> 23</abstract>
14 24
15<version>1.0</version> 25<version>2.0</version>
16<date>07 Mar 2002</date> 26<date>October 9, 2003</date>
17 27
18<chapter> 28<chapter>
19<title>Guide basics</title> 29<title>Guide basics</title>
20 30
21<section> 31<section>
22<title>Guide XML design goals</title> 32<title>Guide XML design goals</title>
23<body> 33<body>
24 34
35<p>
25<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
26learn 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
27documentation. 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.
28This 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
29XML/SGML or web-ready HTML. </p> 40XML/SGML or web-ready HTML.
41</p>
30 42
43<p>
31<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
32documents.</p> 45documents.
46</p>
33 47
34</body> 48</body>
35</section> 49</section>
36 50
37<section> 51<section>
38<title>How to transform guide XML into HTML</title> 52<title>How to transform guide XML into HTML</title>
39<body> 53<body>
40 54
55<p>
41<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
42guide 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
43file called <path>guide-main.xsl</path>, along with a command-line XSLT processing 58file called <path>guide.xsl</path>, along with a command-line XSLT processing
44tool (also called an "engine"). The <path>guide-main.xsl</path> file describes 59tool (also called an "engine"). The <path>guide.xsl</path> file describes
45exactly 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
46create the target HTML file. Two popular XSLT processors are <c>sabcmd</c> 61create the target HTML file. The processing tool that Gentoo Linux uses
47(included in the <path>app-text/sablotron</path> package) and <c>xsltproc</c> 62is called <c>xsltproc</c>, which is found in the <i>libxslt</i> package.
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 64
65<pre caption="Installing libxslt">
66# <c>emerge libxslt</c>
65<pre> 67</pre>
66# <i>cd gentoo-web/xsl</i> 68
67# <i>xsltproc guide-main.xsl ../xml/install.xml &gt; /tmp/install.html</i> 69<p>
70Now that we have the way, we need the means, so to speak. In other words,
71we need some Gentoo XML documents to transform. Gentoo has two types of tarballs
72that are available for download:
68</pre> 73</p>
69 74
75<p>
76<b>The first type contains the entire up-to-date Gentoo Linux website</b>.
77Included are our XSL templates, so if you are planning to transform any
78documentation, you will need this tarball. The tarball can be found <uri
79link="http://www.gentoo.org/dyn/arch/xml-guide-latest.tar.gz">here</uri>.
80</p>
81
82<p>
83<b>The second type contains daily snapshots our XML documentation source</b>
84in every language that we offer. Please note that it is impossible to transform
85documentation with this tarball, so please download the web tarball if you want
86to fully develop your own documentation. These tarballs are especially useful
87for translators. These tarballs can be found <uri
88link="http://www.gentoo.org/dyn/doc-snapshots">here</uri>.
89</p>
90
91<p>
92After the web tarball is downloaded and extracted, go to the directory where
93the tarball was extracted, and enter the <path>htdocs</path> directory. Browse
94around and get comfortable with the layout, but note the <path>xsl</path> and
95<path>doc</path> directories. As you might have guessed, the XSL stylesheets are
96in <path>xsl</path>, and our documentation is in <path>doc</path>. For testing
97purposes, we will be using the Gentoo Linux CD Installation Guide, located at
98<path>doc/en/gentoo-x86-install.xml</path>. Now that the locations of the XSL
99and XML file are known, we can do some transforming with <c>xsltproc</c>.
100</p>
101
102<pre caption="Transforming gentoo-x86-install.xml">
103# <c>xsltproc xsl/guide.xsl doc/en/gentoo-x86-install.xml &gt; /tmp/install.html</c>
104</pre>
105
106<p>
70<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
71<path>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
72to 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
73<path>gentoo-web</path> to <path>/tmp</path>, such 110files from <path>htdocs</path> to <path>/tmp</path>, such as
74as <path>css/main-new.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>
75directory. 112directory.
76</p> 113</p>
77 114
78</body> 115</body>
79</section> 116</section>
80</chapter> 117</chapter>
118
81<chapter> 119<chapter>
82 <title>Guide XML</title> 120<title>Guide XML</title>
83<section> 121<section>
84<title>Basic structure</title> 122<title>Basic structure</title>
85<body> 123<body>
86 124
125<p>
87<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
88the 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
89XML document: </p> 128XML document:
129</p>
90 130
91<pre caption="The initial part of a guide XML document"> 131<pre caption="The initial part of a guide XML document">
92&lt;?xml version='1.0'?&gt; 132&lt;?xml version='1.0' encoding="UTF-8"?&gt;
93&lt;guide&gt; 133&lt;guide link="relative_link_to_your_guide"&gt;
94&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;
95&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;
96 <i>Daniel Robbins</i>&lt;/mail&gt; 136 &lt;mail link="<i>drobbins@gentoo.org</i>"&gt;<i>Daniel Robbins</i>&lt;/mail&gt;
97&lt;/author&gt; 137&lt;/author&gt;
98&lt;author title="<i>Editor</i>"&gt;&lt;mail link="<i>thomasfl@gentoo.org</i>"&gt; 138&lt;author title="<i>Editor</i>"&gt;
99 <i>Thomas Flavel</i>&lt;/mail&gt; 139 &lt;mail link="<i>thomasfl@gentoo.org</i>"&gt;<i>Thomas Flavel</i>&lt;/mail&gt;
100&lt;/author&gt; 140&lt;/author&gt;
101 141
142&lt;abstract&gt;
102&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
103our new lightweight Gentoo guide XML syntax. This syntax is the official 144our new lightweight Gentoo GuideXML syntax. This syntax is the official
104format for Gentoo Linux web documentation, and this document itself was created 145format for Gentoo Linux web documentation, and this document itself was created
105using guide XML.</i> &lt;/abstract&gt; 146using GuideXML.</i>
147&lt;/abstract&gt;
148
149&lt;license/&gt;
106 150
107&lt;version&gt;<i>1.0</i>&lt;/version&gt; 151&lt;version&gt;<i>1.0</i>&lt;/version&gt;
108&lt;date&gt;<i>29 Mar 2001</i>&lt;/date&gt; 152&lt;date&gt;<i>29 Mar 2001</i>&lt;/date&gt;
109</pre> 153</pre>
110 154
155<p>
111<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
112document. 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
113guide 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.
114Next, 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
115guide document. </p> 160guide document.
161</p>
116 162
163<p>
117<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
118about 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
119allows 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
120relationship to the document (author, co-author, editor, etc.). In this 167relationship to the document (author, co-author, editor, etc.). In this
121particular example, the authors' names are enclosed in another tag -- a 168particular 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 169<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 170person. 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. 171more than one <c>&lt;author&gt;</c> element is required per guide document.
125</p> 172</p>
126 173
174<p>
127<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
128<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
129current 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)
130respectively. 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
131a 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>
132tags, these tags shouldn't appear anywhere else except immediately inside the 180tags, these tags shouldn't appear anywhere else except immediately inside the
133<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
134required) that these tags appear before the content of the document. </p> 182required) that these tags appear before the content of the document.
183</p>
184
185<p>
186Finally we have the <c>&lt;license/&gt;</c> tag, used to publish the
187document under the <uri link="http://creativecommons.org/licenses/by-sa/1.0/">Creative
188Commons - Attribution / Share Alike</uri> license as required by the <uri
189link="/doc/en/doc-policy.xml">Documentation Policy</uri>.
190</p>
135 191
136</body> 192</body>
137</section> 193</section>
138 194
139<section> 195<section>
140<title>Chapters and sections</title> 196<title>Chapters and sections</title>
141<body> 197<body>
198
199<p>
142<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
143the structural elements of the document. Guide documents are divided into 201the structural elements of the document. Guide documents are divided into
144chapters, and each chapter can hold one or more sections. Every chapter 202chapters, and each chapter can hold one or more sections. Every chapter
145and 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,
146consisting 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
147excerpt</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
150 208
151<pre> 209<pre>
152&lt;chapter&gt; 210&lt;chapter&gt;
153&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;
154&lt;section&gt; 212&lt;section&gt;
155 &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;
156 &lt;body&gt; 214&lt;body&gt;
215
216&lt;p&gt;
157 &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
158 &lt;/body&gt; 220&lt;/body&gt;
159&lt;/section&gt; 221&lt;/section&gt;
160&lt;/chapter&gt; 222&lt;/chapter&gt;
161</pre> 223</pre>
162 224
225<p>
163<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>
164element 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
165adding 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
166<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
167<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>
168is 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
169content 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
170inside a <c>&lt;body&gt;</c> element in a bit. </p> 233inside a <c>&lt;body&gt;</c> element in a bit.
234</p>
171 235
236<note>
172<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>
173<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
174multiple <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>
175element can only contain one <c>&lt;body&gt;</c> element. </note> 240element can only contain one <c>&lt;body&gt;</c> element.
241</note>
176 242
177</body> 243</body>
178</section> 244</section>
179 245
180<section> 246<section>
181<title>An example &lt;body&gt;</title> 247<title>An example &lt;body&gt;</title>
182<body> 248<body>
249
183<p> 250<p>
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: 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:
185</p> 252</p>
253
186<pre> 254<pre>
187&lt;p&gt; 255&lt;p&gt;
188This 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.
189&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.
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. 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.
197Make HTML/XML easier to read by using selective emphasis: 265Make HTML/XML easier to read by using selective emphasis:
198&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;
199 267
200&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;
201&lt;/pre&gt; 269&lt;/pre&gt;
202&lt;note&gt;This is a note.&lt;/note&gt; 270
203&lt;warn&gt;This is a warning.&lt;/warn&gt; 271&lt;note&gt;
204&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;
205</pre> 282</pre>
283
284<p>
206<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>
207 287
208<p> 288<p>
209This is a paragraph. <path>/etc/passwd</path> is a file. 289This is a paragraph. <path>/etc/passwd</path> is a file.
210<uri>http://www.gentoo.org</uri> is my favorite website. 290<uri>http://www.gentoo.org</uri> is my favorite website.
211Type <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.
218Make HTML/XML easier to read by using selective emphasis: 298Make HTML/XML easier to read by using selective emphasis:
219&lt;foo&gt;<i>bar</i>&lt;/foo&gt; 299&lt;foo&gt;<i>bar</i>&lt;/foo&gt;
220 300
221<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>
222</pre> 302</pre>
223<note>This is a note.</note> 303
224<warn>This is a warning.</warn> 304<note>
225<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
226</body> 316</body>
227</section> 317</section>
228 318
229<section> 319<section>
230<title>The &lt;body&gt; tags</title> 320<title>The &lt;body&gt; tags</title>
231<body> 321<body>
232 322
323<p>
233<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
234need 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
235block), <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
236<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.
237Besides 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),
238these are the only tags that should appear immediately inside a 329these 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 330<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 331stacked -- 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 332<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> 333preserves its whitespace exactly, making it well-suited for code excerpts.
334You can also name the <c>&lt;pre&gt;</c> tag:
335</p>
336
337<pre caption = "Named &lt;pre&gt;">
338&lt;pre caption = "Output of uptime"&gt;
339# &lt;i&gt;uptime&lt;/i&gt;
34016:50:47 up 164 days, 2:06, 5 users, load average: 0.23, 0.20, 0.25
341&lt;/pre&gt;
342</pre>
243 343
244</body> 344</body>
245</section> 345</section>
246<section> 346<section>
247<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>
248<body> 348<body>
249 349
350<p>
250<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
251be 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
252<c>&lt;pre&gt;</c>. </p> 353<c>&lt;pre&gt;</c>.
354</p>
253 355
356<p>
254<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
255<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
256This 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
257standard paragraph type. </p> 360font to offset it from the standard paragraph type.
361</p>
258 362
363<p>
259<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
260input</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
261that 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
262the 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>
263element 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
264not 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
265quickly identify commands that they need to type in. Also, because 370quickly 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 371<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 372necessary 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 373refer 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> 374the use of unnecessary double-quotes makes a document more readable -- and
375adorable!
376</p>
270 377
378<p>
271<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:
272I <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
273offset 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
274prose more <e>punch</e>!</p> 382prose more <e>punch</e>!
383</p>
275 384
276</body> 385</body>
277</section> 386</section>
278 387
279<section> 388<section>
280<title>&lt;mail&gt; and &lt;uri&gt;</title> 389<title>&lt;mail&gt; and &lt;uri&gt;</title>
281<body> 390<body>
282 391
392<p>
283<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
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> 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>
285 397
398<p>
286<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
287Internet. 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
288actual URI displayed in the body text, such as this link to 401actual URI displayed in the body text, such as this link to
289<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
290<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
291when 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
292link="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
293link, 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>.
294</p> 408</p>
295 409
296</body> 410</body>
297</section> 411</section>
298 412
299<section> 413<section>
300<title>Figures</title> 414<title>Figures</title>
301 415
302<body> 416<body>
303 417
418<p>
304<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
305link="mygfx.png" short="my picture" caption="my favorite picture of all 420link="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, 421time"/&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 422the <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 423the 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 424:) We also support the standard HTML-style &lt;img src="foo.gif"/&gt; tag
310for adding images without captions, borders, etc.</p> 425for adding images without captions, borders, etc.
426</p>
311 427
312</body> 428</body>
313</section> 429</section>
314<section> 430<section>
315<title>Tables and lists</title> 431<title>Tables and lists</title>
316<body> 432<body>
317 433
434<p>
318<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
319a 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>
320tag. 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
321HTML &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
322header, 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
323block. 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>
324there'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
325first 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
326be 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.
327</p> 444</p>
328 445
446<p>
329<p> To create ordered or unordered lists, simply use the HTML-style 447To create ordered or unordered lists, simply use the HTML-style
330<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
331should 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>,
332<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>
333 452
334</body> 453</body>
335</section> 454</section>
336 455
337<section> 456<section>
338<title>Intra-document references</title> 457<title>Intra-document references</title>
339<body> 458<body>
340 459
460<p>
341<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
342hyperlinks. 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
343One</uri> by typing <c>&lt;uri link="#doc_chap1"&gt;Chapter 463One</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 464One&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 465Chapter 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 466Chapter 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>, 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
348type <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
349adding other auto-link abilities (such as table support) soon.</p> 470adding other auto-link abilities (such as table support) soon.
471</p>
350 472
351</body> 473</body>
352</section> 474</section>
353</chapter> 475</chapter>
476
354<chapter> 477<chapter>
355<title>Resources</title> 478<title>Resources</title>
356<section> 479<section>
357 <title>Start writing</title> 480<title>Start writing</title>
358 <body> 481<body>
482
483<p>
359 <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
360 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
361 syntax. Hopefully, this will allow developers who aren't unusually "doc-savvy" 486syntax. 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 487to start writing quality Gentoo Linux documentation. If you'd like to help (or
363 post a message to <mail link="gentoo-dev@gentoo.org">the gentoo-dev mailing list</mail> 488have any questions about guide), please post a message to the <mail
364 stating what you'd like to tackle. 489link="gentoo-doc@gentoo.org">gentoo-doc mailing list</mail> stating what you'd
365 Have fun!</p> 490like to tackle. Have fun!
491</p>
492
366 </body> 493</body>
367</section> 494</section>
368</chapter> 495</chapter>
369</guide> 496</guide>
370 497

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

  ViewVC Help
Powered by ViewVC 1.1.20