/[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.17 Revision 1.18
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.1</version> 25<version>2.2</version>
26<date>October 14, 2003</date> 26<date>October 15, 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>
502 502
503<p> 503<p>
504<b>Blank lines</b> must be placed immediately after <e>every</e> 504<b>Blank lines</b> must be placed immediately after <e>every</e>
505<c>&lt;body&gt;</c> (opening tag only) and before <e>every</e> 505<c>&lt;body&gt;</c> (opening tag only) and before <e>every</e>
506<c>&lt;chapter&gt;</c>, <c>&lt;p&gt;</c>, <c>&lt;table&gt;</c>, 506<c>&lt;chapter&gt;</c>, <c>&lt;p&gt;</c>, <c>&lt;table&gt;</c>,
507<c>&lt;author&gt;</c>, <c>&lt;pre&gt;</c>, <c>&lt;ul&gt;</c>, <c>&lt;ol&gt;</c>, 507<c>&lt;author&gt;</c> (set), <c>&lt;pre&gt;</c>, <c>&lt;ul&gt;</c>,
508<c>&lt;warn&gt;</c>, <c>&lt;note&gt;</c> and <c>&lt;impo&gt;</c> (opening tags 508<c>&lt;ol&gt;</c>, <c>&lt;warn&gt;</c>, <c>&lt;note&gt;</c> and
509only). 509<c>&lt;impo&gt;</c> (opening tags only).
510</p> 510</p>
511 511
512<p> 512<p>
513<b>Word-wrapping</b> must be applied at 80 characters except inside 513<b>Word-wrapping</b> must be applied at 80 characters except inside
514<c>&lt;pre&gt;</c>. Only when there is no other choice can be deviated from 514<c>&lt;pre&gt;</c>. Only when there is no other choice can be deviated from
597Try to use <c>&lt;uri&gt;</c> with the <c>link</c> attribute as much as 597Try to use <c>&lt;uri&gt;</c> with the <c>link</c> attribute as much as
598possible. In other words, the <uri link="http://www.gentoo.org">Gentoo 598possible. In other words, the <uri link="http://www.gentoo.org">Gentoo
599Website</uri> is preferred over <uri>http://www.gentoo.org</uri>. 599Website</uri> is preferred over <uri>http://www.gentoo.org</uri>.
600</p> 600</p>
601 601
602<p>
603When you comment something inside a <c>&lt;pre&gt;</c> construct, only use
604<c>&lt;codenote&gt;</c> if the content is a C or C++ code snippet. Otherwise,
605use <c>&lt;comment&gt;</c> and parantheses. Also place the comment <e>before</e>
606the subject of the comment.
607</p>
608
609<pre caption="Comment example">
610<comment>(Substitute "john" with your user name)</comment>
611# <i>id john</i>
612</pre>
613
602</body> 614</body>
603</section> 615</section>
604</chapter> 616</chapter>
605 617
606<chapter> 618<chapter>

Legend:
Removed from v.1.17  
changed lines
  Added in v.1.18

  ViewVC Help
Powered by ViewVC 1.1.20