/[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.41 Revision 1.42
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.41 2005/05/12 08:52:42 cam Exp $ --> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.42 2005/05/12 16:48:46 neysx Exp $ -->
3<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> 3<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
4 4
5<guide link="/doc/en/xml-guide.xml"> 5<guide link="/doc/en/xml-guide.xml">
6<title>Gentoo Linux XML Guide</title> 6<title>Gentoo Linux XML Guide</title>
7 7
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.0 --> 32<!-- See http://creativecommons.org/licenses/by-sa/2.0 -->
33<license/> 33<license/>
34 34
35<version>2.18</version> 35<version>2.19</version>
36<date>2005-05-12</date> 36<date>2005-05-12</date>
37 37
38<chapter> 38<chapter>
39<title>Guide basics</title> 39<title>Guide basics</title>
40<section> 40<section>
83</p> 83</p>
84 84
85<pre caption="The initial part of a guide XML document"> 85<pre caption="The initial part of a guide XML document">
86&lt;?xml version="1.0" encoding="UTF-8"?&gt; 86&lt;?xml version="1.0" encoding="UTF-8"?&gt;
87&lt;!DOCTYPE guide SYSTEM "/dtd/guide.dtd"&gt; 87&lt;!DOCTYPE guide SYSTEM "/dtd/guide.dtd"&gt;
88&lt;!-- &#36;Header&#36; --&gt;
89
88&lt;guide link="<i>relative/link/to/your/guide.xml</i>" lang="<i>en</i>"&gt; 90&lt;guide link="<i>relative/link/to/your/guide.xml</i>" lang="<i>en</i>"&gt;
89&lt;title&gt;<i>Gentoo Linux Documentation Guide</i>&lt;/title&gt; 91&lt;title&gt;<i>Gentoo Linux Documentation Guide</i>&lt;/title&gt;
90&lt;author title="<i>Author</i>"&gt; 92&lt;author title="<i>Author</i>"&gt;
91 &lt;mail link="<i>yourname@gentoo.org</i>"&gt;<i>Your Name</i>&lt;/mail&gt; 93 &lt;mail link="<i>yourname@gentoo.org</i>"&gt;<i>Your Name</i>&lt;/mail&gt;
92&lt;/author&gt; 94&lt;/author&gt;
105&lt;version&gt;<i>1.0</i>&lt;/version&gt; 107&lt;version&gt;<i>1.0</i>&lt;/version&gt;
106&lt;date&gt;<i>2004-12-25</i>&lt;/date&gt; 108&lt;date&gt;<i>2004-12-25</i>&lt;/date&gt;
107</pre> 109</pre>
108 110
109<p> 111<p>
110On the first, line, we see the requisite tag that identifies this as an XML 112On the first lines, we see the requisite tag that identifies this as an XML
111document. Following it, there's a <c>&lt;guide&gt;</c> tag -- the entire 113document and specifies its DTD. The <c>&lt;!-- &#36;Header&#36; --&gt;</c> line
114will be automatically modified by the CVS server and helps to track revisions.
115Next, there's a <c>&lt;guide&gt;</c> tag -- the entire guide document
112guide document is enclosed within a <c>&lt;guide&gt; &lt;/guide&gt;</c> pair. 116is enclosed within a <c>&lt;guide&gt; &lt;/guide&gt;</c> pair. The <c>link</c>
113The <c>link</c> attribute is compulsory and should preferably contain the 117attribute is compulsory and should preferably contain the relative path to the
114relative path to the document even though the file name alone will work. It is 118document even though the file name alone will work. It is mainly used to
115mainly used to generate a link to a printer-friendly version of your document. 119generate a link to a printer-friendly version of your document. If you use a
116If you use a wrong value, the link to the printable version will either not 120wrong value, the link to the printable version will either not work or point to
117work or point to a wrong document. The <c>lang</c> attribute can be used to 121a wrong document. The <c>lang</c> attribute can be used to specify the language
118specify the language code of your document. It is used to format the date and 122code of your document. It is used to format the date and insert strings like
119insert strings like "<e>Note</e>", "<e>Content</e>", etc. in the specified 123"<e>Note</e>", "<e>Content</e>", etc. in the specified language. The default
120language. The default is English. 124is English.
121</p> 125</p>
122 126
123<p> 127<p>
124Next, there's a <c>&lt;title&gt;</c> tag, used to set the title for the entire 128Next, there's a <c>&lt;title&gt;</c> tag, used to set the title for the entire
125guide document. 129guide document.
637</p> 641</p>
638 642
639<pre caption="Example book usage"> 643<pre caption="Example book usage">
640&lt;?xml version='1.0' encoding='UTF-8'?&gt; 644&lt;?xml version='1.0' encoding='UTF-8'?&gt;
641&lt;!DOCTYPE book SYSTEM "/dtd/book.dtd"&gt; 645&lt;!DOCTYPE book SYSTEM "/dtd/book.dtd"&gt;
646&lt;!-- &#36;Header&#36; --&gt;
642 647
643&lt;<i>book</i> link="example.xml"&gt; 648&lt;<i>book</i> link="example.xml"&gt;
644&lt;title&gt;Example Book Usage&lt;/title&gt; 649&lt;title&gt;Example Book Usage&lt;/title&gt;
645 650
646&lt;author...&gt; 651&lt;author...&gt;
712</p> 717</p>
713 718
714<pre caption="Chapter Syntax"> 719<pre caption="Chapter Syntax">
715&lt;?xml version='1.0' encoding='UTF-8'?&gt; 720&lt;?xml version='1.0' encoding='UTF-8'?&gt;
716&lt;!DOCTYPE sections SYSTEM "/dtd/book.dtd"&gt; 721&lt;!DOCTYPE sections SYSTEM "/dtd/book.dtd"&gt;
722&lt;!-- &#36;Header&#36; --&gt;
717 723
718&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt; 724&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt;
719&lt;!-- See http://creativecommons.org/licenses/by-sa/2.0 --&gt; 725&lt;!-- See http://creativecommons.org/licenses/by-sa/2.0 --&gt;
720 726
721&lt;sections&gt; 727&lt;sections&gt;

Legend:
Removed from v.1.41  
changed lines
  Added in v.1.42

  ViewVC Help
Powered by ViewVC 1.1.20