/[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.68 Revision 1.71
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.68 2008/03/09 13:13:15 neysx Exp $ -->
3<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> 2<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
3<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.71 2011/11/29 19:02:45 swift Exp $ -->
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">
18 <mail link="peesh@gentoo.org">Jorge Paulo</mail> 18 <mail link="peesh@gentoo.org">Jorge Paulo</mail>
19</author> 19</author>
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<author title="Editor">
24 <mail link="nightmorph"/>
25</author>
23 26
24<abstract> 27<abstract>
25This guide shows you how to compose web documentation using the new lightweight 28This guide shows you how to compose web documentation using the new lightweight
26Gentoo GuideXML syntax. This syntax is the official format for Gentoo 29Gentoo GuideXML syntax. This syntax is the official format for Gentoo
27documentation, and this document itself was created using GuideXML. This guide 30documentation, and this document itself was created using GuideXML. This guide
30 33
31<!-- The content of this document is licensed under the CC-BY-SA license --> 34<!-- The content of this document is licensed under the CC-BY-SA license -->
32<!-- See http://creativecommons.org/licenses/by-sa/2.5 --> 35<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
33<license/> 36<license/>
34 37
35<version>9</version> 38<version>12</version>
36<date>2008-03-09</date> 39<date>2011-11-29</date>
37 40
38<chapter> 41<chapter>
39<title>GuideXML basics</title> 42<title>GuideXML basics</title>
40<section> 43<section>
41<title>GuideXML design goals</title> 44<title>GuideXML design goals</title>
105format for Gentoo web documentation, and this document itself was created 108format for Gentoo web documentation, and this document itself was created
106using GuideXML.</i> 109using GuideXML.</i>
107&lt;/abstract&gt; 110&lt;/abstract&gt;
108 111
109&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt; 112&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt;
110&lt;!-- See http://creativecommons.org/licenses/by-sa/2.5 --&gt; 113&lt;!-- See http://creativecommons.org/licenses/by-sa/3.0 --&gt;
111&lt;license/&gt; 114&lt;license version="3.0"/&gt;
112 115
113&lt;version&gt;<i>1.0</i>&lt;/version&gt; 116&lt;version&gt;<i>1</i>&lt;/version&gt;
114&lt;date&gt;<i>2004-12-25</i>&lt;/date&gt; 117&lt;date&gt;<i>2011-11-29</i>&lt;/date&gt;
115</pre> 118</pre>
116 119
117<p> 120<p>
118On the first lines, we see the requisite tag that identifies this as an XML 121On the first lines, we see the requisite tag that identifies this as an XML
119document and specifies its DTD. The <c>&lt;!-- &#36;Header&#36; --&gt;</c> line 122document and specifies its DTD. The <c>&lt;!-- &#36;Header&#36; --&gt;</c> line
165<c>&lt;guide&gt;</c> tag, and for consistency it's recommended (but not 168<c>&lt;guide&gt;</c> tag, and for consistency it's recommended (but not
166required) that these tags appear before the content of the document. 169required) that these tags appear before the content of the document.
167</p> 170</p>
168 171
169<p> 172<p>
170Finally we have the <c>&lt;license/&gt;</c> tag, used to publish the document 173Finally we have the <c>&lt;license version="3.0"/&gt;</c> tag, used to publish
171under the <uri link="http://creativecommons.org/licenses/by-sa/2.5/">Creative 174the document under the <uri link="http://creativecommons.org/licenses/by-sa/3.0/">Creative
172Commons - Attribution / Share Alike</uri> license as required by the <uri 175Commons - Attribution / Share Alike</uri> license as required by the <uri
173link="/proj/en/gdp/doc/doc-policy.xml">Documentation Policy</uri>. 176link="/proj/en/gdp/doc/doc-policy.xml">Documentation Policy</uri>. Historically,
177the tag <c>&lt;license /&gt;</c> was used, which denoted the 2.5 version of the
178license. This is still accepted/allowed.
174</p> 179</p>
175 180
176</body> 181</body>
177</section> 182</section>
178<section> 183<section>
445<p> 450<p>
446Sample colour-coded <c>&lt;pre&gt;</c> block: 451Sample colour-coded <c>&lt;pre&gt;</c> block:
447</p> 452</p>
448 453
449<pre caption="My first ebuild"> 454<pre caption="My first ebuild">
450<comment># Copyright 1999-2006 <b>Gentoo Foundation</b> 455<comment># Copyright 1999-2009 <b>Gentoo Foundation</b>
451# Distributed under the terms of the GNU General Public License v2 456# Distributed under the terms of the GNU General Public License v2
452# &#36;Header: $</comment> 457# &#36;Header: $</comment>
453 458
454<ident>DESCRIPTION</ident>=<const>"Exuberant ctags generates tags files for quick source navigation"</const> 459<ident>DESCRIPTION</ident>=<const>"Exuberant ctags generates tags files for quick source navigation"</const>
455<ident>HOMEPAGE</ident>=<const>"http://ctags.sourceforge.net"</const> 460<ident>HOMEPAGE</ident>=<const>"http://ctags.sourceforge.net"</const>
459<ident>SLOT</ident>=<const>"0"</const> 464<ident>SLOT</ident>=<const>"0"</const>
460<ident>KEYWORDS</ident>=<const>"~mips ~sparc ~x86"</const> 465<ident>KEYWORDS</ident>=<const>"~mips ~sparc ~x86"</const>
461<ident>IUSE</ident>=<const>""</const> 466<ident>IUSE</ident>=<const>""</const>
462 467
463<stmt>src_compile()</stmt> { 468<stmt>src_compile()</stmt> {
464 <keyword>econf</keyword> --with-posix-regex || <keyword>die</keyword> <const>"econf failed"</const> 469 <keyword>econf</keyword> --with-posix-regex
465 <keyword>emake</keyword> || <keyword>die</keyword> <const>"emake failed"</const> 470 <keyword>emake</keyword> || <keyword>die</keyword> <const>"emake failed"</const>
466} 471}
467 472
468<stmt>src_install()</stmt> { 473<stmt>src_install()</stmt> {
469 <keyword>make</keyword> <ident>DESTDIR</ident>="<var>${D}</var>" install || <keyword>die</keyword> <const>"install failed"</const> 474 <keyword>make</keyword> <ident>DESTDIR</ident>="<var>${D}</var>" install || <keyword>die</keyword> <const>"install failed"</const>
812&lt;abstract&gt; 817&lt;abstract&gt;
813 ... 818 ...
814&lt;/abstract&gt; 819&lt;/abstract&gt;
815 820
816&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt; 821&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt;
817&lt;!-- See http://creativecommons.org/licenses/by-sa/2.5 --&gt; 822&lt;!-- See http://creativecommons.org/licenses/by-sa/3.0 --&gt;
818&lt;license/&gt; 823&lt;license version="3.0"/&gt;
819 824
820&lt;version&gt;...&lt;/version&gt; 825&lt;version&gt;...&lt;/version&gt;
821&lt;date&gt;...&lt;/date&gt; 826&lt;date&gt;...&lt;/date&gt;
822</pre> 827</pre>
823 828
874&lt;?xml version='1.0' encoding='UTF-8'?&gt; 879&lt;?xml version='1.0' encoding='UTF-8'?&gt;
875&lt;!DOCTYPE sections SYSTEM "/dtd/book.dtd"&gt; 880&lt;!DOCTYPE sections SYSTEM "/dtd/book.dtd"&gt;
876&lt;!-- &#36;Header&#36; --&gt; 881&lt;!-- &#36;Header&#36; --&gt;
877 882
878&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt; 883&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt;
879&lt;!-- See http://creativecommons.org/licenses/by-sa/2.5 --&gt; 884&lt;!-- See http://creativecommons.org/licenses/by-sa/3.0 --&gt;
880 885
881&lt;sections&gt; 886&lt;sections&gt;
882 887
883&lt;abstract&gt; 888&lt;abstract&gt;
884 This is a small explanation on chapter one. 889 This is a small explanation on chapter one.

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

  ViewVC Help
Powered by ViewVC 1.1.20