path: root/en_US/xml-tags.xml

<!-- $Id: xml-tags.xml,v 1.2 2007/02/03 22:29:37 kwade Exp $ -->
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [

<!-- *************** Bring in Fedora entities *************** -->
<!ENTITY % FEDORA-ENTITIES-EN SYSTEM "fdp-entities.ent">
%FEDORA-ENTITIES-EN;

]>


  <chapter id="ch-xml-tags">
    <title>DocBook XML Tags</title>

    <indexterm>
      <primary>XML</primary>
      <secondary>tags</secondary>
      <see>XML tags</see>
    </indexterm>

    <para>Please read this chapter carefully. This chapter describes the tags
      used by the Docs Project. Some of the rules described are specific to the
      project.
    </para>

    <para>If these tags are used appropriately, document searches will provide
      meaningful results. These tags help search engines identify the
      information relevant to the search request. Another benefit is that all
      &PROJECT; documents will have a similar look and feel (however, they will have
      some differences depending upon the output format).
    </para>

    <indexterm>
      <primary>XML</primary>
      <secondary>general tag information</secondary>
    </indexterm>
    
    <para>Most tags in XML must have an opening and closing tag.  A few
    tags, such as <sgmltag class="emptytag">xref</sgmltag>, have no
    content and close themselves.  Additionally,
      proper XML conventions say that there must be a unique identifier for
      sections, chapters, figures, tables, and so on, so that they may be
      correctly identified, and cross referenced if needed.</para>
    
    <para>Although XML is capable of handling many document types, the format
      discussed here is the article format.</para>
    
    <para>
      This chapter only discusses tags used for documentation for the &PROJECT;,
      not all available DocBook XML tags. For the complete list, refer to:
    </para>
<screen>
<computeroutput>
<ulink url="http://www.docbook.org/tdg/en/html/docbook.html">http://www.docbook.org/tdg/en/html/docbook.html</ulink>
</computeroutput>
</screen>

    <section id="sn-xml-tags-caveats">
      <title>Tags and Entities Caveats</title>

      <indexterm>
	<primary>xml tags</primary>
	<secondary>caveats</secondary>
      </indexterm>
    
      <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.
      </para>

      <variablelist>
	<varlistentry>
	  <term>Do Not Use Trademark Entities</term>
	  <listitem>
	    <para>Do not use the trademark entities &amp;trade;, &amp;copy;, or
	    &amp;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
	    associates classes as follows:
	    </para>
	    <itemizedlist>
	      <listitem>
		<para>&lt;trademark&gt;trademark symbol after me&lt;/trademark&gt;
		</para>
	      </listitem>
	      <listitem>
		<para>&lt;trademark class="registered"&gt;registered trademark symbol after me&lt;/trademark&gt;
		</para>
	      </listitem>
	      <listitem>
		<para>&lt;trademark class="copyright"&gt;copyright symbol after me&lt;/trademark&gt;</para>
	      </listitem>
	    </itemizedlist>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>Content inside <command>para</command> 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>
	    <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>
	    <itemizedlist>
	      <listitem>
		<para>&lt;screen&gt;</para>
	      </listitem>
	      <listitem>
		<para>&lt;itemizedlist&gt;</para>
	      </listitem>
	      <listitem>
		<para>&lt;orderedlist&gt;</para>
	      </listitem>
	      <listitem>
		<para>&lt;variablelist&gt;</para>
	      </listitem>
	      <listitem>
		<para>&lt;table&gt;</para>
	      </listitem>
	    </itemizedlist>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>Content inside <command>para</command> tags within
	  <command>listitem</command> tags</term>
	  <listitem>
	    <para>Content inside <command>para</command> tags within
	    <command>listitem</command> tags <emphasis>must</emphasis> start
	    immediately after the beginning &lt;para&gt; tag to avoid extra
	    white space in the PDF version.
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>Content inside <command>screen</command> tags</term>
	  <listitem>
	    <para>The content inside <command>screen</command> tags
	    (&lt;screen&gt; and &lt;/screen&gt;)
	    <emphasis>must</emphasis> be flush left in the XML file;
	    otherwise, the extraneous whitespace will appear in the HTML
	    version.
	    </para>
	  </listitem>
	</varlistentry>
      </variablelist>

    </section>

      <section id="sn-xml-tags-application">
      <title><command>application</command></title>

	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>application</secondary>
	</indexterm>

      <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>&lt;application&gt;</command> and
      <command>&lt;/application&gt;</command> 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
&lt;application&gt;Mozilla&lt;/application&gt; or
&lt;application&gt;lynx&lt;/application&gt; if you only want a text-based
browser.
</computeroutput>
</screen>

      <para>
	produces the following output:
      </para>

      <para>
	To view the Web in Linux, you can use <application>Mozilla</application> 
	or <application>lynx</application> if you only want a text-based browser.
      </para>

      </section>

      <section id="sn-xml-tags-chapter">
      <title><command>chapter</command></title>

	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>chapter</secondary>
	</indexterm>

      <para>
	A DocBook book can be divided into chapters such as:
      </para>

<screen>
<computeroutput>
&lt;!--$Id: xml-tags.xml,v 1.2 2007/02/03 22:29:37 kwade Exp $ --&gt;

  &lt;chapter id="ch-sample"&gt;
    &lt;title&gt;Sample Chapter&lt;/title&gt;

    &lt;para&gt;This is a sample chapter, showing you the XML tags used to create a
    chapter, sections, and subsections.&lt;/para&gt;
    
  &lt;/chapter&gt;
</computeroutput>
</screen>

      <para>
	The chapter can also be further divided into sections
	(<command>section</command>, <command>section</command>,
	<command>sect3</command>, etc.). Refer to <xref
	linkend="sn-xml-tags-sections"></xref> for details.
      </para>

    </section>


      <section id="sn-xml-tags-citetitle">
      <title><command>citetitle</command></title>

	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>citetitle</secondary>
	</indexterm>


      <para>
	The <command>&lt;citetitle&gt;</command> tag provides formatting for a
	specific references (title can be manually typed out or if already
	defined within your document set, given as an entity<footnote><para>An
	entity is a short hand way of referring to another manual or guide. It
	can be defined within the parent document or within a set of files that
	your DTD references for your specific documentation set.</para>
	</footnote>
	).</para>

    <para>
      For example:
    </para>
<screen>
<computeroutput>
&lt;citetitle&gt;IG;&lt;/citetitle&gt;.
</computeroutput>
</screen>
      <para>
	The output looks like <citetitle>&IG;</citetitle> because &amp;IG; is an
	entity.
      </para>

      </section>

      <section id="sn-xml-tags-command">
      <title><command>command</command></title>

	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>command</secondary>
	</indexterm>

      <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. Any
	program that is a command line or text-based only tool is marked with
	<command>command</command> tags. </para>


      <para>If you have text that is a command, use the
	<command>&lt;command&gt;</command> and
	<command>&lt;/command&gt;</command> tags such as:
      </para>
      

	  
<screen>
<computeroutput>
To change your keyboard after installation, become root 
and use the &lt;command&gt;redhat-config-keyboard&lt;/command&gt; command, 
or you can type &lt;command&gt;setup&lt;/command&gt; at the root prompt.
</computeroutput>
</screen>
      
      <para>
	The output:
      </para>
      <para>
	To change your keyboard after installation, become root and use
	the <command>redhat-config-keyboard</command> command, or you can type
	<command>setup</command> at the root prompt.
      </para>

      <para>Another example would be:</para>

<screen>
<computeroutput>
&lt;command&gt;MAILNOVIOLATIONS&lt;/command&gt; &mdash; If set
to &lt;command&gt;true&lt;/command&gt; this option tells Tripwire to
email a report at a regular interval regardless of whether or not
any violations have occured. The default value is
&lt;command&gt;true&lt;/command&gt;.
</computeroutput>
</screen>

      <para>
	with the output:
      </para>

      <para>
	<command>MAILNOVIOLATIONS</command> &mdash; If set to
	<command>true</command> this variable tells Tripwire to email a report
	at a regular interval regardless of whether or not any violations have
	occured. The default value is <command>true</command>.
      </para>

      <note>
	<title>Note</title> <para>In this example, the option value (true) is
	defined with a &lt;command&gt; tag set. Because a option is a
	configuration file option (command line options which would use the
	&lt;option&gt; tag set), and because there is no configuration file
	option tag available to use, we are extending the &lt;command&gt; tag
	set to define options in a configuration file.</para>
      </note>

      <para>
	Terms marked with <command>command</command> tags because there aren't
	exact tags for them:
      </para>
      <itemizedlist>
	<listitem>
	  <para>Options in configuration files such as Apache directives</para>
	</listitem>
	<listitem>
	  <para>daemon names</para>
	</listitem>
      </itemizedlist>

      </section>

      <section id="sn-xml-tags-compoutput">
      <title><command>computeroutput</command></title>

	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>computeroutput</secondary>
	</indexterm>

      <para>
	To show computer output use the following tags:
      </para>
<screen>
<computeroutput>
&lt;computeroutput&gt;Do you want to delete this file? y n&lt;/computeroutput&gt;
</computeroutput>
</screen>

      <para>
	The output:
      </para>
      <para>
	<computeroutput>Do you really want to delete this file? y n</computeroutput>
      </para>
    </section>

    <section id="sn-xml-tags-emphasis">
      <title><command>emphasis</command></title>
      
      <indexterm>
	<primary>XML tags</primary>
	<secondary>emphasis</secondary>
      </indexterm>
      
      <para>
	To emphasis content, use the <command>&lt;emphasis&gt;</command> and
	<command>&lt;/emphasis&gt;</command> tags. For example:
      </para>
<screen>
<computeroutput>
This installation &lt;emphasis&gt;will remove all&lt;/emphasis&gt; existing
Linux partitions on &lt;emphasis&gt;all&lt;/emphasis&gt; hard drives in your
system; non-Linux partitions will not be removed.
</computeroutput>
</screen>

      <para>
	The output:
      </para>

      <para>
	This installation <emphasis>will remove all</emphasis> existing Linux
	partitions on <emphasis>all</emphasis> hard drives in your system;
	non-Linux partitions will not be removed.
      </para>
    </section>
    
    <section id="sn-xml-tags-example">
      <title><command>example</command></title>

	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>example</secondary>
	</indexterm>

      <para>The <command>&lt;example&gt;</command> and
      <command>&lt;/example&gt;</command> tags are used to format text within a
      document and is great for adding emphasis to show examples of code,
      exercises, and more. </para>

      <para>The <command>&lt;example&gt;</command> tag set should be given an ID
      and title:</para>

<screen>
	&lt;example id="static-ip"&gt;
	  &lt;title&gt;Static IP Address using DHCP&lt;/title&gt;

&lt;screen width=60&gt;
&lt;computeroutput&gt;
host apex {
   option host-name "apex.example.com";
   hardware ethernet 00:A0:78:8E:9E:AA; 
   fixed-address 192.168.1.4;
}
&lt;computeroutput&gt;
&lt;/screen&gt;

	&lt;/example&gt;
</screen>

      <para>
	The output:
      </para>

	<example id="static-ip">
	  <title>Static IP Address using DHCP</title>

<screen>
<computeroutput>
host apex {
   option host-name "apex.example.com";
   hardware ethernet 00:A0:78:8E:9E:AA; 
   fixed-address 192.168.1.4;
}
</computeroutput>
</screen>
	</example>

    </section>

    
    <section id="sn-xml-tags-filename">
      <title><command>filename</command></title>
      
      <indexterm>
	<primary>XML tags</primary>
	<secondary>filename</secondary>
      </indexterm>
      
      <para>
	The <command>&lt;filename&gt;</command> and
	<command>&lt;/filename&gt;</command> tags define a filename or path to a
	file. Since directories are just special files, they are marked with the
	<command>filename</command> tags as well. For example:
      </para>
<screen>
Edit the &lt;filename&gt;/home/smoore/sam.xml&lt;/filename&gt; file to make
changes or add comments.
</screen>
      <para>
	The output:
      </para>
      <para>
	Edit the <filename>/home/smoore/sam.xml</filename> file to make changes
	or add comments.
      </para>

      <para>
	They are also used to markup an RPM package name. For example:
      </para>
<screen>
To use the &lt;application&gt;Keyboard Configuration Tool&lt;/application&gt;, the
&lt;filename&gt;system-config-keyboard&lt;/filename&gt; RPM package must be installed.
</screen>
      <para>
	The output:
      </para>
      <para>
	To use the <application>Keyboard Configuration Tool</application>, the
	<command>redhat-config-keyboard</command> RPM package must be installed.
      </para>

      <note>
	<title>Note</title>
	<para>
	  Directory names must end with a forward slash
	  (<computeroutput>/</computeroutput>) to distinguish them from file
	  names.
	</para>
      </note>

    </section>

    <section id="sn-xml-tags-firstterm">
      <title><command>firstterm</command></title>

      <indexterm>
	<primary>XML tags</primary>
	<secondary>firstterm</secondary>
      </indexterm>

      <para>
	The <command>&lt;firstterm&gt;</command> and
	<command>&lt;/firstterm&gt;</command> tags helps to define a word that
	may be unfamiliar to the user, but that will be seen commonly throughout
	the text. For example:
      </para>
<screen>
<computeroutput>
Nearly every modern-day operating system uses &lt;firstterm&gt;disk
partitions&lt;/firstterm&gt;, and &FC; is no exception.
</computeroutput>
</screen>

      <para>
	The output:
      </para>

      <para>
	Nearly every modern-day operating system uses <firstterm>disk
	  partitions</firstterm>, and &FC; is no exception.
      </para>

    </section>

    <section id="sn-xml-tags-footnote">
      <title><command>footnote</command></title>
      
      <indexterm>
	<primary>XML tags</primary>
	<secondary>footnote</secondary>
      </indexterm>

      <para>
	If you need to make a footnote, use the following example:
      </para>
<screen>
<computeroutput>
For those of you who need to perform a server-class
&lt;footnote&gt;
&lt;para&gt;
A server-class installation sets up a typical server
environment. Note, no graphical environment is 
installed during a server-class installation.
&lt;/para&gt; 
&lt;/footnote&gt; installation, refer to the &lt;citetitle&gt;Installation Guide&lt;/citetitle&gt;.
</computeroutput>
</screen>

      <para>
	The output:
      </para>

      <para>
	For those of you who need to perform a server-class <footnote> <para>A
	    server-class installation sets up a typical server environment. Please note, no
	    graphical environment is installed during a server-class installation.</para>
	</footnote> installation, refer to the
	<citetitle>Installation Guide</citetitle>.
      </para>

    </section>

    <section id="sn-xml-tags-figure">
      <title><command>figure</command></title>

      <indexterm>
	<primary>XML tags</primary>
	<secondary>figure</secondary>
      </indexterm>
      
      <important>
	<title>Important</title>
	<para>
	  Order matters! The EPS file <emphasis>must</emphasis> be declared
	  first.
	</para>
      </important>

      <para>
	An example figure declaration:
      </para>

<screen>
<computeroutput>
&lt;figure id="fig-ksconfig-basic"&gt;
   &lt;title&gt;Basic Configuration&lt;/title&gt;
       &lt;mediaobject&gt;
         &lt;imageobject&gt;
           &lt;imagedata fileref="./figs/ksconfig/ksconfig-basic.eps"
                       format="EPS"/&gt;
         &lt;/imageobject&gt;
         &lt;imageobject&gt;
           &lt;imagedata fileref="./figs/ksconfig/ksconfig-basic.png"
                      format="PNG"/&gt;
         &lt;/imageobject&gt;
         &lt;textobject&gt;
           &lt;phrase&gt;
              Some text description of this image
           &lt;/phrase&gt;
         &lt;/textobject&gt;
       &lt;/mediaobject&gt;
&lt;/figure&gt;
</computeroutput>
</screen>

      <para>
	The following describes what needs to be edited:
      </para>

<screen>
&lt;figure id="fig-ksconfig-basic"&gt; <emphasis>==> id="" would be edited</emphasis>

&lt;title&gt;Basic Configuration&lt;/title&gt; <emphasis>==> title would be edited</emphasis>

fileref="./figs/ksconfig/ksconfig-basics.eps"&gt; <emphasis>==> .eps location would be edited</emphasis>

fileref="./figs/ksconfig/ksconfig-basics.png"&gt; <emphasis>==> .png location would be edited</emphasis>
                  
&lt;phrase&gt;Some text description of this image&lt;/phrase&gt; <emphasis>==> "Some text..." would be edited</emphasis>
</screen>

      <para>
	For more information on taking screenshots, refer to <xref
	linkend="sn-screenshots"/>.
      </para>

    </section>

    <section id="sn-xml-tags-gui">
      <title>GUI Tags</title>
      
      <indexterm>
	<primary>XML tags</primary>
	<secondary>GUI tags</secondary>
      </indexterm>
      
      <section id="sn-xml-tags-guilabel">
	<title><command>guilabel</command></title>
	
	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>GUI tags</secondary>
	  <tertiary>guilabel</tertiary>
	</indexterm>

	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>guilabel</secondary>
	</indexterm>
	
	<para>
	  Use the <command>&lt;guilabel&gt;</command> and
	  <command>&lt;/guilabel&gt;</command> tags as a default for GUI
	  descriptions, like a screen name or screen title. For example:
	</para>
<screen>
<computeroutput>
The &lt;guilabel&gt;Authentication Configuration&lt;/guilabel&gt; screen 
shows you how to make your system more secure.
</computeroutput>
</screen>

	<para>
	  The output:
	</para>

	<para>
	  The <guilabel>Authentication Configuration</guilabel> screen shows you how to
	  make your system more secure.
	</para>
      </section>

      <section id="sn-xml-tags-guibutton">
	<title><command>guibutton</command></title>
	
	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>GUI tags</secondary>
	  <tertiary>guibutton</tertiary>
	</indexterm>

	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>guibutton</secondary>
	</indexterm>

	<para>
	  Use the <command>&lt;guibutton&gt;</command> and
	  <command>&lt;/guibutton&gt;</command> tags to denote a button on a screen or
	  menu. For example:
	</para>
<screen>
<computeroutput>
Check the &lt;guibutton&gt;Activate on boot&lt;/guibutton&gt; button 
to have the X Window System start automatically.
</computeroutput>
</screen>

	<para>
	  The output:
	</para>

	  <para>
	  Check the <guibutton>Activate on boot</guibutton> button to have the X
	  Window System start automatically.
	</para>
      </section>
      
      <section id="sn-xml-tags-guiicon">
	<title><command>guiicon</command></title>
	
	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>GUI tags</secondary>
	  <tertiary>guiicon</tertiary>
	</indexterm>

	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>guiicon</secondary>
	</indexterm>

	<para>
	  The <command>&lt;guiicon&gt;</command> and <command>&lt;/guiicon&gt;</command>
	  tags are used to denote a panel or desktop icon. For example:
	</para>
<screen>
<computeroutput>
Double-click the &lt;guiicon&gt;Start Here&lt;/guiicon&gt; icon on the desktop.
</computeroutput>
</screen>

	<para>
	  The output:
	</para>

	<para>
	  Double-click the <guiicon>Start Here</guiicon> icon on the desktop.
	</para>

	</section>

      <section id="sn-xml-tags-guimenu">
	<title><command>guimenu</command> and
	  <command>guimenuitem</command></title>

	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>GUI tags</secondary>
	  <tertiary>guimenu</tertiary>
	</indexterm>
	
	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>guimenu</secondary>
	</indexterm>

	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>GUI tags</secondary>
	  <tertiary>guimenuitem</tertiary>
	</indexterm>

	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>guimenuitem</secondary>
	</indexterm>
	
	<para>
	  To note a menu (like in the installation program or within the control panel),
	  use the <command>&lt;guimenu&gt;</command> and
	  <command>&lt;/guimenu&gt;</command> tags. 
	</para>

	<para>
	  To note submenu items, use the <command>&lt;guimenuitem&gt;</command> and
	  <command>&lt;/guimenuitem&gt;</command> tags. (Please note that there should not
	  be any breaks between these commands, but for printing purposes breaks have been
	  inserted). For example:
	</para>
<screen>
<computeroutput>
Select 
&lt;guimenu&gt;Main Menu&lt;/guimenu&gt; =>
	    &lt;guimenuitem&gt;Programming&lt;/guimenuitem&gt; => &lt;guimenuitem&gt;Emacs&lt;/guimenuitem&gt; to start the 
&lt;application&gt;Emacs&lt;/application&gt; text editor.
</computeroutput>
</screen>

	<para>
	  The output:
	</para>

	<para>
	  From the control panel, click on <guimenu>Main Menu</guimenu> =>
	  <guimenuitem>Programming</guimenuitem> =>
	  <guimenuitem>Emacs</guimenuitem> to start the
	  <application>Emacs</application> text editor.
	</para>
      </section>
    </section>
    
    <section id="sn-xml-tags-keycap">
      <title><command>keycap</command></title>

      <indexterm>
	<primary>XML tags</primary>
	<secondary>keycap</secondary>
      </indexterm>

      <para>
	To denote a specific key, you will need to use the
	<command>&lt;keycap&gt;</command> and <command>&lt;/keycap&gt;</command>
	tags. Brackets are automatically added around the keycap, so do not add
	them in your XML code. For example:
      </para>
<screen>
<computeroutput>
To make your selection, press the &lt;keycap&gt;Enter&lt;/keycap&gt; key.
</computeroutput>
</screen>

      <para>
	The output:
      </para>

      <para>
	To make your selection, press the <keycap>Enter</keycap> key.
      </para>
      
      <section id="sn-xml-tags-menuchoice">
	<title><command>menuchoice</command></title>
	
	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>menuchoice</secondary>
	</indexterm>
	
	<para>
	  Often using a mouse is tedious for common tasks. Therefore,
	  programmers often build in keyboard-shortcuts to simplify their
	  program. These should be described using the shortcut tag as a wrapper
	  for the keyboard tags. The shortcut tag must be wrapped inside the
	  menuchoice tag. For example:
	</para>

<screen>
<computeroutput>
Go to the menu bar and choose: 
 &lt;menuchoice&gt;
   &lt;shortcut&gt;
     &lt;keycombo&gt;&lt;keycap&gt;Ctrl&lt;/keycap&gt;&lt;keycap&gt;s&lt;/keycap&gt;&lt;/keycombo&gt;
   &lt;/shortcut&gt;
   &lt;guimenu&gt;&lt;accel&gt;F&lt;/accel&gt;ile&lt;/guimenu&gt;
   &lt;guimenuitem&gt;&lt;accel&gt;S&lt;/accel&gt;ave&lt;/guimenuitem&gt;
 &lt;/menuchoice&gt;.
</computeroutput>
</screen>


      <para>
	The output:
      </para>
	
	<para>
	  Go to the menu bar and choose: 
	  <menuchoice>
	    <shortcut>
	      <keycombo><keycap>Ctrl</keycap><keycap>s</keycap></keycombo>
	    </shortcut>
	    <guimenu><accel>F</accel>ile</guimenu>
	    <guimenuitem><accel>S</accel>ave</guimenuitem> 
	  </menuchoice>.
	</para>

      </section>

      <section id="sn-xml-tags-keycombo">
	<title><command>keycombo</command></title>
	
	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>keycombo</secondary>
	</indexterm>
	
	<para>
	  To illustrate a key combination, you need to use the
	  <command>&lt;keycombo&gt;</command> and
	  <command>&lt;/keycombo&gt;</command>,
	  <command>&lt;keycap&gt;</command> and
	  <command>&lt;/keycap&gt;</command> tags. For example:
	</para>
<screen>
<computeroutput>
To reboot your system, press &lt;keycombo&gt;
&lt;keycap&gt;Ctrl&lt;/keycap&gt;&lt;keycap&gt;Alt&lt;/keycap&gt;&lt;keycap&gt;Del&lt;/keycap&gt;
&lt;/keycombo&gt;.
</computeroutput>
</screen>

	<para>
	  The output:
	</para>
	
	<para>
	  To reboot your system, press
	  <keycombo><keycap>Ctrl</keycap><keycap>Alt</keycap><keycap>Del</keycap>
	  </keycombo>.
	</para>

	</section>

    </section>

    <section id="sn-xml-tags-lists">
      <title>Lists</title>
      
      <indexterm>
	<primary>lists</primary>
	<secondary>creating</secondary>
      </indexterm>

      <para>There are several types of lists you can create using XML. You
	can have a itemized (bulleted) list, a ordered (numbered) list, or a
	variable list (presents a term and then a separate paragraph).</para>
      
      <para>There is also a list format for tables and for for creating a
	list of glossary terms and their definitions.</para>
      
      <para>The sections below will discuss the proper uses for the various
	list and how to create them.</para>

      <section id="sn-xml-tags-itemizedlist">
	<title><command>itemizedlist</command></title>
	
	<indexterm>
	  <primary>XML tags</primary>
	  <secondary><command>itemizedlist</command></secondary>
	</indexterm>
	
	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>lists</secondary>
	  <tertiary>itemizedlist</tertiary>
	</indexterm>

	<indexterm>
	  <primary>lists</primary>
	  <secondary><command>itemizedlist</command></secondary>
	</indexterm>
	
	<para>An <command>ItemizedList</command> is best used to present
	  information that is important for the reader to know, but that does
	  not need to be in a specific order. It is shorter than a
	  <command>VariableList</command> and presents the information in a
	  very simple way.</para>

	<para>To create an <command>ItemizedList</command> (otherwise known as
	  bulleted list), use the following command sequence:</para>
	
	<note>
	  <title>Note</title> <para>Notice below that the text for the list
	    item is directly surrounded by the <command>para</command>
	    tags. If you do not do this, you will find extra whitespace in
	    your lists where the text does not line up correctly. This is most
	    noticeable when you have a series of list items that consist of
	    multiple lines of text. This whitespace is not as noticeable in
	    the HTML output as it is in the PDFs.</para>
	</note>
	  
<screen>
<computeroutput>
&lt;itemizedlist&gt; 
  &lt;listitem&gt;
    &lt;para&gt;Getting familiar with the installation program's user interface&lt;/para&gt;
  &lt;/listitem&gt;

  &lt;listitem&gt;
    &lt;para&gt;Starting the installation program&lt;/para&gt; 
  &lt;/listitem&gt;

  &lt;listitem&gt;
    &lt;para&gt;Selecting an installation method&lt;/para&gt;
  &lt;/listitem&gt;
&lt;/itemizedlist&gt;
</computeroutput>
</screen>

	<para>The output looks like:</para>
	
	<itemizedlist> 
	  <listitem> 
	    <para>Getting familiar with the installation program's user interface</para> 
	  </listitem> 
	  
	  <listitem> 
	    <para>Starting the installation program</para> 
	  </listitem> 
	  
	  <listitem> 
	    <para>Selecting an installation method</para> 
	  </listitem> 
	</itemizedlist> 
		  
      </section>

      <section id="sn-xml-tags-orderedlist">
	<title><command>OrderedList</command></title>
	  
	<indexterm>
	  <primary>XML tags</primary>
	  <secondary><command>orderedlist</command></secondary>
	</indexterm>
	
	<indexterm>
	  <primary>lists</primary>
	  <secondary><command>orderedlist</command></secondary>
	</indexterm>
	
	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>lists</secondary>
	  <tertiary>orderedlist</tertiary>
	</indexterm>

	<para>An <command>orderedlist</command> is best used to present
	  information that is important for the reader to know in a specific
	  order. <command>orderedlist</command>s are a good way to convey
	  step-by-step senarios to the audience you are writing for.</para>

	<para>
	  To create an <command>orderedlist</command> (numbered list), use the
	  following XML code sequence:
	</para>

	<note>
	  <title>Note</title> <para>Notice below that the text for the list
	    item is directly surrounded by the <command>para</command>
	    tags. If you do not do this, you will find extra whitespace in
	    your lists where the text does not line up correctly. This is most
	    noticeable when you have a series of list items that consist of
	    multiple lines of text. This whitespace is not as noticeable in
	    the HTML output as it is in the PDFs.</para>
	</note>

<screen>
<computeroutput>
&lt;orderedlist&gt;
  &lt;listitem&gt;
    &lt;para&gt;Online &amp;mdash; http://www.redhat.com/support/errata; supplies errata
    you can read online, and you can download diskette images
    easily.&lt;/para&gt;
  &lt;/listitem&gt;
	  
  &lt;listitem&gt;
    &lt;para&gt;Email &amp;mdash; By sending an empty mail message to errata@redhat.com, 
    you will receive an email containing a text listing of the 
    complete errata  of the installation program and related software 
    (if errata exist at  that time).  Also included are URLs to each 
    updated package and diskette  image in the errata. Using these 
    URLs, you can download any necessary  diskette images. Please 
    note: use binary mode when transferring a diskette image.&lt;/para&gt; 
  &lt;/listitem&gt;
&lt;/orderedlist&gt;
</computeroutput>
</screen>

	<para>The  output looks like:</para>
	
	<orderedlist>
	  <listitem>
	    <para>Online &mdash; http://www.redhat.com/support/errata; supplies errata
	      you can read online, and you can download diskette images
	      easily.
	    </para>
	  </listitem>
	  
	  <listitem>
	    <para>
	      Email &mdash; By sending an empty mail message to
	      errata@redhat.com, you will receive an email containing a text
	      listing of the complete errata of the installation program and
	      related software (if errata exist at that time).  Also included
	      are URLs to each updated package and diskette image in the
	      errata. Using these URLs, you can download any necessary
	      diskette images. Please note: use binary mode when transferring
	      a diskette image.
	    </para>
	  </listitem>
	</orderedlist>
	
      </section>

      <section id="sn-xml-tags-varlist">
	<title><command>Variablelist</command></title>
	
	<indexterm>
	  <primary>XML tags</primary>
	  <secondary><command>variablelist</command></secondary>
	</indexterm>
	
	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>lists</secondary>
	  <tertiary>variablelist</tertiary>
	</indexterm>

	<indexterm>
	  <primary>lists</primary>
	  <secondary><command>variablelist</command></secondary>
	</indexterm>
	
	<para>A <command>variablelist</command> best represents a list of
	  terms and definitions or descriptions for those terms.</para>
	
	<para>To create a <command>variablelist</command>, use the following
	  command sequence:
	</para>
	
	<note>
	  <title>Note</title> <para>Notice below that the text for the list
	    item is directly surrounded by the <command>para</command> tags. If
	    you do not do this, you will find extra whitespace in your lists
	    where the text does not line up correctly. This is most noticeable
	    when you have a series of list items that consist of multiple lines
	    of text. This whitespace is not as noticeable in the HTML output as
	    it is in the PDFs.</para>
	</note>
	  
<screen>
<computeroutput>
&lt;variablelist&gt;
  &lt;varlistentry&gt; 
    &lt;term&gt; New Multi-CD Install &lt;/term&gt;
    &lt;listitem&gt; 
      &lt;para&gt;As the installation program continues to grow, Red Hat has developed 
      an installation program capable of installing from 
      multiple CD-ROMs.&lt;/para&gt;
    &lt;/listitem&gt;
  &lt;/varlistentry&gt;

 &lt;varlistentry&gt;
   &lt;term&gt;XFree 4.0 &lt;/term&gt;
   &lt;listitem&gt;
     &lt;para&gt;Configuration of your X Window System during the installation has 
     never been more thorough. From choosing your monitor and its correct 
     settings, to video card probing, to testing your desired X setup, 
     Xconfigurator will help you set  everything just right.&lt;/para&gt;
   &lt;/listitem&gt;
 &lt;/varlistentry&gt;
&lt;/variablelist&gt;
</computeroutput>
</screen>

	<para>The output looks like:</para>
	
	<variablelist> 
	  <varlistentry>
	    <term>New Multi-CD Install</term> <listitem> <para>As the
		installation program continues to grow, Red Hat has developed an
		installation program capable of installing from
		multiple CD-ROMs.</para>
	    </listitem>
	  </varlistentry>
	  
	  <varlistentry>
	    <term> XFree 4.0</term> 
	    <listitem>
	      <para>Configuration of your X Window System during the
		installation has never been more thorough. From choosing your
		monitor and its correct settings, to video card probing, to
		testing your desired X setup, Xconfigurator will help you set
		everything just right.</para>
	    </listitem>
	  </varlistentry>	    
	</variablelist> 

	<warning>
	  <title>Warning</title>
	  <para>
	    Do <emphasis>not</emphasis> specify the
	    <computeroutput>frame</computeroutput> attribute to the table. Doing
	    so breaks PDF production.
	  </para>
	</warning>

      </section>
      
      <section id="sn-xml-tags-simplelist">
	<title>Creating a List Within a Table Using <command>Simplelist</command></title>
	
	<indexterm>
	  <primary>XML tags</primary>
	  <secondary><command>simplelist</command></secondary>
	</indexterm>
	
	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>lists</secondary>
	  <tertiary>simplelist</tertiary>
	</indexterm>

	<indexterm>
	  <primary>lists</primary>
	  <secondary><command>simplelist</command></secondary>
	</indexterm>
	
	<indexterm>
	  <primary>tables</primary>
	  <secondary>creating a list within a table</secondary>
	  <tertiary><command>simplelist</command></tertiary>
	</indexterm>
	
	<para>A <command>simplelist</command> is an unadorned list of
	  items. <command>simplelist</command>s can be inline or arranged in
	  columns.</para> 
	
	<para>We use <command>simplelist</command> to add separate paragraphs
	  of text within a table element. A regular list, such as
	  <command>itemizedlist</command>, cannot be embedded within a table.</para>

	<para>The XML commands for a table look like:</para>

<screen>
<computeroutput>
	  &lt;table id="tb-hwinfo-hostbus"&gt;
	    &lt;title&gt;Host Bus Adapter Features and Configuration Requirements&lt;/title&gt;
	    
	    &lt;tgroup cols="3"&gt;
	      &lt;colspec colnum="1" colname="HostBus" colwidth="33"/&gt;
	      &lt;colspec colnum="2" colname="Features" colwidth="34"/&gt;
	      &lt;colspec colnum="3" colname="Single" colwidth="33"/&gt;
	      
	      &lt;thead&gt;
		&lt;row&gt;
		  &lt;entry&gt;Host Bus Adapter&lt;/entry&gt;
		  &lt;entry&gt;Features&lt;/entry&gt;
		  &lt;entry&gt;Single-Initiator Configuration&lt;/entry&gt;
		&lt;/row&gt;
	      &lt;/thead&gt;
	      
	      &lt;tbody&gt;
		
		&lt;row&gt;
		  &lt;entry&gt;Adaptec 2940U2W&lt;/entry&gt;
		  
		  &lt;entry&gt;&lt;simplelist&gt; 
		      &lt;member&gt;Ultra2, wide, LVD.&lt;/member&gt;
		      &lt;member&gt;HD68 external connector.&lt;/member&gt;
		      &lt;member&gt;One channel, with two bus segments.&lt;/member&gt;
		      &lt;member&gt;Set the onboard termination by using the BIOS
			utility.&lt;/member&gt;
		      &lt;member&gt;Onboard termination is disabled when the power is
			off.&lt;/member&gt;
		    &lt;/simplelist&gt;&lt;/entry&gt;
		  
		  &lt;entry&gt;&lt;simplelist&gt;
		      &lt;member&gt;Set the onboard termination to automatic (the
			default).&lt;/member&gt;
		      &lt;member&gt;Use the internal SCSI connector for private
			(non-cluster) storage.&lt;/member&gt;
		    &lt;/simplelist&gt;&lt;/entry&gt;
		&lt;/row&gt;
		
		&lt;row&gt;
		  &lt;entry&gt;Qlogic QLA1080&lt;/entry&gt;
		  
		  &lt;entry&gt;&lt;simplelist&gt; 
		      &lt;member&gt;Ultra2, wide, LVD&lt;/member&gt;
		      &lt;member&gt;VHDCI external connector&lt;/member&gt;
		      &lt;member&gt;One channel&lt;/member&gt;
		      &lt;member&gt;Set the onboard termination by using the BIOS
			utility.&lt;/member&gt;
		      &lt;member&gt;Onboard termination is disabled when the power is off,
			unless jumpers are used to enforce termination.&lt;/member&gt;
		    &lt;/simplelist&gt;&lt;/entry&gt;
		  
		  
		  &lt;entry&gt;&lt;simplelist&gt; 
		      &lt;member&gt;Set the onboard termination to
			automatic (the default).&lt;/member&gt;
		      &lt;member&gt;Use the internal SCSI connector for private
			(non-cluster) storage.&lt;/member&gt;
		    &lt;/simplelist&gt;&lt;/entry&gt;
		&lt;/row&gt;
		
	      &lt;/tbody&gt;
	    &lt;/tgroup&gt;
	  &lt;/table&gt;
</computeroutput>
</screen>

	<para>The output looks like:</para>
	
	<table id="tb-hwinfo-hostbus">
	  <title>Host Bus Adapter Features and Configuration Requirements</title>
	  
	  <tgroup cols="3">
	    <colspec colnum="1" colname="HostBus" colwidth="33"/>
	    <colspec colnum="2" colname="Features" colwidth="34"/>
	    <colspec colnum="3" colname="Single" colwidth="33"/>
	    
	    <thead>
	      <row>
		<entry>Host Bus Adapter</entry>
		<entry>Features</entry>
		  <entry>Single-Initiator Configuration</entry>
	      </row>
	    </thead>
	      
	    <tbody>
	      
	      <row>
		<entry>Adaptec 2940U2W</entry>
		
		<entry><simplelist> 
		    <member>Ultra2, wide, LVD.</member>
		    <member>HD68 external connector.</member>
		    <member>One channel, with two bus segments.</member>
		    <member>Set the onboard termination by using the BIOS
		      utility.</member>
		    <member>Onboard termination is disabled when the power is
		      off.</member>
		  </simplelist></entry>
		
		<entry><simplelist>
		    <member>Set the onboard termination to automatic (the
		      default).</member>
		    <member>Use the internal SCSI connector for private
		      (non-cluster) storage.</member>
		  </simplelist></entry>
	      </row>
	      
	      <row>
		<entry>Qlogic QLA1080</entry>
		
		<entry><simplelist> 
		    <member>Ultra2, wide, LVD</member>
		    <member>VHDCI external connector</member>
		    <member>One channel</member>
		    <member>Set the onboard termination by using the BIOS
		      utility.</member>
		    <member>Onboard termination is disabled when the power is off,
		      unless jumpers are used to enforce termination.</member>
		  </simplelist></entry>
		
		
		<entry><simplelist> 
		    <member>Set the onboard termination to
		      automatic (the default).</member>
		    <member>Use the internal SCSI connector for private
		      (non-cluster) storage.</member>
		  </simplelist></entry>
	      </row>
	      
	    </tbody>
	  </tgroup>
	</table>

	<note>
	  <title>Note</title>
	  <para>Notice how the <command>SimpleList</command> tags are
	    used. The  &lt;entry&gt; and &lt;simplelist&gt; tags must be aligned
	    beside one another, otherwise you will receive a parsing error.</para>
	</note>

	<para>For each paragraph or list item to be added within a
	  <command>SimpleList</command>, the &lt;member&gt; tag set must be
	  added around that particular text item.</para>
      </section>
      
      <section id="sn-xml-tags-glossary">
	<title><command>glosslist</command></title>
	
	<indexterm>
	  <primary>XML tags</primary>
	  <secondary><command>glosslist</command></secondary>
	</indexterm>
	
	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>lists</secondary>
	  <tertiary>glosslist</tertiary>
	</indexterm>

	<indexterm>
	  <primary>lists</primary>
	  <secondary><command>glosslist</command></secondary>
	</indexterm>
	
	<para>Use the <command>glosslist</command> command set to create a
	  list of glossary terms and their definitions.</para>
	
	
	<para>In XML, an example looks like the following:</para>
	
<screen>
<computeroutput>
	  &lt;glosslist&gt;
	    &lt;glossentry&gt;
	      &lt;glossterm&gt;applet&lt;/glossterm&gt;
	      &lt;glossdef&gt;
		&lt;para&gt;A small application, usually a utility or other
	        simple program.&lt;/para&gt;
	      &lt;/glossdef&gt;
	    &lt;/glossentry&gt;

	    &lt;glossentry&gt;
	      &lt;glossterm&gt;architecture&lt;/glossterm&gt;
	      &lt;glossdef&gt;
		&lt;para&gt;The design for organization and integration of 
                components within a computer or computer system.&lt;/para&gt;
	      &lt;/glossdef&gt;
	    &lt;/glossentry&gt;

	    &lt;glossentry&gt;
	      &lt;glossterm&gt;archive&lt;/glossterm&gt;
	      &lt;glossdef&gt;
		&lt;para&gt;To transfer files into storage for the purpose of 
	        saving space and/or organization.&lt;/para&gt;
	      &lt;/glossdef&gt;
	    &lt;/glossentry&gt;
	  &lt;/glosslist&gt;
</computeroutput>	  
</screen>

	<para>
	  The output looks like:
	</para>

	<glosslist>
	  <glossentry>
	    <glossterm>applet</glossterm>
	    <glossdef>
	      <para>A small application, usually a utility or other simple program.</para>
	    </glossdef>
	  </glossentry>
	  
	  <glossentry>
	    <glossterm>architecture</glossterm>
	    <glossdef>
	      <para>The design for organization and integration of components
		within a computer or computer system.</para>
	    </glossdef>
	  </glossentry>
	  
	  <glossentry>
	    <glossterm>archive</glossterm>
	    <glossdef>
	      <para>To transfer files into storage for the purpose of saving
		space and/or organization.</para>
	    </glossdef>
	  </glossentry>
	</glosslist>
	
      </section>
    </section>

   
    <section id="sn-xml-tags-option">
      <title><command>option</command></title>
      
      <indexterm>
	<primary>XML tags</primary>
	<secondary>option</secondary>
      </indexterm>
      
      <para>If you have a command that offers an option or a flag, use the
	<command>&lt;option&gt;</command> and
	<command>&lt;/option&gt;</command> tags.
      </para>
      
      <note>
	<title>Note</title>
	<para>The &lt;option&gt; tag set is only meant to be used for command
	  line options, not options in configuration files.</para>
      </note>
      
      <para>In XML, specifying an option would look like the
	following:</para>

<screen>
<computeroutput>
For example, with the command &lt;command&gt;ls&lt;/command&gt; you can 
specify an option such as &lt;option&gt;-la&lt;/option&gt;.
</computeroutput>
</screen>

      <para>
	The output:
      </para>
	
      <para>For example, with the command <command>ls</command> you can
	specify an option such as <option>-la</option>.</para>
      
    </section>

    <section id="sn-xml-tags-indexing">
      <title>Index Entries</title>

	<indexterm>
	  <primary>indexing</primary>
	</indexterm>


	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>indexing</secondary>
	</indexterm>

      <para>The following command sequence shows you the code inserted into
	the body of the text to add an index entry to your document:
	</para>
	
<screen>
<computeroutput>
&lt;indexterm&gt; &lt;-- indicates a term to be placed in the index
&lt;primary&gt;foo&lt;/primary&gt; &lt;-- indicates that "foo" is the first term
&lt;secondary&gt;bar&lt;/secondary&gt; &lt;-- "bar" will be listed under "foo" 
&lt;/indexterm&gt; &lt;-- closes this index entry
</computeroutput>
</screen>

      <indexterm>
	<primary>foo</primary>
	<secondary>bar</secondary>
      </indexterm>
      
      
      <para>The <command>&lt;seealso&gt;</command> tag allows you to
	reference another index entry or refer to another manual. Make sure
	the <command>&lt;seealso&gt;</command> reference you are pointing to
	has its own entry. For example:
      </para>
      
      <indexterm>
	<primary>indexing</primary>
	<secondary>seealso tag</secondary>
      </indexterm>

<screen>
<computeroutput>
&lt;indexterm&gt; 
&lt;primary&gt;SWAK&lt;/primary&gt; 
&lt;seealso&gt;salutations&lt;/seealso&gt;
&lt;/indexterm&gt;


&lt;indexterm&gt; 
&lt;primary&gt;salutations&lt;/primary&gt; 
&lt;/indexterm&gt;
</computeroutput>
</screen>

      <indexterm>
	<primary>SWAK</primary>
	<seealso>Salutations</seealso>
      </indexterm>
      
      <indexterm>
	<primary>Salutations</primary>
      </indexterm>
      
      <para>
	The <command>&lt;see&gt;</command> tag allows you to reference to
	another index entry entirely. For example:
      </para>
	<indexterm>
	  <primary>indexing</primary>
	    <secondary>see tag</secondary>
	</indexterm>


<screen>
<computeroutput>
&lt;indexterm&gt; 
&lt;primary&gt;Guinness&lt;/primary&gt; 
&lt;see&gt;beer&lt;/see&gt; &lt;-- beer will be listed under 
the Guinness entry, but you must make sure beer also has its 
own entry to refer to.
&lt;/indexterm&gt;

&lt;indexterm&gt;
&lt;primary&gt;beer&lt;/primary&gt;
&lt;/indexterm&gt;
</computeroutput>
</screen>

      <indexterm>
	<primary>Guinness</primary>
	<see>Beer</see>
      </indexterm>
      
      <indexterm>
	<primary>Beer</primary>
      </indexterm>
      
      <para>To view the HTML output of the index entries shown here, refer
	to the <filename>generated-index.html</filename> file at the end of
	this document.</para>
      
      <para>How does the index get generated? If indexterms exist in the
	document and the beginning and ending index tags exist before the end
	tag for the book or article, an index is created because of the
	<command>generate.index</command> stylesheet parameter, which is set to
	true by default.
	</para>

    </section>

    <section id="sn-xml-tags-para">
      <title><command>para</command></title>
      
      
      <indexterm>
	<primary>XML tags</primary>
	<secondary>para</secondary>
      </indexterm>
      
      <para>For any paragraph, the <command>&lt;para&gt;</command> and
	<command>&lt;/para&gt;</command> tags must open and close that
	particular paragraph.
      </para>
      
      <para>Do not use para tags around anything other than a simple
	paragraph. Doing so will create additional white space within
	the text itself.</para> 
	      
      <para>Do not use <command>&lt;para&gt;</command> tags around the
	following (or, to put this another way, do not embed the
	following within <command>&lt;para&gt;</command> tags):</para>
	      
      <itemizedlist>
	<listitem>
	  <para><command>&lt;screen&gt;</command></para>
	</listitem>
	<listitem>
	  <para><command>&lt;itemizedlist&gt;</command></para>
	</listitem>
	<listitem>
	  <para><command>&lt;orderedlist&gt;</command></para>
	</listitem>
	<listitem>
	  <para><command>&lt;variablelist&gt;</command></para>
	</listitem>
	<listitem>
	  <para><command>&lt;table&gt;</command></para>
	</listitem>
      </itemizedlist>
      
    </section>

    <section id="sn-xml-tags-part">
      <title><command>part</command></title>

	<indexterm>
	  <primary>parts</primary>
	</indexterm>


	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>part</secondary>
	</indexterm>

      <para>
	In the parent file, you can separate the chapters into parts to divide
	them into logical groups. For example, in the parent file, the
	<command>part</command> tags surround the chapter entities:
      </para>
<screen>
<computeroutput>
&lt;part id="pt-foo"&gt;
  &lt;partintro&gt;
  &lt;para&gt;Some text for the part intro&lt;/para&gt;
     &amp;CHAPTER; 

     &amp;ANOTHER-CHAPTER;
&lt;/part&gt;
</computeroutput>
</screen>

      <para>
	If you create a part, include a part introduction describing the
	contents of the part. For example:
      </para>

<screen>
<computeroutput>
  &lt;part id="pt-setup"&gt;
    &lt;title&gt;Getting Setup&lt;/title&gt;
    &lt;partintro&gt;
      &lt;para&gt;This section contains information you will need when you first join
	the Docs group. You might need to refer to this part again for
	information such as installing &amp;FC;.&lt;/para&gt;
    &lt;/partintro&gt;
</computeroutput>
</screen>

      <para>
	In the HTML output, a separate HTML page is generated with the part
	number, title, introduction, and TOC. In the PDF output, the same
	information about the part is on a separate page.
      </para>

    </section>

    <section id="sn-xml-tags-prompt">
      <title><command>prompt</command></title>
      
      <indexterm>
	<primary>XML tags</primary>
	<secondary>prompt</secondary>
      </indexterm>
      
      <para>
	To show a prompt, such as a root or DOS prompt, use the
	<command>&lt;prompt&gt;</command> and <command>&lt;/prompt&gt;</command>
	commands. For example:
      </para>
<screen>
<computeroutput>
At the &lt;prompt&gt;LILO:&lt;/prompt&gt; boot prompt, type linux to 
boot into your Linux partition.

At the &lt;prompt&gt;C:\>&lt;/prompt&gt; prompt, type ....
</computeroutput>
</screen>

      <para>
	The output:
      </para>

      <para>
	At the <prompt>LILO:</prompt> boot prompt, type linux to boot into your
	Linux partition.
      </para>
      <para>
	At the <prompt>C:\></prompt> prompt, type ....
      </para>

      <note>
	<title>Note</title> 
	<para>
	  When showing example computer output (usually in
	  <command>screen</command> tags), do not include the prompt or command
	  (unless the command or prompt is the actually computer output you want
	  to show).</para>
      </note>
    </section>

    <section id="sn-xml-tags-replaceable">
      <title><command>replaceable</command></title>
      
      <indexterm>
	<primary>XML tags</primary>
	<secondary>replaceable</secondary>
      </indexterm>
      
      <para>
	To create replaceable text, use the tags
	<command>&lt;replaceable&gt;</command> and
	<command>&lt;/replaceable&gt;</command> around the text you want to use as a
	variable.
      </para>
      <para>
	This example demonstrates how to use the <command>replaceable</command>
	tags when referencing the name of an RPM file:
      </para>
<screen>
foo-&lt;replaceable&gt;version-number&lt;/replaceable&gt;.&lt;replaceable&gt;arch&lt;/replaceable&gt;.rpm
</screen>

      <para>
	The output:
      </para>

<screen>
foo-<replaceable>version-number</replaceable>.<replaceable>arch</replaceable>.rpm
</screen>
    </section>

    <section id="sn-xml-tags-screen">
      <title><command>screen</command></title>
      <indexterm>
	<primary>XML tags</primary>
	<secondary>screen</secondary>
      </indexterm>
      
    <para>
      The <command>&lt;screen&gt;</command> command is used to format text
      within a document and is great for adding emphasis to show examples of
      code, computer output, and more. In HTML with the Fedora CSS file, this
      appears in box with a grey background. To use this command you only need
      the opening <command>&lt;screen&gt;</command> and closing
      <command>&lt;/screen&gt;</command> tags around the text you are
      emphasizing.
    </para>

    <important>
      <title>Important</title> 
      <para>
	When using the <command>&lt;screen&gt;</command> tag, set
	everything within that screen to flush left.  The contents of
	the <sgmltag class="starttag">screen</sgmltag> element are
	rendered exactly as is, including any indentation.  Using flush
	left prevents extra blank space in front of the text inside the
	gray background when the content is converted to HTML.
      </para>
    </important>

    <para>
      The <command>&lt;screen&gt;</command> tag set may contain other inline
      tags, such as <command>&lt;computeroutput&gt;</command>,
      <command>&lt;userinput&gt;</command>, or
      <command>&lt;replaceable&gt;</command>. Additional inline tags are not
      required by definition. The <command>&lt;screen&gt;</command> tags by
      themselves may provide sufficient context, especially for simple examples
      or file listings. Consider the context of the example, and use inline tags
      if they are helpful to the reader.
    </para>

    <para>
      If you use inline tags, remember that line breaks inside
      <command>&lt;screen&gt;</command> tags create line breaks in any rendered
      output. Place any inline tags <emphasis>on the same line</emphasis> as
      their content. Do not overuse tagging within a
      <command>&lt;screen&gt;</command> tag set.
    </para>

    <para>
      An example of <command>&lt;screen&gt;</command> is the following:
    </para>

<screen>
<computeroutput>&lt;screen&gt;
This is an example of a screen. You do not need &amp;lt;para&amp;gt; tags
within this command.
&lt;/screen&gt;</computeroutput>
</screen>
	  
    <para>
      The output:
    </para>

<screen>
This is an example of a screen.  You do not need &lt;para&gt; tags
within this command.
</screen>

    <section id="sn-xml-tags-screen-inline-tags">
      <title>Using Inline Tags with <command>screen</command></title>
      <para>
	If you choose to use inline tags inside a
	<command>&lt;screen&gt;</command> section, follow these guidelines for
	consistency. If the content in the screen is a listing of a
	configuration file or the output of a program, use the
	<command>&lt;computeroutput&gt;</command> tag set around the entire
	output. If the user should type the example on the command line or in
	a configuration file, use the <command>&lt;userinput&gt;</command> tag
	set. Separate input and output with a short sentence of narrative, as
	below:
      </para>

<screen>
	<command>&lt;para&gt;</command>
	  Type the following command:
	<command>&lt;/para&gt;</command>

<command>&lt;screen&gt;</command>
<command>&lt;userinput&gt;</command>command -sw file1<command>&lt;/userinput&gt;</command>
<command>&lt;/screen&gt;</command>

	<command>&lt;para&gt;</command>
	  You should see the following output:
	<command>&lt;/para&gt;</command>

<command>&lt;screen&gt;</command>
<command>&lt;computeroutput&gt;</command>Completed, time = 0.12 sec<command>&lt;/computeroutput&gt;</command>
<command>&lt;/screen&gt;</command>
</screen>

	<para>
	  The output looks like:
	</para>

	<para>
	  Type the following command:
	</para>

<screen>
<userinput>command -sw file1</userinput>
</screen>

	<para>
	  You should see the following output:
	</para>

<screen>
<computeroutput>Completed, time = 0.12 sec</computeroutput>
</screen>

	<note>
	  <title>Note</title>
	  <para>
	    When showing a command or series of commands inside
	    <command>screen</command> tags, do not show the prompt.
	  </para>
	</note>

	<para>
	  If the <command>&lt;screen&gt;</command> shows the reader how to
	  change only <emphasis>part</emphasis> of a line, mark the change with
	  an inline <command>&lt;userinput&gt;</command> tag set. You may use
	  the <command>&lt;userinput&gt;</command> tag set inside a larger area
	  that is already marked inline with
	  <command>&lt;computeroutput&gt;</command>. Do not include any extra
	  lines of context in this case, unless excluding them would confuse the
	  reader. The following example illustrates these guidelines:
	</para>

<screen>
	<command>&lt;para&gt;</command>
	  Edit the <command>&lt;filename&gt;</command>/etc/sysconfig/init<command>&lt;/filename&gt;</command> file as follows:
	<command>&lt;/para&gt;</command>

<command>&lt;screen&gt;</command>
GRAPHICAL=<command>&lt;userinput&gt;</command>yes<command>&lt;/userinput&gt;</command> 
<command>&lt;/screen&gt;</command>
</screen>

	<para>
  	The output looks like:
	</para>

	<para>
	  Edit the <filename>/etc/sysconfig/init</filename> file as follows:
	</para>

<screen>
GRAPHICAL=<userinput>yes</userinput>
</screen>

	<para>
	  For an explanation of how to use the <command>replaceable</command>
	  tags within a set of <command>screen</command> tags, refer to <xref
	  linkend="sn-xml-tags-replaceable"></xref>.
	</para>

      </section>
    </section>

      <section id="sn-xml-tags-sections">
	<title>Sections</title>

	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>sections</secondary>
	</indexterm>

	<indexterm>
	  <primary>sections</primary>
	</indexterm>

    <para>Within an article (or chapter if it is a DocBook XML book like the
	<citetitle>&IG;</citetitle>), you can have sections and
	subsections. <command>&lt;section&gt;</command> is always the highest
	section and you cannot have two sections of the same level within one
	another (a section 2 can be created within a section 1, but section 1
	has to be closed before another section 1 can be created). The general
	layout follows:</para>
	  
<screen>
<computeroutput>
&lt;section id="sn-uniquename"&gt;
  &lt;title&gt;Insert Title Here&lt;/title&gt;
  &lt;para&gt;
    Body text goes here.
  &lt;/para&gt;


  &lt;section id="sn-uniquename"&gt;
    &lt;title&gt;Insert Title Here&lt;/title&gt;
    &lt;para&gt;
      Body text goes here.
    &lt;/para&gt;

    &lt;sect3 id="s3-uniquename"&gt;
      &lt;title&gt;Insert Title Here&lt;/title&gt;
      &lt;para&gt;
        Body text goes here.
      &lt;/para&gt;

    &lt;/sect3&gt;

  &lt;/section&gt;

&lt;/section&gt;
</computeroutput>
</screen>
    
      <para>
	If you only need one level of sections in a DocBook article, you can use
	the <command>section</command> tag. For example:
      </para>

<screen>
<computeroutput>
&lt;section id="sn-uniquename"&gt;
  &lt;title&gt;Insert Title Here&lt;/title&gt;
  &lt;para&gt;
    Body text goes here.
  &lt;/para&gt;
&lt;/section&gt;
&lt;section id="sn-anothername"&gt;
  &lt;title&gt;Insert Title Here&lt;/title&gt;
  &lt;para&gt;
    More body text goes here.
  &lt;/para&gt;
&lt;/section&gt;
</computeroutput>
</screen>
    </section>

    <section id="sn-xml-tags-table">
      <title><command>table</command></title>
      
      <indexterm>
	<primary>XML tags</primary>
	<secondary>table</secondary>
      </indexterm>
      
      <para>
	The following is an example of creating a table. 
      </para>

<screen>
&lt;table id="tb-mockup-before-begin"&gt;
   <emphasis>This tells XML that you will be creating a table
             and the ID name is <command>"tb-mockup-before-begin."</command></emphasis>

&lt;title&gt;Available Features of GNOME and KDE&lt;/title&gt;

&lt;tgroup cols="3"&gt;
    <emphasis>This tells XML that you are creating a table
              with three columns.</emphasis>

&lt;colspec colnum="1" colname="Features" colwidth="3"/&gt;
    <emphasis><command>colspec</command> says that you are giving information
    about the column to XML</emphasis> <emphasis><command>colnum="1"</command>
    says that you are giving specifications for the first column.</emphasis>
    
    <emphasis><command>colname="Features"</command> says that the title for this
    column will be "Features."</emphasis>
    
    <emphasis><command>colwidth="3"</command> specifies the width of the
    column. This can be more tricky: such as two columns with 
    widths of 1 and 2,the 1 is one-half the width of the 2, in 
    respect to the page size. But, what if you need the 1 to be a 
    little more than half of the 2, using a larger number ratio, 
    such as 10 to 20 would accomplish this. You could then change the
    10 to an 11 or a 12 to make it a little more than half of the 
    second column of 20. In no value is given, a value of 1 is 
	  assumed.</emphasis>

&lt;colspec colnum="2" colname="GNOME" colwidth="2"/&gt;
&lt;colspec colnum="3" colname="KDE" colwidth="2"/&gt;

&lt;thead&gt;
    <emphasis>Contains one or more table row elements.</emphasis>

&lt;row&gt; 
   <emphasis>Contains one or more table cell (entry) elements.</emphasis>

&lt;entry&gt;Features&lt;/entry&gt;
   <emphasis>Table cell element, one of several in a row element, defining
   columns within the row.</emphasis>

&lt;entry&gt;GNOME&lt;/entry&gt; 
&lt;entry&gt;KDE&lt;/entry&gt;
&lt;/row&gt; 
&lt;/thead&gt; 

&lt;tbody&gt; 
   <emphasis>Contains one or more row elements, for the main text 
   of the table.</emphasis>

&lt;row&gt; 
&lt;entry&gt;highly configurable&lt;/entry&gt; 
&lt;entry&gt;yes&lt;/entry&gt; 
&lt;entry&gt;yes&lt;/entry&gt; 
&lt;/row&gt; 
&lt;row&gt; 
&lt;entry&gt;multiple window managers &lt;/entry&gt;
&lt;entry&gt;yes&lt;/entry&gt; 
&lt;entry&gt;yes&lt;/entry&gt; 
&lt;/row&gt; 
&lt;row&gt; 
&lt;entry&gt;Internet applications&lt;/entry&gt; 
&lt;entry&gt;yes &lt;/entry&gt; 
&lt;entry&gt;yes &lt;/entry&gt; 
&lt;/row&gt; 
&lt;/tbody&gt; 
&lt;/tgroup&gt; 
&lt;/table&gt; 
</screen>

      <table id="tb-mockup-before-begin"> 
	<title>Available Features of GNOME and KDE</title> 

	<tgroup cols="3"> 
	  <colspec colnum="1" colname="Features" colwidth="3"/> 
	  <colspec colnum="2" colname="GNOME" colwidth="2"/> 
	  <colspec colnum="3" colname="KDE" colwidth="2"/> 
	  
	  <thead> 
	    <row> 
	      <entry>Features </entry> 
	      <entry>GNOME</entry> 
	      <entry>KDE</entry> 
	    </row> 
	  </thead> 
	  
	  <tbody> 
	    <row> 
	      <entry>highly configurable</entry> 
	      <entry>yes</entry> 
	      <entry>yes</entry> 
	    </row> 
	    <row> 
	      <entry>multiple window managers </entry>
	      <entry>yes</entry> 
	      <entry>yes</entry> 
	    </row> 
	    <row> 
	      <entry>Internet applications</entry> 
	      <entry>yes </entry> 
	      <entry>yes </entry> 
	    </row> 
	  </tbody> 
	</tgroup> 
      </table> 
      
      <section id="sn-xml-tags-listintable">
	<title>Creating a List Within a Table</title>
	
	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>table</secondary>
	  <tertiary>list within a table</tertiary>
	</indexterm>


	<para>Creating a list within a table can be a difficult task. It
	  requires strict formatting and a set of commands that are not
	  available for command completion in
	  <application>Emacs</application>.</para>
	
	<para>The tags you will need to use are
	  <command>&lt;simplelist&gt;</command> and
	  <command>&lt;member&gt;</command>.</para>
	
	<para>The following example will show you the proper formatting for
	  creating a list within a table.</para>
	

<screen>
<computeroutput>
&lt;table id="tb-hardware-powerswitch"&gt;
  &lt;title&gt;Power Switch Hardware Table&lt;/title&gt;
    &lt;tgroup cols="4"&gt;
      &lt;colspec colnum="1" colname="Hardware" colwidth="2"/&gt;
      &lt;colspec colnum="2" colname="Quantity" colwidth="2"/&gt;
      &lt;colspec colnum="3" colname="Description" colwidth="6"/&gt; 
      &lt;colspec colnum="4" colname="Required" colwidth="2"/&gt;

       &lt;thead&gt;
	 &lt;row&gt;
           &lt;entry&gt;Hardware&lt;/entry&gt;
	   &lt;entry&gt;Quantity&lt;/entry&gt;
           &lt;entry&gt;Description&lt;/entry&gt;
	   &lt;entry&gt;Required&lt;/entry&gt;
	 &lt;/row&gt;
       &lt;/thead&gt;
	    
       &lt;tbody&gt;
	      
	&lt;row&gt;
          &lt;entry&gt;Serial power switches&lt;/entry&gt;

	  &lt;entry&gt;Two&lt;/entry&gt;

	  &lt;entry&gt;&lt;simplelist&gt; &lt;member&gt;Power switches enable each cluster system
	   to power-cycle the other cluster system. Note that clusters are
	   configured with either serial or network attached power switches and
	   not both.&lt;/member&gt;
		      
               &lt;member&gt;The following serial attached power switch has been
	       fully tested:&lt;/member&gt;

               &lt;member&gt;RPS-10 (model M/HD in the US, and model M/EC in
	       Europe) &lt;/member&gt;

               &lt;member&gt;Latent support is provided for the following serial
	       attached power switch.  This switch has not yet been fully
               tested:&lt;/member&gt;
		  
	       &lt;member&gt;APC Serial On/Off Switch (partAP9211), &lt;ulink
               url="http://www.apc.com/"&gt;http://www.apc.com/&lt;/ulink&gt;&lt;/member&gt;
               &lt;/simplelist&gt;&lt;/entry&gt;

           &lt;entry&gt;Strongly recommended for data integrity under all failure
	   conditions&lt;/entry&gt;

	 &lt;/row&gt;
     &lt;/tbody&gt;
  &lt;/tgroup&gt;
&lt;/table&gt;
</computeroutput>
</screen>

	<para>Notice how the <command>&lt;simplelist&gt;</command> tag must be
	  beside the <command>&lt;entry&gt;</command> tag? If you do not format
	  this properly, it will not parse cleanly.</para>
	
	<para>The above example will look like the following:</para>
	  
	<table id="tb-hardware-powerswitch">
	  <title>Power Switch Hardware Table</title>
	  <tgroup cols="4">
	    <colspec colnum="1" colname="Hardware" colwidth="2"/>
	    <colspec colnum="2" colname="Quantity" colwidth="2"/>
	    <colspec colnum="3" colname="Description" colwidth="6"/> 
	    <colspec colnum="4" colname="Required" colwidth="2"/>
	    
	    <thead>
	      <row>
		<entry>Hardware</entry>
		<entry>Quantity</entry>
		<entry>Description</entry>
		<entry>Required</entry>
	      </row>
	    </thead>
	    
	    <tbody>
	      
	      <row>
		<entry>Serial power switches</entry>
		
		<entry>Two</entry>
		  
		<entry><simplelist> <member>Power switches enable each cluster
		      system to power-cycle the other cluster system. Note
		      that clusters are configured with either serial or
		      network attached power switches and not both.</member>
		    
		    <member>The following serial attached power switch has been
		      fully tested:</member>
		    
		    <member>RPS-10 (model M/HD in the US, and model M/EC in
		      Europe) </member>
		    
		    <member>Latent support is provided for the following
		      serial attached power switch.  This switch has not yet
		      been fully tested:</member>
		    
		    <member>APC Serial On/Off Switch (partAP9211), <ulink
			url="http://www.apc.com/">http://www.apc.com/</ulink></member>
		  </simplelist></entry>
		
		<entry>Strongly recommended for data integrity under all failure
		  conditions</entry>
		
	      </row>
	    </tbody>
	  </tgroup>
	</table>
	
      </section>
      
    </section>

    <section id="sn-xml-tags-trademark">
      <title><command>trademark</command></title>

      <indexterm>
	<primary>XML tags</primary>
	<secondary><command>trademark</command></secondary>
      </indexterm>


      <para>Do not use the trademark entities &amp;trade;, &amp;copy;, or
	&amp;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
	associates classes as follows:
      </para>

<screen>
<computeroutput>
&lt;trademark&gt;trademark symbol after me&lt;/trademark&gt;
&lt;trademark class="registered"&gt;registered trademark symbol after me&lt;/trademark&gt;
&lt;trademark class="copyright"&gt;copyright symbol after me&lt;/trademark&gt;
</computeroutput>
</screen>
      
    </section>
    
    <section id="sn-xml-tags-userinput">
      <title><command>userinput</command></title>

      <indexterm>
	<primary>XML tags</primary>
	<secondary><command>userinput</command></secondary>
      </indexterm>
      
      <para>
	To show what a user would type, use the <command>userinput</command>
	tag. For example:
      </para>
<screen>
<computeroutput>
At the prompt, type:

&lt;userinput&gt;dd if=boot.img of=/dev/fd0 bs=1440k&lt;/userinput&gt;
</computeroutput>
</screen>

      <para>
	The output:
      </para>

      <para>
	At the prompt, type:
      </para>

      <para>
	<userinput>dd if=boot.img of=/dev/fd0 bs=1440k</userinput>
      </para>
    </section>


<!--      <section id="sn-xml-tags-mouse">
	<title><command>mousebutton</command></title>

	<indexterm>
	  <primary>XML tags</primary>
	  <secondary>mousebutton</secondary>
	</indexterm>
	<para>
Describe mouse actions with the mousebutton tag. Below is an example of its use.
</para>

<screen>
&lt;mousebutton&gt;Right click&lt;/mousebutton&gt; on the image and a new menu will appear.
</screen>

	<para>
<mousebutton>Right click</mousebutton> on the image and a new menu will appear.
 </para>

      </section> -->

    <section id="sn-xml-tag-sulink">
      <title><command>ulink</command></title>
      
      <indexterm>
	<primary>XML tags</primary>
	<secondary>ulink</secondary>
      </indexterm>
      
      <para>
	To create a URL link within your text, use the following example:
      </para>
<screen>
<computeroutput>
Online &amp;mdash; &lt;ulink url="http://www.redhat.com/support/errata/"&gt;
http://www.redhat.com/support/errata/&lt;/ulink&gt;; supplies errata 
you can read online, and you can download diskette images easily.
</computeroutput>
</screen>

      <para>
	The output:
      </para>

      <para>
	Online &mdash; <ulink url="http://www.redhat.com/support/errata/">
	  http://www.redhat.com/support/errata/</ulink>; supplies errata 
	you can read online, and you can download diskette images easily.
      </para>

      <note>
	<title>Note</title>
	<para>
	  If the URL does not end in a filename, it must end in a slash
	  (<computeroutput>/</computeroutput>) to be a properly formed URL. For
	  example, <ulink
	  url="http://www.redhat.com/">http://www.redhat.com/</ulink>.
	</para>
      </note>

    </section>
    
    <section id="sn-xml-tags-wordasword">
      <title><command>wordasword</command></title>
      
      <indexterm>
	<primary>XML tags</primary>
	<secondary>wordasword</secondary>
      </indexterm>
      
      <para>The &lt;wordasword&gt; tag set is used to define a word meant
	specifically as a word and not representing anything else.</para>
      
      <para>A lot of technical documentation contains words that have overloaded
	meanings. Sometimes it is useful to be able to use a word without invoking
	its technical meaning. The &lt;wordasword&gt; element identifies a word or
	phrase that might otherwise be interpreted in some specific way, and
	asserts that it should be interpreted simply as a word.</para>
      
      <para>It is unlikely that the presentation of this element will be able to
	help readers understand the variation in meaning; good writing will have
	to achieve that goal. The real value of &lt;wordasword&gt; lies in the
	fact that full-text searching and indexing tools can use it to avoid
	false-positives.</para>
      
      <para>For example:</para>

<screen>	
<computeroutput>To use &lt;command&gt;grep&lt;/command&gt; to search for the word
&lt;wordasword&gt;linux&lt;/wordasword&gt;, use the command 
&lt;command&gt;grep linux&lt;/command&gt;.</computeroutput>
</screen>

      <para>
	The output:
      </para>

      <para>To use <command>grep</command> to search for the word
	<wordasword>linux</wordasword>, use the command <command>grep
	  linux</command>.</para>
      
      <para>In the example, the word "linux" is just a word. It is not
	meant to convey anything about Linux as a subject, or to add relevance or
	meaning to the content. It can be replaced with any other word without
	losing any of the context.</para>
      
    </section>
    

    <section id="sn-xml-tags-xref">
      <title><command>xref</command></title>
      
      <indexterm>
	<primary>XML tags</primary>
	<secondary>xref</secondary>
      </indexterm>
      
      <para>
	To refer to other sections or chapters within a manual, use the
	<command>&lt;xref&gt;</command> tag.
      </para>

      <para>
	The output of this displays the title of the section or chapter you are
	pointing the user to. For example:
      </para>
<screen>
<computeroutput>
For more information about the parent file, refer to
&lt;xref linkend="ch-tutorial"&gt;&lt;/xref&gt; and &lt;xref linkend="sn-tutorial-parent"&gt;&lt;/xref&gt;
</computeroutput>
</screen>

      <para>
	The output:
      </para>

      <para>
	For more information about the parent file, refer to <xref linkend="ch-tutorial"></xref>
	and <xref linkend="sn-tutorial-parent"></xref>.
      </para>
    </section>

  </chapter>

<!--
Local variables:
mode: xml
fill-column: 72
End:
-->