/[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.69
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 $ --> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.69 2009/02/28 01:34:20 nightmorph 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">
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
28assumes a basic working knowledge of XML and HTML. 31assumes a basic working knowledge of XML and HTML.
29</abstract> 32</abstract>
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>10</version>
36<date>2008-03-09</date> 39<date>2009-02-27</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>
42<body> 45<body>
43 46
44<p> 47<p>
45The guideXML syntax is lightweight yet expressive, so that it is easy to 48The 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 49learn 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. 50documentation. 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 51This makes it easy to transform guide into other formats, such as DocBook
49XML/SGML or web-ready HTML. 52XML/SGML or web-ready HTML.
50</p> 53</p>
51 54
435 <dt><c>&lt;var&gt;</c></dt> 438 <dt><c>&lt;var&gt;</c></dt>
436 <dd>Used for a variable 439 <dd>Used for a variable
437 </dd> 440 </dd>
438</dl> 441</dl>
439 442
440<note> 443<note>
441Remember that all leading and trailing spaces, and line breaks in 444Remember that all leading and trailing spaces, and line breaks in
442<c>&lt;pre&gt;</c> blocks will appear in the displayed html page. 445<c>&lt;pre&gt;</c> blocks will appear in the displayed html page.
443</note> 446</note>
444 447
445<p> 448<p>
446Sample colour-coded <c>&lt;pre&gt;</c> block: 449Sample colour-coded <c>&lt;pre&gt;</c> block:
447</p> 450</p>
448 451
449<pre caption="My first ebuild"> 452<pre caption="My first ebuild">
450<comment># Copyright 1999-2006 <b>Gentoo Foundation</b> 453<comment># Copyright 1999-2009 <b>Gentoo Foundation</b>
451# Distributed under the terms of the GNU General Public License v2 454# Distributed under the terms of the GNU General Public License v2
452# &#36;Header: $</comment> 455# &#36;Header: $</comment>
453 456
454<ident>DESCRIPTION</ident>=<const>"Exuberant ctags generates tags files for quick source navigation"</const> 457<ident>DESCRIPTION</ident>=<const>"Exuberant ctags generates tags files for quick source navigation"</const>
455<ident>HOMEPAGE</ident>=<const>"http://ctags.sourceforge.net"</const> 458<ident>HOMEPAGE</ident>=<const>"http://ctags.sourceforge.net"</const>
456<ident>SRC_URI</ident>=<const>"mirror://sourceforge/ctags/<var>${P}</var>.tar.gz"</const> 459<ident>SRC_URI</ident>=<const>"mirror://sourceforge/ctags/<var>${P}</var>.tar.gz"</const>
457 460
458<ident>LICENSE</ident>=<const>"GPL-2"</const> 461<ident>LICENSE</ident>=<const>"GPL-2"</const>
459<ident>SLOT</ident>=<const>"0"</const> 462<ident>SLOT</ident>=<const>"0"</const>
460<ident>KEYWORDS</ident>=<const>"~mips ~sparc ~x86"</const> 463<ident>KEYWORDS</ident>=<const>"~mips ~sparc ~x86"</const>
461<ident>IUSE</ident>=<const>""</const> 464<ident>IUSE</ident>=<const>""</const>
462 465
463<stmt>src_compile()</stmt> { 466<stmt>src_compile()</stmt> {
464 <keyword>econf</keyword> --with-posix-regex || <keyword>die</keyword> <const>"econf failed"</const> 467 <keyword>econf</keyword> --with-posix-regex
465 <keyword>emake</keyword> || <keyword>die</keyword> <const>"emake failed"</const> 468 <keyword>emake</keyword> || <keyword>die</keyword> <const>"emake failed"</const>
466} 469}
467 470
468<stmt>src_install()</stmt> { 471<stmt>src_install()</stmt> {
469 <keyword>make</keyword> <ident>DESTDIR</ident>="<var>${D}</var>" install || <keyword>die</keyword> <const>"install failed"</const> 472 <keyword>make</keyword> <ident>DESTDIR</ident>="<var>${D}</var>" install || <keyword>die</keyword> <const>"install failed"</const>
470 473
471 <keyword>dodoc</keyword> FAQ NEWS README 474 <keyword>dodoc</keyword> FAQ NEWS README
472 <keyword>dohtml</keyword> EXTENDING.html ctags.html 475 <keyword>dohtml</keyword> EXTENDING.html ctags.html
473} 476}
474</pre> 477</pre>
475 478
476</body> 479</body>
477</section> 480</section>
478<section> 481<section>
479<title>&lt;mail&gt; and &lt;uri&gt;</title> 482<title>&lt;mail&gt; and &lt;uri&gt;</title>

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

  ViewVC Help
Powered by ViewVC 1.1.20