/[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.44 Revision 1.45
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.44 2005/05/23 19:05:33 swift Exp $ --> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.45 2005/05/23 19:08:16 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
259Now, here's how the <c>&lt;body&gt;</c> element above is rendered: 259Now, here's how the <c>&lt;body&gt;</c> element above is rendered:
260</p> 260</p>
261 261
262<p> 262<p>
263This is a paragraph. <path>/etc/passwd</path> is a file. 263This is a paragraph. <path>/etc/passwd</path> is a file.
264<uri>http://forums.gentoo.org</uri> is my favorite website. 264<uri>http://forums.gentoo.org</uri> is my favorite web site.
265Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now. 265Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now.
266</p> 266</p>
267 267
268<pre caption="Code Sample"> 268<pre caption="Code Sample">
269This is text output or code. 269This is text output or code.
328</p> 328</p>
329 329
330<p> 330<p>
331The <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
332<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
333<e>simple filename</e>. This element is generally rendered with a monospaced 333<e>simple filename</e>. This element is generally rendered with a mono spaced
334font to offset it from the standard paragraph type. 334font to offset it from the standard paragraph type.
335</p> 335</p>
336 336
337<p> 337<p>
338The <c>&lt;c&gt;</c> element is used to mark up a <e>command</e> or <e>user 338The <c>&lt;c&gt;</c> element is used to mark up a <e>command</e> or <e>user
381<c>&lt;uri&gt;http://forums.gentoo.org&lt;/uri&gt;</c>. The alternate form is 381<c>&lt;uri&gt;http://forums.gentoo.org&lt;/uri&gt;</c>. The alternate form is
382when you want to associate a URI with some other text -- for example, <uri 382when you want to associate a URI with some other text -- for example, <uri
383link="http://forums.gentoo.org">the Gentoo Forums</uri>. To create <e>this</e> 383link="http://forums.gentoo.org">the Gentoo Forums</uri>. To create <e>this</e>
384link, I typed <c>&lt;uri link="http://forums.gentoo.org"&gt;the Gentoo 384link, I typed <c>&lt;uri link="http://forums.gentoo.org"&gt;the Gentoo
385Forums&lt;/uri&gt;</c>. You don't need to write <c>http://www.gentoo.org/</c> 385Forums&lt;/uri&gt;</c>. You don't need to write <c>http://www.gentoo.org/</c>
386to link to other parts of the Gentoo website. For instance, a link to the <uri 386to link to other parts of the Gentoo web site. For instance, a link to the <uri
387link="/doc/en/">documentation main index</uri> should be simply <c>&lt;uri 387link="/doc/en/">documentation main index</uri> should be simply <c>&lt;uri
388link="/doc/en/index.xml"&gt;documentation main index&lt;/uri&gt;</c>. You can 388link="/doc/en/index.xml"&gt;documentation main index&lt;/uri&gt;</c>. You can
389even omit <c>index.xml</c> when you link to a directory index, e.g. <c>&lt;uri 389even omit <c>index.xml</c> when you link to a directory index, e.g. <c>&lt;uri
390link="/doc/en/"&gt;documentation main index&lt;/uri&gt;</c>. 390link="/doc/en/"&gt;documentation main index&lt;/uri&gt;</c>.
391</p> 391</p>
479 479
480<p> 480<p>
481Since all Gentoo Documentation is a joint effort and several people will 481Since all Gentoo Documentation is a joint effort and several people will
482most likely change existing documentation, a coding style is needed. 482most likely change existing documentation, a coding style is needed.
483A coding style contains two sections. The first one is regarding 483A coding style contains two sections. The first one is regarding
484internal coding - how the xml-tags are placed. The second one is 484internal coding - how the XML-tags are placed. The second one is
485regarding the content - how not to confuse the reader. 485regarding the content - how not to confuse the reader.
486</p> 486</p>
487 487
488<p> 488<p>
489Both sections are described next. 489Both sections are described next.

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

  ViewVC Help
Powered by ViewVC 1.1.20