/[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.67 Revision 1.68
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.67 2007/10/04 19:37:23 neysx Exp $ --> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.68 2008/03/09 13:13:15 neysx Exp $ -->
3<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> 3<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
4 4
5<guide> 5<guide>
6<title>Gentoo GuideXML Guide</title> 6<title>Gentoo GuideXML Guide</title>
7 7
8<author title="Author"> 8<author title="Author">
9 <mail link="neysx"/> 9 <mail link="neysx"/>
10</author> 10</author>
11<author title="Author"> 11<author title="Author">
12 <mail link="drobbins@gentoo.org">Daniel Robbins</mail> 12 <mail link="drobbins@gentoo.org">Daniel Robbins</mail>
13</author> 13</author>
14<author title="Author"><!-- zhen@gentoo.org --> 14<author title="Author"><!-- zhen@gentoo.org -->
15 John P. Davis 15 John P. Davis
16</author> 16</author>
17<author title="Editor"> 17<author title="Editor">
20<author title="Editor"> 20<author title="Editor">
21 <mail link="swift@gentoo.org">Sven Vermeulen</mail> 21 <mail link="swift@gentoo.org">Sven Vermeulen</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>8</version> 35<version>9</version>
36<date>2007-10-04</date> 36<date>2008-03-09</date>
37 37
38<chapter> 38<chapter>
39<title>GuideXML basics</title> 39<title>GuideXML basics</title>
40<section> 40<section>
41<title>GuideXML design goals</title> 41<title>GuideXML design goals</title>
42<body> 42<body>
43 43
44<p> 44<p>
45The guideXML syntax is lightweight yet expressive, so that it is easy to 45The guideXML 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
557tag. However, for inserting actual table data, we <e>don't</e> support the HTML 557tag. However, for inserting actual table data, we <e>don't</e> support the HTML
558&lt;td&gt; tag; instead, use the <c>&lt;th&gt;</c> if you are inserting a 558&lt;td&gt; tag; instead, use the <c>&lt;th&gt;</c> if you are inserting a
559header, and <c>&lt;ti&gt;</c> if you are inserting a normal informational 559header, and <c>&lt;ti&gt;</c> if you are inserting a normal informational
560block. You can use a <c>&lt;th&gt;</c> anywhere you can use a <c>&lt;ti&gt;</c> 560block. You can use a <c>&lt;th&gt;</c> anywhere you can use a <c>&lt;ti&gt;</c>
561-- there's no requirement that <c>&lt;th&gt;</c> elements appear only in the 561-- there's no requirement that <c>&lt;th&gt;</c> elements appear only in the
562first row. 562first row.
563</p> 563</p>
564 564
565<p> 565<p>
566Besides, both table headers (<c>&lt;th&gt;</c>) and table items 566Besides, both table headers (<c>&lt;th&gt;</c>) and table items
567(<c>&lt;ti&gt;</c>) accept the <c>colspan</c> and <c>rowspan</c> attributes to 567(<c>&lt;ti&gt;</c>) accept the <c>colspan</c> and <c>rowspan</c> attributes to
568span their content across rows, columns or both. 568span their content across rows, columns or both.
569</p> 569</p>
570 570
571<p> 571<p>
572Furthermore, table items (<c>&lt;ti&gt;</c>) can be right-aligned or centered 572Furthermore, table cells (<c>&lt;ti&gt;</c> &amp; <c>&lt;th&gt;</c>) can be
573with the <c>align</c> attribute. Table headers (<c>&lt;th&gt;</c>) are 573right-aligned, left-aligned or centered with the <c>align</c> attribute.
574automatically centered.
575</p> 574</p>
576 575
577<table> 576<table>
578 <tr> 577 <tr>
579 <th colspan="4">This title spans 4 columns</th> 578 <th align="center" colspan="4">This title spans 4 columns</th>
580 </tr> 579 </tr>
581 <tr> 580 <tr>
582 <th rowspan="6">This title spans 6 rows</th> 581 <th rowspan="6">This title spans 6 rows</th>
583 <ti>Item A1</ti> 582 <ti>Item A1</ti>
584 <ti>Item A2</ti> 583 <ti>Item A2</ti>
585 <ti>Item A3</ti> 584 <ti>Item A3</ti>
586 </tr> 585 </tr>
587 <tr> 586 <tr>
588 <ti align="center">Item B1</ti> 587 <ti align="center">Item B1</ti>
589 <th colspan="2" rowspan="2">Blocky 2x2 title</th> 588 <th colspan="2" rowspan="2" align="right">Blocky 2x2 title</th>
590 </tr> 589 </tr>
591 <tr> 590 <tr>
592 <ti align="right">Item C1</ti> 591 <ti align="right">Item C1</ti>
593 </tr> 592 </tr>
594 <tr> 593 <tr>
595 <ti colspan="3" align="center">Item D1..D3</ti> 594 <ti colspan="3" align="center">Item D1..D3</ti>
596 </tr> 595 </tr>
597 <tr> 596 <tr>
598 <ti rowspan="2">Item E1..F1</ti> 597 <ti rowspan="2">Item E1..F1</ti>
599 <ti colspan="2" align="right">Item E2..E3</ti> 598 <ti colspan="2" align="right">Item E2..E3</ti>
600 </tr> 599 </tr>
601 <tr> 600 <tr>
602 <ti colspan="2" align="right">Item F2..F3</ti> 601 <ti colspan="2" align="right">Item F2..F3</ti>
603 </tr> 602 </tr>
604</table> 603</table>

Legend:
Removed from v.1.67  
changed lines
  Added in v.1.68

  ViewVC Help
Powered by ViewVC 1.1.20