/[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.38 Revision 1.39
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.38 2005/04/13 14:12:19 neysx Exp $ --> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.39 2005/04/16 19:45:35 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.15</version> 35<version>2.16</version>
36<date>2005-04-13</date> 36<date>2005-04-16</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
403<body> 403<body>
404 404
405<p> 405<p>
406Guide supports a simplified table syntax similar to that of HTML. To start 406Guide supports a simplified table syntax similar to that of HTML. To start
407a table, use a <c>&lt;table&gt;</c> tag. Start a row with a <c>&lt;tr&gt;</c> 407a table, use a <c>&lt;table&gt;</c> tag. Start a row with a <c>&lt;tr&gt;</c>
408tag. However, for inserting actual table data, we <e>don't</e> support the 408tag. However, for inserting actual table data, we <e>don't</e> support the
409HTML &lt;td&gt; tag; instead, use the <c>&lt;th&gt;</c> if you are inserting a 409HTML &lt;td&gt; tag; instead, use the <c>&lt;th&gt;</c> if you are inserting a
410header, and <c>&lt;ti&gt;</c> if you are inserting a normal informational 410header, and <c>&lt;ti&gt;</c> if you are inserting a normal informational
411block. You can use a <c>&lt;th&gt;</c> anywhere you can use a <c>&lt;ti&gt;</c> 411block. You can use a <c>&lt;th&gt;</c> anywhere you can use a <c>&lt;ti&gt;</c>
412-- there's no requirement that <c>&lt;th&gt;</c> elements appear only in the 412-- there's no requirement that <c>&lt;th&gt;</c> elements appear only in the
413first row. Currently, these tags don't support any attributes, but some will 413first row. Currently, these tags don't support any attributes, but some will
414be added (such as a <c>caption=</c> attribute for <c>&lt;table&gt;</c>) soon. 414be added (such as a <c>caption=</c> attribute for <c>&lt;table&gt;</c>) soon.
415</p> 415</p>
416 416
417<p> 417<p>
418To create ordered or unordered lists, simply use the HTML-style 418To create ordered or unordered lists, simply use the XHTML-style
419<c>&lt;ol&gt;</c>, <c>&lt;ul&gt;</c> and <c>&lt;li&gt;</c> tags. List tags 419<c>&lt;ol&gt;</c>, <c>&lt;ul&gt;</c> and <c>&lt;li&gt;</c> tags. List tags
420should only appear inside a <c>&lt;body&gt;</c>, <c>&lt;ul&gt;</c> or 420should only appear inside a <c>&lt;body&gt;</c>, <c>&lt;ul&gt;</c> or
421<c>&lt;ol&gt;</c> tag. 421<c>&lt;ol&gt;</c> tag. You need to close the tags as well (which is a general
422XML requirement).
422</p> 423</p>
423 424
424</body> 425</body>
425</section> 426</section>
426<section> 427<section>
427<title>Intra-document references</title> 428<title>Intra-document references</title>
428<body> 429<body>
429 430
430<p> 431<p>
431Guide makes it really easy to reference other parts of the document using 432Guide makes it really easy to reference other parts of the document using
432hyperlinks. You can create a link pointing to <uri link="#doc_chap1">Chapter 433hyperlinks. You can create a link pointing to <uri link="#doc_chap1">Chapter
433One</uri> by typing <c>&lt;uri link="#doc_chap1"&gt;Chapter 434One</uri> by typing <c>&lt;uri link="#doc_chap1"&gt;Chapter
434One&lt;/uri&gt;</c>. To point to <uri link="#doc_chap1_sect2">section two of 435One&lt;/uri&gt;</c>. To point to <uri link="#doc_chap1_sect2">section two of
435Chapter One</uri>, type <c>&lt;uri link="#doc_chap1_sect2"&gt;section two of 436Chapter One</uri>, type <c>&lt;uri link="#doc_chap1_sect2"&gt;section two of
436Chapter One&lt;/uri&gt;</c>. To refer to figure 3 in chapter 1, type <c>&lt;uri 437Chapter One&lt;/uri&gt;</c>. To refer to figure 3 in chapter 1, type <c>&lt;uri

Legend:
Removed from v.1.38  
changed lines
  Added in v.1.39

  ViewVC Help
Powered by ViewVC 1.1.20