/[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.22 Revision 1.23
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.22 2003/11/15 00:32:59 neysx Exp $ --> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.23 2003/11/17 17:05:58 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 17
18<license/> 18<license/>
19<abstract> 19<abstract>
20This guide shows you how to compose web documentation using the new lightweight 20This guide shows you how to compose web documentation using the new lightweight
21Gentoo GuideXML syntax. This syntax is the official format for Gentoo Linux 21Gentoo GuideXML syntax. This syntax is the official format for Gentoo Linux
22documentation, and this document itself was created using GuideXML. This guide 22documentation, and this document itself was created using GuideXML. This guide
23assumes a basic working knowledge of XML and HTML. 23assumes a basic working knowledge of XML and HTML.
24</abstract> 24</abstract>
25 25
26<version>2.4</version> 26<version>2.5</version>
27<date>November 5, 2003</date> 27<date>November 17, 2003</date>
28 28
29<chapter> 29<chapter>
30<title>Guide basics</title> 30<title>Guide basics</title>
31<section> 31<section>
32<title>Guide XML design goals</title> 32<title>Guide XML design goals</title>
33<body> 33<body>
34 34
35<p> 35<p>
36The guide XML syntax is lightweight yet expressive, so that it is easy to 36The guide XML syntax is lightweight yet expressive, so that it is easy to
37learn yet also provides all the features we need for the creation of web 37learn yet also provides all the features we need for the creation of web
38documentation. The number of tags is kept to a minimum -- just those we need. 38documentation. The number of tags is kept to a minimum -- just those we need.
39This makes it easy to transform guide into other formats, such as DocBook 39This makes it easy to transform guide into other formats, such as DocBook
40XML/SGML or web-ready HTML. 40XML/SGML or web-ready HTML.
41</p> 41</p>
42 42
… …
398<title>Intra-document references</title> 398<title>Intra-document references</title>
399<body> 399<body>
400 400
401<p> 401<p>
402Guide makes it really easy to reference other parts of the document using 402Guide makes it really easy to reference other parts of the document using
403hyperlinks. You can create a link pointing to <uri link="#doc_chap1">Chapter 403hyperlinks. You can create a link pointing to <uri link="#doc_chap1">Chapter
404One</uri> by typing <c>&lt;uri link="#doc_chap1"&gt;Chapter 404One</uri> by typing <c>&lt;uri link="#doc_chap1"&gt;Chapter
405One&lt;/uri&gt;</c>. To point to <uri link="#doc_chap1_sect2">section two of 405One&lt;/uri&gt;</c>. To point to <uri link="#doc_chap1_sect2">section two of
406Chapter One</uri>, type <c>&lt;uri link="#doc_chap1_sect2"&gt;section two of 406Chapter One</uri>, type <c>&lt;uri link="#doc_chap1_sect2"&gt;section two of
407Chapter One&lt;/uri&gt;</c>. To refer to figure 3 in chapter 1, type <c>&lt;uri 407Chapter One&lt;/uri&gt;</c>. To refer to figure 3 in chapter 1, type <c>&lt;uri
408link="doc_chap1_fig3"&gt;figure 1.3&lt;/uri&gt;</c>. Or, to refer to <uri 408link="doc_chap1_fig3"&gt;figure 1.3&lt;/uri&gt;</c>. Or, to refer to <uri
409link="#doc_chap2_pre2">code listing 2 in chapter 2</uri>, type <c>&lt;uri 409link="#doc_chap2_pre2">code listing 2 in chapter 2</uri>, type <c>&lt;uri
410link="doc_chap2_pre2"&gt;code listing 2.2&lt;/uri&gt;</c>. We'll be 410link="doc_chap2_pre2"&gt;code listing 2.2&lt;/uri&gt;</c>. We'll be
411adding other auto-link abilities (such as table support) soon. 411adding other auto-link abilities (such as table support) soon.
412</p> 412</p>
413
414<p>
415However, some guides change often and using such "counting" can lead to broken
416links. In order to cope with this, you can define a name for a
417<c>&lt;chapter&gt;</c> or <c>&lt;section&gt;</c> by using the <c>id</c>
418attribute, and then point to that attribute, like this:
419</p>
420
421<pre caption="Using the id attribute">
422&lt;chapter id="foo"&gt;
423&lt;title&gt;This is foo!&lt;/title&gt;
424...
425&lt;p&gt;
426More information can be found in the &lt;uri link="#foo"&gt;foo chapter&lt;/uri&gt;
427&lt;/p&gt;
428</pre>
413 429
414</body> 430</body>
415</section> 431</section>
416</chapter> 432</chapter>
417 433
418<chapter> 434<chapter>
419<title>Coding Style</title> 435<title>Coding Style</title>
420<section> 436<section>
421<title>Introduction</title> 437<title>Introduction</title>
422<body> 438<body>
423 439
424<p> 440<p>
425Since all Gentoo Documentation is a joint effort and several people will 441Since all Gentoo Documentation is a joint effort and several people will
426most likely change existing documentation, a coding style is needed. 442most likely change existing documentation, a coding style is needed.
427A coding style contains two sections. The first one is regarding 443A coding style contains two sections. The first one is regarding
Legend:
Removed from v.1.22  
changed lines
  Added in v.1.23
  ViewVC Help
Powered by ViewVC 1.1.13