/[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.42 Revision 1.43
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.42 2005/05/12 16:48:46 neysx Exp $ --> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.43 2005/05/12 16:57:02 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.19</version> 35<version>2.20</version>
36<date>2005-05-12</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>
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>
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>
81Let's start learning the GuideXML syntax. We'll start with the the initial 81Let's start learning the GuideXML syntax. We'll start with the the initial
82tags used in a GuideXML document: 82tags 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&lt;?xml version="1.0" encoding="UTF-8"?&gt; 86&lt;?xml version="1.0" encoding="UTF-8"?&gt;
87&lt;!DOCTYPE guide SYSTEM "/dtd/guide.dtd"&gt; 87&lt;!DOCTYPE guide SYSTEM "/dtd/guide.dtd"&gt;
88&lt;!-- &#36;Header&#36; --&gt; 88&lt;!-- &#36;Header&#36; --&gt;
89 89
90&lt;guide link="<i>relative/link/to/your/guide.xml</i>" lang="<i>en</i>"&gt; 90&lt;guide link="<i>/doc/en/guide.xml</i>" lang="<i>en</i>"&gt;
91&lt;title&gt;<i>Gentoo Linux Documentation Guide</i>&lt;/title&gt; 91&lt;title&gt;<i>Gentoo Linux Documentation Guide</i>&lt;/title&gt;
92&lt;author title="<i>Author</i>"&gt; 92&lt;author title="<i>Author</i>"&gt;
93 &lt;mail link="<i>yourname@gentoo.org</i>"&gt;<i>Your Name</i>&lt;/mail&gt; 93 &lt;mail link="<i>yourname@gentoo.org</i>"&gt;<i>Your Name</i>&lt;/mail&gt;
94&lt;/author&gt; 94&lt;/author&gt;
95 95
96&lt;abstract&gt; 96&lt;abstract&gt;
97<i>This guide shows you how to compose web documentation using 97<i>This guide shows you how to compose web documentation using
98our new lightweight Gentoo GuideXML syntax. This syntax is the official 98our new lightweight Gentoo GuideXML syntax. This syntax is the official
99format for Gentoo Linux web documentation, and this document itself was created 99format for Gentoo Linux web documentation, and this document itself was created
100using GuideXML.</i> 100using GuideXML.</i>
101&lt;/abstract&gt; 101&lt;/abstract&gt;
102 102
103&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt; 103&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt;
104&lt;!-- See http://creativecommons.org/licenses/by-sa/2.0 --&gt; 104&lt;!-- See http://creativecommons.org/licenses/by-sa/2.0 --&gt;
105&lt;license/&gt; 105&lt;license/&gt;
106 106
107&lt;version&gt;<i>1.0</i>&lt;/version&gt; 107&lt;version&gt;<i>1.0</i>&lt;/version&gt;
108&lt;date&gt;<i>2004-12-25</i>&lt;/date&gt; 108&lt;date&gt;<i>2004-12-25</i>&lt;/date&gt;
109</pre> 109</pre>
110 110
111<p> 111<p>
112On the first lines, we see the requisite tag that identifies this as an XML 112On the first lines, we see the requisite tag that identifies this as an XML
113document and specifies its DTD. The <c>&lt;!-- &#36;Header&#36; --&gt;</c> line 113document and specifies its DTD. The <c>&lt;!-- &#36;Header&#36; --&gt;</c> line
114will be automatically modified by the CVS server and helps to track revisions. 114will be automatically modified by the CVS server and helps to track revisions.
115Next, there's a <c>&lt;guide&gt;</c> tag -- the entire guide document 115Next, there's a <c>&lt;guide&gt;</c> tag -- the entire guide document is
116is enclosed within a <c>&lt;guide&gt; &lt;/guide&gt;</c> pair. The <c>link</c> 116enclosed within a <c>&lt;guide&gt; &lt;/guide&gt;</c> pair. The <c>link</c>
117attribute is compulsory and should preferably contain the relative path to the 117attribute is compulsory and should preferably contain the absolute path to the
118document even though the file name alone will work. It is mainly used to 118document relatively to the document root even though the file name alone will
119generate a link to a printer-friendly version of your document. If you use a 119work. It is mainly used to generate a link to a printer-friendly version of
120wrong value, the link to the printable version will either not work or point to 120your document. If you use a wrong value, the link to the printable version
121a wrong document. The <c>lang</c> attribute can be used to specify the language 121will either not work or point to a wrong document. The <c>lang</c> attribute
122code of your document. It is used to format the date and insert strings like 122can be used to specify the language code of your document. It is used to format
123"<e>Note</e>", "<e>Content</e>", etc. in the specified language. The default 123the date and insert strings like "<e>Note</e>", "<e>Content</e>", etc. in the
124is English. 124specified language. The default is English.
125</p> 125</p>
126 126
127<p> 127<p>
128Next, there's a <c>&lt;title&gt;</c> tag, used to set the title for the entire 128Next, there's a <c>&lt;title&gt;</c> tag, used to set the title for the entire
129guide document. 129guide document.
130</p> 130</p>
131 131
132<p> 132<p>
133Then, we come to the <c>&lt;author&gt;</c> tags, which contain information 133Then, we come to the <c>&lt;author&gt;</c> tags, which contain information
134about the various authors of the document. Each <c>&lt;author&gt;</c> tag 134about the various authors of the document. Each <c>&lt;author&gt;</c> tag
135allows for an optional <c>title=</c> element, used to specify the author's 135allows for an optional <c>title=</c> element, used to specify the author's
136relationship to the document (author, co-author, editor, etc.). In this 136relationship to the document (author, co-author, editor, etc.). In this
137particular example, the authors' names are enclosed in another tag -- a 137particular example, the authors' names are enclosed in another tag -- a
138<c>&lt;mail&gt;</c> tag, used to specify an email address for this particular 138<c>&lt;mail&gt;</c> tag, used to specify an email address for this particular
139person. The <c>&lt;mail&gt;</c> tag is optional and can be omitted, and no 139person. The <c>&lt;mail&gt;</c> tag is optional and can be omitted, and no

Legend:
Removed from v.1.42  
changed lines
  Added in v.1.43

  ViewVC Help
Powered by ViewVC 1.1.20