/[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.11 Revision 1.12
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<author title="Author"><mail link="drobbins@gentoo.org">Daniel Robbins</mail></author> 6<author title="Author"><mail link="drobbins@gentoo.org">Daniel Robbins</mail></author>
7<author title="Author"><mail link="zhen@gentoo.org">John P. Davis</mail></author> 7<author title="Author"><mail link="zhen@gentoo.org">John P. Davis</mail></author>
8<author title="Editor"><mail link="peesh@gentoo.org">Jorge Paulo</mail></author> 8<author title="Editor"><mail link="peesh@gentoo.org">Jorge Paulo</mail></author>
9 9
10<abstract>This guide shows you how to compose web documentation using the new lightweight Gentoo guide 10<abstract>This guide shows you how to compose web documentation using the new lightweight Gentoo guide
11XML syntax. This syntax is the official format for Gentoo Linux documentation, and this document 11XML syntax. This syntax is the official format for Gentoo Linux documentation, and this document
12itself was created using guide XML. This guide assumes a basic working knowledge of XML and HTML. 12itself was created using guide XML. This guide assumes a basic working knowledge of XML and HTML.
13</abstract> 13</abstract>
14 14
15<version>2.0</version> 15<version>2.0</version>
16<date>15 April 2003</date> 16<date>12 May 2003</date>
17 17
18<chapter> 18<chapter>
19<title>Guide basics</title> 19<title>Guide basics</title>
20 20
21<section> 21<section>
22<title>Guide XML design goals</title> 22<title>Guide XML design goals</title>
23<body> 23<body>
24 24
25<p> The guide XML syntax is lightweight yet expressive, so that it is easy to 25<p> The 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 26learn 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. 27documentation. 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 28This makes it easy to transform guide into other formats, such as DocBook
29XML/SGML or web-ready HTML. </p> 29XML/SGML or web-ready HTML. </p>
30 30
31<p>The goal is to make it easy to <e>create</e> and <e>transform</e> guide XML 31<p>The goal is to make it easy to <e>create</e> and <e>transform</e> guide XML
242</section> 242</section>
243 243
244<section> 244<section>
245<title>The &lt;body&gt; tags</title> 245<title>The &lt;body&gt; tags</title>
246<body> 246<body>
247 247
248<p> We introduced a lot of new tags in the previous section -- here's what you 248<p> We introduced a lot of new tags in the previous section -- here's what you
249need to know. The <c>&lt;p&gt;</c> (paragraph), <c>&lt;pre&gt;</c> (code 249need to know. The <c>&lt;p&gt;</c> (paragraph), <c>&lt;pre&gt;</c> (code
250block), <c>&lt;note&gt;</c>, <c>&lt;warn&gt;</c> (warning) and 250block), <c>&lt;note&gt;</c>, <c>&lt;warn&gt;</c> (warning) and
251<c>&lt;impo&gt;</c> (important) tags all can contain one or more lines of text. 251<c>&lt;impo&gt;</c> (important) tags all can contain one or more lines of text.
252Besides the <c>&lt;table&gt;</c> element (which we'll cover in just a bit), 252Besides the <c>&lt;table&gt;</c> element (which we'll cover in just a bit),
253these are the only tags that should appear immediately inside a 253these are the only tags that should appear immediately inside a
254<c>&lt;body&gt;</c> element. Another thing -- these tags <e>should not</e> be 254<c>&lt;body&gt;</c> element. Another thing -- these tags <e>should not</e> be
255stacked -- in other words, don't put a <c>&lt;note&gt;</c> element inside a 255stacked -- in other words, don't put a <c>&lt;note&gt;</c> element inside a
256<c>&lt;p&gt;</c> element. As you might guess, the <c>&lt;pre&gt;</c> element 256<c>&lt;p&gt;</c> element. As you might guess, the <c>&lt;pre&gt;</c> element
257preserves its whitespace exactly, making it well-suited for code excerpts.</p> 257preserves its whitespace exactly, making it well-suited for code excerpts.
258You can also name the <c>&lt;pre&gt;</c> tag:</p>
259
260<pre caption = "Named &lt;pre&gt;">
261&lt;pre caption = "Output of uptime"&gt;
262# &lt;i&gt;uptime&lt;/i&gt;
26316:50:47 up 164 days, 2:06, 5 users, load average: 0.23, 0.20, 0.25
264&lt;/pre&gt;
265</pre>
258 266
259</body> 267</body>
260</section> 268</section>
261<section> 269<section>
262<title>&lt;path&gt;, &lt;c&gt; and &lt;e&gt;</title> 270<title>&lt;path&gt;, &lt;c&gt; and &lt;e&gt;</title>
263<body> 271<body>
264 272
265<p>The <c>&lt;path&gt;</c>, <c>&lt;c&gt;</c> and <c>&lt;e&gt;</c> elements can 273<p>The <c>&lt;path&gt;</c>, <c>&lt;c&gt;</c> and <c>&lt;e&gt;</c> elements can
266be used inside any child <c>&lt;body&gt;</c> tag, except for 274be used inside any child <c>&lt;body&gt;</c> tag, except for
267<c>&lt;pre&gt;</c>. </p> 275<c>&lt;pre&gt;</c>. </p>
268 276
269<p>The <c>&lt;path&gt;</c> element is used to mark text that refers to an 277<p>The <c>&lt;path&gt;</c> element is used to mark text that refers to an
270<e>on-disk file</e> -- either an <e>absolute or relative path</e>, or a <e>simple filename</e>. 278<e>on-disk file</e> -- either an <e>absolute or relative path</e>, or a <e>simple filename</e>.
271This element is generally rendered with a monospaced font to offset it from the 279This element is generally rendered with a monospaced font to offset it from the
272standard paragraph type. </p> 280standard paragraph type. </p>

Legend:
Removed from v.1.11  
changed lines
  Added in v.1.12

  ViewVC Help
Powered by ViewVC 1.1.20