| 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.42 2005/05/12 16:48:46 neysx Exp $ --> |
2 | <!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.43 2005/05/12 16:57:02 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.19</version> |
35 | <version>2.20</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> |
| … | |
… | |
| 85 | <pre caption="The initial part of a guide XML document"> |
85 | <pre caption="The initial part of a guide XML document"> |
| 86 | <?xml version="1.0" encoding="UTF-8"?> |
86 | <?xml version="1.0" encoding="UTF-8"?> |
| 87 | <!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
87 | <!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
| 88 | <!-- $Header$ --> |
88 | <!-- $Header$ --> |
| 89 | |
89 | |
| 90 | <guide link="<i>relative/link/to/your/guide.xml</i>" lang="<i>en</i>"> |
90 | <guide link="<i>/doc/en/guide.xml</i>" lang="<i>en</i>"> |
| 91 | <title><i>Gentoo Linux Documentation Guide</i></title> |
91 | <title><i>Gentoo Linux Documentation Guide</i></title> |
| 92 | <author title="<i>Author</i>"> |
92 | <author title="<i>Author</i>"> |
| 93 | <mail link="<i>yourname@gentoo.org</i>"><i>Your Name</i></mail> |
93 | <mail link="<i>yourname@gentoo.org</i>"><i>Your Name</i></mail> |
| 94 | </author> |
94 | </author> |
| 95 | |
95 | |
| … | |
… | |
| 110 | |
110 | |
| 111 | <p> |
111 | <p> |
| 112 | On the first lines, we see the requisite tag that identifies this as an XML |
112 | On the first lines, we see the requisite tag that identifies this as an XML |
| 113 | document and specifies its DTD. The <c><!-- $Header$ --></c> line |
113 | document and specifies its DTD. The <c><!-- $Header$ --></c> line |
| 114 | will be automatically modified by the CVS server and helps to track revisions. |
114 | will be automatically modified by the CVS server and helps to track revisions. |
| 115 | Next, there's a <c><guide></c> tag -- the entire guide document |
115 | Next, there's a <c><guide></c> tag -- the entire guide document is |
| 116 | is enclosed within a <c><guide> </guide></c> pair. The <c>link</c> |
116 | enclosed within a <c><guide> </guide></c> pair. The <c>link</c> |
| 117 | attribute is compulsory and should preferably contain the relative path to the |
117 | attribute is compulsory and should preferably contain the absolute path to the |
| 118 | document even though the file name alone will work. It is mainly used to |
118 | document relatively to the document root even though the file name alone will |
| 119 | generate a link to a printer-friendly version of your document. If you use a |
119 | work. It is mainly used to generate a link to a printer-friendly version of |
| 120 | wrong value, the link to the printable version will either not work or point to |
120 | your document. If you use a wrong value, the link to the printable version |
| 121 | a wrong document. The <c>lang</c> attribute can be used to specify the language |
121 | will either not work or point to a wrong document. The <c>lang</c> attribute |
| 122 | code of your document. It is used to format the date and insert strings like |
122 | can be used to specify the language code of your document. It is used to format |
| 123 | "<e>Note</e>", "<e>Content</e>", etc. in the specified language. The default |
123 | the date and insert strings like "<e>Note</e>", "<e>Content</e>", etc. in the |
| 124 | is English. |
124 | specified language. The default is English. |
| 125 | </p> |
125 | </p> |
| 126 | |
126 | |
| 127 | <p> |
127 | <p> |
| 128 | Next, there's a <c><title></c> tag, used to set the title for the entire |
128 | Next, there's a <c><title></c> tag, used to set the title for the entire |
| 129 | guide document. |
129 | guide document. |