/[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.20 Revision 1.21
10<author title="Author"><!-- zhen@gentoo.org --> 10<author title="Author"><!-- zhen@gentoo.org -->
11 John P. Davis 11 John P. Davis
12</author> 12</author>
13<author title="Editor"> 13<author title="Editor">
14 <mail link="peesh@gentoo.org">Jorge Paulo</mail> 14 <mail link="peesh@gentoo.org">Jorge Paulo</mail>
15</author> 15</author>
16 16
17<license/> 17<license/>
18<abstract> 18<abstract>
19This guide shows you how to compose web documentation using the new lightweight 19This guide shows you how to compose web documentation using the new lightweight
20Gentoo GuideXML syntax. This syntax is the official format for Gentoo Linux 20Gentoo GuideXML syntax. This syntax is the official format for Gentoo Linux
21documentation, and this document itself was created using GuideXML. This guide 21documentation, and this document itself was created using GuideXML. This guide
22assumes a basic working knowledge of XML and HTML. 22assumes a basic working knowledge of XML and HTML.
23</abstract> 23</abstract>
24 24
25<version>2.3</version> 25<version>2.4</version>
26<date>October 31, 2003</date> 26<date>November 5, 2003</date>
27 27
28<chapter> 28<chapter>
29<title>Guide basics</title> 29<title>Guide basics</title>
30<section> 30<section>
31<title>Guide XML design goals</title> 31<title>Guide XML design goals</title>
32<body> 32<body>
33 33
34<p> 34<p>
35The guide XML syntax is lightweight yet expressive, so that it is easy to 35The guide XML syntax is lightweight yet expressive, so that it is easy to
36learn yet also provides all the features we need for the creation of web 36learn yet also provides all the features we need for the creation of web
37documentation. The number of tags is kept to a minimum -- just those we need. 37documentation. The number of tags is kept to a minimum -- just those we need.
38This makes it easy to transform guide into other formats, such as DocBook 38This makes it easy to transform guide into other formats, such as DocBook
39XML/SGML or web-ready HTML. 39XML/SGML or web-ready HTML.
40</p> 40</p>
41 41
455<c>&lt;author&gt;</c> (set), <c>&lt;pre&gt;</c>, <c>&lt;ul&gt;</c>, 455<c>&lt;author&gt;</c> (set), <c>&lt;pre&gt;</c>, <c>&lt;ul&gt;</c>,
456<c>&lt;ol&gt;</c>, <c>&lt;warn&gt;</c>, <c>&lt;note&gt;</c> and 456<c>&lt;ol&gt;</c>, <c>&lt;warn&gt;</c>, <c>&lt;note&gt;</c> and
457<c>&lt;impo&gt;</c> (opening tags only). 457<c>&lt;impo&gt;</c> (opening tags only).
458</p> 458</p>
459 459
460<p> 460<p>
461<b>Word-wrapping</b> must be applied at 80 characters except inside 461<b>Word-wrapping</b> must be applied at 80 characters except inside
462<c>&lt;pre&gt;</c>. Only when there is no other choice can be deviated from 462<c>&lt;pre&gt;</c>. Only when there is no other choice can be deviated from
463this rule (for instance when a URL exceeds the maximum amount of characters). 463this rule (for instance when a URL exceeds the maximum amount of characters).
464The editor must then wrap whenever the first whitespace occurs. 464The editor must then wrap whenever the first whitespace occurs.
465</p> 465</p>
466 466
467<p> 467<p>
468<b>Indentation</b> may not be used, except with the XML-constructs of which 468<b>Indentation</b> may not be used, except with the XML-constructs of which
469the parent XML-tags are <c>&lt;tr&gt;</c> (from <c>&lt;table&gt;</c>), 469the parent XML-tags are <c>&lt;tr&gt;</c> (from <c>&lt;table&gt;</c>),
470<c>&lt;ul&gt;</c> and <c>&lt;ol&gt;</c>. If indentation is used, it 470<c>&lt;ul&gt;</c>, <c>&lt;ol&gt;</c> and <c>&lt;author&gt;</c>. If indentation
471<e>must</e> be two spaces for each indentation. That means <e>no</e> tabs and 471is used, it <e>must</e> be two spaces for each indentation. That means <e>no</e>
472<e>not</e> more spaces. 472tabs and <e>not</e> more spaces.
473</p> 473</p>
474 474
475<p> 475<p>
476In case word-wrapping happens in <c>&lt;ti&gt;</c>, <c>&lt;th&gt;</c> or 476In case word-wrapping happens in <c>&lt;ti&gt;</c>, <c>&lt;th&gt;</c> or
477<c>&lt;li&gt;</c> constructs, indentation must be used for the content. 477<c>&lt;li&gt;</c> constructs, indentation must be used for the content.
478</p> 478</p>
479 479
480<p> 480<p>
481An example for indentation is: 481An example for indentation is:
482</p> 482</p>
483 483
484<pre caption = "Indentation Example"> 484<pre caption = "Indentation Example">
485&lt;table&gt; 485&lt;table&gt;
486&lt;tr&gt; 486&lt;tr&gt;
487 &lt;th&gt;Foo&lt;/th&gt; 487 &lt;th&gt;Foo&lt;/th&gt;

Legend:
Removed from v.1.20  
changed lines
  Added in v.1.21

  ViewVC Help
Powered by ViewVC 1.1.20