/[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.47 Revision 1.48
1<?xml version="1.0" encoding="UTF-8"?> 1<?xml version="1.0" encoding="UTF-8"?>
2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.47 2005/07/26 11:51:06 neysx Exp $ --> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.48 2005/08/11 11:01:06 swift Exp $ -->
3<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> 3<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
4 4
5<guide link="/doc/en/xml-guide.xml"> 5<guide link="/doc/en/xml-guide.xml">
6<title>Gentoo Linux XML Guide</title> 6<title>Gentoo Linux XML Guide</title>
7 7
8<author title="Author"> 8<author title="Author">
9 <mail link="drobbins@gentoo.org">Daniel Robbins</mail> 9 <mail link="drobbins@gentoo.org">Daniel Robbins</mail>
10</author> 10</author>
11<author title="Author"><!-- zhen@gentoo.org --> 11<author title="Author"><!-- zhen@gentoo.org -->
12 John P. Davis 12 John P. Davis
13</author> 13</author>
14<author title="Editor"> 14<author title="Editor">
15 <mail link="peesh@gentoo.org">Jorge Paulo</mail> 15 <mail link="peesh@gentoo.org">Jorge Paulo</mail>
16</author> 16</author>
17<author title="Editor"> 17<author title="Editor">
20<author title="Editor"> 20<author title="Editor">
21 <mail link="neysx@gentoo.org">Xavier Neys</mail> 21 <mail link="neysx@gentoo.org">Xavier Neys</mail>
22</author> 22</author>
23 23
24<abstract> 24<abstract>
25This guide shows you how to compose web documentation using the new lightweight 25This guide shows you how to compose web documentation using the new lightweight
26Gentoo GuideXML syntax. This syntax is the official format for Gentoo Linux 26Gentoo GuideXML syntax. This syntax is the official format for Gentoo Linux
27documentation, and this document itself was created using GuideXML. This guide 27documentation, and this document itself was created using GuideXML. This guide
28assumes a basic working knowledge of XML and HTML. 28assumes a basic working knowledge of XML and HTML.
29</abstract> 29</abstract>
30 30
31<!-- The content of this document is licensed under the CC-BY-SA license --> 31<!-- The content of this document is licensed under the CC-BY-SA license -->
32<!-- See http://creativecommons.org/licenses/by-sa/2.5 --> 32<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
33<license/> 33<license/>
34 34
35<version>2.23</version> 35<version>2.24</version>
36<date>2005-07-26</date> 36<date>2005-08-11</date>
37 37
38<chapter> 38<chapter>
39<title>Guide basics</title> 39<title>Guide basics</title>
40<section> 40<section>
41<title>Guide XML design goals</title> 41<title>Guide XML design goals</title>
42<body> 42<body>
43 43
44<p> 44<p>
45The guide XML syntax is lightweight yet expressive, so that it is easy to 45The guide XML syntax is lightweight yet expressive, so that it is easy to
46learn yet also provides all the features we need for the creation of web 46learn yet also provides all the features we need for the creation of web
47documentation. The number of tags is kept to a minimum -- just those we need. 47documentation. The number of tags is kept to a minimum -- just those we need.
48This makes it easy to transform guide into other formats, such as DocBook 48This makes it easy to transform guide into other formats, such as DocBook
49XML/SGML or web-ready HTML. 49XML/SGML or web-ready HTML.
50</p> 50</p>
51 51
533In case word-wrapping happens in <c>&lt;ti&gt;</c>, <c>&lt;th&gt;</c> or 533In case word-wrapping happens in <c>&lt;ti&gt;</c>, <c>&lt;th&gt;</c> or
534<c>&lt;li&gt;</c> constructs, indentation must be used for the content. 534<c>&lt;li&gt;</c> constructs, indentation must be used for the content.
535</p> 535</p>
536 536
537<p> 537<p>
538An example for indentation is: 538An example for indentation is:
539</p> 539</p>
540 540
541<pre caption="Indentation Example"> 541<pre caption="Indentation Example">
542&lt;table&gt; 542&lt;table&gt;
543&lt;tr&gt; 543&lt;tr&gt;
544 &lt;th&gt;Foo&lt;/th&gt; 544 &lt;th&gt;Foo&lt;/th&gt;
545 &lt;th&gt;Bar&lt;/th&gt; 545 &lt;th&gt;Bar&lt;/th&gt;
546&lt;/tr&gt; 546&lt;/tr&gt;
547&lt;tr&gt; 547&lt;tr&gt;
548 &lt;ti&gt;This is an example for indentation.&lt;/ti&gt; 548 &lt;ti&gt;This is an example for indentation&lt;/ti&gt;
549 &lt;ti&gt; 549 &lt;ti&gt;
550 In case text cannot be shown within an 80-character wide line, you 550 In case text cannot be shown within an 80-character wide line, you
551 must use indentation if the parent tag allows it. 551 must use indentation if the parent tag allows it
552 &lt;/ti&gt; 552 &lt;/ti&gt;
553&lt;/tr&gt; 553&lt;/tr&gt;
554&lt;/table&gt; 554&lt;/table&gt;
555 555
556&lt;ul&gt; 556&lt;ul&gt;
557 &lt;li&gt;First option&lt;/li&gt; 557 &lt;li&gt;First option&lt;/li&gt;
558 &lt;li&gt;Second option&lt;/li&gt; 558 &lt;li&gt;Second option&lt;/li&gt;
559&lt;/ul&gt; 559&lt;/ul&gt;
560</pre> 560</pre>
561 561
562<p> 562<p>
563<b>Attributes</b> may not have spaces in between the attribute, the 563<b>Attributes</b> may not have spaces in between the attribute, the
564&quot;=&quot; mark, and the attribute value. As an example: 564&quot;=&quot; mark, and the attribute value. As an example:
565</p> 565</p>
566 566

Legend:
Removed from v.1.47  
changed lines
  Added in v.1.48

  ViewVC Help
Powered by ViewVC 1.1.20