/[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.53 Revision 1.54
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.53 2005/10/13 20:33:40 neysx Exp $ --> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.54 2005/10/13 20:47:14 alin 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 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">
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 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.28</version> 35<version>2.29</version>
36<date>2005-10-13</date> 36<date>2005-10-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>
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>
587&lt;chapter id="foo"&gt; 587&lt;chapter id="foo"&gt;
588&lt;title&gt;This is foo!&lt;/title&gt; 588&lt;title&gt;This is foo!&lt;/title&gt;
589... 589...
590&lt;p&gt; 590&lt;p&gt;
591More information can be found in the &lt;uri link="#foo"&gt;foo chapter&lt;/uri&gt; 591More information can be found in the &lt;uri link="#foo"&gt;foo chapter&lt;/uri&gt;
592&lt;/p&gt; 592&lt;/p&gt;
593</pre> 593</pre>
594 594
595</body> 595</body>
596</section> 596</section>
597<section> 597<section>
598<title>Disclaimers and obsolete documents</title> 598<title>Disclaimers and obsolete documents</title>
599<body> 599<body>
600 600
601<p> 601<p>
602A disclaimer attribute can be applied to guides and handbooks to display a predefined disclaimer at the top of the document. The available disclaimers are: 602A <c>disclaimer</c> attribute can be applied to guides and handbooks to display
603a predefined disclaimer at the top of the document. The available disclaimers
604are:
603</p> 605</p>
604 606
605<ul> 607<ul>
606 <li> 608 <li>
607 <b>articles</b> is used for <uri link="/doc/en/articles/">republished 609 <b>articles</b> is used for <uri link="/doc/en/articles/">republished
608 articles</uri> 610 articles</uri>
609 </li> 611 </li>
610 <li> 612 <li>
611 <b>draft</b> is used to indicate a document is still being worked on and 613 <b>draft</b> is used to indicate a document is still being worked on and
612 should not be considered official 614 should not be considered official
613 </li> 615 </li>
614 <li> 616 <li>
615 <b>oldbook</b> is used on old handbooks to indicate they are not maintained 617 <b>oldbook</b> is used on old handbooks to indicate they are not maintained
616 anymore 618 anymore
617 </li> 619 </li>

Legend:
Removed from v.1.53  
changed lines
  Added in v.1.54

  ViewVC Help
Powered by ViewVC 1.1.20