/[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.37 Revision 1.38
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.37 2005/04/06 10:59:55 neysx Exp $ --> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.38 2005/04/13 14:12:19 neysx 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.0 --> 32<!-- See http://creativecommons.org/licenses/by-sa/2.0 -->
33<license/> 33<license/>
34 34
35<version>2.14</version> 35<version>2.15</version>
36<date>2005-04-06</date> 36<date>2005-04-13</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
141<c>&lt;date&gt;</c> tags, used to specify a summary of the document, the 141<c>&lt;date&gt;</c> tags, used to specify a summary of the document, the
142current version number, and the current version date (in YYYY-MM-DD format) 142current version number, and the current version date (in YYYY-MM-DD format)
143respectively. Dates that are invalid or not in the YYYY-MM-DD format will 143respectively. Dates that are invalid or not in the YYYY-MM-DD format will
144appear verbatim in the rendered document. 144appear verbatim in the rendered document.
145</p> 145</p>
146 146
147<p> 147<p>
148This rounds out the tags that should appear at the beginning of a guide 148This rounds out the tags that should appear at the beginning of a guide
149document. Besides the <c>&lt;title&gt;</c> and <c>&lt;mail&gt;</c> tags, these 149document. Besides the <c>&lt;title&gt;</c> and <c>&lt;mail&gt;</c> tags, these
150tags shouldn't appear anywhere else except immediately inside the 150tags shouldn't appear anywhere else except immediately inside the
151<c>&lt;guide&gt;</c> tag, and for consistency it's recommended (but not 151<c>&lt;guide&gt;</c> tag, and for consistency it's recommended (but not
152required) that these tags appear before the content of the document. 152required) that these tags appear before the content of the document.
153</p> 153</p>
154 154
155<p> 155<p>
156Finally we have the <c>&lt;license/&gt;</c> tag, used to publish the 156Finally we have the <c>&lt;license/&gt;</c> tag, used to publish the document
157document under the <uri link="http://creativecommons.org/licenses/by-sa/2.0/">Creative 157under the <uri link="http://creativecommons.org/licenses/by-sa/2.0/">Creative
158Commons - Attribution / Share Alike</uri> license as required by the <uri 158Commons - Attribution / Share Alike</uri> license as required by the <uri
159link="/doc/en/doc-policy.xml">Documentation Policy</uri>. 159link="/proj/en/gdp/doc/doc-policy.xml">Documentation Policy</uri>.
160</p> 160</p>
161 161
162</body> 162</body>
163</section> 163</section>
164<section> 164<section>
165<title>Chapters and sections</title> 165<title>Chapters and sections</title>
166<body> 166<body>
167 167
168<p> 168<p>
169Once the initial tags have been specified, you're ready to start adding the 169Once the initial tags have been specified, you're ready to start adding the
170structural elements of the document. Guide documents are divided into 170structural elements of the document. Guide documents are divided into
171chapters, and each chapter can hold one or more sections. Every chapter and 171chapters, and each chapter can hold one or more sections. Every chapter and
172section has a title. Here's an example chapter with a single section, 172section has a title. Here's an example chapter with a single section,
173consisting of a paragraph. If you append this XML to the XML in the <uri 173consisting of a paragraph. If you append this XML to the XML in the <uri
174link="#doc_chap2_pre1">previous excerpt</uri> and append a 174link="#doc_chap2_pre1">previous excerpt</uri> and append a

Legend:
Removed from v.1.37  
changed lines
  Added in v.1.38

  ViewVC Help
Powered by ViewVC 1.1.20