web/html/participate/documentation-guide acknowledgments.php, 1.3, 1.4 ch-converting.php, 1.3, 1.4 ch-cvs.php, 1.3, 1.4 ch-emacs-nxml.php, 1.3, 1.4 ch-emacs.php, 1.3, 1.4 ch-getting-files.php, 1.3, 1.4 ch-intro.php, 1.3, 1.4 ch-rh-guidelines.php, 1.3, 1.4 ch-style.php, 1.2, 1.3 ch-tutorial.php, 1.3, 1.4 ch-vim.php, 1.3, 1.4 ch-xml-tags.php, 1.3, 1.4 generated-index.php, 1.3, 1.4 index.php, 1.3, 1.4 ln-legalnotice.php, 1.3, 1.4 s1-diagrams-images.php, 1.3, 1.4 s1-emacs-additional-resources.php, 1.3, 1.4 s1-emacs-basic-commands.php, 1.3, 1.4 s1-emacs-cedfile.php, 1.3, 1.4 s1-emacs-colors.php, 1.3, 1.4 s1-emacs-examples.php, 1.3, 1.4 s1-emacs-loadced.php, 1.3, 1.4 s1-emacs-nxml-additional-resources.php, 1.3, 1.4 s1-emacs-nxml-readme.php, 1.3, 1.4 s1-nxml-examples.php, 1.3, 1.4 s1-screenshots.php, 1.3, 1.4 s1-tutorial-license.php, 1.3, 1.4 s1-vim-additional-resources.php, 1.3, 1.4 s1-vim-keymapping.php, 1.3, 1.4 s1-xml-admon.php, 1.3, 1.4 s1-xml-guidelines-header.php, 1.3, 1.4 s1-xml-tag-sulink.php, 1.3, 1.4 s1-xml-tags-application.! php, 1.3, 1.4 s1-xml-tags-chapter.php, 1.3, 1.4 s1-xml-tags-citetitle.php, 1.3, 1.4 s1-xml-tags-command.php, 1.3, 1.4 s1-xml-tags-compoutput.php, 1.3, 1.4 s1-xml-tags-emphasis.php, 1.3, 1.4 s1-xml-tags-example.php, 1.3, 1.4 s1-xml-tags-figure.php, 1.3, 1.4 s1-xml-tags-filename.php, 1.3, 1.4 s1-xml-tags-firstterm.php, 1.3, 1.4 s1-xml-tags-footnote.php, 1.3, 1.4 s1-xml-tags-gui.php, 1.3, 1.4 s1-xml-tags-indexing.php, 1.3, 1.4 s1-xml-tags-keycap.php, 1.3, 1.4 s1-xml-tags-lists.php, 1.3, 1.4 s1-xml-tags-option.php, 1.3, 1.4 s1-xml-tags-para.php, 1.3, 1.4 s1-xml-tags-part.php, 1.3, 1.4 s1-xml-tags-prompt.php, 1.3, 1.4 s1-xml-tags-replaceable.php, 1.3, 1.4 s1-xml-tags-screen.php, 1.3, 1.4 s1-xml-tags-sections.php, 1.3, 1.4 s1-xml-tags-table.php, 1.3, 1.4 s1-xml-tags-trademark.php, 1.3, 1.4 s1-xml-tags-userinput.php, 1.3, 1.4 s1-xml-tags-wordasword.php, 1.3, 1.4 s1-xml-tags-xref.php, 1.3, 1.4 sn-composition-tips.php, 1.2, 1.3 sn-cvs-config.php, 1.1, 1.2 sn-cvs-cvscommands.php, 1.1, 1.2 sn-cvs-preparation.php, 1.1, 1.2 sn-grammar-and-usage.ph! p,1.2,1.3 sn-tech-docs-fundamentals.php,1.2,1.3 s1-cvs-configu! re.php
Karsten Wade (kwade)
fedora-extras-commits at redhat.com
Mon Sep 19 18:50:51 UTC 2005
- Previous message (by thread): rpms/SDL_ttf/devel .cvsignore, 1.2, 1.3 SDL_ttf.spec, 1.6, 1.7 sources, 1.2, 1.3 SDL_ttf-2.0.6-ft2-build.patch, 1.1, NONE SDL_ttf-2.0.6-openstream.patch, 1.1, NONE
- Next message (by thread): rpms/nexuiz/FC-4 .cvsignore, 1.2, 1.3 nexuiz.spec, 1.3, 1.4 sources, 1.2, 1.3
- Messages sorted by:
[ date ]
[ thread ]
[ subject ]
[ author ]
Author: kwade
Update of /cvs/fedora/web/html/participate/documentation-guide
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv29592
Modified Files:
acknowledgments.php ch-converting.php ch-cvs.php
ch-emacs-nxml.php ch-emacs.php ch-getting-files.php
ch-intro.php ch-rh-guidelines.php ch-style.php ch-tutorial.php
ch-vim.php ch-xml-tags.php generated-index.php index.php
ln-legalnotice.php s1-diagrams-images.php
s1-emacs-additional-resources.php s1-emacs-basic-commands.php
s1-emacs-cedfile.php s1-emacs-colors.php s1-emacs-examples.php
s1-emacs-loadced.php s1-emacs-nxml-additional-resources.php
s1-emacs-nxml-readme.php s1-nxml-examples.php
s1-screenshots.php s1-tutorial-license.php
s1-vim-additional-resources.php s1-vim-keymapping.php
s1-xml-admon.php s1-xml-guidelines-header.php
s1-xml-tag-sulink.php s1-xml-tags-application.php
s1-xml-tags-chapter.php s1-xml-tags-citetitle.php
s1-xml-tags-command.php s1-xml-tags-compoutput.php
s1-xml-tags-emphasis.php s1-xml-tags-example.php
s1-xml-tags-figure.php s1-xml-tags-filename.php
s1-xml-tags-firstterm.php s1-xml-tags-footnote.php
s1-xml-tags-gui.php s1-xml-tags-indexing.php
s1-xml-tags-keycap.php s1-xml-tags-lists.php
s1-xml-tags-option.php s1-xml-tags-para.php
s1-xml-tags-part.php s1-xml-tags-prompt.php
s1-xml-tags-replaceable.php s1-xml-tags-screen.php
s1-xml-tags-sections.php s1-xml-tags-table.php
s1-xml-tags-trademark.php s1-xml-tags-userinput.php
s1-xml-tags-wordasword.php s1-xml-tags-xref.php
sn-composition-tips.php sn-cvs-config.php
sn-cvs-cvscommands.php sn-cvs-preparation.php
sn-grammar-and-usage.php sn-tech-docs-fundamentals.php
Removed Files:
s1-cvs-configure.php s1-cvs-cvscommands.php
Log Message:
Updating Doc Guide to reflect latest CVS information.
Index: ch-cvs.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/ch-cvs.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ch-cvs.php 24 Aug 2005 17:49:48 -0000 1.3
+++ ch-cvs.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -18,7 +18,7 @@
conflicts arise, <span><b class="application">CVS</b></span> lets you know.
<span><b class="application">CVS</b></span> is often used so that programmers can
share code, but it also works well for documentation.
- </p><a class="indexterm" name="id2723389"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-cvs-overview"></a>10.1. How CVS Works</h2></div></div><div></div></div><a class="indexterm" name="id2723406"></a><a class="indexterm" name="id2723419"></a><p>
+ </p><a class="indexterm" name="id2970063"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-cvs-overview"></a>10.1. How CVS Works</h2></div></div><div></div></div><a class="indexterm" name="id2970081"></a><a class="indexterm" name="id2970093"></a><p>
In most cases, each set of files that make up a package or project
is stored as a <i class="firstterm">module</i> on the CVS server.
</p><p>
Index: ch-emacs-nxml.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/ch-emacs-nxml.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ch-emacs-nxml.php 24 Aug 2005 17:49:48 -0000 1.3
+++ ch-emacs-nxml.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 4. Emacs and nXML Mode</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-emacs-additional-resources.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="s1-nxml-examples.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="ch-emacs-nxml"></a>Chapter 4. Emacs and nXML Mode</h2></div></div><div></div></div><a class="indexterm" name="id2701655"></a><a class="indexterm" name="id2701060"></a><a class="indexterm" name="id2701069"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 4. Emacs and nXML Mode</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-emacs-additional-resources.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="s1-nxml-examples.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="ch-emacs-nxml"></a>Chapter 4. Emacs and nXML Mode</h2></div></div><div></div></div><a class="indexterm" name="id2948330"></a><a class="indexterm" name="id2947735"></a><a class="indexterm" name="id2947744"></a><p>
You can also use the nXML mode available for
<span><b class="application">Emacs</b></span> to make it even easier to write in
DocBook XML format. nXML mode provides context-sensitive editing using
@@ -19,7 +19,7 @@
when using it with other documents types. If you keep an eye on the
mailing-list, you can keep up to date with these, as well as ask
questions. For more details, check out <a href="s1-emacs-nxml-readme.php" title="4.4. nXML README File">Section 4.4, “nXML README File”</a>.
- </p></td></tr></table></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-nxml-rpm"></a>4.1. Getting the nXML RPM</h2></div></div><div></div></div><a class="indexterm" name="id2701706"></a><a class="indexterm" name="id2701718"></a><p>
+ </p></td></tr></table></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-nxml-rpm"></a>4.1. Getting the nXML RPM</h2></div></div><div></div></div><a class="indexterm" name="id2948380"></a><a class="indexterm" name="id2948392"></a><p>
To use nXML mode with emacs, you will need to install the nXML RPM
available from <a href="http://people.redhat.com/twaugh/ftp/docbook/nxml-mode/" target="_top">Tim
Waugh's</a> website or the source from <a href="http://www.thaiopensource.com/download/" target="_top">http://www.thaiopensource.com/download/</a>. The
Index: ch-emacs.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/ch-emacs.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ch-emacs.php 24 Aug 2005 17:49:48 -0000 1.3
+++ ch-emacs.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,11 +7,11 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 3. Emacs and PSGML Mode</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-diagrams-images.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="s1-emacs-colors.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="ch-emacs"></a>Chapter 3. Emacs and PSGML Mode</h2></div></div><div></div></div><a class="indexterm" name="id2696736"></a><a class="indexterm" name="id2696745"></a><a class="indexterm" name="id2696754"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 3. Emacs and PSGML Mode</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-diagrams-images.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="s1-emacs-colors.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="ch-emacs"></a>Chapter 3. Emacs and PSGML Mode</h2></div></div><div></div></div><a class="indexterm" name="id2943411"></a><a class="indexterm" name="id2943419"></a><a class="indexterm" name="id2943428"></a><p>
You can use the PSGML mode available for Emacs to make it easier to write
in XML format. PSGML mode provides syntax-highlighting, tag completion,
and more.
- </p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-emacs-file"></a>3.1. Setting Up Your <tt class="filename">.emacs</tt> File</h2></div></div><div></div></div><a class="indexterm" name="id2697359"></a><a class="indexterm" name="id2697372"></a><p>
+ </p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-emacs-file"></a>3.1. Setting Up Your <tt class="filename">.emacs</tt> File</h2></div></div><div></div></div><a class="indexterm" name="id2944034"></a><a class="indexterm" name="id2944046"></a><p>
For Emacs to parse your DocBook documents correctly, you must have a
<tt class="filename">.emacs</tt> file. Cut and paste the following into your
existing <tt class="filename">.emacs</tt> file or create a new one that
Index: ch-getting-files.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/ch-getting-files.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ch-getting-files.php 24 Aug 2005 17:49:48 -0000 1.3
+++ ch-getting-files.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -26,7 +26,8 @@
cd my-fedora-docs
export CVSROOT=:pserver:anonymous at cvs.fedora.redhat.com:/cvs/docs
cvs login
-cvs co docs-setup</tt></b>
+cvs co docs-common
+cvs co example-tutorial</tt></b>
</pre><p>
When you perform an anonymous CVS checkout, you can view the files and
retreive the latest versions. You cannot add (commit) any updates or new
@@ -35,7 +36,7 @@
about getting write access to <span class="abbrev">CVS</span>.
</p><p>
To see a list of the available documents:
- </p><pre class="screen"><tt class="prompt">$ </tt><tt class="command">cvs co -c</tt></pre><p>
+ </p><pre class="screen"><b class="userinput"><tt>cvs co -c</tt></b></pre><p>
Pick your document of interest and then download it to your working directory:
</p><pre class="screen"><b class="userinput"><tt>cvs co example-tutorial</tt></b></pre><p>
Except for the <i class="citetitle">Installation Guide</i>, all documentation in CVS must
Index: ch-rh-guidelines.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/ch-rh-guidelines.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ch-rh-guidelines.php 24 Aug 2005 17:49:48 -0000 1.3
+++ ch-rh-guidelines.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,9 +7,9 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 2. Red Hat Documentation Guidelines</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-getting-files.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-guidelines-header.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="ch-rh-guidelines"></a>Chapter 2. Red Hat Documentation Guidelines</h2></div></div><div></div></div><a class="indexterm" name="id2693597"></a><a class="indexterm" name="id2693609"></a><a class="indexterm" name="id2693554"></a><p>Please read this chapter carefully. This chapter describes the
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 2. Red Hat Documentation Guidelines</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-getting-files.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-guidelines-header.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="ch-rh-guidelines"></a>Chapter 2. Red Hat Documentation Guidelines</h2></div></div><div></div></div><a class="indexterm" name="id2879934"></a><a class="indexterm" name="id2879946"></a><a class="indexterm" name="id2879962"></a><p>Please read this chapter carefully. This chapter describes the
guidelines that must be followed such as naming conventions.
- </p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-guidelines-naming"></a>2.1. ID Naming Conventions</h2></div></div><div></div></div><a class="indexterm" name="id2694083"></a><a class="indexterm" name="id2694095"></a><p>You will see certain ID names referred to below and this will
+ </p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-guidelines-naming"></a>2.1. ID Naming Conventions</h2></div></div><div></div></div><a class="indexterm" name="id2879913"></a><a class="indexterm" name="id2940770"></a><p>You will see certain ID names referred to below and this will
help to explain how we come up with those names. For example:
</p><pre class="screen">
<tt class="computeroutput">
@@ -21,7 +21,7 @@
</tt>
</pre><p>IDs are unique identifiers, allowing DocBook XML to know where to
cross-reference a section or chapter or the like.
- </p><p>The general rules for defining an ID are:</p><a class="indexterm" name="id2694132"></a><a class="indexterm" name="id2694145"></a><div class="itemizedlist"><ul type="disc"><li><p>Keep it 32 characters or under (this is counted as
+ </p><p>The general rules for defining an ID are:</p><a class="indexterm" name="id2940807"></a><a class="indexterm" name="id2940819"></a><div class="itemizedlist"><ul type="disc"><li><p>Keep it 32 characters or under (this is counted as
everything between the quotation marks)</p></li><li><p>Keep it as short and simple as possible</p></li><li><p>Make sure the name is relevant to the information (make it
recognizable)</p></li></ul></div><p>Some examples are <tt class="command">"ch-uniquename"</tt> (with 13
characters) and <tt class="command">"s3-install-make-disks"</tt> (with 21
Index: ch-style.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/ch-style.php,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ch-style.php 24 Aug 2005 17:49:48 -0000 1.2
+++ ch-style.php 19 Sep 2005 18:50:48 -0000 1.3
@@ -35,7 +35,7 @@
Writing well comes naturally to almost no one. It is a skill that
professional writers, even famous ones, must practice constantly.
<i class="firstterm">Style</i>
- <a class="indexterm" name="id2715119"></a> is the quality
+ <a class="indexterm" name="id2961793"></a> is the quality
that separates elegant writing from the merely functional.
</p><p>
Elegance comes in many forms. In prose and poetry, elegant
@@ -55,12 +55,12 @@
idioms, or jargon, a reader or translator may easily become
confused. The following example compares two different written
executions of the same idea:
- </p><div class="example"><a name="id2715658"></a><p>
+ </p><div class="example"><a name="id2962333"></a><p>
So you made the changes I showed you in the last section. What's
the next thing you should do? Just pop your thumb drive onto
your system and read the <tt class="filename">messages</tt> log. When
you see "USB device found," then Bob's your uncle.
- </p><p class="title"><b>Example 8.1. Incorrect style</b></p></div><div class="example"><a name="id2715685"></a><p>
+ </p><p class="title"><b>Example 8.1. Incorrect style</b></p></div><div class="example"><a name="id2962360"></a><p>
After you complete the configuration changes above, attach the
USB removable media to your system. Use the
<tt class="command">dmesg</tt> command to examine the kernel message
Index: ch-vim.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/ch-vim.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ch-vim.php 24 Aug 2005 17:49:48 -0000 1.3
+++ ch-vim.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 5. VIM and DocBook</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-emacs-nxml-readme.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="s1-vim-keymapping.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="ch-vim"></a>Chapter 5. VIM and DocBook</h2></div></div><div></div></div><a class="indexterm" name="id2702650"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 5. VIM and DocBook</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-emacs-nxml-readme.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="s1-vim-keymapping.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="ch-vim"></a>Chapter 5. VIM and DocBook</h2></div></div><div></div></div><a class="indexterm" name="id2949325"></a><p>
VIM has many features to help you write XML content such as DocBook,
including syntax highlighting and customizable key bindings.
Additionally, one can easily use external programs from VIM for features
@@ -15,7 +15,7 @@
This chapter assumes you already know generally how to use VIM; if you
want to learn how, try the <tt class="command">vimtutor</tt> or by typing
<b class="userinput"><tt>:help tutor</tt></b> from inside VIM.
- </p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-vimrc-file"></a>5.1. Setting Up Your <tt class="filename">.vimrc</tt> File</h2></div></div><div></div></div><a class="indexterm" name="id2703266"></a><p>
+ </p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-vimrc-file"></a>5.1. Setting Up Your <tt class="filename">.vimrc</tt> File</h2></div></div><div></div></div><a class="indexterm" name="id2949941"></a><p>
Below is a short sample <tt class="filename">.vimrc</tt> file that turns on
some VIM features useful for editing SGML or XML content such as
DocBook:
Index: ch-xml-tags.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/ch-xml-tags.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ch-xml-tags.php 24 Aug 2005 17:49:48 -0000 1.3
+++ ch-xml-tags.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 6. DocBook XML Tags</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-vim-additional-resources.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-application.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="ch-xml-tags"></a>Chapter 6. DocBook XML Tags</h2></div></div><div></div></div><a class="indexterm" name="id2703080"></a><p>Please read this chapter carefully. This chapter describes the tags
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 6. DocBook XML Tags</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-vim-additional-resources.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-application.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="ch-xml-tags"></a>Chapter 6. DocBook XML Tags</h2></div></div><div></div></div><a class="indexterm" name="id2949754"></a><p>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.
</p><p>If these tags are used appropriately, document searches will provide
@@ -15,7 +15,7 @@
information relevant to the search request. Another benefit is that all
Fedora Project documents will have a similar look and feel (however, they will have
some differences depending upon the output format).
- </p><a class="indexterm" name="id2702909"></a><p>All tags in XML must have an opening and closing tag Additionally,
+ </p><a class="indexterm" name="id2949583"></a><p>All tags in XML must have an opening and closing tag 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.</p><p>Although XML is capable of handling many document types, the format
@@ -26,7 +26,7 @@
<tt class="computeroutput">
<a href="http://www.docbook.org/tdg/en/html/docbook.html" target="_top">http://www.docbook.org/tdg/en/html/docbook.html</a>
</tt>
-</pre><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-caveats"></a>6.1. Tags and Entities Caveats</h2></div></div><div></div></div><a class="indexterm" name="id2704009"></a><p>
+</pre><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-caveats"></a>6.1. Tags and Entities Caveats</h2></div></div><div></div></div><a class="indexterm" name="id2950683"></a><p>
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.
Index: index.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/index.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- index.php 24 Aug 2005 17:49:48 -0000 1.3
+++ index.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Fedora Project Documentation Guide</th></tr><tr><td width="20%" align="left"> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch-intro.php">Next</a></td></tr></table><hr></div><div class="book" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="documentation-guide"></a>Fedora Project Documentation Guide</h1></div><div><h2 class="subtitle">Version 0.2.6.1</h2></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">Tammy</span> <span class="surname">Fox</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Johnray</span> <span class="surname">Fuller</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Sandra</span> <span class="surname">Moore</span></h3></div></div></div><div><p class="copyright">!
Copyright © 2003,2004,2005 Red Hat, Inc., Tammy Fox, Johnray Fuller, Sandra Moore</p></div><div><a href="ln-legalnotice.php">Legal Notice</a></div></div><div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="preface"><a href="ch-intro.php">Introduction</a></span></dt><dt><span class="chapter"><a href="ch-getting-files.php">1. Getting the Files</a></span></dt><dt><span class="chapter"><a href="ch-rh-guidelines.php">2. Red Hat Documentation Guidelines</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch-rh-guidelines.php#s1-xml-guidelines-naming">2.1. ID Naming Conventions</a></span></dt><dt><span class="sect1"><a href="s1-xml-guidelines-header.php">2.2. File Header</a></span></dt><dt><span class="sect1"><a href="s1-xml-admon.php">2.3. Admonitions</a></span></dt><dd><dl><dt><span class="sect2"><a href="s1-xml-admon.php#s2-xml-notesetc">2.3.1. Creating Notes, Tips, Cautions, Importants, and Warnings</a></span></dt></dl></dd><dt><sp!
an class="sect1"><a href="s1-screenshots.php">2.4. Screenshots!
</a></
n></dt><dt><span class="sect1"><a href="s1-diagrams-images.php">2.5. Diagrams and Images</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch-emacs.php">3. Emacs and PSGML Mode</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch-emacs.php#s1-emacs-file">3.1. Setting Up Your .emacs File</a></span></dt><dt><span class="sect1"><a href="s1-emacs-colors.php">3.2. Customizing Emacs</a></span></dt><dt><span class="sect1"><a href="s1-emacs-cedfile.php">3.3. Create Recompiled DTD Subset</a></span></dt><dt><span class="sect1"><a href="s1-emacs-loadced.php">3.4. Load the Parsed DTD</a></span></dt><dt><span class="sect1"><a href="s1-emacs-basic-commands.php">3.5. Basic Emacs Commands</a></span></dt><dt><span class="sect1"><a href="s1-emacs-examples.php">3.6. Examples</a></span></dt><dd><dl><dt><span class="sect2"><a href="s1-emacs-examples.php#s2-emacs-tag-completion">3.6.1. Tag Completion</a></span></dt><dt><span class="sect2"><a href="s1-emacs-examples.php#s2-emacs-ta!
g-closing">3.6.2. Tag Closure</a></span></dt><dt><span class="sect2"><a href="s1-emacs-examples.php#s2-emacs-other">3.6.3. Other Emacs Tasks</a></span></dt></dl></dd><dt><span class="sect1"><a href="s1-emacs-additional-resources.php">3.7. Additional Resources</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch-emacs-nxml.php">4. Emacs and nXML Mode</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch-emacs-nxml.php#s1-nxml-rpm">4.1. Getting the nXML RPM</a></span></dt><dt><span class="sect1"><a href="s1-nxml-examples.php">4.2. Examples</a></span></dt><dd><dl><dt><span class="sect2"><a href="s1-nxml-examples.php#s2-nxml-commands">4.2.1. Commands</a></span></dt></dl></dd><dt><span class="sect1"><a href="s1-emacs-nxml-additional-resources.php">4.3. Additional Resources</a></span></dt><dt><span class="sect1"><a href="s1-emacs-nxml-readme.php">4.4. nXML README File</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch-vim.php">5. VIM and DocBook</a></sp!
an></dt><dd><dl><dt><span class="sect1"><a href="ch-vim.php#s1!
-vimrc
le">5.1. Setting Up Your .vimrc File</a></span></dt><dt><span class="sect1"><a href="s1-vim-keymapping.php">5.2. Keymapping with VIM</a></span></dt><dt><span class="sect1"><a href="s1-vim-additional-resources.php">5.3. Additional VIM Resources</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch-xml-tags.php">6. DocBook XML Tags</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch-xml-tags.php#s1-xml-tags-caveats">6.1. Tags and Entities Caveats</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-application.php">6.2. application</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-chapter.php">6.3. chapter</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-citetitle.php">6.4. citetitle</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-command.php">6.5. command</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-compoutput.php">6.6. computeroutput</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-emphasis.php!
">6.7. emphasis</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-example.php">6.8. example</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-filename.php">6.9. filename</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-firstterm.php">6.10. firstterm</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-footnote.php">6.11. footnote</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-figure.php">6.12. figure</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-gui.php">6.13. GUI Tags</a></span></dt><dd><dl><dt><span class="sect2"><a href="s1-xml-tags-gui.php#s2-xml-tags-guilabel">6.13.1. guilabel</a></span></dt><dt><span class="sect2"><a href="s1-xml-tags-gui.php#s2-xml-tags-guibutton">6.13.2. guibutton</a></span></dt><dt><span class="sect2"><a href="s1-xml-tags-gui.php#s2-xml-tags-guiicon">6.13.3. guiicon</a></span></dt><dt><span class="sect2"><a href="s1-xml-tags-gui.php#s2-xml-tags-guimenu">6.13.4. guimenu and
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Fedora Project Documentation Guide</th></tr><tr><td width="20%" align="left"> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch-intro.php">Next</a></td></tr></table><hr></div><div class="book" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="documentation-guide"></a>Fedora Project Documentation Guide</h1></div><div><h2 class="subtitle">Version 0.2.6.3</h2></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">Tammy</span> <span class="surname">Fox</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Johnray</span> <span class="surname">Fuller</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Sandra</span> <span class="surname">Moore</span></h3></div></div></div><div><p class="copyright">!
Copyright © 2003,2004,2005 Red Hat, Inc., Tammy Fox, Johnray Fuller, Sandra Moore</p></div><div><a href="ln-legalnotice.php">Legal Notice</a></div></div><div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="preface"><a href="ch-intro.php">Introduction</a></span></dt><dt><span class="chapter"><a href="ch-getting-files.php">1. Getting the Files</a></span></dt><dt><span class="chapter"><a href="ch-rh-guidelines.php">2. Red Hat Documentation Guidelines</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch-rh-guidelines.php#s1-xml-guidelines-naming">2.1. ID Naming Conventions</a></span></dt><dt><span class="sect1"><a href="s1-xml-guidelines-header.php">2.2. File Header</a></span></dt><dt><span class="sect1"><a href="s1-xml-admon.php">2.3. Admonitions</a></span></dt><dd><dl><dt><span class="sect2"><a href="s1-xml-admon.php#s2-xml-notesetc">2.3.1. Creating Notes, Tips, Cautions, Importants, and Warnings</a></span></dt></dl></dd><dt><sp!
an class="sect1"><a href="s1-screenshots.php">2.4. Screenshots!
</a></
n></dt><dt><span class="sect1"><a href="s1-diagrams-images.php">2.5. Diagrams and Images</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch-emacs.php">3. Emacs and PSGML Mode</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch-emacs.php#s1-emacs-file">3.1. Setting Up Your .emacs File</a></span></dt><dt><span class="sect1"><a href="s1-emacs-colors.php">3.2. Customizing Emacs</a></span></dt><dt><span class="sect1"><a href="s1-emacs-cedfile.php">3.3. Create Recompiled DTD Subset</a></span></dt><dt><span class="sect1"><a href="s1-emacs-loadced.php">3.4. Load the Parsed DTD</a></span></dt><dt><span class="sect1"><a href="s1-emacs-basic-commands.php">3.5. Basic Emacs Commands</a></span></dt><dt><span class="sect1"><a href="s1-emacs-examples.php">3.6. Examples</a></span></dt><dd><dl><dt><span class="sect2"><a href="s1-emacs-examples.php#s2-emacs-tag-completion">3.6.1. Tag Completion</a></span></dt><dt><span class="sect2"><a href="s1-emacs-examples.php#s2-emacs-ta!
g-closing">3.6.2. Tag Closure</a></span></dt><dt><span class="sect2"><a href="s1-emacs-examples.php#s2-emacs-other">3.6.3. Other Emacs Tasks</a></span></dt></dl></dd><dt><span class="sect1"><a href="s1-emacs-additional-resources.php">3.7. Additional Resources</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch-emacs-nxml.php">4. Emacs and nXML Mode</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch-emacs-nxml.php#s1-nxml-rpm">4.1. Getting the nXML RPM</a></span></dt><dt><span class="sect1"><a href="s1-nxml-examples.php">4.2. Examples</a></span></dt><dd><dl><dt><span class="sect2"><a href="s1-nxml-examples.php#s2-nxml-commands">4.2.1. Commands</a></span></dt></dl></dd><dt><span class="sect1"><a href="s1-emacs-nxml-additional-resources.php">4.3. Additional Resources</a></span></dt><dt><span class="sect1"><a href="s1-emacs-nxml-readme.php">4.4. nXML README File</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch-vim.php">5. VIM and DocBook</a></sp!
an></dt><dd><dl><dt><span class="sect1"><a href="ch-vim.php#s1!
-vimrc
le">5.1. Setting Up Your .vimrc File</a></span></dt><dt><span class="sect1"><a href="s1-vim-keymapping.php">5.2. Keymapping with VIM</a></span></dt><dt><span class="sect1"><a href="s1-vim-additional-resources.php">5.3. Additional VIM Resources</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch-xml-tags.php">6. DocBook XML Tags</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch-xml-tags.php#s1-xml-tags-caveats">6.1. Tags and Entities Caveats</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-application.php">6.2. application</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-chapter.php">6.3. chapter</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-citetitle.php">6.4. citetitle</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-command.php">6.5. command</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-compoutput.php">6.6. computeroutput</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-emphasis.php!
">6.7. emphasis</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-example.php">6.8. example</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-filename.php">6.9. filename</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-firstterm.php">6.10. firstterm</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-footnote.php">6.11. footnote</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-figure.php">6.12. figure</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-gui.php">6.13. GUI Tags</a></span></dt><dd><dl><dt><span class="sect2"><a href="s1-xml-tags-gui.php#s2-xml-tags-guilabel">6.13.1. guilabel</a></span></dt><dt><span class="sect2"><a href="s1-xml-tags-gui.php#s2-xml-tags-guibutton">6.13.2. guibutton</a></span></dt><dt><span class="sect2"><a href="s1-xml-tags-gui.php#s2-xml-tags-guiicon">6.13.3. guiicon</a></span></dt><dt><span class="sect2"><a href="s1-xml-tags-gui.php#s2-xml-tags-guimenu">6.13.4. guimenu and
guimenuitem</a></span></dt></dl></dd><dt><span class="sect1"><a href="s1-xml-tags-keycap.php">6.14. keycap</a></span></dt><dd><dl><dt><span class="sect2"><a href="s1-xml-tags-keycap.php#s2-xml-tags-menuchoice">6.14.1. menuchoice</a></span></dt><dt><span class="sect2"><a href="s1-xml-tags-keycap.php#s2-xml-tags-keycombo">6.14.2. keycombo</a></span></dt></dl></dd><dt><span class="sect1"><a href="s1-xml-tags-lists.php">6.15. Lists</a></span></dt><dd><dl><dt><span class="sect2"><a href="s1-xml-tags-lists.php#s2-xml-tags-itemizedlist">6.15.1. itemizedlist</a></span></dt><dt><span class="sect2"><a href="s1-xml-tags-lists.php#s2-xml-tags-orderedlist">6.15.2. OrderedList</a></span></dt><dt><span class="sect2"><a href="s1-xml-tags-lists.php#s2-xml-tags-varlist">6.15.3. Variablelist</a></span></dt><dt><span class="sect2"><a href="s1-xml-tags-lists.php#s2-xml-tags-simplelist">6.15.4. Creating a List Within a Table Using Simplelist</a></span></dt><dt><span class="sect2"><a href="s1-!
xml-tags-lists.php#s2-xml-tags-glossary">6.15.5. glosslist</a></span></dt></dl></dd><dt><span class="sect1"><a href="s1-xml-tags-option.php">6.16. option</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-indexing.php">6.17. Index Entries</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-para.php">6.18. para</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-part.php">6.19. part</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-prompt.php">6.20. prompt</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-replaceable.php">6.21. replaceable</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-screen.php">6.22. screen</a></span></dt><dd><dl><dt><span class="sect2"><a href="s1-xml-tags-screen.php#s2-xml-tags-screen-inline-tags">6.22.1. Using Inline Tags with screen</a></span></dt></dl></dd><dt><span class="sect1"><a href="s1-xml-tags-sections.php">6.23. Sections</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-table!
.php">6.24. table</a></span></dt><dd><dl><dt><span class="sect!
2"><a
f="s1-xml-tags-table.php#s2-xml-tags-listintable">6.24.1. Creating a List Within a Table</a></span></dt></dl></dd><dt><span class="sect1"><a href="s1-xml-tags-trademark.php">6.25. trademark</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-userinput.php">6.26. userinput</a></span></dt><dt><span class="sect1"><a href="s1-xml-tag-sulink.php">6.27. ulink</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-wordasword.php">6.28. wordasword</a></span></dt><dt><span class="sect1"><a href="s1-xml-tags-xref.php">6.29. xref</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch-tutorial.php">7. The Layout of a Tutorial</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch-tutorial.php#s1-tutorial-parent">7.1. The Parent File</a></span></dt><dt><span class="sect1"><a href="s1-tutorial-license.php">7.2. Including the License Information</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch-style.php">8. Style</a></span></dt><dd><dl><dt><span class!
="section"><a href="ch-style.php#sn-intro-to-style">8.1. Why Style Is Important</a></span></dt><dt><span class="section"><a href="sn-tech-docs-fundamentals.php">8.2. Fundamental Concepts of Technical Documentation</a></span></dt><dd><dl><dt><span class="section"><a href="sn-tech-docs-fundamentals.php#sn-fundamentals-1">8.2.1. General Style Requirements</a></span></dt><dt><span class="section"><a href="sn-tech-docs-fundamentals.php#sn-fundamentals-2">8.2.2. Golden Rules</a></span></dt><dt><span class="section"><a href="sn-tech-docs-fundamentals.php#sn-fundamentals-3">8.2.3. Tone</a></span></dt><dt><span class="section"><a href="sn-tech-docs-fundamentals.php#sn-fundamentals-4">8.2.4. Reaching the Right Audience</a></span></dt><dt><span class="section"><a href="sn-tech-docs-fundamentals.php#sn-fundamentals-6">8.2.5. User Motivation</a></span></dt><dt><span class="section"><a href="sn-tech-docs-fundamentals.php#sn-fundamentals-7">8.2.6. New Users</a></span></dt><dt><span class=!
"section"><a href="sn-tech-docs-fundamentals.php#sn-fundamenta!
ls-8">
.7. Experienced Users</a></span></dt><dt><span class="section"><a href="sn-tech-docs-fundamentals.php#sn-fundamentals-9">8.2.8. Do Not Offend Your Audience</a></span></dt></dl></dd><dt><span class="section"><a href="sn-grammar-and-usage.php">8.3. Grammar and Usage Guidelines</a></span></dt><dt><span class="section"><a href="sn-composition-tips.php">8.4. Composition Tips</a></span></dt><dd><dl><dt><span class="section"><a href="sn-composition-tips.php#sn-misc-active-voice">8.4.1. Active Voice</a></span></dt><dt><span class="section"><a href="sn-composition-tips.php#sn-present-tense">8.4.2. Present Tense</a></span></dt><dt><span class="section"><a href="sn-composition-tips.php#sn-narrative-voice">8.4.3. Narrative Voice</a></span></dt><dt><span class="section"><a href="sn-composition-tips.php#sn-misc-negative">8.4.4. Negative Words</a></span></dt><dt><span class="section"><a href="sn-composition-tips.php#sn-misc-uncertainty">8.4.5. Uncertainty</a></span></dt><dt><span class="se!
ction"><a href="sn-composition-tips.php#sn-misc-offtopic">8.4.6. Redundant Coverage</a></span></dt><dt><span class="section"><a href="sn-composition-tips.php#sn-misc-importance">8.4.7. Self-referential Value Judgments</a></span></dt><dt><span class="section"><a href="sn-composition-tips.php#sn-misc-precision">8.4.8. Precision of Language</a></span></dt><dt><span class="section"><a href="sn-composition-tips.php#sn-misc-docbook-tips">8.4.9. DocBook Tips</a></span></dt><dd><dl><dt><span class="section"><a href="sn-composition-tips.php#sn-misc-admonitions">8.4.9.1. Admonitions</a></span></dt><dt><span class="section"><a href="sn-composition-tips.php#sn-misc-replaceable">8.4.9.2. The replaceable
Tag</a></span></dt><dt><span class="section"><a href="sn-composition-tips.php#sn-misc-entities">8.4.9.3. XML Entities</a></span></dt></dl></dd></dl></dd></dl></dd><dt><span class="chapter"><a href="ch-converting.php">9. Converting to HTML and PDF</a></span></dt><dt><span class="chapter"><a href="ch-cvs.php">10. CVS</a></span></dt><dd><dl><dt><span class="section"><a href="ch-cvs.php#sn-cvs-overview">10.1. How CVS Works</a></span></dt><dt><span class="section"><a href="sn-cvs-preparation.php">10.2. Preparing For CVS Use</a></span></dt><dd><dl><dt><span class="section"><a href="sn-cvs-preparation.php#sn-cvs-rpm-check">10.2.1. Is CVS Installed On Your System</a></span></dt><dt><span class="section"><a href="sn-cvs-preparation.php#sn-cvs-generate-keys">10.2.2. Generating SSH Keys</a></span></dt></dl></dd><dt><span class="section"><a href="sn-cvs-config.php">10.3. Configuring For CVS Access</a></span></dt><dd><dl><dt><span class="section"><a href="sn-cvs-config.php#sn-cvs-con!
fig-cvsrc">10.3.1. Avoiding Repetitive Typing</a></span></dt><dt><span class="section"><a href="sn-cvs-config.php#sn-cvs-config-anon">10.3.2. Configuring for Read-Only CVS Access</a></span></dt><dt><span class="section"><a href="sn-cvs-config.php#sn-cvs-config-author">10.3.3. Configuring Read/Write CVS Access</a></span></dt></dl></dd><dt><span class="section"><a href="sn-cvs-cvscommands.php">10.4. Basic CVS Commands</a></span></dt><dd><dl><dt><span class="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-co">10.4.1. Checking Out Modules</a></span></dt><dd><dl><dt><span class="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-co-branch">10.4.1.1. Checking Out Branches of Modules</a></span></dt></dl></dd><dt><span class="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-up">10.4.2. Updating Files</a></span></dt><dt><span class="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-commit">10.4.3. Committing Files</a></span></dt><dt><span cl!
ass="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscomman!
ds-add
0.4.4. Adding Files</a></span></dt><dt><span class="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-admin">10.4.5. Managing Binary Files</a></span></dt><dt><span class="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-rm">10.4.6. Removing Files</a></span></dt><dt><span class="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-status">10.4.7. Status of Files</a></span></dt><dt><span class="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts">10.4.8. Resolving Conflicts</a></span></dt><dt><span class="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-summary">10.4.9. Summary</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="acknowledgments.php">11. Acknowledgments</a></span></dt><dt><span class="index"><a href="generated-index.php">Index</a></span></dt></dl></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"> </td><td width="2!
0%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch-intro.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"> </td><td width="40%" align="right" valign="top"> Introduction</td></tr></table></div>
Index: ln-legalnotice.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/ln-legalnotice.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ln-legalnotice.php 24 Aug 2005 17:49:48 -0000 1.3
+++ ln-legalnotice.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -26,7 +26,7 @@
They all may be freely redistributed with documentation
produced for the Fedora Project.
</p><p>
- documentation-guide-0.2.6.1 (2005-08-24)
+ documentation-guide-0.2.6.3 (2005-09-18)
</p><p>
Red Hat, Red Hat Network, the Red Hat "Shadow Man" logo, RPM, Maximum RPM, the RPM logo, Linux
Library, PowerTools, Linux Undercover, RHmember, RHmember More, Rough Cuts,
Index: s1-diagrams-images.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-diagrams-images.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-diagrams-images.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-diagrams-images.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.5. Diagrams and Images</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-screenshots.php">Prev</a> </td><th width="60%" align="center">Chapter 2. Red Hat Documentation Guidelines</th><td width="20%" align="right"> <a accesskey="n" href="ch-emacs.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-diagrams-images"></a>2.5. Diagrams and Images</h2></div></div><div></div></div><a class="indexterm" name="id2695589"></a><a class="indexterm" name="id2695598"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.5. Diagrams and Images</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-screenshots.php">Prev</a> </td><th width="60%" align="center">Chapter 2. Red Hat Documentation Guidelines</th><td width="20%" align="right"> <a accesskey="n" href="ch-emacs.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-diagrams-images"></a>2.5. Diagrams and Images</h2></div></div><div></div></div><a class="indexterm" name="id2942263"></a><a class="indexterm" name="id2942272"></a><p>
To be written
</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="s1-screenshots.php">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch-rh-guidelines.php">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch-emacs.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">2.4. Screenshots </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> Chapter 3. Emacs and PSGML Mode</td></tr></table></div>
Index: s1-emacs-colors.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-emacs-colors.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-emacs-colors.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-emacs-colors.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">3.2. Customizing Emacs</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-emacs.php">Prev</a> </td><th width="60%" align="center">Chapter 3. Emacs and PSGML Mode</th><td width="20%" align="right"> <a accesskey="n" href="s1-emacs-cedfile.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-emacs-colors"></a>3.2. Customizing Emacs</h2></div></div><div></div></div><a class="indexterm" name="id2697597"></a><a class="indexterm" name="id2697618"></a><a class="indexterm" name="id2697630"></a><a class="indexterm" name="id2697642"></a><a class="indexterm" name="id2697655"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">3.2. Customizing Emacs</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-emacs.php">Prev</a> </td><th width="60%" align="center">Chapter 3. Emacs and PSGML Mode</th><td width="20%" align="right"> <a accesskey="n" href="s1-emacs-cedfile.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-emacs-colors"></a>3.2. Customizing Emacs</h2></div></div><div></div></div><a class="indexterm" name="id2944271"></a><a class="indexterm" name="id2944292"></a><a class="indexterm" name="id2944304"></a><a class="indexterm" name="id2944317"></a><a class="indexterm" name="id2944329"></a><p>
The colors, font, and geometry (default size of window) for Emacs in your
<tt class="filename">~/.Xresources</tt> file. The format for the settings is
<tt class="computeroutput">emacs.keyword:value</tt>
Index: s1-screenshots.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-screenshots.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-screenshots.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-screenshots.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.4. Screenshots</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-admon.php">Prev</a> </td><th width="60%" align="center">Chapter 2. Red Hat Documentation Guidelines</th><td width="20%" align="right"> <a accesskey="n" href="s1-diagrams-images.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-screenshots"></a>2.4. Screenshots</h2></div></div><div></div></div><a class="indexterm" name="id2694948"></a><a class="indexterm" name="id2694960"></a><a class="indexterm" name="id2694972"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.4. Screenshots</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-admon.php">Prev</a> </td><th width="60%" align="center">Chapter 2. Red Hat Documentation Guidelines</th><td width="20%" align="right"> <a accesskey="n" href="s1-diagrams-images.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-screenshots"></a>2.4. Screenshots</h2></div></div><div></div></div><a class="indexterm" name="id2941622"></a><a class="indexterm" name="id2941635"></a><a class="indexterm" name="id2941647"></a><p>
There are two types of screenshots: graphical and textual. The
philosophy on using these two types is <i class="firstterm">rely on text over
graphics</i>. This means, if you can say it in text instead of
Index: s1-tutorial-license.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-tutorial-license.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-tutorial-license.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-tutorial-license.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">7.2. Including the License Information</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-tutorial.php">Prev</a> </td><th width="60%" align="center">Chapter 7. The Layout of a Tutorial</th><td width="20%" align="right"> <a accesskey="n" href="ch-style.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-tutorial-license"></a>7.2. Including the License Information</h2></div></div><div></div></div><a class="indexterm" name="id2715354"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">7.2. Including the License Information</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-tutorial.php">Prev</a> </td><th width="60%" align="center">Chapter 7. The Layout of a Tutorial</th><td width="20%" align="right"> <a accesskey="n" href="ch-style.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-tutorial-license"></a>7.2. Including the License Information</h2></div></div><div></div></div><a class="indexterm" name="id2962028"></a><p>
All Fedora Project manuals <span class="emphasis"><em>must</em></span> contain the file
<tt class="filename">legalnotice.xml</tt>. This file makes the license for
the file the GNU Free Documentation License (FDL).
Index: s1-xml-admon.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-admon.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-admon.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-admon.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,12 +7,12 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.3. Admonitions</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-guidelines-header.php">Prev</a> </td><th width="60%" align="center">Chapter 2. Red Hat Documentation Guidelines</th><td width="20%" align="right"> <a accesskey="n" href="s1-screenshots.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-admon"></a>2.3. Admonitions</h2></div></div><div></div></div><a class="indexterm" name="id2694540"></a><a class="indexterm" name="id2694549"></a><a class="indexterm" name="id2694562"></a><a class="indexterm" name="id2694574"></a><a class="indexterm" name="id2694586"></a><a class="indexterm" name="id2694599"></a><a class="indexterm" name="id2694611"></a><a class="indexterm" name="id2694627"></a><a class="indexterm" nam!
e="id2694642"></a><a class="indexterm" name="id2694658"></a><a class="indexterm" name="id2694674"></a><p>There are five types of admonitions in DocBook: Caution, Important,
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.3. Admonitions</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-guidelines-header.php">Prev</a> </td><th width="60%" align="center">Chapter 2. Red Hat Documentation Guidelines</th><td width="20%" align="right"> <a accesskey="n" href="s1-screenshots.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-admon"></a>2.3. Admonitions</h2></div></div><div></div></div><a class="indexterm" name="id2941215"></a><a class="indexterm" name="id2941224"></a><a class="indexterm" name="id2941236"></a><a class="indexterm" name="id2941248"></a><a class="indexterm" name="id2941261"></a><a class="indexterm" name="id2941273"></a><a class="indexterm" name="id2941286"></a><a class="indexterm" name="id2941301"></a><a class="indexterm" nam!
e="id2941317"></a><a class="indexterm" name="id2941333"></a><a class="indexterm" name="id2941349"></a><p>There are five types of admonitions in DocBook: Caution, Important,
Note, Tip, and Warning.</p><p>All of the admonitions have the same structure: an optional Title
followed by paragraph-level elements. The DocBook DTD does not impose any
specific semantics on the individual admonitions. For example, DocBook
does not mandate that Warnings be reserved for cases where bodily harm can
- result.</p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-notesetc"></a>2.3.1. Creating Notes, Tips, Cautions, Importants, and Warnings</h3></div></div><div></div></div><a class="indexterm" name="id2694714"></a><a class="indexterm" name="id2694726"></a><a class="indexterm" name="id2694738"></a><a class="indexterm" name="id2694751"></a><a class="indexterm" name="id2694763"></a><p>There are several ways to bring attention to text within a
+ result.</p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-notesetc"></a>2.3.1. Creating Notes, Tips, Cautions, Importants, and Warnings</h3></div></div><div></div></div><a class="indexterm" name="id2941388"></a><a class="indexterm" name="id2941401"></a><a class="indexterm" name="id2941413"></a><a class="indexterm" name="id2941425"></a><a class="indexterm" name="id2941438"></a><p>There are several ways to bring attention to text within a
document. A <span class="emphasis"><em>Note</em></span> is used to bring additional
information to the users' attention. A <span class="emphasis"><em>Tip</em></span> is
used to show the user helpful information or another way to do
Index: s1-xml-tag-sulink.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tag-sulink.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tag-sulink.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tag-sulink.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.27. ulink</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-userinput.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-wordasword.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tag-sulink"></a>6.27. <tt class="command">ulink</tt></h2></div></div><div></div></div><a class="indexterm" name="id2709238"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.27. ulink</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-userinput.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-wordasword.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tag-sulink"></a>6.27. <tt class="command">ulink</tt></h2></div></div><div></div></div><a class="indexterm" name="id2955913"></a><p>
To create a URL link within your text, use the following example:
</p><pre class="screen">
<tt class="computeroutput">
Index: s1-xml-tags-application.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-application.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-application.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-application.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.2. application</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-xml-tags.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-chapter.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-application"></a>6.2. <tt class="command">application</tt></h2></div></div><div></div></div><a class="indexterm" name="id2704278"></a><p>An application is the name of a GUI software program. A command is
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.2. application</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-xml-tags.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-chapter.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-application"></a>6.2. <tt class="command">application</tt></h2></div></div><div></div></div><a class="indexterm" name="id2950952"></a><p>An application is the name of a GUI software program. A command is
the name of an executable (text) program or a software command.</p><p>The <tt class="command"><application></tt> and
<tt class="command"></application></tt> tags allow you to refer to an
application or program. For example, the following XML:
Index: s1-xml-tags-chapter.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-chapter.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-chapter.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-chapter.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.3. chapter</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-application.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-citetitle.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-chapter"></a>6.3. <tt class="command">chapter</tt></h2></div></div><div></div></div><a class="indexterm" name="id2704362"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.3. chapter</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-application.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-citetitle.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-chapter"></a>6.3. <tt class="command">chapter</tt></h2></div></div><div></div></div><a class="indexterm" name="id2951037"></a><p>
A DocBook book can be divided into chapters such as:
</p><pre class="screen">
<tt class="computeroutput">
Index: s1-xml-tags-citetitle.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-citetitle.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-citetitle.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-citetitle.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,10 +7,10 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.4. citetitle</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-chapter.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-command.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-citetitle"></a>6.4. <tt class="command">citetitle</tt></h2></div></div><div></div></div><a class="indexterm" name="id2704443"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.4. citetitle</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-chapter.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-command.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-citetitle"></a>6.4. <tt class="command">citetitle</tt></h2></div></div><div></div></div><a class="indexterm" name="id2951117"></a><p>
The <tt class="command"><citetitle></tt> 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<sup>[<a name="id2704466" href="#ftn.id2704466">1</a>]</sup>
+ defined within your document set, given as an entity<sup>[<a name="id2951140" href="#ftn.id2951140">1</a>]</sup>
).</p><p>
For example:
</p><pre class="screen">
@@ -20,7 +20,7 @@
</pre><p>
The output looks like <i class="citetitle">Installation Guide</i> because &IG; is an
entity.
- </p><div class="footnotes"><br><hr width="100" align="left"><div class="footnote"><p><sup>[<a name="ftn.id2704466" href="#id2704466">1</a>] </sup>An
+ </p><div class="footnotes"><br><hr width="100" align="left"><div class="footnote"><p><sup>[<a name="ftn.id2951140" href="#id2951140">1</a>] </sup>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.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="s1-xml-tags-chapter.php">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch-xml-tags.php">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="s1-xml-tags-command.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">6.3. chapter </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 6.5. command</td></tr></table></div>
Index: s1-xml-tags-command.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-command.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-command.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-command.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.5. command</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-citetitle.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-compoutput.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-command"></a>6.5. <tt class="command">command</tt></h2></div></div><div></div></div><a class="indexterm" name="id2704514"></a><p>An application is the name of a GUI software program. A command is
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.5. command</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-citetitle.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-compoutput.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-command"></a>6.5. <tt class="command">command</tt></h2></div></div><div></div></div><a class="indexterm" name="id2951189"></a><p>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
<tt class="command">command</tt> tags. </p><p>If you have text that is a command, use the
Index: s1-xml-tags-compoutput.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-compoutput.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-compoutput.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-compoutput.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.6. computeroutput</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-command.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-emphasis.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-compoutput"></a>6.6. <tt class="command">computeroutput</tt></h2></div></div><div></div></div><a class="indexterm" name="id2704706"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.6. computeroutput</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-command.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-emphasis.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-compoutput"></a>6.6. <tt class="command">computeroutput</tt></h2></div></div><div></div></div><a class="indexterm" name="id2951380"></a><p>
To show computer output use the following tags:
</p><pre class="screen">
<tt class="computeroutput">
Index: s1-xml-tags-emphasis.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-emphasis.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-emphasis.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-emphasis.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.7. emphasis</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-compoutput.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-example.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-emphasis"></a>6.7. <tt class="command">emphasis</tt></h2></div></div><div></div></div><a class="indexterm" name="id2704763"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.7. emphasis</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-compoutput.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-example.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-emphasis"></a>6.7. <tt class="command">emphasis</tt></h2></div></div><div></div></div><a class="indexterm" name="id2951437"></a><p>
To emphasis content, use the <tt class="command"><emphasis></tt> and
<tt class="command"></emphasis></tt> tags. For example:
</p><pre class="screen">
Index: s1-xml-tags-example.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-example.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-example.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-example.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.8. example</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-emphasis.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-filename.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-example"></a>6.8. <tt class="command">example</tt></h2></div></div><div></div></div><a class="indexterm" name="id2704839"></a><p>The <tt class="command"><example></tt> and
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.8. example</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-emphasis.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-filename.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-example"></a>6.8. <tt class="command">example</tt></h2></div></div><div></div></div><a class="indexterm" name="id2951513"></a><p>The <tt class="command"><example></tt> and
<tt class="command"></example></tt> tags are used to format text within a
document and is great for adding emphasis to show examples of code,
exercises, and more. </p><p>The <tt class="command"><example></tt> tag set should be given an ID
Index: s1-xml-tags-figure.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-figure.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-figure.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-figure.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.12. figure</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-footnote.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-gui.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-figure"></a>6.12. <tt class="command">figure</tt></h2></div></div><div></div></div><a class="indexterm" name="id2705205"></a><div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Important: Important"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="./stylesheet-images/important.png"></td><th align="left">Important</th></tr><tr><td colspan="2" align="lef!
t" valign="top"><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.12. figure</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-footnote.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-gui.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-figure"></a>6.12. <tt class="command">figure</tt></h2></div></div><div></div></div><a class="indexterm" name="id2951880"></a><div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Important: Important"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="./stylesheet-images/important.png"></td><th align="left">Important</th></tr><tr><td colspan="2" align="lef!
t" valign="top"><p>
Order matters! The EPS file <span class="emphasis"><em>must</em></span> be declared
first.
</p></td></tr></table></div><p>
Index: s1-xml-tags-filename.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-filename.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-filename.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-filename.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.9. filename</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-example.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-firstterm.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-filename"></a>6.9. <tt class="command">filename</tt></h2></div></div><div></div></div><a class="indexterm" name="id2704937"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.9. filename</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-example.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-firstterm.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-filename"></a>6.9. <tt class="command">filename</tt></h2></div></div><div></div></div><a class="indexterm" name="id2951611"></a><p>
The <tt class="command"><filename></tt> and
<tt class="command"></filename></tt> tags define a filename or path to a
file. Since directories are just special files, they are marked with the
Index: s1-xml-tags-firstterm.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-firstterm.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-firstterm.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-firstterm.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.10. firstterm</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-filename.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-footnote.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-firstterm"></a>6.10. <tt class="command">firstterm</tt></h2></div></div><div></div></div><a class="indexterm" name="id2705063"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.10. firstterm</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-filename.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-footnote.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-firstterm"></a>6.10. <tt class="command">firstterm</tt></h2></div></div><div></div></div><a class="indexterm" name="id2951738"></a><p>
The <tt class="command"><firstterm></tt> and
<tt class="command"></firstterm></tt> tags helps to define a word that
may be unfamiliar to the user, but that will be seen commonly throughout
Index: s1-xml-tags-footnote.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-footnote.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-footnote.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-footnote.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.11. footnote</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-firstterm.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-figure.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-footnote"></a>6.11. <tt class="command">footnote</tt></h2></div></div><div></div></div><a class="indexterm" name="id2705133"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.11. footnote</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-firstterm.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-figure.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-footnote"></a>6.11. <tt class="command">footnote</tt></h2></div></div><div></div></div><a class="indexterm" name="id2951808"></a><p>
If you need to make a footnote, use the following example:
</p><pre class="screen">
<tt class="computeroutput">
@@ -23,9 +23,9 @@
</pre><p>
The output:
</p><p>
- For those of you who need to perform a server-class <sup>[<a name="id2705176" href="#ftn.id2705176">2</a>]</sup> installation, refer to the
+ For those of you who need to perform a server-class <sup>[<a name="id2951851" href="#ftn.id2951851">2</a>]</sup> installation, refer to the
<i class="citetitle">Installation Guide</i>.
- </p><div class="footnotes"><br><hr width="100" align="left"><div class="footnote"><p><sup>[<a name="ftn.id2705176" href="#id2705176">2</a>] </sup>A
+ </p><div class="footnotes"><br><hr width="100" align="left"><div class="footnote"><p><sup>[<a name="ftn.id2951851" href="#id2951851">2</a>] </sup>A
server-class installation sets up a typical server environment. Please note, no
graphical environment is installed during a server-class installation.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="s1-xml-tags-firstterm.php">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch-xml-tags.php">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="s1-xml-tags-figure.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">6.10. firstterm </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 6.12. figure</td></tr></table></div>
Index: s1-xml-tags-gui.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-gui.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-gui.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-gui.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.13. GUI Tags</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-figure.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-keycap.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-gui"></a>6.13. GUI Tags</h2></div></div><div></div></div><a class="indexterm" name="id2705324"></a><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-tags-guilabel"></a>6.13.1. <tt class="command">guilabel</tt></h3></div></div><div></div></div><a class="indexterm" name="id2705350"></a><a class="indexterm" name="id2705366"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.13. GUI Tags</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-figure.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-keycap.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-gui"></a>6.13. GUI Tags</h2></div></div><div></div></div><a class="indexterm" name="id2951998"></a><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-tags-guilabel"></a>6.13.1. <tt class="command">guilabel</tt></h3></div></div><div></div></div><a class="indexterm" name="id2952025"></a><a class="indexterm" name="id2952041"></a><p>
Use the <tt class="command"><guilabel></tt> and
<tt class="command"></guilabel></tt> tags as a default for GUI
descriptions, like a screen name or screen title. For example:
@@ -21,7 +21,7 @@
</p><p>
The <span><b class="guilabel">Authentication Configuration</b></span> screen shows you how to
make your system more secure.
- </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-tags-guibutton"></a>6.13.2. <tt class="command">guibutton</tt></h3></div></div><div></div></div><a class="indexterm" name="id2705440"></a><a class="indexterm" name="id2705456"></a><p>
+ </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-tags-guibutton"></a>6.13.2. <tt class="command">guibutton</tt></h3></div></div><div></div></div><a class="indexterm" name="id2952115"></a><a class="indexterm" name="id2952130"></a><p>
Use the <tt class="command"><guibutton></tt> and
<tt class="command"></guibutton></tt> tags to denote a button on a screen or
menu. For example:
@@ -35,7 +35,7 @@
</p><p>
Check the <span><b class="guibutton">Activate on boot</b></span> button to have the X
Window System start automatically.
- </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-tags-guiicon"></a>6.13.3. <tt class="command">guiicon</tt></h3></div></div><div></div></div><a class="indexterm" name="id2705529"></a><a class="indexterm" name="id2705545"></a><p>
+ </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-tags-guiicon"></a>6.13.3. <tt class="command">guiicon</tt></h3></div></div><div></div></div><a class="indexterm" name="id2952204"></a><a class="indexterm" name="id2952220"></a><p>
The <tt class="command"><guiicon></tt> and <tt class="command"></guiicon></tt>
tags are used to denote a panel or desktop icon. For example:
</p><pre class="screen">
@@ -47,7 +47,7 @@
</p><p>
Double-click the <span><b class="guiicon">Start Here</b></span> icon on the desktop.
</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-tags-guimenu"></a>6.13.4. <tt class="command">guimenu</tt> and
- <tt class="command">guimenuitem</tt></h3></div></div><div></div></div><a class="indexterm" name="id2705621"></a><a class="indexterm" name="id2705637"></a><a class="indexterm" name="id2705649"></a><a class="indexterm" name="id2705665"></a><p>
+ <tt class="command">guimenuitem</tt></h3></div></div><div></div></div><a class="indexterm" name="id2952295"></a><a class="indexterm" name="id2952311"></a><a class="indexterm" name="id2952324"></a><a class="indexterm" name="id2952339"></a><p>
To note a menu (like in the installation program or within the control panel),
use the <tt class="command"><guimenu></tt> and
<tt class="command"></guimenu></tt> tags.
Index: s1-xml-tags-indexing.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-indexing.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-indexing.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-indexing.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.17. Index Entries</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-option.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-para.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-indexing"></a>6.17. Index Entries</h2></div></div><div></div></div><a class="indexterm" name="id2707390"></a><a class="indexterm" name="id2707399"></a><p>The following command sequence shows you the code inserted into
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.17. Index Entries</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-option.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-para.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-indexing"></a>6.17. Index Entries</h2></div></div><div></div></div><a class="indexterm" name="id2954064"></a><a class="indexterm" name="id2954073"></a><p>The following command sequence shows you the code inserted into
the body of the text to add an index entry to your document:
</p><pre class="screen">
<tt class="computeroutput">
@@ -16,11 +16,11 @@
<secondary>bar</secondary> <-- "bar" will be listed under "foo"
</indexterm> <-- closes this index entry
</tt>
-</pre><a class="indexterm" name="id2707433"></a><p>The <tt class="command"><seealso></tt> tag allows you to
+</pre><a class="indexterm" name="id2954108"></a><p>The <tt class="command"><seealso></tt> tag allows you to
reference another index entry or refer to another manual. Make sure
the <tt class="command"><seealso></tt> reference you are pointing to
has its own entry. For example:
- </p><a class="indexterm" name="id2707464"></a><pre class="screen">
+ </p><a class="indexterm" name="id2954138"></a><pre class="screen">
<tt class="computeroutput">
<indexterm>
<primary>SWAK</primary>
@@ -32,10 +32,10 @@
<primary>salutations</primary>
</indexterm>
</tt>
-</pre><a class="indexterm" name="id2707490"></a><a class="indexterm" name="id2707503"></a><p>
+</pre><a class="indexterm" name="id2954165"></a><a class="indexterm" name="id2954177"></a><p>
The <tt class="command"><see></tt> tag allows you to reference to
another index entry entirely. For example:
- </p><a class="indexterm" name="id2707522"></a><pre class="screen">
+ </p><a class="indexterm" name="id2954197"></a><pre class="screen">
<tt class="computeroutput">
<indexterm>
<primary>Guinness</primary>
@@ -48,7 +48,7 @@
<primary>beer</primary>
</indexterm>
</tt>
-</pre><a class="indexterm" name="id2707552"></a><a class="indexterm" name="id2707565"></a><p>To view the HTML output of the index entries shown here, refer
+</pre><a class="indexterm" name="id2954227"></a><a class="indexterm" name="id2954239"></a><p>To view the HTML output of the index entries shown here, refer
to the <tt class="filename">generated-index.php</tt> file at the end of
this document.</p><p>How does the index get generated? If indexterms exist in the
document and the beginning and ending index tags exist before the end
Index: s1-xml-tags-keycap.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-keycap.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-keycap.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-keycap.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.14. keycap</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-gui.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-lists.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-keycap"></a>6.14. <tt class="command">keycap</tt></h2></div></div><div></div></div><a class="indexterm" name="id2705776"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.14. keycap</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-gui.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-lists.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-keycap"></a>6.14. <tt class="command">keycap</tt></h2></div></div><div></div></div><a class="indexterm" name="id2952451"></a><p>
To denote a specific key, you will need to use the
<tt class="command"><keycap></tt> and <tt class="command"></keycap></tt>
tags. Brackets are automatically added around the keycap, so do not add
@@ -20,7 +20,7 @@
The output:
</p><p>
To make your selection, press the <span><b class="keycap">Enter</b></span> key.
- </p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-tags-menuchoice"></a>6.14.1. <tt class="command">menuchoice</tt></h3></div></div><div></div></div><a class="indexterm" name="id2705847"></a><p>
+ </p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-tags-menuchoice"></a>6.14.1. <tt class="command">menuchoice</tt></h3></div></div><div></div></div><a class="indexterm" name="id2952521"></a><p>
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
@@ -42,7 +42,7 @@
</p><p>
Go to the menu bar and choose:
<span><b class="guimenu"><span class="accel">F</span>ile</b></span>-><span><b class="guimenuitem"><span class="accel">S</span>ave</b></span> (<span><b class="shortcut"><span><b class="keycap">Ctrl</b></span>-<span><b class="keycap">s</b></span></b></span>).
- </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-tags-keycombo"></a>6.14.2. <tt class="command">keycombo</tt></h3></div></div><div></div></div><a class="indexterm" name="id2703903"></a><p>
+ </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-tags-keycombo"></a>6.14.2. <tt class="command">keycombo</tt></h3></div></div><div></div></div><a class="indexterm" name="id2950577"></a><p>
To illustrate a key combination, you need to use the
<tt class="command"><keycombo></tt> and
<tt class="command"></keycombo></tt>,
Index: s1-xml-tags-lists.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-lists.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-lists.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-lists.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,11 +7,11 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.15. Lists</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-keycap.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-option.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-lists"></a>6.15. Lists</h2></div></div><div></div></div><a class="indexterm" name="id2706176"></a><p>There are several types of lists you can create using XML. You
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.15. Lists</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-keycap.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-option.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-lists"></a>6.15. Lists</h2></div></div><div></div></div><a class="indexterm" name="id2952850"></a><p>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).</p><p>There is also a list format for tables and for for creating a
list of glossary terms and their definitions.</p><p>The sections below will discuss the proper uses for the various
- list and how to create them.</p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-tags-itemizedlist"></a>6.15.1. <tt class="command">itemizedlist</tt></h3></div></div><div></div></div><a class="indexterm" name="id2706218"></a><a class="indexterm" name="id2706234"></a><a class="indexterm" name="id2706250"></a><p>An <tt class="command">ItemizedList</tt> is best used to present
+ list and how to create them.</p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-tags-itemizedlist"></a>6.15.1. <tt class="command">itemizedlist</tt></h3></div></div><div></div></div><a class="indexterm" name="id2952893"></a><a class="indexterm" name="id2952909"></a><a class="indexterm" name="id2952925"></a><p>An <tt class="command">ItemizedList</tt> 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
<tt class="command">VariableList</tt> and presents the information in a
@@ -38,7 +38,7 @@
</listitem>
</itemizedlist>
</tt>
-</pre><p>The output looks like:</p><div class="itemizedlist"><ul type="disc"><li><p>Getting familiar with the installation program's user interface</p></li><li><p>Starting the installation program</p></li><li><p>Selecting an installation method</p></li></ul></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-tags-orderedlist"></a>6.15.2. <tt class="command">OrderedList</tt></h3></div></div><div></div></div><a class="indexterm" name="id2706382"></a><a class="indexterm" name="id2706398"></a><a class="indexterm" name="id2706414"></a><p>An <tt class="command">orderedlist</tt> is best used to present
+</pre><p>The output looks like:</p><div class="itemizedlist"><ul type="disc"><li><p>Getting familiar with the installation program's user interface</p></li><li><p>Starting the installation program</p></li><li><p>Selecting an installation method</p></li></ul></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-tags-orderedlist"></a>6.15.2. <tt class="command">OrderedList</tt></h3></div></div><div></div></div><a class="indexterm" name="id2953057"></a><a class="indexterm" name="id2953072"></a><a class="indexterm" name="id2953088"></a><p>An <tt class="command">orderedlist</tt> is best used to present
information that is important for the reader to know in a specific
order. <tt class="command">orderedlist</tt>s are a good way to convey
step-by-step senarios to the audience you are writing for.</p><p>
@@ -82,7 +82,7 @@
errata. Using these URLs, you can download any necessary
diskette images. Please note: use binary mode when transferring
a diskette image.
- </p></li></ol></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-tags-varlist"></a>6.15.3. <tt class="command">Variablelist</tt></h3></div></div><div></div></div><a class="indexterm" name="id2706570"></a><a class="indexterm" name="id2706586"></a><a class="indexterm" name="id2706602"></a><p>A <tt class="command">variablelist</tt> best represents a list of
+ </p></li></ol></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-tags-varlist"></a>6.15.3. <tt class="command">Variablelist</tt></h3></div></div><div></div></div><a class="indexterm" name="id2953245"></a><a class="indexterm" name="id2953260"></a><a class="indexterm" name="id2953276"></a><p>A <tt class="command">variablelist</tt> best represents a list of
terms and definitions or descriptions for those terms.</p><p>To create a <tt class="command">variablelist</tt>, use the following
command sequence:
</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note: Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="./stylesheet-images/note.png"></td><th align="left">Note</th></tr><tr><td colspan="2" align="left" valign="top"><p>Notice below that the text for the list
@@ -125,7 +125,7 @@
Do <span class="emphasis"><em>not</em></span> specify the
<tt class="computeroutput">frame</tt> attribute to the table. Doing
so breaks PDF production.
- </p></td></tr></table></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-tags-simplelist"></a>6.15.4. Creating a List Within a Table Using <tt class="command">Simplelist</tt></h3></div></div><div></div></div><a class="indexterm" name="id2706773"></a><a class="indexterm" name="id2706788"></a><a class="indexterm" name="id2706804"></a><a class="indexterm" name="id2706820"></a><p>A <tt class="command">simplelist</tt> is an unadorned list of
+ </p></td></tr></table></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-tags-simplelist"></a>6.15.4. Creating a List Within a Table Using <tt class="command">Simplelist</tt></h3></div></div><div></div></div><a class="indexterm" name="id2953447"></a><a class="indexterm" name="id2953463"></a><a class="indexterm" name="id2953479"></a><a class="indexterm" name="id2953494"></a><p>A <tt class="command">simplelist</tt> is an unadorned list of
items. <tt class="command">simplelist</tt>s can be inline or arranged in
columns.</p><p>We use <tt class="command">simplelist</tt> to add separate paragraphs
of text within a table element. A regular list, such as
@@ -208,7 +208,7 @@
used. The <entry> and <simplelist> tags must be aligned
beside one another, otherwise you will receive a parsing error.</p></td></tr></table></div><p>For each paragraph or list item to be added within a
<tt class="command">SimpleList</tt>, the <member> tag set must be
- added around that particular text item.</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-tags-glossary"></a>6.15.5. <tt class="command">glosslist</tt></h3></div></div><div></div></div><a class="indexterm" name="id2707144"></a><a class="indexterm" name="id2707160"></a><a class="indexterm" name="id2707176"></a><p>Use the <tt class="command">glosslist</tt> command set to create a
+ added around that particular text item.</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-tags-glossary"></a>6.15.5. <tt class="command">glosslist</tt></h3></div></div><div></div></div><a class="indexterm" name="id2953819"></a><a class="indexterm" name="id2953835"></a><a class="indexterm" name="id2953850"></a><p>Use the <tt class="command">glosslist</tt> command set to create a
list of glossary terms and their definitions.</p><p>In XML, an example looks like the following:</p><pre class="screen">
<tt class="computeroutput">
<glosslist>
Index: s1-xml-tags-option.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-option.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-option.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-option.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.16. option</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-lists.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-indexing.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-option"></a>6.16. <tt class="command">option</tt></h2></div></div><div></div></div><a class="indexterm" name="id2707300"></a><p>If you have a command that offers an option or a flag, use the
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.16. option</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-lists.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-indexing.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-option"></a>6.16. <tt class="command">option</tt></h2></div></div><div></div></div><a class="indexterm" name="id2953974"></a><p>If you have a command that offers an option or a flag, use the
<tt class="command"><option></tt> and
<tt class="command"></option></tt> tags.
</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note: Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="./stylesheet-images/note.png"></td><th align="left">Note</th></tr><tr><td colspan="2" align="left" valign="top"><p>The <option> tag set is only meant to be used for command
Index: s1-xml-tags-para.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-para.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-para.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-para.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.18. para</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-indexing.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-part.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-para"></a>6.18. <tt class="command">para</tt></h2></div></div><div></div></div><a class="indexterm" name="id2707612"></a><p>For any paragraph, the <tt class="command"><para></tt> and
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.18. para</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-indexing.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-part.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-para"></a>6.18. <tt class="command">para</tt></h2></div></div><div></div></div><a class="indexterm" name="id2954287"></a><p>For any paragraph, the <tt class="command"><para></tt> and
<tt class="command"></para></tt> tags must open and close that
particular paragraph.
</p><p>Do not use para tags around anything other than a simple
Index: s1-xml-tags-part.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-part.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-part.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-part.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.19. part</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-para.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-prompt.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-part"></a>6.19. <tt class="command">part</tt></h2></div></div><div></div></div><a class="indexterm" name="id2707732"></a><a class="indexterm" name="id2707741"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.19. part</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-para.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-prompt.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-part"></a>6.19. <tt class="command">part</tt></h2></div></div><div></div></div><a class="indexterm" name="id2954406"></a><a class="indexterm" name="id2954415"></a><p>
In the parent file, you can separate the chapters into parts to divide
them into logical groups. For example, in the parent file, the
<tt class="command">part</tt> tags surround the chapter entities:
Index: s1-xml-tags-prompt.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-prompt.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-prompt.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-prompt.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.20. prompt</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-part.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-replaceable.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-prompt"></a>6.20. <tt class="command">prompt</tt></h2></div></div><div></div></div><a class="indexterm" name="id2707824"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.20. prompt</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-part.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-replaceable.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-prompt"></a>6.20. <tt class="command">prompt</tt></h2></div></div><div></div></div><a class="indexterm" name="id2954498"></a><p>
To show a prompt, such as a root or DOS prompt, use the
<tt class="command"><prompt></tt> and <tt class="command"></prompt></tt>
commands. For example:
Index: s1-xml-tags-replaceable.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-replaceable.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-replaceable.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-replaceable.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.21. replaceable</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-prompt.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-screen.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-replaceable"></a>6.21. <tt class="command">replaceable</tt></h2></div></div><div></div></div><a class="indexterm" name="id2707926"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.21. replaceable</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-prompt.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-screen.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-replaceable"></a>6.21. <tt class="command">replaceable</tt></h2></div></div><div></div></div><a class="indexterm" name="id2954601"></a><p>
To create replaceable text, use the tags
<tt class="command"><replaceable></tt> and
<tt class="command"></replaceable></tt> around the text you want to use as a
Index: s1-xml-tags-screen.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-screen.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-screen.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-screen.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.22. screen</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-replaceable.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-sections.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-screen"></a>6.22. <tt class="command">screen</tt></h2></div></div><div></div></div><a class="indexterm" name="id2708005"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.22. screen</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-replaceable.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-sections.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-screen"></a>6.22. <tt class="command">screen</tt></h2></div></div><div></div></div><a class="indexterm" name="id2954680"></a><p>
The <tt class="command"><screen></tt> 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
Index: s1-xml-tags-sections.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-sections.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-sections.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-sections.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.23. Sections</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-screen.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-table.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-sections"></a>6.23. Sections</h2></div></div><div></div></div><a class="indexterm" name="id2708497"></a><a class="indexterm" name="id2708509"></a><p>Within an article (or chapter if it is a DocBook XML book like the
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.23. Sections</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-screen.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-table.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-sections"></a>6.23. Sections</h2></div></div><div></div></div><a class="indexterm" name="id2955171"></a><a class="indexterm" name="id2955184"></a><p>Within an article (or chapter if it is a DocBook XML book like the
<i class="citetitle">Installation Guide</i>), you can have sections and
subsections. <tt class="command"><sect1></tt> is always the highest
section and you cannot have two sections of the same level within one
Index: s1-xml-tags-table.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-table.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-table.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-table.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.24. table</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-sections.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-trademark.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-table"></a>6.24. <tt class="command">table</tt></h2></div></div><div></div></div><a class="indexterm" name="id2708601"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.24. table</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-sections.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-trademark.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-table"></a>6.24. <tt class="command">table</tt></h2></div></div><div></div></div><a class="indexterm" name="id2955276"></a><p>
The following is an example of creating a table.
</p><pre class="screen">
<table id="tb-mockup-before-begin">
@@ -78,7 +78,7 @@
</tbody>
</tgroup>
</table>
-</pre><div class="table"><a name="tb-mockup-before-begin"></a><table summary="Available Features of GNOME and KDE" border="1"><colgroup><col><col><col></colgroup><thead><tr><th>Features </th><th>GNOME</th><th>KDE</th></tr></thead><tbody><tr><td>highly configurable</td><td>yes</td><td>yes</td></tr><tr><td>multiple window managers </td><td>yes</td><td>yes</td></tr><tr><td>Internet applications</td><td>yes </td><td>yes </td></tr></tbody></table><p class="title"><b>Table 6.2. Available Features of GNOME and KDE</b></p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-tags-listintable"></a>6.24.1. Creating a List Within a Table</h3></div></div><div></div></div><a class="indexterm" name="id2708831"></a><p>Creating a list within a table can be a difficult task. It
+</pre><div class="table"><a name="tb-mockup-before-begin"></a><table summary="Available Features of GNOME and KDE" border="1"><colgroup><col><col><col></colgroup><thead><tr><th>Features </th><th>GNOME</th><th>KDE</th></tr></thead><tbody><tr><td>highly configurable</td><td>yes</td><td>yes</td></tr><tr><td>multiple window managers </td><td>yes</td><td>yes</td></tr><tr><td>Internet applications</td><td>yes </td><td>yes </td></tr></tbody></table><p class="title"><b>Table 6.2. Available Features of GNOME and KDE</b></p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="s2-xml-tags-listintable"></a>6.24.1. Creating a List Within a Table</h3></div></div><div></div></div><a class="indexterm" name="id2955505"></a><p>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
<span><b class="application">Emacs</b></span>.</p><p>The tags you will need to use are
Index: s1-xml-tags-trademark.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-trademark.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-trademark.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-trademark.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.25. trademark</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-table.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-userinput.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-trademark"></a>6.25. <tt class="command">trademark</tt></h2></div></div><div></div></div><a class="indexterm" name="id2709089"></a><p>Do not use the trademark entities ™, ©, or
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.25. trademark</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-table.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-userinput.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-trademark"></a>6.25. <tt class="command">trademark</tt></h2></div></div><div></div></div><a class="indexterm" name="id2955764"></a><p>Do not use the trademark entities ™, ©, or
® 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.</p><p>Instead, use the <tt class="command">trademark</tt> tag and its
Index: s1-xml-tags-userinput.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-userinput.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-userinput.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-userinput.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.26. userinput</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-trademark.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tag-sulink.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-userinput"></a>6.26. <tt class="command">userinput</tt></h2></div></div><div></div></div><a class="indexterm" name="id2709157"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.26. userinput</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-trademark.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tag-sulink.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-userinput"></a>6.26. <tt class="command">userinput</tt></h2></div></div><div></div></div><a class="indexterm" name="id2955832"></a><p>
To show what a user would type, use the <tt class="command">userinput</tt>
tag. For example:
</p><pre class="screen">
Index: s1-xml-tags-wordasword.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-wordasword.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-wordasword.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-wordasword.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.28. wordasword</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tag-sulink.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-xref.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-wordasword"></a>6.28. <tt class="command">wordasword</tt></h2></div></div><div></div></div><a class="indexterm" name="id2709328"></a><p>The <wordasword> tag set is used to define a word meant
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.28. wordasword</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tag-sulink.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="s1-xml-tags-xref.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-wordasword"></a>6.28. <tt class="command">wordasword</tt></h2></div></div><div></div></div><a class="indexterm" name="id2956002"></a><p>The <wordasword> tag set is used to define a word meant
specifically as a word and not representing anything else.</p><p>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 <wordasword> element identifies a word or
Index: s1-xml-tags-xref.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/s1-xml-tags-xref.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- s1-xml-tags-xref.php 24 Aug 2005 17:49:48 -0000 1.3
+++ s1-xml-tags-xref.php 19 Sep 2005 18:50:48 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.29. xref</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-wordasword.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="ch-tutorial.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-xref"></a>6.29. <tt class="command">xref</tt></h2></div></div><div></div></div><a class="indexterm" name="id2709429"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.29. xref</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="s1-xml-tags-wordasword.php">Prev</a> </td><th width="60%" align="center">Chapter 6. DocBook XML Tags</th><td width="20%" align="right"> <a accesskey="n" href="ch-tutorial.php">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s1-xml-tags-xref"></a>6.29. <tt class="command">xref</tt></h2></div></div><div></div></div><a class="indexterm" name="id2956104"></a><p>
To refer to other sections or chapters within a manual, use the
<tt class="command"><xref></tt> tag.
</p><p>
Index: sn-cvs-config.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/sn-cvs-config.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- sn-cvs-config.php 24 Aug 2005 17:56:10 -0000 1.1
+++ sn-cvs-config.php 19 Sep 2005 18:50:48 -0000 1.2
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">10.3. Configuring For CVS Access</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-cvs-preparation.php">Prev</a> </td><th width="60%" align="center">Chapter 10. CVS</th><td width="20%" align="right"> <a accesskey="n" href="sn-cvs-cvscommands.php">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-cvs-config"></a>10.3. Configuring For CVS Access</h2></div></div><div></div></div><a class="indexterm" name="id2724175"></a><a class="indexterm" name="id2724188"></a><a class="indexterm" name="id2724200"></a><a class="indexterm" name="id2724212"></a><a class="indexterm" name="id2724221"></a><a class="indexterm" name="id2724230"></a><a class="indexterm" name="id2724246"></a><div class="section" lang="en"><div class="titlepage"><div><d!
iv><h3 class="title"><a name="sn-cvs-config-cvsrc"></a>10.3.1. Avoiding Repetitive Typing</h3></div></div><div></div></div><a class="indexterm" name="id2724269"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">10.3. Configuring For CVS Access</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-cvs-preparation.php">Prev</a> </td><th width="60%" align="center">Chapter 10. CVS</th><td width="20%" align="right"> <a accesskey="n" href="sn-cvs-cvscommands.php">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-cvs-config"></a>10.3. Configuring For CVS Access</h2></div></div><div></div></div><a class="indexterm" name="id2970850"></a><a class="indexterm" name="id2970862"></a><a class="indexterm" name="id2970874"></a><a class="indexterm" name="id2970886"></a><a class="indexterm" name="id2970895"></a><a class="indexterm" name="id2970904"></a><a class="indexterm" name="id2970921"></a><div class="section" lang="en"><div class="titlepage"><div><d!
iv><h3 class="title"><a name="sn-cvs-config-cvsrc"></a>10.3.1. Avoiding Repetitive Typing</h3></div></div><div></div></div><a class="indexterm" name="id2970944"></a><p>
Many <span><b class="application">CVS</b></span> commands need certain
command line switches to operate consistently. Rather than
typing them every time that command is used, you can save the
@@ -21,7 +21,7 @@
diff -uNp
rdiff -uNp
update -dP</tt></pre><p>
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-config-anon"></a>10.3.2. Configuring for Read-Only CVS Access</h3></div></div><div></div></div><a class="indexterm" name="id2724333"></a><a class="indexterm" name="id2724346"></a><p>
+ </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-config-anon"></a>10.3.2. Configuring for Read-Only CVS Access</h3></div></div><div></div></div><a class="indexterm" name="id2971008"></a><a class="indexterm" name="id2971020"></a><p>
If your goal is to download the various Fedora Core documents and to
render them on your system, you only need read-only access to
the <span><b class="application">CVS</b></span> repository. Follow the
@@ -33,7 +33,7 @@
following commands:
</p><pre class="screen"><tt class="prompt">$ </tt><tt class="command">export CVSROOT=:pserver:cvs.fedora.redhat.com:/cvs/docs</tt>
<tt class="prompt">$ </tt><tt class="command">cvs login</tt>
-<tt class="prompt">$ </tt><tt class="command">cvs checkout docs-setup</tt> <i class="replaceable"><tt>module-name</tt></i>
+<tt class="prompt">$ </tt><tt class="command">cvs checkout docs-common</tt> <i class="replaceable"><tt>module-name</tt></i>
<tt class="prompt">$ </tt><tt class="command">cvs checkout</tt> <i class="replaceable"><tt>module-name</tt></i>
<tt class="prompt">$ </tt><tt class="command">cd</tt> <i class="replaceable"><tt>module-name</tt></i></pre><p>
Once you have checked the module out, it doesn't matter what
@@ -45,7 +45,7 @@
<tt class="filename">CVS/</tt> directory, the
<span><b class="application">CVS</b></span> program will automatically locate
the Fedora Core repository.
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-config-author"></a>10.3.3. Configuring Read/Write CVS Access</h3></div></div><div></div></div><a class="indexterm" name="id2724497"></a><a class="indexterm" name="id2724509"></a><p>
+ </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-config-author"></a>10.3.3. Configuring Read/Write CVS Access</h3></div></div><div></div></div><a class="indexterm" name="id2971171"></a><a class="indexterm" name="id2971184"></a><p>
To author a new document or to change an existing one, you must
obtain full read/write access to the Fedora Core Docs
<span><b class="application">CVS</b></span> repository. For the full details
Index: sn-cvs-cvscommands.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/sn-cvs-cvscommands.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- sn-cvs-cvscommands.php 24 Aug 2005 17:56:10 -0000 1.1
+++ sn-cvs-cvscommands.php 19 Sep 2005 18:50:48 -0000 1.2
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">10.4. Basic CVS Commands</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-cvs-config.php">Prev</a> </td><th width="60%" align="center">Chapter 10. CVS</th><td width="20%" align="right"> <a accesskey="n" href="acknowledgments.php">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-cvs-cvscommands"></a>10.4. Basic CVS Commands</h2></div></div><div></div></div><a class="indexterm" name="id2724741"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">10.4. Basic CVS Commands</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-cvs-config.php">Prev</a> </td><th width="60%" align="center">Chapter 10. CVS</th><td width="20%" align="right"> <a accesskey="n" href="acknowledgments.php">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-cvs-cvscommands"></a>10.4. Basic CVS Commands</h2></div></div><div></div></div><a class="indexterm" name="id2971416"></a><p>
After configuring your system to work with CVS, checkout the
modules you will be working on.
</p><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Tip: Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="./stylesheet-images/tip.png"></td><th align="left">Tip</th></tr><tr><td colspan="2" align="left" valign="top"><p>
@@ -22,7 +22,7 @@
<span><b class="application">CVS</b></span> ignores any
<tt class="envar">$CVSROOT</tt>
or <tt class="option">-m</tt> command line switch.
- </p></td></tr></table></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-co"></a>10.4.1. Checking Out Modules</h3></div></div><div></div></div><a class="indexterm" name="id2724822"></a><p>
+ </p></td></tr></table></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-co"></a>10.4.1. Checking Out Modules</h3></div></div><div></div></div><a class="indexterm" name="id2971496"></a><p>
You only need to checkout a module once. After a local copy of
the module is on your system, it is on your system.
</p><p>
@@ -38,7 +38,7 @@
If a branch name is not specified when checking out a module, it
is referred to as the <i class="firstterm">HEAD</i> of the
<span><b class="application">CVS</b></span> module.
- </p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="sn-cvs-cvscommands-co-branch"></a>10.4.1.1. Checking Out Branches of Modules</h4></div></div><div></div></div><a class="indexterm" name="id2724923"></a><p>
+ </p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="sn-cvs-cvscommands-co-branch"></a>10.4.1.1. Checking Out Branches of Modules</h4></div></div><div></div></div><a class="indexterm" name="id2971598"></a><p>
Think of a <span><b class="application">CVS</b></span> branch as a version
of the files for a particular version of a manual or package.
</p><p>
@@ -81,7 +81,7 @@
Only tags marked as branches in the second column under the
<tt class="computeroutput">Existing Tags</tt> section can be
checked out as a branch.
- </p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-up"></a>10.4.2. Updating Files</h3></div></div><div></div></div><a class="indexterm" name="id2725119"></a><p>
+ </p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-up"></a>10.4.2. Updating Files</h3></div></div><div></div></div><a class="indexterm" name="id2971794"></a><p>
To retrieve the latest versions of the files in a module, change
to the directory that contains the files for the module and
execute the command:
@@ -89,7 +89,7 @@
The latest versions of all the files in the module are
downloaded into your local copy. If you notice a file conflict,
refer to <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts" title="10.4.8. Resolving Conflicts">Section 10.4.8, “Resolving Conflicts”</a>.
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-commit"></a>10.4.3. Committing Files</h3></div></div><div></div></div><a class="indexterm" name="id2725171"></a><p>
+ </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-commit"></a>10.4.3. Committing Files</h3></div></div><div></div></div><a class="indexterm" name="id2971845"></a><p>
After modifying files in your local version of a module, commit
them to save the changes on the <span><b class="application">CVS</b></span>
server:
@@ -123,13 +123,13 @@
</p><p>
If you notice a file conflict, refer to
<a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts" title="10.4.8. Resolving Conflicts">Section 10.4.8, “Resolving Conflicts”</a>.
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-add"></a>10.4.4. Adding Files</h3></div></div><div></div></div><a class="indexterm" name="id2725324"></a><p>
+ </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-add"></a>10.4.4. Adding Files</h3></div></div><div></div></div><a class="indexterm" name="id2971999"></a><p>
To add a file to a module, create the file in your local copy
then execute the following command:
</p><pre class="screen"><tt class="prompt">$ </tt><tt class="command">cvs add</tt> <i class="replaceable"><tt>file-to-add</tt></i></pre><p>
After adding the file, you must <tt class="command">commit</tt> the
<tt class="command">add</tt> to copy it to the server:
- </p><pre class="screen"><tt class="prompt">$ </tt><tt class="command">cvs commit</tt> <tt class="option">-m</tt> "<i class="replaceable"><tt>some log message</tt></i>" <i class="replaceable"><tt>file-to-add</tt></i></pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-admin"></a>10.4.5. Managing Binary Files</h3></div></div><div></div></div><a class="indexterm" name="id2725409"></a><p>
+ </p><pre class="screen"><tt class="prompt">$ </tt><tt class="command">cvs commit</tt> <tt class="option">-m</tt> "<i class="replaceable"><tt>some log message</tt></i>" <i class="replaceable"><tt>file-to-add</tt></i></pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-admin"></a>10.4.5. Managing Binary Files</h3></div></div><div></div></div><a class="indexterm" name="id2972084"></a><p>
The most commonly-archived files are simple text files but
sometimes binary files are also archived. The
<span><b class="application">cvs</b></span> program recognizes most common
@@ -160,7 +160,7 @@
it corrupted when it is checked out, do not panic. Simply use
the <tt class="option">admin</tt> command as described above, delete
your local file copy, and check it out again.
- </p></td></tr></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-rm"></a>10.4.6. Removing Files</h3></div></div><div></div></div><a class="indexterm" name="id2725560"></a><p>
+ </p></td></tr></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-rm"></a>10.4.6. Removing Files</h3></div></div><div></div></div><a class="indexterm" name="id2972234"></a><p>
If a file is no longer needed in the module, use the
<tt class="command">remove</tt> command to remove it from your local
copy and then <tt class="command">commit</tt> the removal to the
@@ -182,7 +182,7 @@
email to
<a href="mailto:cvsdocs-administrator at fedora.redhat.com" target="_top"><tt class="filename">cvsdocs-administrator at fedora.redhat.com</tt>
</a> asking to have the file renamed.
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-status"></a>10.4.7. Status of Files</h3></div></div><div></div></div><a class="indexterm" name="id2725698"></a><p>
+ </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-status"></a>10.4.7. Status of Files</h3></div></div><div></div></div><a class="indexterm" name="id2972373"></a><p>
Sometimes it is necessary to view the
<i class="firstterm">status</i> of a file in a
<span><b class="application">CVS</b></span> module. To view the status of a
@@ -233,7 +233,7 @@
<tt class="filename">generated-index.sgml</tt> or for files
that you want to add to the repository but have not yet
issued the <tt class="command">cvs add</tt> command.
- </p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-conflicts"></a>10.4.8. Resolving Conflicts</h3></div></div><div></div></div><a class="indexterm" name="id2726014"></a><p>
+ </p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-conflicts"></a>10.4.8. Resolving Conflicts</h3></div></div><div></div></div><a class="indexterm" name="id2972689"></a><p>
If you modify a file and the same region is modified by someone
else and committed first, you will probably see a message
similar to the following when committing the file or updating
@@ -274,7 +274,7 @@
the content from the server.
</p><p>
Resolve the conflict by editing your copy, and commit the file.
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-summary"></a>10.4.9. Summary</h3></div></div><div></div></div><a class="indexterm" name="id2726126"></a><p>
+ </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-summary"></a>10.4.9. Summary</h3></div></div><div></div></div><a class="indexterm" name="id2972801"></a><p>
All commands assume you are in the proper directory for the
<span><b class="application">CVS</b></span> module.
</p><div class="table"><a name="tb-cvs-basic-commands"></a><table summary="Basic CVS Commands" border="1"><colgroup><col><col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><tt class="command">cvs checkout
Index: sn-cvs-preparation.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-guide/sn-cvs-preparation.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- sn-cvs-preparation.php 24 Aug 2005 17:56:10 -0000 1.1
+++ sn-cvs-preparation.php 19 Sep 2005 18:50:48 -0000 1.2
@@ -7,12 +7,12 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">10.2. Preparing For CVS Use</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-cvs.php">Prev</a> </td><th width="60%" align="center">Chapter 10. CVS</th><td width="20%" align="right"> <a accesskey="n" href="sn-cvs-config.php">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-cvs-preparation"></a>10.2. Preparing For CVS Use</h2></div></div><div></div></div><a class="indexterm" name="id2723738"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">10.2. Preparing For CVS Use</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-cvs.php">Prev</a> </td><th width="60%" align="center">Chapter 10. CVS</th><td width="20%" align="right"> <a accesskey="n" href="sn-cvs-config.php">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-cvs-preparation"></a>10.2. Preparing For CVS Use</h2></div></div><div></div></div><a class="indexterm" name="id2970413"></a><p>
Before using <span><b class="application">CVS</b></span>, you need to establish
an account with the <span><b class="application">CVS</b></span> server. After
getting an account, you do not need to perform these actions
again.
- </p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-rpm-check"></a>10.2.1. Is CVS Installed On Your System</h3></div></div><div></div></div><a class="indexterm" name="id2723778"></a><p>
+ </p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-rpm-check"></a>10.2.1. Is CVS Installed On Your System</h3></div></div><div></div></div><a class="indexterm" name="id2970452"></a><p>
You must have the <span><b class="application">CVS</b></span>
<span class="abbrev">RPM</span> package installed. Verify its presence by
typing the command:
@@ -24,7 +24,7 @@
<span><b class="application">cvs</b></span> package before continuing. If you
do not know how to do this, consult your system administrator
who can install it for you.
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-generate-keys"></a>10.2.2. Generating SSH Keys</h3></div></div><div></div></div><a class="indexterm" name="id2723855"></a><p>
+ </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-generate-keys"></a>10.2.2. Generating SSH Keys</h3></div></div><div></div></div><a class="indexterm" name="id2970530"></a><p>
The <span><b class="application">CVS</b></span> server uses
<span><b class="application">SSH</b></span> Protocol 2 keys to authenticate
users. Thus, you need to generate a pair of keys before applying
@@ -44,7 +44,7 @@
required for an
<tt class="computeroutput">cvs.fedora.redhat.com</tt>
<span><b class="application">CVS</b></span> account.
- </p><div class="orderedlist"><a class="indexterm" name="id2723967"></a><a class="indexterm" name="id2723983"></a><ol type="1"><li><p>
+ </p><div class="orderedlist"><a class="indexterm" name="id2970641"></a><a class="indexterm" name="id2970658"></a><ol type="1"><li><p>
To generate a
<span class="acronym">DSA</span>
key to work with version 2.0 protocol, at a shell prompt,
--- s1-cvs-configure.php DELETED ---
--- s1-cvs-cvscommands.php DELETED ---
- Previous message (by thread): rpms/SDL_ttf/devel .cvsignore, 1.2, 1.3 SDL_ttf.spec, 1.6, 1.7 sources, 1.2, 1.3 SDL_ttf-2.0.6-ft2-build.patch, 1.1, NONE SDL_ttf-2.0.6-openstream.patch, 1.1, NONE
- Next message (by thread): rpms/nexuiz/FC-4 .cvsignore, 1.2, 1.3 nexuiz.spec, 1.3, 1.4 sources, 1.2, 1.3
- Messages sorted by:
[ date ]
[ thread ]
[ subject ]
[ author ]
More information about the fedora-extras-commits
mailing list