| 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> |
| 25 | This guide shows you how to compose web documentation using the new lightweight |
25 | This guide shows you how to compose web documentation using the new lightweight |
| 26 | Gentoo GuideXML syntax. This syntax is the official format for Gentoo Linux |
26 | Gentoo GuideXML syntax. This syntax is the official format for Gentoo Linux |
| 27 | documentation, and this document itself was created using GuideXML. This guide |
27 | documentation, and this document itself was created using GuideXML. This guide |
| 28 | assumes a basic working knowledge of XML and HTML. |
28 | assumes 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> |
| 45 | The guide XML syntax is lightweight yet expressive, so that it is easy to |
45 | The guide XML syntax is lightweight yet expressive, so that it is easy to |
| 46 | learn yet also provides all the features we need for the creation of web |
46 | learn yet also provides all the features we need for the creation of web |
| 47 | documentation. The number of tags is kept to a minimum -- just those we need. |
47 | documentation. The number of tags is kept to a minimum -- just those we need. |
| 48 | This makes it easy to transform guide into other formats, such as DocBook |
48 | This makes it easy to transform guide into other formats, such as DocBook |
| 49 | XML/SGML or web-ready HTML. |
49 | XML/SGML or web-ready HTML. |
| 50 | </p> |
50 | </p> |
| 51 | |
51 | |
| … | |
… | |
| 141 | <c><date></c> tags, used to specify a summary of the document, the |
141 | <c><date></c> tags, used to specify a summary of the document, the |
| 142 | current version number, and the current version date (in YYYY-MM-DD format) |
142 | current version number, and the current version date (in YYYY-MM-DD format) |
| 143 | respectively. Dates that are invalid or not in the YYYY-MM-DD format will |
143 | respectively. Dates that are invalid or not in the YYYY-MM-DD format will |
| 144 | appear verbatim in the rendered document. |
144 | appear verbatim in the rendered document. |
| 145 | </p> |
145 | </p> |
| 146 | |
146 | |
| 147 | <p> |
147 | <p> |
| 148 | This rounds out the tags that should appear at the beginning of a guide |
148 | This rounds out the tags that should appear at the beginning of a guide |
| 149 | document. Besides the <c><title></c> and <c><mail></c> tags, these |
149 | document. Besides the <c><title></c> and <c><mail></c> tags, these |
| 150 | tags shouldn't appear anywhere else except immediately inside the |
150 | tags shouldn't appear anywhere else except immediately inside the |
| 151 | <c><guide></c> tag, and for consistency it's recommended (but not |
151 | <c><guide></c> tag, and for consistency it's recommended (but not |
| 152 | required) that these tags appear before the content of the document. |
152 | required) that these tags appear before the content of the document. |
| 153 | </p> |
153 | </p> |
| 154 | |
154 | |
| 155 | <p> |
155 | <p> |
| 156 | Finally we have the <c><license/></c> tag, used to publish the |
156 | Finally we have the <c><license/></c> tag, used to publish the document |
| 157 | document under the <uri link="http://creativecommons.org/licenses/by-sa/2.0/">Creative |
157 | under the <uri link="http://creativecommons.org/licenses/by-sa/2.0/">Creative |
| 158 | Commons - Attribution / Share Alike</uri> license as required by the <uri |
158 | Commons - Attribution / Share Alike</uri> license as required by the <uri |
| 159 | link="/doc/en/doc-policy.xml">Documentation Policy</uri>. |
159 | link="/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> |
| 169 | Once the initial tags have been specified, you're ready to start adding the |
169 | Once the initial tags have been specified, you're ready to start adding the |
| 170 | structural elements of the document. Guide documents are divided into |
170 | structural elements of the document. Guide documents are divided into |
| 171 | chapters, and each chapter can hold one or more sections. Every chapter and |
171 | chapters, and each chapter can hold one or more sections. Every chapter and |
| 172 | section has a title. Here's an example chapter with a single section, |
172 | section has a title. Here's an example chapter with a single section, |
| 173 | consisting of a paragraph. If you append this XML to the XML in the <uri |
173 | consisting of a paragraph. If you append this XML to the XML in the <uri |
| 174 | link="#doc_chap2_pre1">previous excerpt</uri> and append a |
174 | link="#doc_chap2_pre1">previous excerpt</uri> and append a |
Parent Directory
| 
Revision Log
| 
Patch