/[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.35 Revision 1.36
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.35 2004/12/24 11:52:37 neysx Exp $ --> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.36 2005/02/14 16:14:46 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.0 --> 32<!-- See http://creativecommons.org/licenses/by-sa/2.0 -->
33<license/> 33<license/>
34 34
35<version>2.12</version> 35<version>2.13</version>
36<date>2004-12-24</date> 36<date>2005-02-14</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
66link="/proj/en/gdp/doc/doc-tipsntricks.xml">Tips and Tricks</uri> which 66link="/proj/en/gdp/doc/doc-tipsntricks.xml">Tips and Tricks</uri> which
67contains tips and tricks for documentation development. 67contains tips and tricks for documentation development.
68</p> 68</p>
69 69
70</body> 70</body>
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>
81Now that you know how to transform guide XML, you're ready to start learning 81Let's start learning the GuideXML syntax. We'll start with the the initial
82the GuideXML syntax. We'll start with the the initial tags used in a guide 82tags used in a GuideXML document:
83XML document:
84</p> 83</p>
85 84
86<pre caption="The initial part of a guide XML document"> 85<pre caption="The initial part of a guide XML document">
87&lt;?xml version='1.0' encoding="UTF-8"?&gt; 86&lt;?xml version='1.0' encoding="UTF-8"?&gt;
88&lt;!DOCTYPE guide SYSTEM "/dtd/guide.dtd"&gt; 87&lt;!DOCTYPE guide SYSTEM "/dtd/guide.dtd"&gt;
89&lt;guide link="<i>relative/link/to/your/guide.xml</i>" lang="<i>en</i>"&gt; 88&lt;guide link="<i>relative/link/to/your/guide.xml</i>" lang="<i>en</i>"&gt;
90&lt;title&gt;<i>Gentoo Linux Documentation Guide</i>&lt;/title&gt; 89&lt;title&gt;<i>Gentoo Linux Documentation Guide</i>&lt;/title&gt;
91&lt;author title="<i>Author</i>"&gt; 90&lt;author title="<i>Author</i>"&gt;
92 &lt;mail link="<i>yourname@gentoo.org</i>"&gt;<i>Your Name</i>&lt;/mail&gt; 91 &lt;mail link="<i>yourname@gentoo.org</i>"&gt;<i>Your Name</i>&lt;/mail&gt;
93&lt;/author&gt; 92&lt;/author&gt;
94 93
95&lt;abstract&gt; 94&lt;abstract&gt;
96<i>This guide shows you how to compose web documentation using 95<i>This guide shows you how to compose web documentation using
97our new lightweight Gentoo GuideXML syntax. This syntax is the official 96our new lightweight Gentoo GuideXML syntax. This syntax is the official
98format for Gentoo Linux web documentation, and this document itself was created 97format for Gentoo Linux web documentation, and this document itself was created

Legend:
Removed from v.1.35  
changed lines
  Added in v.1.36

  ViewVC Help
Powered by ViewVC 1.1.20