/[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.43 Revision 1.44
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.43 2005/05/12 16:57:02 neysx Exp $ --> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.44 2005/05/23 19:05:33 swift 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.20</version> 35<version>2.21</version>
36<date>2005-05-12</date> 36<date>2005-05-23</date>
37 37
38<chapter> 38<chapter>
39<title>Guide basics</title> 39<title>Guide basics</title>
40<section> 40<section>
41<title>Guide XML design goals</title> 41<title>Guide XML design goals</title>
315</pre> 315</pre>
316 316
317</body> 317</body>
318</section> 318</section>
319<section> 319<section>
320<title>&lt;path&gt;, &lt;c&gt; and &lt;e&gt;</title> 320<title>&lt;path&gt;, &lt;c&gt;, &lt;i&gt; and &lt;e&gt;</title>
321<body> 321<body>
322 322
323<p> 323<p>
324The <c>&lt;path&gt;</c>, <c>&lt;c&gt;</c> and <c>&lt;e&gt;</c> elements can 324The <c>&lt;path&gt;</c>, <c>&lt;c&gt;</c> and <c>&lt;e&gt;</c> elements can
325be used inside any child <c>&lt;body&gt;</c> tag, except for 325be used inside any child <c>&lt;body&gt;</c> tag, except for
326<c>&lt;pre&gt;</c>. The <c>&lt;i&gt;</c> element can only be used inside
326<c>&lt;pre&gt;</c>. 327<c>&lt;pre&gt;</c>.
327</p> 328</p>
328 329
329<p> 330<p>
330The <c>&lt;path&gt;</c> element is used to mark text that refers to an 331The <c>&lt;path&gt;</c> element is used to mark text that refers to an
331<e>on-disk file</e> -- either an <e>absolute or relative path</e>, or a 332<e>on-disk file</e> -- either an <e>absolute or relative path</e>, or a
344<c>&lt;c&gt;</c> elements are already offset from regular text, <e>it is rarely 345<c>&lt;c&gt;</c> elements are already offset from regular text, <e>it is rarely
345necessary to surround user input with double-quotes</e>. For example, don't 346necessary to surround user input with double-quotes</e>. For example, don't
346refer to a "<c>&lt;c&gt;</c>" element like I did in this sentence. Avoiding 347refer to a "<c>&lt;c&gt;</c>" element like I did in this sentence. Avoiding
347the use of unnecessary double-quotes makes a document more readable -- and 348the use of unnecessary double-quotes makes a document more readable -- and
348adorable! 349adorable!
350</p>
351
352<p>
353When you want to highlight some text as user input inside a <c>&lt;pre&gt;</c>,
354use <c>&lt;i&gt;</c> instead.
349</p> 355</p>
350 356
351<p> 357<p>
352<c>&lt;e&gt;</c> is used to apply emphasis to a word or phrase; for example: 358<c>&lt;e&gt;</c> is used to apply emphasis to a word or phrase; for example:
353I <e>really</e> should use semicolons more often. As you can see, this text is 359I <e>really</e> should use semicolons more often. As you can see, this text is
493<b>Newlines</b> must be placed immediately after <e>every</e> 499<b>Newlines</b> must be placed immediately after <e>every</e>
494GuideXML-tag (both opening as closing), except for: 500GuideXML-tag (both opening as closing), except for:
495<c>&lt;version&gt;</c>, <c>&lt;date&gt;</c>, <c>&lt;title&gt;</c>, 501<c>&lt;version&gt;</c>, <c>&lt;date&gt;</c>, <c>&lt;title&gt;</c>,
496<c>&lt;th&gt;</c>, <c>&lt;ti&gt;</c>, 502<c>&lt;th&gt;</c>, <c>&lt;ti&gt;</c>,
497<c>&lt;li&gt;</c>, <c>&lt;i&gt;</c>, <c>&lt;e&gt;</c>, 503<c>&lt;li&gt;</c>, <c>&lt;i&gt;</c>, <c>&lt;e&gt;</c>,
498<c>&lt;uri&gt;</c>, <c>&lt;path&gt;</c>, <c>&lt;b&gt;</c>, 504<c>&lt;uri&gt;</c>, <c>&lt;path&gt;</c>, <c>&lt;b&gt;</c>, <c>&lt;c&gt;</c>,
499<c>&lt;comment&gt;</c>, <c>&lt;mail&gt;</c>. 505<c>&lt;comment&gt;</c>, <c>&lt;mail&gt;</c>.
500</p> 506</p>
501 507
502<p> 508<p>
503<b>Blank lines</b> must be placed immediately after <e>every</e> 509<b>Blank lines</b> must be placed immediately after <e>every</e>

Legend:
Removed from v.1.43  
changed lines
  Added in v.1.44

  ViewVC Help
Powered by ViewVC 1.1.20