8:46 a.m.
Author: pfrields
Update of /cvs/docs/documentation-guide/en_US
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv17847
Modified Files:
xml-tags.xml
Log Message:
Start correcting tagging to reflect sgmltag instead of command for all
tags, elements, etc.
Index: xml-tags.xml
===================================================================
RCS file: /cvs/docs/documentation-guide/en_US/xml-tags.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- xml-tags.xml 4 Feb 2007 13:42:58 -0000 1.3
+++ xml-tags.xml 4 Feb 2007 14:46:04 -0000 1.4
@@ -63,81 +63,93 @@
<para>
It is very important that you remember the caveats in this section. Even
though they are more strict than valid DocBook XML, these rules exist
- so that both the HTML and PDF outputs look proper.
+ so that both the HTML and PDF outputs look proper.
</para>
<variablelist>
<varlistentry>
<term>Do Not Use Trademark Entities</term>
<listitem>
- <para>Do not use the trademark entities &trade;, &copy;, or
- &reg; because the do not produce HTML output that works for all
- charsets. The HTML output produces by these entities are declared in
- the DTD and cannot be changed via the stylesheet.</para>
- <para>Instead, use the <command>trademark</command> tag and its
+ <para>Do not use the trademark entities <sgmltag
+ class="genentity">trade</sgmltag>, <sgmltag
+ class="genentity">copy</sgmltag>, or <sgmltag
+ class="genentity">reg</sgmltag> because they do not produce
+ HTML output that works for all charsets. The HTML output
+ produces by these entities are declared in the DTD and
+ cannot be changed via the stylesheet.</para>
+ <para>Instead, use the <sgmltag
class="element">trademark</sgmltag> tag and its
associates classes as follows:
</para>
<itemizedlist>
<listitem>
- <para><trademark>trademark symbol after
me</trademark>
+ <para><sgmltag
+ class="starttag">trademark</sgmltag>trademark symbol after
+ me<sgmltag class="endtag">trademark</sgmltag>
</para>
</listitem>
<listitem>
- <para><trademark class="registered">registered trademark
symbol after me</trademark>
+ <para><sgmltag class="starttag">trademark
+ class="registered"</sgmltag>registered trademark symbol
+ after me<sgmltag class="endtag">trademark</sgmltag>
</para>
</listitem>
<listitem>
- <para><trademark class="copyright">copyright symbol after
me</trademark></para>
+ <para><sgmltag class="starttag">trademark
+ class="copyright"</sgmltag>copyright symbol after
+ me<sgmltag class="endtag">trademark</sgmltag></para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
- <term>Content inside <command>para</command> tags</term>
+ <term>Content inside <sgmltag>para</sgmltag> tags</term>
<listitem>
- <para>Do not use <command>para</command> tags around anything
other
- than a simple paragraph. Doing so will create additional white space
- within the text itself in the PDF version.
+ <para>Do not use <sgmltag>para</sgmltag> tags around
+ anything other than a simple paragraph. Doing so will create
+ additional white space within the text itself in the PDF
+ version.
</para>
- <para>Specifically, do not use <command>para</command> tags
around
- the following (or, to put this another way, do not embed the
- following within <command>para</command> tags):
+ <para>Specifically, do not use <sgmltag>para</sgmltag> tags
+ around the following (or, to put this another way, do not
+ embed the following within <sgmltag>para</sgmltag> tags):
</para>
<itemizedlist>
<listitem>
- <para><screen></para>
+ <para><sgmltag
class="element">screen</sgmltag></para>
</listitem>
<listitem>
- <para><itemizedlist></para>
+ <para><sgmltag
class="element">itemizedlist</sgmltag></para>
</listitem>
<listitem>
- <para><orderedlist></para>
+ <para><sgmltag
class="element">orderedlist</sgmltag></para>
</listitem>
<listitem>
- <para><variablelist></para>
+ <para><sgmltag
class="element">variablelist</sgmltag></para>
</listitem>
<listitem>
- <para><table></para>
+ <para><sgmltag
class="element">table</sgmltag></para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
- <term>Content inside <command>para</command> tags within
- <command>listitem</command> tags</term>
+ <term>Content inside <sgmltag>para</sgmltag> tags within
+ <sgmltag>listitem</sgmltag> tags</term>
<listitem>
- <para>Content inside <command>para</command> tags within
- <command>listitem</command> tags <emphasis>must</emphasis>
start
- immediately after the beginning <para> tag to avoid extra
- white space in the PDF version.
+ <para>Content inside <sgmltag>para</sgmltag> tags within
+ <sgmltag>listitem</sgmltag> tags <emphasis>must</emphasis>
+ start immediately after the beginning <sgmltag
+ class="starttag">para</sgmltag> tag to avoid extra white
+ space in the PDF version.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>Content inside <command>screen</command> tags</term>
+ <term>Content inside <sgmltag>screen</sgmltag> tags</term>
<listitem>
- <para>The content inside <command>screen</command> tags
- (<screen> and </screen>)
+ <para>The content inside <sgmltag>screen</sgmltag> tags
+ (<sgmltag class="starttag">screen</sgmltag> and <sgmltag
+ class="endtag">screen</sgmltag>)
<emphasis>must</emphasis> be flush left in the XML file;
otherwise, the extraneous whitespace will appear in the HTML
version.
@@ -149,7 +161,7 @@
</section>
<section id="sn-xml-tags-application">
- <title><command>application</command></title>
+ <title><sgmltag>application</sgmltag></title>
<indexterm>
<primary>XML tags</primary>
@@ -159,17 +171,19 @@
<para>An application is the name of a GUI software program. A command is
the name of an executable (text) program or a software command.</para>
- <para>The <command><application></command> and
- <command></application></command> tags allow you to refer
to an
+ <para>The <sgmltag class="starttag">application</sgmltag>
and
+ <sgmltag class="endtag">application</sgmltag> tags allow you
to refer to an
application or program. For example, the following XML:
</para>
<screen>
<computeroutput>
To view the Web in Linux, you can use
-<application>Mozilla</application> or
-<application>lynx</application> if you only want a
text-based
-browser.
+<sgmltag class="starttag">application</sgmltag>Mozilla<sgmltag
+ class="endtag">application</sgmltag>
+or <sgmltag class="starttag">application</sgmltag>lynx<sgmltag
+ class="endtag">application</sgmltag> if
+you only want a text-based browser.
</computeroutput>
</screen>
@@ -185,7 +199,7 @@
</section>
<section id="sn-xml-tags-chapter">
- <title><command>chapter</command></title>
+ <title><sgmltag>chapter</sgmltag></title>
<indexterm>
<primary>XML tags</primary>
@@ -193,7 +207,7 @@
</indexterm>
<para>
- A DocBook book can be divided into chapters such as:
+ A DocBook book can be divided into chapters such as:
</para>
<screen>