| 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.40 2005/05/09 14:08:35 swift Exp $ --> |
2 | <!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.41 2005/05/12 08:52:42 cam 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.17</version> |
35 | <version>2.18</version> |
| 36 | <date>2005-05-09</date> |
36 | <date>2005-05-12</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 | |
| … | |
… | |
| 71 | </section> |
71 | </section> |
| 72 | </chapter> |
72 | </chapter> |
| 73 | |
73 | |
| 74 | <chapter> |
74 | <chapter> |
| 75 | <title>Guide XML</title> |
75 | <title>Guide XML</title> |
| 76 | <section> |
76 | <section> |
| 77 | <title>Basic structure</title> |
77 | <title>Basic structure</title> |
| 78 | <body> |
78 | <body> |
| 79 | |
79 | |
| 80 | <p> |
80 | <p> |
| 81 | Let's start learning the GuideXML syntax. We'll start with the the initial |
81 | Let's start learning the GuideXML syntax. We'll start with the the initial |
| 82 | tags used in a GuideXML document: |
82 | tags used in a GuideXML document: |
| 83 | </p> |
83 | </p> |
| 84 | |
84 | |
| 85 | <pre caption="The initial part of a guide XML document"> |
85 | <pre caption="The initial part of a guide XML document"> |
| 86 | <?xml version='1.0' encoding="UTF-8"?> |
86 | <?xml version="1.0" encoding="UTF-8"?> |
| 87 | <!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
87 | <!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
| 88 | <guide link="<i>relative/link/to/your/guide.xml</i>" lang="<i>en</i>"> |
88 | <guide link="<i>relative/link/to/your/guide.xml</i>" lang="<i>en</i>"> |
| 89 | <title><i>Gentoo Linux Documentation Guide</i></title> |
89 | <title><i>Gentoo Linux Documentation Guide</i></title> |
| 90 | <author title="<i>Author</i>"> |
90 | <author title="<i>Author</i>"> |
| 91 | <mail link="<i>yourname@gentoo.org</i>"><i>Your Name</i></mail> |
91 | <mail link="<i>yourname@gentoo.org</i>"><i>Your Name</i></mail> |
| 92 | </author> |
92 | </author> |
| 93 | |
93 | |
| 94 | <abstract> |
94 | <abstract> |
| 95 | <i>This guide shows you how to compose web documentation using |
95 | <i>This guide shows you how to compose web documentation using |
| 96 | our new lightweight Gentoo GuideXML syntax. This syntax is the official |
96 | our new lightweight Gentoo GuideXML syntax. This syntax is the official |
| 97 | format for Gentoo Linux web documentation, and this document itself was created |
97 | format for Gentoo Linux web documentation, and this document itself was created |
| 98 | using GuideXML.</i> |
98 | using GuideXML.</i> |
| 99 | </abstract> |
99 | </abstract> |
| 100 | |
100 | |
| 101 | <!-- The content of this document is licensed under the CC-BY-SA license --> |
101 | <!-- The content of this document is licensed under the CC-BY-SA license --> |
Parent Directory
| 
Revision Log
| 
Patch