/[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.49 Revision 1.50
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.49 2005/08/23 09:18:12 neysx Exp $ --> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.50 2005/10/09 06:07:09 vapier 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 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">
18 <mail link="swift@gentoo.org">Sven Vermeulen</mail> 18 <mail link="swift@gentoo.org">Sven Vermeulen</mail>
19</author> 19</author>
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
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.5 --> 32<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
33<license/> 33<license/>
34 34
35<version>2.25</version> 35<version>2.26</version>
36<date>2005-08-23</date> 36<date>2005-10-09</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
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>/doc/en/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 Documentation Guide</i>&lt;/title&gt;
92 92
93&lt;author title="<i>Author</i>"&gt; 93&lt;author title="<i>Author</i>"&gt;
94 &lt;mail link="<i>yourname@gentoo.org</i>"&gt;<i>Your Name</i>&lt;/mail&gt; 94 &lt;mail link="<i>yourname@gentoo.org</i>"&gt;<i>Your Name</i>&lt;/mail&gt;
95&lt;/author&gt; 95&lt;/author&gt;
96 96
97&lt;abstract&gt; 97&lt;abstract&gt;
98<i>This guide shows you how to compose web documentation using 98<i>This guide shows you how to compose web documentation using
99our new lightweight Gentoo GuideXML syntax. This syntax is the official 99our new lightweight Gentoo GuideXML syntax. This syntax is the official
100format for Gentoo Linux web documentation, and this document itself was created 100format for Gentoo web documentation, and this document itself was created
101using GuideXML.</i> 101using GuideXML.</i>
102&lt;/abstract&gt; 102&lt;/abstract&gt;
103 103
104&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt; 104&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt;
105&lt;!-- See http://creativecommons.org/licenses/by-sa/2.5 --&gt; 105&lt;!-- See http://creativecommons.org/licenses/by-sa/2.5 --&gt;
106&lt;license/&gt; 106&lt;license/&gt;
107 107
108&lt;version&gt;<i>1.0</i>&lt;/version&gt; 108&lt;version&gt;<i>1.0</i>&lt;/version&gt;
109&lt;date&gt;<i>2004-12-25</i>&lt;/date&gt; 109&lt;date&gt;<i>2004-12-25</i>&lt;/date&gt;
110</pre> 110</pre>
111 111
112<p> 112<p>
113On the first lines, we see the requisite tag that identifies this as an XML 113On the first lines, we see the requisite tag that identifies this as an XML
114document and specifies its DTD. The <c>&lt;!-- &#36;Header&#36; --&gt;</c> line 114document and specifies its DTD. The <c>&lt;!-- &#36;Header&#36; --&gt;</c> line
115will be automatically modified by the CVS server and helps to track revisions. 115will be automatically modified by the CVS server and helps to track revisions.
755 755
756</body> 756</body>
757</section> 757</section>
758</chapter> 758</chapter>
759 759
760<chapter> 760<chapter>
761<title>Resources</title> 761<title>Resources</title>
762<section> 762<section>
763<title>Start writing</title> 763<title>Start writing</title>
764<body> 764<body>
765 765
766<p> 766<p>
767Guide has been specially designed to be "lean and mean" so that developers can 767Guide has been specially designed to be "lean and mean" so that developers can
768spend more time writing documentation and less time learning the actual XML 768spend more time writing documentation and less time learning the actual XML
769syntax. Hopefully, this will allow developers who aren't unusually "doc-savvy" 769syntax. Hopefully, this will allow developers who aren't unusually "doc-savvy"
770to start writing quality Gentoo Linux documentation. You might be interested 770to start writing quality Gentoo documentation. You might be interested
771in our <uri link="/proj/en/gdp/doc/doc-tipsntricks.xml">Documentation 771in our <uri link="/proj/en/gdp/doc/doc-tipsntricks.xml">Documentation
772Development Tips &amp; Tricks</uri>. If you'd like to help (or have any 772Development Tips &amp; Tricks</uri>. If you'd like to help (or have any
773questions about guide), please post a message to the <mail 773questions about guide), please post a message to the <mail
774link="gentoo-doc@gentoo.org">gentoo-doc mailing list</mail> stating what you'd 774link="gentoo-doc@gentoo.org">gentoo-doc mailing list</mail> stating what you'd
775like to tackle. Have fun! 775like to tackle. Have fun!
776</p> 776</p>
777 777
778</body> 778</body>
779</section> 779</section>
780</chapter> 780</chapter>
781</guide> 781</guide>

Legend:
Removed from v.1.49  
changed lines
  Added in v.1.50

  ViewVC Help
Powered by ViewVC 1.1.20