web/html/docs/documentation-guide/en_US acknowledgments.php, 1.3, 1.4 ch-cvs.php, 1.3, 1.4 ch-emacs.php, 1.3, 1.4 ch-getting-files-build-system-targets.php, 1.3, 1.4 ch-getting-files-fdp.php, 1.3, 1.4 ch-getting-files.php, 1.3, 1.4 ch-how-modules-work.php, 1.3, 1.4 ch-intro.php, 1.3, 1.4 ch-publishing.php, 1.2, 1.3 ch-tutorial.php, 1.3, 1.4 ch-vim.php, 1.3, 1.4 ch-writing-guidelines.php, 1.3, 1.4 generated-index.php, 1.3, 1.4 index.php, 1.3, 1.4 rv-revhistory.php, 1.3, 1.4 sn-build-system.php, 1.3, 1.4 sn-creating-new-pub.php, 1.2, 1.3 sn-cvs-config.php, 1.3, 1.4 sn-cvs-cvscommands.php, 1.3, 1.4 sn-cvs-preparation.php, 1.3, 1.4 sn-emacs-additional-resources.php, 1.3, 1.4 sn-emacs-basic-commands.php, 1.3, 1.4 sn-emacs-colors.php, 1.3, 1.4 sn-emacs-examples.php, 1.3, 1.4 sn-emacs-file.php, 1.3, 1.4 sn-getting-files-names.php, 1.3, 1.4 sn-id-naming-conventions.php, 1.3, 1.4 sn-live-previews.php, 1.1, 1.2 sn-sandbox-setup.php, 1.2, 1.3 sn-screenshots.php, 1.3, 1.4 sn-tutorial-metadata.php, 1.3, 1.4 sn-vim-additional-resources.php, ! 1.3, 1.4 sn-vim-keymapping.php, 1.3, 1.4 sn-xml-admon.php, 1.3, 1.4 sn-xml-tags.php, 1.3, 1.4
Paul W. Frields (pfrields)
fedora-websites-list at redhat.com
Thu Nov 15 02:10:17 UTC 2007
- Previous message (by thread): web/html/docs/translation-quick-start-guide/en_US generated-index.php, 1.2, 1.3 index.php, 1.6, 1.7 rv-revhistory.php, 1.6, 1.7 sn_accounts.php, 1.6, 1.7 sn_translating_docs.php, 1.6, 1.7 sn_translating_software.php, 1.6, 1.7
- Next message (by thread): web/html/docs/install-guide/f8 index.php,1.1,1.2
- Messages sorted by:
[ date ]
[ thread ]
[ subject ]
[ author ]
Author: pfrields
Update of /cvs/fedora/web/html/docs/documentation-guide/en_US
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv28881
Modified Files:
acknowledgments.php ch-cvs.php ch-emacs.php
ch-getting-files-build-system-targets.php
ch-getting-files-fdp.php ch-getting-files.php
ch-how-modules-work.php ch-intro.php ch-publishing.php
ch-tutorial.php ch-vim.php ch-writing-guidelines.php
generated-index.php index.php rv-revhistory.php
sn-build-system.php sn-creating-new-pub.php sn-cvs-config.php
sn-cvs-cvscommands.php sn-cvs-preparation.php
sn-emacs-additional-resources.php sn-emacs-basic-commands.php
sn-emacs-colors.php sn-emacs-examples.php sn-emacs-file.php
sn-getting-files-names.php sn-id-naming-conventions.php
sn-live-previews.php sn-sandbox-setup.php sn-screenshots.php
sn-tutorial-metadata.php sn-vim-additional-resources.php
sn-vim-keymapping.php sn-xml-admon.php sn-xml-tags.php
Log Message:
Publish new DocGuide 0.3.2.1 en_US
Index: acknowledgments.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/acknowledgments.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- acknowledgments.php 16 Sep 2007 19:16:25 -0000 1.3
+++ acknowledgments.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 9. Acknowledgments</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-cvs-cvscommands.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="generated-index.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en-US" id="acknowledgments"><div class="titlepage"><div><div><h2 class="title"><a name="acknowledgments"></a>Chapter 9. Acknowledgments</h2></div></div></div><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 9. Acknowledgments</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-cvs-cvscommands.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="generated-index.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en-US" id="acknowledgments"><div class="titlepage"><div><div><h2 class="title">Chapter 9. Acknowledgments</h2></div></div></div><p>
This document is based on a document started by Tammy Fox (tfox at
redhat.com) and contributed to by Sandra Moore (smoore at redhat.com) and
Johnray Fuller (jrfuller at redhat.com).
@@ -21,10 +21,10 @@
in <code class="filename">docs-xml-tags.xml</code>.
</p><p>
A patch from Joshua Daniel Franklin (joshuadfranklin at yahoo.com) has been
- applied to add <a href="ch-vim.php" title="Chapter 5. VIM and DocBook">Chapter 5, <i>VIM and DocBook</i></a>.
+ applied to add <a class="xref" href="ch-vim.php" title="Chapter 5. VIM and DocBook">Chapter 5, <i>VIM and DocBook</i></a>.
</p><p>
A patch from Karsten Wade (kwade at redhat.com) has been applied to add
- <a href="sn-screenshots.php" title="3.5. Screenshots">Section 3.5, “Screenshotsâ€</a>. It was edited by Paul
+ <a class="xref" href="sn-screenshots.php" title="3.5. Screenshots">Section 3.5, “Screenshotsâ€</a>. It was edited by Paul
W. Frields (stickster at gmail.com).
</p><p>
A patch from Tommy Reynolds (Tommy.Reynolds at MegaCoder.com) has been
Index: ch-cvs.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/ch-cvs.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ch-cvs.php 16 Sep 2007 19:16:25 -0000 1.3
+++ ch-cvs.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,30 +7,30 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 8. CVS</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-creating-new-pub.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="sn-cvs-preparation.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en-US" id="ch-cvs"><div class="titlepage"><div><div><h2 class="title"><a name="ch-cvs"></a>Chapter 8. CVS</h2></div></div></div><p>
- The Concurrent Versions System (<span><strong class="application">CVS</strong></span>)
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 8. CVS</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-creating-new-pub.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="sn-cvs-preparation.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en-US" id="ch-cvs"><div class="titlepage"><div><div><h2 class="title">Chapter 8. CVS</h2></div></div></div><p>
+ The Concurrent Versions System (<span class="application"><strong>CVS</strong></span>)
provides a framework for collaborative revision. Without such a
framework, a group of users editing files in a single directory
- would cause chaos. Using <span><strong class="application">CVS</strong></span>, however, a
+ would cause chaos. Using <span class="application"><strong>CVS</strong></span>, however, a
group of people can safely work on the same set of files. The
- <span><strong class="application">CVS</strong></span> server keeps the master copy of the
+ <span class="application"><strong>CVS</strong></span> server keeps the master copy of the
files, and it records all changes and associated data, such as
authors and time, in a central repository. If conflicts arise,
- <span><strong class="application">CVS</strong></span> advises the users. Programmers often
- use <span><strong class="application">CVS</strong></span> to share code, but it also works
+ <span class="application"><strong>CVS</strong></span> advises the users. Programmers often
+ use <span class="application"><strong>CVS</strong></span> to share code, but it also works
well for documentation.
- </p><a class="indexterm" name="id2591387"></a><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-cvs-overview"></a>8.1. How CVS Works</h2></div></div></div><a class="indexterm" name="id2602602"></a><a class="indexterm" name="id2602894"></a><p>
+ </p><a class="indexterm" name="id343593"></a><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-cvs-overview">8.1. How CVS Works</h2></div></div></div><a class="indexterm" name="id345234"></a><a class="indexterm" name="id361031"></a><p>
In most cases, each set of files that make up a package or project
is stored as a <em class="firstterm">module</em> on the CVS server.
- When working with files from <span><strong class="application">CVS</strong></span>, you
+ When working with files from <span class="application"><strong>CVS</strong></span>, you
<em class="firstterm">checkout</em> a copy of the module on your local
file system. After modifying one or more files, you
<em class="firstterm">commit</em> them back to the central
- <span><strong class="application">CVS</strong></span> repository server.
+ <span class="application"><strong>CVS</strong></span> repository server.
</p><p>
- With <span><strong class="application">CVS</strong></span> you may edit a file without
+ With <span class="application"><strong>CVS</strong></span> you may edit a file without
first getting permission or locking the file. As long as none of
- the changes overlap, <span><strong class="application">CVS</strong></span> can correctly
+ the changes overlap, <span class="application"><strong>CVS</strong></span> can correctly
record their changes. When duplicate changes occur, they are
clearly marked in the files and the authors must resolve the issue
among themselves.
@@ -43,12 +43,12 @@
from your local checkout of a module, you must specify that you
want to remove it from the repository on the CVS server and then
commit the removal of the file. The specific commands to perform
- these actions are discussed in <a href="sn-cvs-cvscommands.php" title="8.4. Basic CVS Commands">Section 8.4, “Basic CVS Commandsâ€</a>.
+ these actions are discussed in <a class="xref" href="sn-cvs-cvscommands.php" title="8.4. Basic CVS Commands">Section 8.4, “Basic CVS Commandsâ€</a>.
</p><p>
If someone has modified the file between the last time you grabbed
the file from CVS and when you try to commit a change,
- <span><strong class="application">CVS</strong></span> will try to merge the changes into
- the master copy of the <span><strong class="application">CVS</strong></span> server. If
+ <span class="application"><strong>CVS</strong></span> will try to merge the changes into
+ the master copy of the <span class="application"><strong>CVS</strong></span> server. If
the content you changed is in a different location in the file
than the content changed by someone else, the commit action will
likely go through without a <em class="firstterm">conflict</em>. If
@@ -56,7 +56,7 @@
and tried to commit, you will see a message that a file conflict
has occurred. Thus, you need to <em class="firstterm">update</em> your
files frequently. It is a good practice to update them right
- before you start modifying a file. Refer to <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts" title="8.4.8. Resolving Conflicts">Section 8.4.8, “Resolving Conflictsâ€</a> for instructions on
+ before you start modifying a file. Refer to <a class="xref" href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts" title="8.4.8. Resolving Conflicts">Section 8.4.8, “Resolving Conflictsâ€</a> for instructions on
resolving conflicts.
</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sn-creating-new-pub.php">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="sn-cvs-preparation.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">7.3. Creating a New Publication </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 8.2. Preparing For CVS Use</td></tr></table></div>
<?
Index: ch-emacs.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/ch-emacs.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ch-emacs.php 16 Sep 2007 19:16:25 -0000 1.3
+++ ch-emacs.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,11 +7,11 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 4. Emacs and PSGML Mode</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-live-previews.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="sn-emacs-file.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en-US" id="ch-emacs"><div class="titlepage"><div><div><h2 class="title"><a name="ch-emacs"></a>Chapter 4. Emacs and PSGML Mode</h2></div></div></div><a class="indexterm" name="id2604995"></a><a class="indexterm" name="id2595050"></a><a class="indexterm" name="id2639672"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 4. Emacs and PSGML Mode</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-live-previews.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="sn-emacs-file.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en-US" id="ch-emacs"><div class="titlepage"><div><div><h2 class="title">Chapter 4. Emacs and PSGML Mode</h2></div></div></div><a class="indexterm" name="id344212"></a><a class="indexterm" name="id379349"></a><a class="indexterm" name="id362840"></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="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-installing-psgml"></a>4.1. Installing PSGML</h2></div></div></div><p>To install PSGML, use the <code class="command">yum</code> command:</p><pre class="screen"><strong class="userinput"><code>yum install psgml</code></strong></pre></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sn-live-previews.php">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="sn-emacs-file.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">3.6. Previewing Your Work </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 4.2. Setting Up Your <code class="filename">.emacs</code> File</td></tr></table></div>
+ </p><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-installing-psgml">4.1. Installing PSGML</h2></div></div></div><p>To install PSGML, use the <code class="command">yum</code> command:</p><pre class="screen"><strong class="userinput"><code>yum install psgml</code></strong></pre></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sn-live-previews.php">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="sn-emacs-file.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">3.6. Previewing Your Work </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 4.2. Setting Up Your <code class="filename">.emacs</code> File</td></tr></table></div>
<?
$template->displayFooter('$Date$');
Index: ch-getting-files-build-system-targets.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/ch-getting-files-build-system-targets.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ch-getting-files-build-system-targets.php 16 Sep 2007 19:16:25 -0000 1.3
+++ ch-getting-files-build-system-targets.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.3. Build System Actions</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-build-system.php">Prev</a> </td><th width="60%" align="center">Chapter 2. How Modules Work</th><td width="20%" align="right"> <a accesskey="n" href="ch-writing-guidelines.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="ch-getting-files-build-system-targets"></a>2.3. Build System Actions</h2></div></div></div><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.3. Build System Actions</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-build-system.php">Prev</a> </td><th width="60%" align="center">Chapter 2. How Modules Work</th><td width="20%" align="right"> <a accesskey="n" href="ch-writing-guidelines.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ch-getting-files-build-system-targets">2.3. Build System Actions</h2></div></div></div><p>
To render the <abbr class="abbrev">XML</abbr> document into another format,
use one of the following <code class="command">make</code> targets:
</p><div class="segmentedlist"><div class="title"><strong><span class="title">Build Targets</span></strong></div><table border="0"><thead><tr class="segtitle"><th>Target</th><th>Explanation</th></tr></thead><tbody><tr class="seglistitem"><td class="seg"><code class="systemitem">html</code></td><td class="seg">This target builds the "chunked" <abbr class="abbrev">HTML</abbr>
@@ -26,7 +26,7 @@
<abbr class="abbrev">PDF</abbr>, and archive files. This target
automatically invokes the <code class="filename">clean</code> target as
well.</td></tr></tbody></table></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note: PDF Generation is Erratic"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="./stylesheet-images/note.png"></td><th align="left">PDF Generation is Erratic</th></tr><tr><td align="left" valign="top"><p><abbr class="abbrev">PDF</abbr> production is currently erratic and may
- not work for your document.</p></td></tr></table></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="id2615603"></a>2.3.1. Adding or Changing Targets</h3></div></div></div><p>
+ not work for your document.</p></td></tr></table></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="id383200">2.3.1. Adding or Changing Targets</h3></div></div></div><p>
To add a new target and rules, place them at the bottom of the
document <code class="filename">Makefile</code>, below the
<code class="literal">include</code> line. Follow your target definitions
@@ -37,17 +37,17 @@
For more information on using <code class="command">make(1)</code>,
consult the online documentation with the command <code class="command">info
make</code> in a terminal.
- </p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="ch-getting-files-build-system-images"></a>2.3.2. Using Document Image Files</h3></div></div></div><p>
+ </p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="ch-getting-files-build-system-images">2.3.2. Using Document Image Files</h3></div></div></div><p>
Tutorial documents often make use of images such as <code class="filename">.PNG</code> files. Store image files in
a <code class="filename">figs/</code> folder in the
- main module directory, as shown in <a href="ch-how-modules-work.php#ex-module-structure" title="Example 2.1. Example Module Structure">Example 2.1, “Example Module Structureâ€</a>.
+ main module directory, as shown in <a class="xref" href="ch-how-modules-work.php#ex-module-structure" title="Example 2.1. Example Module Structure">Example 2.1, “Example Module Structureâ€</a>.
</p><p>
Depending on the output media, sometimes images may be scaled,
streteched, or squashed. To minimize any distortions, we
recommend that you use only <code class="filename">.PNG</code> images. Avoid <code class="filename">.JPG</code> files. The
<code class="command">convert(1)</code> program, from the <span class="package">ImageMagick</span> <abbr class="abbrev">RPM</abbr> package,
provides a convenient way to reformat <code class="filename">.JPG</code> images into <code class="filename">.PNG</code> format. For more information
- on formatting images such as screenshots, refer to <a href="sn-screenshots.php" title="3.5. Screenshots">Section 3.5, “Screenshotsâ€</a>.
+ on formatting images such as screenshots, refer to <a class="xref" href="sn-screenshots.php" title="3.5. Screenshots">Section 3.5, “Screenshotsâ€</a>.
</p><p>
Image files may be organized into subdirectories under
<code class="filename">figs/</code> if necessary. The document building
@@ -70,19 +70,19 @@
<code class="filename">figs/Manifest-</code><code class="systemitem">${LANG}</code> so the build system finds
it when searching for image filenames.
</p><p>
- <a href="ch-getting-files-build-system-targets.php#ch-getting-files-build-system-manifest" title="Example 2.3. Building A Manifest">Example 2.3, “Building A Manifestâ€</a>
+ <a class="xref" href="ch-getting-files-build-system-targets.php#ch-getting-files-build-system-manifest" title="Example 2.3. Building A Manifest">Example 2.3, “Building A Manifestâ€</a>
demonstrates one way to create this
<code class="filename">Manifest</code> file.
</p><div class="example"><a name="ch-getting-files-build-system-manifest"></a><div class="example-contents"><pre class="programlisting">rm -f figs/Manifest-en
find figs -print >/tmp/manifest
-mv /tmp/manifest figs/Manifest-en</pre></div><p class="title"><b>Example 2.3. Building A Manifest</b></p></div><br class="example-break"></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="id2536244"></a>2.3.3. Adding a New DocBook XML File</h3></div></div></div><p>To add a new DocBook XML file to an existing document,
+mv /tmp/manifest figs/Manifest-en</pre></div><p class="title"><b>Example 2.3. Building A Manifest</b></p></div><br class="example-break"></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="id383416">2.3.3. Adding a New DocBook XML File</h3></div></div></div><p>To add a new DocBook XML file to an existing document,
follow these steps:</p><div class="procedure"><ol type="1"><li><p>Place the new DocBook XML file in the primary language
directory.</p></li><li><p>Edit the <code class="filename">Makefile</code> and add the
filename to the <code class="varname">XMLFILES-${1}</code> listing.
- Append a <span><strong class="keycap">\</strong></span> to the last existing line, and
+ Append a <span class="keycap"><strong>\</strong></span> to the last existing line, and
on the next line add an entry for the new file. Remember to
add the <code class="literal">${1}/</code> prefix as a substitute for
- the language directory name.</p></li></ol></div></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="id2596139"></a>2.3.4. Adding a Translation</h3></div></div></div><p>Translations are stored as PO (portable object) files, which
+ the language directory name.</p></li></ol></div></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="id383474">2.3.4. Adding a Translation</h3></div></div></div><p>Translations are stored as PO (portable object) files, which
the toolchain transforms into translated documents. Each PO
file is based on the POT (PO template) for the document and
translated by the Fedora Translation Project. To add a
Index: ch-getting-files-fdp.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/ch-getting-files-fdp.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ch-getting-files-fdp.php 16 Sep 2007 19:16:25 -0000 1.3
+++ ch-getting-files-fdp.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,12 +7,12 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">1.2. Fedora Documentation Tools</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-getting-files.php">Prev</a> </td><th width="60%" align="center">Chapter 1. Prerequisites</th><td width="20%" align="right"> <a accesskey="n" href="sn-getting-files-names.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="ch-getting-files-fdp"></a>1.2. Fedora Documentation Tools</h2></div></div></div><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">1.2. Fedora Documentation Tools</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-getting-files.php">Prev</a> </td><th width="60%" align="center">Chapter 1. Prerequisites</th><td width="20%" align="right"> <a accesskey="n" href="sn-getting-files-names.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ch-getting-files-fdp">1.2. Fedora Documentation Tools</h2></div></div></div><p>
The Fedora Documentation Project's custom scripts and stylesheets are stored in CVS on the
<code class="systemitem">cvs.fedoraproject.org</code> CVS
server. When you check out a document module from CVS, the tools
are included in the module inside the <code class="filename">docs-common/</code> directory.
- To work on existing documents in CVS, refer to <a href="ch-cvs.php" title="Chapter 8. CVS">Chapter 8, <i>CVS</i></a>.
+ To work on existing documents in CVS, refer to <a class="xref" href="ch-cvs.php" title="Chapter 8. CVS">Chapter 8, <i>CVS</i></a>.
</p><p>The most powerful component in the Fedora Documentation Project toolbox is
<em class="firstterm">DocBook XML</em>. DocBook XML is a specific
scheme for authoring technical documentation using
@@ -42,13 +42,15 @@
documents for Fedora users around the world. The flexibility of
XML allows for a single document to be used many times for many
purposes, like reusable code for a programmer.</p><p>DocBook is itself very well documented. For more information
- about DocBook, visit <a href="http://www.docbook.org/" target="_top">http://www.docbook.org/</a>. The
+ about DocBook, visit <a class="ulink" href="http://www.docbook.org/" target="_top">http://www.docbook.org/</a>. The
DocBook site also features complete copies of <em class="citetitle">DocBook:
The Definitive Guide</em> to browse and download, the
canonical source for DocBook information.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note: DocBook XML Versions"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="./stylesheet-images/note.png"></td><th align="left">DocBook XML Versions</th></tr><tr><td align="left" valign="top"><p>DocBook XML, like a computer program, has version numbers.
The version used by Fedora Documentation Project right now is 4.4. The DocBook web
site may document a slightly newer version, but the majority of
- the schema still applies.</p></td></tr></table></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch-getting-files.php">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch-getting-files.php">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="sn-getting-files-names.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 1. Prerequisites </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 1.3. Naming Conventions</td></tr></table></div>
+ the schema still applies.</p></td></tr></table></div><p>Contributors who use the Microsoft Windows operating system
+ can still make use of DocBook tools. For more information, refer
+ to <a class="ulink" href="http://www.codeproject.com/winhelp/docbook_howto.asp" target="_top">http://www.codeproject.com/winhelp/docbook_howto.asp</a>.</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch-getting-files.php">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch-getting-files.php">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="sn-getting-files-names.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 1. Prerequisites </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 1.3. Naming Conventions</td></tr></table></div>
<?
$template->displayFooter('$Date$');
Index: ch-getting-files.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/ch-getting-files.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ch-getting-files.php 16 Sep 2007 19:16:25 -0000 1.3
+++ ch-getting-files.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,10 +7,10 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 1. Prerequisites</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-intro.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch-getting-files-fdp.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en-US" id="ch-getting-files"><div class="titlepage"><div><div><h2 class="title"><a name="ch-getting-files"></a>Chapter 1. Prerequisites</h2></div></div></div><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 1. Prerequisites</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-intro.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch-getting-files-fdp.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en-US" id="ch-getting-files"><div class="titlepage"><div><div><h2 class="title">Chapter 1. Prerequisites</h2></div></div></div><p>
To work on official Fedora documentation you need to install the required
tools. Follow the directions below to configure your system.
- </p><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-system-packages"></a>1.1. System Packages</h2></div></div></div><p>
+ </p><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-system-packages">1.1. System Packages</h2></div></div></div><p>
Install the "Authoring and Publishing" package group, which contains
required DocBook XML files, stylesheets and scripts:
</p><pre class="screen">
@@ -20,7 +20,7 @@
handle revision control on files in the official repository:
</p><pre class="screen">
<strong class="userinput"><code>su -c 'yum install cvs'</code></strong>
-</pre><p>If you plan to use <span><strong class="application">Emacs</strong></span> to edit
+</pre><p>If you plan to use <span class="application"><strong>Emacs</strong></span> to edit
DocBook XML documentation, install <span class="package">psgml</span>, which
adds helpful and time-saving functionality to maximize editing
efficiency:</p><pre class="screen"><strong class="userinput"><code>su -c 'yum install psgml'</code></strong></pre></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch-intro.php">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch-getting-files-fdp.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Introduction </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 1.2. Fedora Documentation Tools</td></tr></table></div>
Index: ch-how-modules-work.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/ch-how-modules-work.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ch-how-modules-work.php 16 Sep 2007 19:16:25 -0000 1.3
+++ ch-how-modules-work.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,11 +7,11 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 2. How Modules Work</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-getting-files-names.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="sn-build-system.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en-US" id="ch-how-modules-work"><div class="titlepage"><div><div><h2 class="title"><a name="ch-how-modules-work"></a>Chapter 2. How Modules Work</h2></div></div></div><p>Documentation modules have a specific structure that enables the
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 2. How Modules Work</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-getting-files-names.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="sn-build-system.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en-US" id="ch-how-modules-work"><div class="titlepage"><div><div><h2 class="title">Chapter 2. How Modules Work</h2></div></div></div><p>Documentation modules have a specific structure that enables the
preconfigured tools to work correctly. Follow this structure exactly or you
may have problems building your module. The Fedora Documentation Project build tools locate
resources in the module and use them to build new output such as HTML or RPM
- packages.</p><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-module-struct"></a>2.1. Structure of a Module</h2></div></div></div><p><a href="ch-how-modules-work.php#ex-module-structure" title="Example 2.1. Example Module Structure">Example 2.1, “Example Module Structureâ€</a> shows a directory tree
+ packages.</p><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-module-struct">2.1. Structure of a Module</h2></div></div></div><p><a class="xref" href="ch-how-modules-work.php#ex-module-structure" title="Example 2.1. Example Module Structure">Example 2.1, “Example Module Structureâ€</a> shows a directory tree
of an example module, excluding any <code class="filename">CVS</code> folders. Note that this
example document does not have branches.</p><div class="example"><a name="ex-module-structure"></a><div class="example-contents"><pre class="screen"><code class="computeroutput">example-doc/
|
@@ -36,7 +36,7 @@
primary language does not have to be US English; all languages
are supported. This directory contains all the XML source for
the actual document, as well as XML source for
- document-specific <em class="firstterm">entities</em><sup>[<a name="id2630826" href="#ftn.id2630826">1</a>]</sup>.</td></tr><tr class="seglistitem"><td class="seg">Graphics directory</td><td class="seg">optional</td><td class="seg">The <code class="filename">figs/</code> directory
+ document-specific <em class="firstterm">entities</em><sup>[<a name="id354988" href="#ftn.id354988" class="footnote">1</a>]</sup>.</td></tr><tr class="seglistitem"><td class="seg">Graphics directory</td><td class="seg">optional</td><td class="seg">The <code class="filename">figs/</code> directory
is an optional directory where graphics for the document
should be stored. If graphics are screenshots that are
particular to a language, the <code class="filename">figs/</code> directory can and should
@@ -50,11 +50,11 @@
contains the <code class="filename">LINGUAS</code> file, which lists
the active translation <em class="firstterm">locales</em>, or
languages.</td></tr><tr class="seglistitem"><td class="seg">Makefile</td><td class="seg">required</td><td class="seg">The <code class="filename">Makefile</code> controls the build
- process. Its content is discussed in <a href="sn-build-system.php#ex-makefile" title="Example 2.2. Sample Document Makefile">Example 2.2, “Sample Document Makefileâ€</a>.</td></tr><tr class="seglistitem"><td class="seg"><code class="filename">rpm-info.xml</code></td><td class="seg">required</td><td class="seg">The <code class="filename">rpm-info.xml</code> file contains
+ process. Its content is discussed in <a class="xref" href="sn-build-system.php#ex-makefile" title="Example 2.2. Sample Document Makefile">Example 2.2, “Sample Document Makefileâ€</a>.</td></tr><tr class="seglistitem"><td class="seg"><code class="filename">rpm-info.xml</code></td><td class="seg">required</td><td class="seg">The <code class="filename">rpm-info.xml</code> file contains
document specific metadata</td></tr></tbody></table></div><div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Important: Common Build Tools"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="./stylesheet-images/important.png"></td><th align="left">Common Build Tools</th></tr><tr><td align="left" valign="top"><p>Never add the <code class="systemitem">docs-common</code> build
tools directory to an individual module. Special formatting in
the module list downloads these tools when a user checks out a
- document module. For more information, refer to <a href="sn-getting-files-names.php#ch-getting-files-naming-modules" title="1.3.1. Module Names">Section 1.3.1, “Module Namesâ€</a>.</p></td></tr></table></div></div><div class="footnotes"><br><hr width="100" align="left"><div class="footnote"><p><sup>[<a name="ftn.id2630826" href="#id2630826">1</a>] </sup>Think of an XML entity as a predefined snippet of
+ document module. For more information, refer to <a class="xref" href="sn-getting-files-names.php#ch-getting-files-naming-modules" title="1.3.1. Module Names">Section 1.3.1, “Module Namesâ€</a>.</p></td></tr></table></div></div><div class="footnotes"><br><hr width="100" align="left"><div class="footnote"><p><sup>[<a name="ftn.id354988" href="#id354988" class="para">1</a>] </sup>Think of an XML entity as a predefined snippet of
information. It can represent a chunk of XML source, or
simply a word or character. If the information changes, it
need be replaced only once, in the definition, to fix all
Index: ch-intro.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/ch-intro.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ch-intro.php 16 Sep 2007 19:16:25 -0000 1.3
+++ ch-intro.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Introduction</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="index.php">Prev</a>Â </td><th width="60%" align="center">Â </th><td width="20%" align="right">Â <a accesskey="n" href="ch-getting-files.php">Next</a></td></tr></table><hr></div><div class="preface" lang="en-US" id="ch-intro"><div class="titlepage"><div><div><h2 class="title"><a name="ch-intro"></a>Introduction</h2></div></div></div><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Introduction</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="index.php">Prev</a>Â </td><th width="60%" align="center">Â </th><td width="20%" align="right">Â <a accesskey="n" href="ch-getting-files.php">Next</a></td></tr></table><hr></div><div class="preface" lang="en-US" id="ch-intro"><div class="titlepage"><div><div><h2 class="title">Introduction</h2></div></div></div><p>
The goal of the Fedora Documentation Project is to create easy-to-follow, task-based
documentation for Fedora users and developers. The Fedora Documentation Project uses the
following tools:
Index: ch-publishing.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/ch-publishing.php,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ch-publishing.php 16 Sep 2007 19:16:25 -0000 1.2
+++ ch-publishing.php 15 Nov 2007 02:10:15 -0000 1.3
@@ -7,14 +7,14 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 7. Publishing Official Documentation</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-tutorial-metadata.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="sn-sandbox-setup.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en-US" id="ch-publishing"><div class="titlepage"><div><div><h2 class="title"><a name="ch-publishing"></a>Chapter 7. Publishing Official Documentation</h2></div></div></div><p>This chapter shows how to publish official Fedora Documentation Project work to the
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 7. Publishing Official Documentation</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-tutorial-metadata.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="sn-sandbox-setup.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en-US" id="ch-publishing"><div class="titlepage"><div><div><h2 class="title">Chapter 7. Publishing Official Documentation</h2></div></div></div><p>This chapter shows how to publish official Fedora Documentation Project work to the
<code class="systemitem">docs.fedoraproject.org</code>
website. To publish official documentation, you must be approved to
write to the web repository in CVS. Access for publishing is
limited to contributors who have demonstrated capacity for working
with CVS and other project tools. Once you have acquired and are
comfortable with these skills, contributions as a publisher are
- welcome.</p><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-how-site-works"></a>7.1. How the Site Works</h2></div></div></div><p>The <code class="systemitem">docs.fedoraproject.org</code> website
+ welcome.</p><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-how-site-works">7.1. How the Site Works</h2></div></div></div><p>The <code class="systemitem">docs.fedoraproject.org</code> website
is a set of PHP files and scripts. Publishers maintain these
files in a CVS repository, and the website host retrieves them
hourly to refresh the site. The host does not automatically use
Index: ch-tutorial.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/ch-tutorial.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ch-tutorial.php 16 Sep 2007 19:16:25 -0000 1.3
+++ ch-tutorial.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,10 +7,10 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 6. The Layout of a Tutorial</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-vim-additional-resources.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="sn-tutorial-metadata.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en-US" id="ch-tutorial"><div class="titlepage"><div><div><h2 class="title"><a name="ch-tutorial"></a>Chapter 6. The Layout of a Tutorial</h2></div></div></div><p>In this chapter, you will find an example of a very short tutorial
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 6. The Layout of a Tutorial</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-vim-additional-resources.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="sn-tutorial-metadata.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en-US" id="ch-tutorial"><div class="titlepage"><div><div><h2 class="title">Chapter 6. The Layout of a Tutorial</h2></div></div></div><p>In this chapter, you will find an example of a very short tutorial
as used by the Fedora Documentation Project. This example is specific to the way the Docs
Project uses DocBook XML. The example consists of a set of files
- used to hold the content and metadata for the tutorial.</p><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-tutorial-article"></a>6.1. The Article</h2></div></div></div><a class="indexterm" name="id2648096"></a><p>Below is a sample article:</p><pre class="screen"><!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+ used to hold the content and metadata for the tutorial.</p><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-tutorial-article">6.1. The Article</h2></div></div></div><a class="indexterm" name="id358267"></a><p>Below is a sample article:</p><pre class="screen"><!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!ENTITY % FEDORA-ENTITIES SYSTEM "fdp-entities.ent">
Index: ch-vim.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/ch-vim.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ch-vim.php 16 Sep 2007 19:16:25 -0000 1.3
+++ ch-vim.php 15 Nov 2007 02:10:15 -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="sn-emacs-additional-resources.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="sn-vim-keymapping.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en-US" id="ch-vim"><div class="titlepage"><div><div><h2 class="title"><a name="ch-vim"></a>Chapter 5. VIM and DocBook</h2></div></div></div><a class="indexterm" name="id2627558"></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="sn-emacs-additional-resources.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="sn-vim-keymapping.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en-US" id="ch-vim"><div class="titlepage"><div><div><h2 class="title">Chapter 5. VIM and DocBook</h2></div></div></div><a class="indexterm" name="id396089"></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 <code class="command">vimtutor</code> or by typing
<strong class="userinput"><code>:help tutor</code></strong> from inside VIM.
- </p><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-vimrc-file"></a>5.1. Setting Up Your <code class="filename">.vimrc</code> File</h2></div></div></div><a class="indexterm" name="id2602070"></a><p>
+ </p><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-vimrc-file">5.1. Setting Up Your <code class="filename">.vimrc</code> File</h2></div></div></div><a class="indexterm" name="id343533"></a><p>
Below is a short sample <code class="filename">.vimrc</code> file that turns on
some VIM features useful for editing SGML or XML content such as
DocBook:
@@ -37,7 +37,7 @@
<code class="filename">vim-minimal</code> package, or if you are using an older
version of VIM, you may not have the
<code class="filename">$VIMRUNTIME/macros/matchit.vim</code> file. You can still
- download <a href="http://vim.org/scripts/script.php?script_id=39" target="_top">matchit.zip from
+ download <a class="ulink" href="http://vim.org/scripts/script.php?script_id=39" target="_top">matchit.zip from
Vim.org</a> and load it separately.
</p></td></tr></table></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sn-emacs-additional-resources.php">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="sn-vim-keymapping.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">4.6. Additional Resources </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 5.2. Keymapping with VIM</td></tr></table></div>
<?
Index: ch-writing-guidelines.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/ch-writing-guidelines.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ch-writing-guidelines.php 16 Sep 2007 19:16:25 -0000 1.3
+++ ch-writing-guidelines.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,13 +7,13 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 3. Fedora Documentation Guidelines</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-getting-files-build-system-targets.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="sn-id-naming-conventions.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en-US" id="ch-writing-guidelines"><div class="titlepage"><div><div><h2 class="title"><a name="ch-writing-guidelines"></a>Chapter 3. Fedora Documentation Guidelines</h2></div></div></div><a class="indexterm" name="id2597909"></a><a class="indexterm" name="id2648464"></a><a class="indexterm" name="id2617601"></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 3. Fedora Documentation Guidelines</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-getting-files-build-system-targets.php">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="sn-id-naming-conventions.php">Next</a></td></tr></table><hr></div><div class="chapter" lang="en-US" id="ch-writing-guidelines"><div class="titlepage"><div><div><h2 class="title">Chapter 3. Fedora Documentation Guidelines</h2></div></div></div><a class="indexterm" name="id405173"></a><a class="indexterm" name="id315479"></a><a class="indexterm" name="id352698"></a><p>Please read this chapter carefully. This chapter describes the
guidelines that must be followed such as naming conventions.</p><p>This chapter only discusses tags used for documentation for the Fedora Project,
not all available DocBook XML tags. For the complete list, refer to
- <a href="http://www.docbook.org/tdg/en/html/docbook.html" target="_top">http://www.docbook.org/tdg/en/html/docbook.html</a>.
- </p><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-xml-guidelines-header"></a>3.1. File Header</h2></div></div></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="sn-xml-header-xml"></a>3.1.1. XML Header</h3></div></div></div><p>In accordance with good XML practices, the first line in any
+ <a class="ulink" href="http://www.docbook.org/tdg/en/html/docbook.html" target="_top">http://www.docbook.org/tdg/en/html/docbook.html</a>.
+ </p><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-xml-guidelines-header">3.1. File Header</h2></div></div></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="sn-xml-header-xml">3.1.1. XML Header</h3></div></div></div><p>In accordance with good XML practices, the first line in any
DocBook XML source files should identify the file as XML. Use
- the following line as the first line of any new XML file:</p><pre class="screen"><?xml version="1.0" encoding="UTF-8"?></pre></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="sn-xml-header-cvs"></a>3.1.2. CVS Id Header</h3></div></div></div><p>All the files must contain the CVS Id header. Use the
+ the following line as the first line of any new XML file:</p><pre class="screen"><?xml version="1.0" encoding="UTF-8"?></pre></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="sn-xml-header-cvs">3.1.2. CVS Id Header</h3></div></div></div><p>All the files must contain the CVS Id header. Use the
following line as the second line of any new XML file:</p><pre class="screen"><!-- $Id: --></pre><p>Any time the file is committed to CVS, the line is updated
automatically to include information about the file. For
example:</p><pre class="screen"><!-- $Id$ --></pre></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch-getting-files-build-system-targets.php">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="sn-id-naming-conventions.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">2.3. Build System Actions </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 3.2. ID Naming Conventions</td></tr></table></div>
Index: generated-index.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/generated-index.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- generated-index.php 16 Sep 2007 19:16:25 -0000 1.3
+++ generated-index.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,16 +7,16 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Index</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="acknowledgments.php">Prev</a>Â </td><th width="60%" align="center">Â </th><td width="20%" align="right">Â </td></tr></table><hr></div><div class="index" id="generated-index"><div class="titlepage"><div><div><h2 class="title"><a name="generated-index"></a>Index</h2></div></div></div><div class="index"><div class="indexdiv"><h3>Symbols</h3><dl><dt>.cvsrc
- , <a href="sn-cvs-config.php">Configuring For CVS Access</a></dt><dt>.emacs, <a href="sn-emacs-file.php">Setting Up Your .emacs File</a></dt><dt>.Xresources, <a href="sn-emacs-colors.php">Customizing Emacs</a></dt></dl></div><div class="indexdiv"><h3>A</h3><dl><dt>admonitions, <a href="sn-xml-admon.php">Admonitions</a></dt></dl></div><div class="indexdiv"><h3>C</h3><dl><dt>cvs, <a href="ch-cvs.php">CVS</a></dt><dd><dl><dt>.cvsrc
- , <a href="sn-cvs-config.php">Configuring For CVS Access</a></dt><dt>adding files, <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-add">Adding Files</a></dt><dt>anonymous access, <a href="sn-cvs-config.php#sn-cvs-config-anon">Configuring for Read-Only CVS Access</a></dt><dt>avoiding repetitive typing, <a href="sn-cvs-config.php#sn-cvs-config-cvsrc">Avoiding Repetitive Typing</a></dt><dt>binary files, <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-admin">Managing Binary Files</a></dt><dt>check out modules</dt><dd><dl><dt>checking out branches, <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-co-branch">Checking Out Branches of Modules</a></dt></dl></dd><dt>checking out modules, <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-co">Checking Out Modules</a></dt><dt>commands, <a href="sn-cvs-cvscommands.php">Basic CVS Commands</a></dt><dd><dl><dt>summary of, <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-summary">Summary</a></dt></dl></dd><dt>committing file!
s, <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-commit">Committing Files</a></dt><dt>configuring access for authors, <a href="sn-cvs-config.php#sn-cvs-config-author">Configuring Read/Write CVS Access</a></dt><dt>configuring for access, <a href="sn-cvs-config.php">Configuring For CVS Access</a></dt><dt>configuring read-only access, <a href="sn-cvs-config.php#sn-cvs-config-anon">Configuring for Read-Only CVS Access</a></dt><dt>configuring read/write access, <a href="sn-cvs-config.php#sn-cvs-config-author">Configuring Read/Write CVS Access</a></dt><dt>CVSROOT, <a href="sn-cvs-config.php">Configuring For CVS Access</a></dt><dt>CVS_RSH, <a href="sn-cvs-config.php">Configuring For CVS Access</a></dt><dt>how it works, <a href="ch-cvs.php#sn-cvs-overview">How CVS Works</a></dt><dt>overview, <a href="ch-cvs.php#sn-cvs-overview">How CVS Works</a></dt><dt>preparing for use, <a href="sn-cvs-preparation.php">Preparing For CVS Use</a></dt><dt>removing files, <a href="sn-cvs-cvscomm!
ands.php#sn-cvs-cvscommands-rm">Removing Files</a></dt><dt>res!
olving
nflicts, <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts">Resolving Conflicts</a></dt><dt>RPM installation, <a href="sn-cvs-preparation.php#sn-cvs-rpm-check">Is CVS Installed On Your System</a></dt><dt>status of files, <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-status">Status of Files</a></dt><dt>updating files, <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-up">Updating Files</a></dt></dl></dd><dt>CVSROOT, <a href="sn-cvs-config.php">Configuring For CVS Access</a></dt><dt>CVS_RSH, <a href="sn-cvs-config.php">Configuring For CVS Access</a></dt></dl></div><div class="indexdiv"><h3>E</h3><dl><dt>Emacs, <a href="ch-emacs.php">Emacs and PSGML Mode</a></dt><dd><dl><dt>colors, <a href="sn-emacs-colors.php">Customizing Emacs</a></dt><dt>configuration file, <a href="sn-emacs-file.php">Setting Up Your .emacs File</a></dt><dt>customizing, <a href="sn-emacs-colors.php">Customizing Emacs</a></dt><dt>font, <a href="sn-emacs-colors.php">Customizing Emacs</a></dt><!
dt>geometry, <a href="sn-emacs-colors.php">Customizing Emacs</a></dt><dt>PSGML mode, <a href="ch-emacs.php">Emacs and PSGML Mode</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>H</h3><dl><dt>humor</dt><dd><dl><dt>RTFM, <a href="ch-writing-guidelines.php">Fedora Documentation Guidelines</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>N</h3><dl><dt>naming conventions, <a href="sn-id-naming-conventions.php">ID Naming Conventions</a></dt><dd><dl><dt>rules for defining an ID, <a href="sn-id-naming-conventions.php">ID Naming Conventions</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>O</h3><dl><dt>OpenSSH</dt><dd><dl><dt>authorization keys, <a href="sn-cvs-preparation.php#sn-cvs-generate-keys">Generating SSH Keys</a></dt><dt>ssh-keygen
- , <a href="sn-cvs-preparation.php#sn-cvs-generate-keys">Generating SSH Keys</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>P</h3><dl><dt>PSGML, <a href="ch-emacs.php">Emacs and PSGML Mode</a></dt></dl></div><div class="indexdiv"><h3>R</h3><dl><dt>recursion (see recursion)</dt><dt>RTFM</dt><dd><dl><dt>read the fine manual, <a href="ch-writing-guidelines.php">Fedora Documentation Guidelines</a></dt><dd><dl><dt>(see also humor)</dt></dl></dd></dl></dd></dl></div><div class="indexdiv"><h3>S</h3><dl><dt>screen captures (see screenshots)</dt><dt>screen grabs (see screenshots)</dt><dt>screenshots</dt><dd><dl><dt>how to take, <a href="sn-screenshots.php">Screenshots</a></dt></dl></dd><dt>ssh-keygen
- , <a href="sn-cvs-preparation.php#sn-cvs-generate-keys">Generating SSH Keys</a></dt></dl></div><div class="indexdiv"><h3>T</h3><dl><dt>tutorial layout</dt><dd><dl><dt>article, <a href="ch-tutorial.php#sn-tutorial-article">The Article</a></dt><dt>metadata, <a href="sn-tutorial-metadata.php">The Metadata</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>V</h3><dl><dt>VIM, <a href="ch-vim.php">VIM and DocBook</a></dt><dd><dl><dt>configuration file, <a href="ch-vim.php#sn-vimrc-file">Setting Up Your .vimrc File</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>X</h3><dl><dt>XML tags</dt><dd><dl><dt>admonitions</dt><dd><dl><dt>caution, <a href="sn-xml-admon.php">Admonitions</a></dt><dt>important, <a href="sn-xml-admon.php">Admonitions</a></dt><dt>note, <a href="sn-xml-admon.php">Admonitions</a></dt><dt>tip, <a href="sn-xml-admon.php">Admonitions</a></dt><dt>warning, <a href="sn-xml-admon.php">Admonitions</a></dt></dl></dd><dt>caution, <a href="sn-xml-admon.ph!
p">Admonitions</a>, <a href="sn-xml-admon.php#sn-xml-notesetc">Creating a note,
- tip, caution, important, or warning</a></dt><dt>important, <a href="sn-xml-admon.php">Admonitions</a>, <a href="sn-xml-admon.php#sn-xml-notesetc">Creating a note,
- tip, caution, important, or warning</a></dt><dt>naming conventions, <a href="sn-id-naming-conventions.php">ID Naming Conventions</a></dt><dt>note, <a href="sn-xml-admon.php">Admonitions</a>, <a href="sn-xml-admon.php#sn-xml-notesetc">Creating a note,
- tip, caution, important, or warning</a></dt><dt>rules for defining an ID, <a href="sn-id-naming-conventions.php">ID Naming Conventions</a></dt><dt>tip, <a href="sn-xml-admon.php">Admonitions</a>, <a href="sn-xml-admon.php#sn-xml-notesetc">Creating a note,
- tip, caution, important, or warning</a></dt><dt>warning, <a href="sn-xml-admon.php">Admonitions</a>, <a href="sn-xml-admon.php#sn-xml-notesetc">Creating a note,
- tip, caution, important, or warning</a></dt></dl></dd><dt>xml tags</dt><dd><dl><dt>caveats, <a href="sn-xml-tags.php">XML Tags</a></dt></dl></dd></dl></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="acknowledgments.php">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> </td></tr><tr><td width="40%" align="left" valign="top">Chapter 9. Acknowledgments </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Index</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="acknowledgments.php">Prev</a>Â </td><th width="60%" align="center">Â </th><td width="20%" align="right">Â </td></tr></table><hr></div><div class="index" id="generated-index"><div class="titlepage"><div><div><h2 class="title">Index</h2></div></div></div><div class="index"><div class="indexdiv"><h3>Symbols</h3><dl><dt>.cvsrc
+ , <a class="indexterm" href="sn-cvs-config.php">Configuring For CVS Access</a></dt><dt>.emacs, <a class="indexterm" href="sn-emacs-file.php">Setting Up Your .emacs File</a></dt><dt>.Xresources, <a class="indexterm" href="sn-emacs-colors.php">Customizing Emacs</a></dt></dl></div><div class="indexdiv"><h3>A</h3><dl><dt>admonitions, <a class="indexterm" href="sn-xml-admon.php">Admonitions</a></dt></dl></div><div class="indexdiv"><h3>C</h3><dl><dt>cvs, <a class="indexterm" href="ch-cvs.php">CVS</a></dt><dd><dl><dt>.cvsrc
+ , <a class="indexterm" href="sn-cvs-config.php">Configuring For CVS Access</a></dt><dt>adding files, <a class="indexterm" href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-add">Adding Files</a></dt><dt>anonymous access, <a class="indexterm" href="sn-cvs-config.php#sn-cvs-config-anon">Configuring for Read-Only CVS Access</a></dt><dt>avoiding repetitive typing, <a class="indexterm" href="sn-cvs-config.php#sn-cvs-config-cvsrc">Avoiding Repetitive Typing</a></dt><dt>binary files, <a class="indexterm" href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-admin">Managing Binary Files</a></dt><dt>check out modules</dt><dd><dl><dt>checking out branches, <a class="indexterm" href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-co-branch">Checking Out Branches of Modules</a></dt></dl></dd><dt>checking out modules, <a class="indexterm" href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-co">Checking Out Modules</a></dt><dt>commands, <a class="indexterm" href="sn-cvs-cvscommands.php">Basic CVS Co!
mmands</a></dt><dd><dl><dt>summary of, <a class="indexterm" href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-summary">Summary</a></dt></dl></dd><dt>committing files, <a class="indexterm" href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-commit">Committing Files</a></dt><dt>configuring access for authors, <a class="indexterm" href="sn-cvs-config.php#sn-cvs-config-author">Configuring Read/Write CVS Access</a></dt><dt>configuring for access, <a class="indexterm" href="sn-cvs-config.php">Configuring For CVS Access</a></dt><dt>configuring read-only access, <a class="indexterm" href="sn-cvs-config.php#sn-cvs-config-anon">Configuring for Read-Only CVS Access</a></dt><dt>configuring read/write access, <a class="indexterm" href="sn-cvs-config.php#sn-cvs-config-author">Configuring Read/Write CVS Access</a></dt><dt>CVSROOT, <a class="indexterm" href="sn-cvs-config.php">Configuring For CVS Access</a></dt><dt>CVS_RSH, <a class="indexterm" href="sn-cvs-config.php">Configuring For CVS Access!
</a></dt><dt>how it works, <a class="indexterm" href="ch-cvs.p!
hp#sn-
-overview">How CVS Works</a></dt><dt>overview, <a class="indexterm" href="ch-cvs.php#sn-cvs-overview">How CVS Works</a></dt><dt>preparing for use, <a class="indexterm" href="sn-cvs-preparation.php">Preparing For CVS Use</a></dt><dt>removing files, <a class="indexterm" href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-rm">Removing Files</a></dt><dt>resolving conflicts, <a class="indexterm" href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts">Resolving Conflicts</a></dt><dt>RPM installation, <a class="indexterm" href="sn-cvs-preparation.php#sn-cvs-rpm-check">Is CVS Installed On Your System</a></dt><dt>status of files, <a class="indexterm" href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-status">Status of Files</a></dt><dt>updating files, <a class="indexterm" href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-up">Updating Files</a></dt></dl></dd><dt>CVSROOT, <a class="indexterm" href="sn-cvs-config.php">Configuring For CVS Access</a></dt><dt>CVS_RSH, <a class="indexterm" href="!
sn-cvs-config.php">Configuring For CVS Access</a></dt></dl></div><div class="indexdiv"><h3>E</h3><dl><dt>Emacs, <a class="indexterm" href="ch-emacs.php">Emacs and PSGML Mode</a></dt><dd><dl><dt>colors, <a class="indexterm" href="sn-emacs-colors.php">Customizing Emacs</a></dt><dt>configuration file, <a class="indexterm" href="sn-emacs-file.php">Setting Up Your .emacs File</a></dt><dt>customizing, <a class="indexterm" href="sn-emacs-colors.php">Customizing Emacs</a></dt><dt>font, <a class="indexterm" href="sn-emacs-colors.php">Customizing Emacs</a></dt><dt>geometry, <a class="indexterm" href="sn-emacs-colors.php">Customizing Emacs</a></dt><dt>PSGML mode, <a class="indexterm" href="ch-emacs.php">Emacs and PSGML Mode</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>H</h3><dl><dt>humor</dt><dd><dl><dt>RTFM, <a class="indexterm" href="ch-writing-guidelines.php">Fedora Documentation Guidelines</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>N</h3><dl><dt>naming conven!
tions, <a class="indexterm" href="sn-id-naming-conventions.php!
">ID N
ng Conventions</a></dt><dd><dl><dt>rules for defining an ID, <a class="indexterm" href="sn-id-naming-conventions.php">ID Naming Conventions</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>O</h3><dl><dt>OpenSSH</dt><dd><dl><dt>authorization keys, <a class="indexterm" href="sn-cvs-preparation.php#sn-cvs-generate-keys">Generating SSH Keys</a></dt><dt>ssh-keygen
+ , <a class="indexterm" href="sn-cvs-preparation.php#sn-cvs-generate-keys">Generating SSH Keys</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>P</h3><dl><dt>PSGML, <a class="indexterm" href="ch-emacs.php">Emacs and PSGML Mode</a></dt></dl></div><div class="indexdiv"><h3>R</h3><dl><dt>recursion (see recursion)</dt><dt>RTFM</dt><dd><dl><dt>read the fine manual, <a class="indexterm" href="ch-writing-guidelines.php">Fedora Documentation Guidelines</a></dt><dd><dl><dt>(see also humor)</dt></dl></dd></dl></dd></dl></div><div class="indexdiv"><h3>S</h3><dl><dt>screen captures (see screenshots)</dt><dt>screen grabs (see screenshots)</dt><dt>screenshots</dt><dd><dl><dt>how to take, <a class="indexterm" href="sn-screenshots.php">Screenshots</a></dt></dl></dd><dt>ssh-keygen
+ , <a class="indexterm" href="sn-cvs-preparation.php#sn-cvs-generate-keys">Generating SSH Keys</a></dt></dl></div><div class="indexdiv"><h3>T</h3><dl><dt>tutorial layout</dt><dd><dl><dt>article, <a class="indexterm" href="ch-tutorial.php#sn-tutorial-article">The Article</a></dt><dt>metadata, <a class="indexterm" href="sn-tutorial-metadata.php">The Metadata</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>V</h3><dl><dt>VIM, <a class="indexterm" href="ch-vim.php">VIM and DocBook</a></dt><dd><dl><dt>configuration file, <a class="indexterm" href="ch-vim.php#sn-vimrc-file">Setting Up Your .vimrc File</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>X</h3><dl><dt>XML tags</dt><dd><dl><dt>admonitions</dt><dd><dl><dt>caution, <a class="indexterm" href="sn-xml-admon.php">Admonitions</a></dt><dt>important, <a class="indexterm" href="sn-xml-admon.php">Admonitions</a></dt><dt>note, <a class="indexterm" href="sn-xml-admon.php">Admonitions</a></dt><dt>tip, <a class="!
indexterm" href="sn-xml-admon.php">Admonitions</a></dt><dt>warning, <a class="indexterm" href="sn-xml-admon.php">Admonitions</a></dt></dl></dd><dt>caution, <a class="indexterm" href="sn-xml-admon.php">Admonitions</a>, <a class="indexterm" href="sn-xml-admon.php#sn-xml-notesetc">Creating a note,
+ tip, caution, important, or warning</a></dt><dt>important, <a class="indexterm" href="sn-xml-admon.php">Admonitions</a>, <a class="indexterm" href="sn-xml-admon.php#sn-xml-notesetc">Creating a note,
+ tip, caution, important, or warning</a></dt><dt>naming conventions, <a class="indexterm" href="sn-id-naming-conventions.php">ID Naming Conventions</a></dt><dt>note, <a class="indexterm" href="sn-xml-admon.php">Admonitions</a>, <a class="indexterm" href="sn-xml-admon.php#sn-xml-notesetc">Creating a note,
+ tip, caution, important, or warning</a></dt><dt>rules for defining an ID, <a class="indexterm" href="sn-id-naming-conventions.php">ID Naming Conventions</a></dt><dt>tip, <a class="indexterm" href="sn-xml-admon.php">Admonitions</a>, <a class="indexterm" href="sn-xml-admon.php#sn-xml-notesetc">Creating a note,
+ tip, caution, important, or warning</a></dt><dt>warning, <a class="indexterm" href="sn-xml-admon.php">Admonitions</a>, <a class="indexterm" href="sn-xml-admon.php#sn-xml-notesetc">Creating a note,
+ tip, caution, important, or warning</a></dt></dl></dd><dt>xml tags</dt><dd><dl><dt>caveats, <a class="indexterm" href="sn-xml-tags.php">XML Tags</a></dt></dl></dd></dl></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="acknowledgments.php">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> </td></tr><tr><td width="40%" align="left" valign="top">Chapter 9. Acknowledgments </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div>
<?
$template->displayFooter('$Date$');
Index: index.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/index.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- index.php 16 Sep 2007 19:16:25 -0000 1.3
+++ index.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,8 +7,8 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Fedora 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-US" id="documentation-guide"><div class="titlepage"><div><div><h1 class="title"><a name="documentation-guide"></a>Fedora Documentation Guide</h1></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">Fedora Documentation</span> <span class="surname">Project</span></h3></div></div></div><div><p class="releaseinfo">Version 0.3.2 (2007-09-16)</p></div><div><p class="copyright">Copyright © 2003, 2004, 2005, 2006, 2007 Red Hat, Inc. and others</p></div><div><a href="ln-legalnotice-opl.php">Legal Notice</a></div><div><a href="rv-revhistory.php">Revision History</a></div></div><hr></div><div!
class="toc"><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. Prerequisites</a></span></dt><dd><dl><dt><span class="section"><a href="ch-getting-files.php#sn-system-packages">1.1. System Packages</a></span></dt><dt><span class="section"><a href="ch-getting-files-fdp.php">1.2. Fedora Documentation Tools</a></span></dt><dt><span class="section"><a href="sn-getting-files-names.php">1.3. Naming Conventions</a></span></dt><dd><dl><dt><span class="section"><a href="sn-getting-files-names.php#ch-getting-files-naming-modules">1.3.1. Module Names</a></span></dt><dt><span class="section"><a href="sn-getting-files-names.php#id2655326">1.3.2. File Names</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="ch-how-modules-work.php">2. How Modules Work</a></span></dt><dd><dl><dt><span class="section"><a href="ch-how-modules-work.php#sn-module-struct">2.1. Structure of a Module</a><!
/span></dt><dt><span class="section"><a href="sn-build-system.!
php">2
The Document Build System</a></span></dt><dd><dl><dt><span class="section"><a href="sn-build-system.php#sn-makefile">2.2.1. The Document <code class="filename">Makefile</code></a></span></dt><dt><span class="section"><a href="sn-build-system.php#sn-rpm-info">2.2.2. The Document <code class="filename">rpm-info.xml</code></a></span></dt></dl></dd><dt><span class="section"><a href="ch-getting-files-build-system-targets.php">2.3. Build System Actions</a></span></dt><dd><dl><dt><span class="section"><a href="ch-getting-files-build-system-targets.php#id2615603">2.3.1. Adding or Changing Targets</a></span></dt><dt><span class="section"><a href="ch-getting-files-build-system-targets.php#ch-getting-files-build-system-images">2.3.2. Using Document Image Files</a></span></dt><dt><span class="section"><a href="ch-getting-files-build-system-targets.php#id2536244">2.3.3. Adding a New DocBook XML File</a></span></dt><dt><span class="section"><a href="ch-getting-files-build-system-targets.!
php#id2596139">2.3.4. Adding a Translation</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="ch-writing-guidelines.php">3. Fedora Documentation Guidelines</a></span></dt><dd><dl><dt><span class="section"><a href="ch-writing-guidelines.php#sn-xml-guidelines-header">3.1. File Header</a></span></dt><dd><dl><dt><span class="section"><a href="ch-writing-guidelines.php#sn-xml-header-xml">3.1.1. XML Header</a></span></dt><dt><span class="section"><a href="ch-writing-guidelines.php#sn-xml-header-cvs">3.1.2. CVS Id Header</a></span></dt></dl></dd><dt><span class="section"><a href="sn-id-naming-conventions.php">3.2. ID Naming Conventions</a></span></dt><dt><span class="section"><a href="sn-xml-tags.php">3.3. XML Tags</a></span></dt><dt><span class="section"><a href="sn-xml-admon.php">3.4. Admonitions</a></span></dt><dd><dl><dt><span class="section"><a href="sn-xml-admon.php#sn-xml-notesetc">3.4.1. Creating a <code class="sgmltag-element">note</code>,
- <code class="sgmltag-element">tip</code>, <code class="sgmltag-element">caution</code>, <code class="sgmltag-element">important</code>, or <code class="sgmltag-element">warning</code></a></span></dt></dl></dd><dt><span class="section"><a href="sn-screenshots.php">3.5. Screenshots</a></span></dt><dt><span class="section"><a href="sn-live-previews.php">3.6. Previewing Your Work</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch-emacs.php">4. Emacs and PSGML Mode</a></span></dt><dd><dl><dt><span class="section"><a href="ch-emacs.php#sn-installing-psgml">4.1. Installing PSGML</a></span></dt><dt><span class="section"><a href="sn-emacs-file.php">4.2. Setting Up Your <code class="filename">.emacs</code> File</a></span></dt><dt><span class="section"><a href="sn-emacs-colors.php">4.3. Customizing Emacs</a></span></dt><dt><span class="section"><a href="sn-emacs-basic-commands.php">4.4. Basic Emacs Commands</a></span></dt><dt><span class="section"><a href="sn-emacs-exampl!
es.php">4.5. Examples</a></span></dt><dd><dl><dt><span class="section"><a href="sn-emacs-examples.php#sn-emacs-tag-completion">4.5.1. Tag Completion</a></span></dt><dt><span class="section"><a href="sn-emacs-examples.php#sn-emacs-tag-closing">4.5.2. Tag Closure</a></span></dt><dt><span class="section"><a href="sn-emacs-examples.php#sn-emacs-other">4.5.3. Other Emacs Tasks</a></span></dt><dd><dl><dt><span class="section"><a href="sn-emacs-examples.php#sn-emacs-other-one-window">4.5.3.1. Working with One Window</a></span></dt><dt><span class="section"><a href="sn-emacs-examples.php#sn-emacs-other-save">4.5.3.2. Saving Work</a></span></dt><dt><span class="section"><a href="sn-emacs-examples.php#sn-emacs-other-clearquit">4.5.3.3. The "Clear/Quit" Command</a></span></dt><dt><span class="section"><a href="sn-emacs-examples.php#sn-emacs-other-open">4.5.3.4. Opening a new file</a></span></dt><dt><span class="section"><a href="sn-emacs-examples.php#sn-emacs-other-close">4.5.3.5. Clo!
sing <span><strong class="application">Emacs</strong></span></!
a></sp
</dt></dl></dd></dl></dd><dt><span class="section"><a href="sn-emacs-additional-resources.php">4.6. Additional Resources</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch-vim.php">5. VIM and DocBook</a></span></dt><dd><dl><dt><span class="section"><a href="ch-vim.php#sn-vimrc-file">5.1. Setting Up Your <code class="filename">.vimrc</code> File</a></span></dt><dt><span class="section"><a href="sn-vim-keymapping.php">5.2. Keymapping with VIM</a></span></dt><dt><span class="section"><a href="sn-vim-additional-resources.php">5.3. Additional VIM Resources</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch-tutorial.php">6. The Layout of a Tutorial</a></span></dt><dd><dl><dt><span class="section"><a href="ch-tutorial.php#sn-tutorial-article">6.1. The Article</a></span></dt><dt><span class="section"><a href="sn-tutorial-metadata.php">6.2. The Metadata</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch-publishing.php">7. Publishing Official Docume!
ntation</a></span></dt><dd><dl><dt><span class="section"><a href="ch-publishing.php#sn-how-site-works">7.1. How the Site Works</a></span></dt><dt><span class="section"><a href="sn-sandbox-setup.php">7.2. Setting Up a Web Sandbox</a></span></dt><dt><span class="section"><a href="sn-creating-new-pub.php">7.3. Creating a New Publication</a></span></dt><dd><dl><dt><span class="section"><a href="sn-creating-new-pub.php#sn-creating-new-pub-prepdirs">7.3.1. General Guidelines</a></span></dt><dt><span class="section"><a href="sn-creating-new-pub.php#sn-creating-new-pub-content">7.3.2. Adding Content</a></span></dt><dt><span class="section"><a href="sn-creating-new-pub.php#creating-new-pub-push">7.3.3. Pushing Content to the Web</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="ch-cvs.php">8. CVS</a></span></dt><dd><dl><dt><span class="section"><a href="ch-cvs.php#sn-cvs-overview">8.1. How CVS Works</a></span></dt><dt><span class="section"><a href="sn-cvs-prepara!
tion.php">8.2. Preparing For CVS Use</a></span></dt><dd><dl><d!
t><spa
lass="section"><a href="sn-cvs-preparation.php#sn-cvs-rpm-check">8.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">8.2.2. Generating SSH Keys</a></span></dt></dl></dd><dt><span class="section"><a href="sn-cvs-config.php">8.3. Configuring For CVS Access</a></span></dt><dd><dl><dt><span class="section"><a href="sn-cvs-config.php#sn-cvs-config-cvsrc">8.3.1. Avoiding Repetitive Typing</a></span></dt><dt><span class="section"><a href="sn-cvs-config.php#sn-cvs-config-anon">8.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">8.3.3. Configuring Read/Write CVS Access</a></span></dt></dl></dd><dt><span class="section"><a href="sn-cvs-cvscommands.php">8.4. Basic CVS Commands</a></span></dt><dd><dl><dt><span class="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-co">8.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">8.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">8.4.2. Updating Files</a></span></dt><dt><span class="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-commit">8.4.3. Committing Files</a></span></dt><dt><span class="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-add">8.4.4. Adding Files</a></span></dt><dt><span class="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-admin">8.4.5. Managing Binary Files</a></span></dt><dt><span class="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-rm">8.4.6. Removing Files</a></span></dt><dt><span class="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-status">8.4.7. Status of Files</a></span></dt><dt><span class="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts">8.4.8. Resol!
ving Conflicts</a></span></dt><dt><span class="section"><a hre!
f="sn-
-cvscommands.php#sn-cvs-cvscommands-summary">8.4.9. Summary</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="acknowledgments.php">9. 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="20%" 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>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Fedora 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-US" id="documentation-guide"><div class="titlepage"><div><div><h1 class="title">Fedora Documentation Guide</h1></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">Fedora Documentation</span> <span class="surname">Project</span></h3></div></div></div><div><p class="releaseinfo">Version 0.3.2.1 (2007-11-14)</p></div><div><p class="copyright">Copyright © 2003, 2004, 2005, 2006, 2007 Red Hat, Inc. and others</p></div><div><a href="legalnotice-opl.php">Legal Notice</a></div><div><a href="rv-revhistory.php">Revision History</a></div></div><hr></div><div class="toc"><dl><dt><span class="p!
reface"><a href="ch-intro.php">Introduction</a></span></dt><dt><span class="chapter"><a href="ch-getting-files.php">1. Prerequisites</a></span></dt><dd><dl><dt><span class="section"><a href="ch-getting-files.php#sn-system-packages">1.1. System Packages</a></span></dt><dt><span class="section"><a href="ch-getting-files-fdp.php">1.2. Fedora Documentation Tools</a></span></dt><dt><span class="section"><a href="sn-getting-files-names.php">1.3. Naming Conventions</a></span></dt><dd><dl><dt><span class="section"><a href="sn-getting-files-names.php#ch-getting-files-naming-modules">1.3.1. Module Names</a></span></dt><dt><span class="section"><a href="sn-getting-files-names.php#id358844">1.3.2. File Names</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="ch-how-modules-work.php">2. How Modules Work</a></span></dt><dd><dl><dt><span class="section"><a href="ch-how-modules-work.php#sn-module-struct">2.1. Structure of a Module</a></span></dt><dt><span class="section"!
><a href="sn-build-system.php">2.2. The Document Build System<!
/a></s
></dt><dd><dl><dt><span class="section"><a href="sn-build-system.php#sn-makefile">2.2.1. The Document <code class="filename">Makefile</code></a></span></dt><dt><span class="section"><a href="sn-build-system.php#sn-rpm-info">2.2.2. The Document <code class="filename">rpm-info.xml</code></a></span></dt></dl></dd><dt><span class="section"><a href="ch-getting-files-build-system-targets.php">2.3. Build System Actions</a></span></dt><dd><dl><dt><span class="section"><a href="ch-getting-files-build-system-targets.php#id383200">2.3.1. Adding or Changing Targets</a></span></dt><dt><span class="section"><a href="ch-getting-files-build-system-targets.php#ch-getting-files-build-system-images">2.3.2. Using Document Image Files</a></span></dt><dt><span class="section"><a href="ch-getting-files-build-system-targets.php#id383416">2.3.3. Adding a New DocBook XML File</a></span></dt><dt><span class="section"><a href="ch-getting-files-build-system-targets.php#id383474">2.3.4. Adding a Translat!
ion</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="ch-writing-guidelines.php">3. Fedora Documentation Guidelines</a></span></dt><dd><dl><dt><span class="section"><a href="ch-writing-guidelines.php#sn-xml-guidelines-header">3.1. File Header</a></span></dt><dd><dl><dt><span class="section"><a href="ch-writing-guidelines.php#sn-xml-header-xml">3.1.1. XML Header</a></span></dt><dt><span class="section"><a href="ch-writing-guidelines.php#sn-xml-header-cvs">3.1.2. CVS Id Header</a></span></dt></dl></dd><dt><span class="section"><a href="sn-id-naming-conventions.php">3.2. ID Naming Conventions</a></span></dt><dt><span class="section"><a href="sn-xml-tags.php">3.3. XML Tags</a></span></dt><dt><span class="section"><a href="sn-xml-admon.php">3.4. Admonitions</a></span></dt><dd><dl><dt><span class="section"><a href="sn-xml-admon.php#sn-xml-notesetc">3.4.1. Creating a <code class="sgmltag-element">note</code>,
+ <code class="sgmltag-element">tip</code>, <code class="sgmltag-element">caution</code>, <code class="sgmltag-element">important</code>, or <code class="sgmltag-element">warning</code></a></span></dt></dl></dd><dt><span class="section"><a href="sn-screenshots.php">3.5. Screenshots</a></span></dt><dt><span class="section"><a href="sn-live-previews.php">3.6. Previewing Your Work</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch-emacs.php">4. Emacs and PSGML Mode</a></span></dt><dd><dl><dt><span class="section"><a href="ch-emacs.php#sn-installing-psgml">4.1. Installing PSGML</a></span></dt><dt><span class="section"><a href="sn-emacs-file.php">4.2. Setting Up Your <code class="filename">.emacs</code> File</a></span></dt><dt><span class="section"><a href="sn-emacs-colors.php">4.3. Customizing Emacs</a></span></dt><dt><span class="section"><a href="sn-emacs-basic-commands.php">4.4. Basic Emacs Commands</a></span></dt><dt><span class="section"><a href="sn-emacs-exampl!
es.php">4.5. Examples</a></span></dt><dd><dl><dt><span class="section"><a href="sn-emacs-examples.php#sn-emacs-tag-completion">4.5.1. Tag Completion</a></span></dt><dt><span class="section"><a href="sn-emacs-examples.php#sn-emacs-tag-closing">4.5.2. Tag Closure</a></span></dt><dt><span class="section"><a href="sn-emacs-examples.php#sn-emacs-other">4.5.3. Other Emacs Tasks</a></span></dt><dd><dl><dt><span class="section"><a href="sn-emacs-examples.php#sn-emacs-other-one-window">4.5.3.1. Working with One Window</a></span></dt><dt><span class="section"><a href="sn-emacs-examples.php#sn-emacs-other-save">4.5.3.2. Saving Work</a></span></dt><dt><span class="section"><a href="sn-emacs-examples.php#sn-emacs-other-clearquit">4.5.3.3. The "Clear/Quit" Command</a></span></dt><dt><span class="section"><a href="sn-emacs-examples.php#sn-emacs-other-open">4.5.3.4. Opening a new file</a></span></dt><dt><span class="section"><a href="sn-emacs-examples.php#sn-emacs-other-close">4.5.3.5. Clo!
sing <span class="application"><strong>Emacs</strong></span></!
a></sp
</dt></dl></dd></dl></dd><dt><span class="section"><a href="sn-emacs-additional-resources.php">4.6. Additional Resources</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch-vim.php">5. VIM and DocBook</a></span></dt><dd><dl><dt><span class="section"><a href="ch-vim.php#sn-vimrc-file">5.1. Setting Up Your <code class="filename">.vimrc</code> File</a></span></dt><dt><span class="section"><a href="sn-vim-keymapping.php">5.2. Keymapping with VIM</a></span></dt><dt><span class="section"><a href="sn-vim-additional-resources.php">5.3. Additional VIM Resources</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch-tutorial.php">6. The Layout of a Tutorial</a></span></dt><dd><dl><dt><span class="section"><a href="ch-tutorial.php#sn-tutorial-article">6.1. The Article</a></span></dt><dt><span class="section"><a href="sn-tutorial-metadata.php">6.2. The Metadata</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch-publishing.php">7. Publishing Official Docume!
ntation</a></span></dt><dd><dl><dt><span class="section"><a href="ch-publishing.php#sn-how-site-works">7.1. How the Site Works</a></span></dt><dt><span class="section"><a href="sn-sandbox-setup.php">7.2. Setting Up a Web Sandbox</a></span></dt><dt><span class="section"><a href="sn-creating-new-pub.php">7.3. Creating a New Publication</a></span></dt><dd><dl><dt><span class="section"><a href="sn-creating-new-pub.php#sn-creating-new-pub-prepdirs">7.3.1. General Guidelines</a></span></dt><dt><span class="section"><a href="sn-creating-new-pub.php#sn-creating-new-pub-content">7.3.2. Adding Content</a></span></dt><dt><span class="section"><a href="sn-creating-new-pub.php#creating-new-pub-push">7.3.3. Pushing Content to the Web</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="ch-cvs.php">8. CVS</a></span></dt><dd><dl><dt><span class="section"><a href="ch-cvs.php#sn-cvs-overview">8.1. How CVS Works</a></span></dt><dt><span class="section"><a href="sn-cvs-prepara!
tion.php">8.2. Preparing For CVS Use</a></span></dt><dd><dl><d!
t><spa
lass="section"><a href="sn-cvs-preparation.php#sn-cvs-rpm-check">8.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">8.2.2. Generating SSH Keys</a></span></dt></dl></dd><dt><span class="section"><a href="sn-cvs-config.php">8.3. Configuring For CVS Access</a></span></dt><dd><dl><dt><span class="section"><a href="sn-cvs-config.php#sn-cvs-config-cvsrc">8.3.1. Avoiding Repetitive Typing</a></span></dt><dt><span class="section"><a href="sn-cvs-config.php#sn-cvs-config-anon">8.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">8.3.3. Configuring Read/Write CVS Access</a></span></dt></dl></dd><dt><span class="section"><a href="sn-cvs-cvscommands.php">8.4. Basic CVS Commands</a></span></dt><dd><dl><dt><span class="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-co">8.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">8.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">8.4.2. Updating Files</a></span></dt><dt><span class="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-commit">8.4.3. Committing Files</a></span></dt><dt><span class="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-add">8.4.4. Adding Files</a></span></dt><dt><span class="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-admin">8.4.5. Managing Binary Files</a></span></dt><dt><span class="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-rm">8.4.6. Removing Files</a></span></dt><dt><span class="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-status">8.4.7. Status of Files</a></span></dt><dt><span class="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts">8.4.8. Resol!
ving Conflicts</a></span></dt><dt><span class="section"><a hre!
f="sn-
-cvscommands.php#sn-cvs-cvscommands-summary">8.4.9. Summary</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="acknowledgments.php">9. 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="20%" 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>
<?
$template->displayFooter('$Date$');
Index: rv-revhistory.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/rv-revhistory.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- rv-revhistory.php 16 Sep 2007 19:16:25 -0000 1.3
+++ rv-revhistory.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,27 +7,31 @@
?>
-<div class="revhistory"><table border="1" width="100%" summary="Revision history"><tr><th align="left" valign="top" colspan="3"><b>Revision History</b></th></tr><tr><td align="left">Revision 0.3.2</td><td align="left">2007-09-16</td><td align="left"></td></tr><tr><td align="left" colspan="3">
+<div class="revhistory"><table border="1" width="100%" summary="Revision history"><tr><th align="left" valign="top" colspan="3"><b>Revision History</b></th></tr><tr><td align="left">Revision 0.3.2.1</td><td align="left">2007-11-14</td><td align="left">PWF</td></tr><tr><td align="left" colspan="3">
+ <p>
+ Add link to DocBook XML help for Windows
+ </p>
+ </td></tr><tr><td align="left">Revision 0.3.2</td><td align="left">2007-09-16</td><td align="left">PWF</td></tr><tr><td align="left" colspan="3">
<p>
Add guidance on CVS web access and previewing work
</p>
- </td></tr><tr><td align="left">Revision 0.3.1</td><td align="left">2007-08-03</td><td align="left"></td></tr><tr><td align="left" colspan="3">
+ </td></tr><tr><td align="left">Revision 0.3.1</td><td align="left">2007-08-03</td><td align="left">PWF</td></tr><tr><td align="left" colspan="3">
<p>
Add new chapter on publishing
</p>
- </td></tr><tr><td align="left">Revision 0.3.0.3</td><td align="left">2007-07-29</td><td align="left"></td></tr><tr><td align="left" colspan="3">
+ </td></tr><tr><td align="left">Revision 0.3.0.3</td><td align="left">2007-07-29</td><td align="left">PWF</td></tr><tr><td align="left" colspan="3">
<p>
Include information on LINGUAS usage
</p>
- </td></tr><tr><td align="left">Revision 0.3.0.2</td><td align="left">2007-07-28</td><td align="left"></td></tr><tr><td align="left" colspan="3">
+ </td></tr><tr><td align="left">Revision 0.3.0.2</td><td align="left">2007-07-28</td><td align="left">PWF</td></tr><tr><td align="left" colspan="3">
<p>
Remove unnecessary chapter on XML tags
</p>
- </td></tr><tr><td align="left">Revision 0.3.0.1</td><td align="left">2007-07-01</td><td align="left"></td></tr><tr><td align="left" colspan="3">
+ </td></tr><tr><td align="left">Revision 0.3.0.1</td><td align="left">2007-07-01</td><td align="left">PWF</td></tr><tr><td align="left" colspan="3">
<p>
Assorted fixes to reflect newer version of reality
</p>
- </td></tr><tr><td align="left">Revision 0.3.0</td><td align="left">2007-06-23</td><td align="left"></td></tr><tr><td align="left" colspan="3">
+ </td></tr><tr><td align="left">Revision 0.3.0</td><td align="left">2007-06-23</td><td align="left">TFJFSMPWF</td></tr><tr><td align="left" colspan="3">
<p>
Update to new content and build requirements
</p>
Index: sn-build-system.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-build-system.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- sn-build-system.php 16 Sep 2007 19:16:25 -0000 1.3
+++ sn-build-system.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,19 +7,19 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.2. The Document Build System</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-how-modules-work.php">Prev</a> </td><th width="60%" align="center">Chapter 2. How Modules Work</th><td width="20%" align="right"> <a accesskey="n" href="ch-getting-files-build-system-targets.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-build-system"></a>2.2. The Document Build System</h2></div></div></div><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.2. The Document Build System</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-how-modules-work.php">Prev</a> </td><th width="60%" align="center">Chapter 2. How Modules Work</th><td width="20%" align="right"> <a accesskey="n" href="ch-getting-files-build-system-targets.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-build-system">2.2. The Document Build System</h2></div></div></div><p>
The build system can render the document into another format such
as <abbr class="abbrev">HTML</abbr> or <abbr class="abbrev">PDF</abbr>, using
- <code class="command">make(1)</code><sup>[<a name="id2532622" href="#ftn.id2532622">2</a>]</sup> and shell scripts. Authors need
+ <code class="command">make(1)</code><sup>[<a name="id358457" href="#ftn.id358457" class="footnote">2</a>]</sup> and shell scripts. Authors need
<span class="emphasis"><em>no</em></span> prior experience with either shell scripts
or a <code class="command">make(1)</code>.
- </p><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="sn-makefile"></a>2.2.1. The Document <code class="filename">Makefile</code></h3></div></div></div><p>
+ </p><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="sn-makefile">2.2.1. The Document <code class="filename">Makefile</code></h3></div></div></div><p>
Each individual document has its own
<code class="filename">Makefile</code>, which only needs to be a few
lines long. The document <code class="filename">Makefile</code> content
is designed for cut and paste operations.
</p><p>
- <a href="sn-build-system.php#ex-makefile" title="Example 2.2. Sample Document Makefile">Example 2.2, “Sample Document Makefileâ€</a> below shows the whole
+ <a class="xref" href="sn-build-system.php#ex-makefile" title="Example 2.2. Sample Document Makefile">Example 2.2, “Sample Document Makefileâ€</a> below shows the whole
<code class="filename">Makefile</code> for a simple document with two
files and two translations.
</p><div class="example"><a name="ex-makefile"></a><div class="example-contents"><pre class="screen">DOCBASE = example-doc
@@ -61,14 +61,14 @@
The final section, beginning with <code class="literal">define</code>,
locates the main <code class="filename">Makefile.common</code> for the
build system. This <code class="filename">Makefile.common</code> file
- contains all the <span><strong class="application">make(1)</strong></span> targets and
+ contains all the <span class="application"><strong>make(1)</strong></span> targets and
rules to actually build the document and the various archives.
- </p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="sn-rpm-info"></a>2.2.2. The Document <code class="filename">rpm-info.xml</code></h3></div></div></div><p>Each document module's primary language directory contains a
+ </p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="sn-rpm-info">2.2.2. The Document <code class="filename">rpm-info.xml</code></h3></div></div></div><p>Each document module's primary language directory contains a
file called <code class="filename">rpm-info.xml</code>. This file
contains document-specific metadata used to generate revision
history, copyright, and contributor information. It follows a
DTD specification included with the rest of the build system
- tools.</p></div><div class="footnotes"><br><hr width="100" align="left"><div class="footnote"><p><sup>[<a name="ftn.id2532622" href="#id2532622">2</a>] </sup>In Linux and Fedora documentation, references to
+ tools.</p></div><div class="footnotes"><br><hr width="100" align="left"><div class="footnote"><p><sup>[<a name="ftn.id358457" href="#id358457" class="para">2</a>] </sup>In Linux and Fedora documentation, references to
commands often include a number inside parentheses. This
number represents the section of
<em class="firstterm">manpages</em> that includes documentation
Index: sn-creating-new-pub.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-creating-new-pub.php,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- sn-creating-new-pub.php 16 Sep 2007 19:16:25 -0000 1.2
+++ sn-creating-new-pub.php 15 Nov 2007 02:10:15 -0000 1.3
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">7.3. Creating a New Publication</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-sandbox-setup.php">Prev</a> </td><th width="60%" align="center">Chapter 7. Publishing Official Documentation</th><td width="20%" align="right"> <a accesskey="n" href="ch-cvs.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-creating-new-pub"></a>7.3. Creating a New Publication</h2></div></div></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="sn-creating-new-pub-prepdirs"></a>7.3.1. General Guidelines</h3></div></div></div><p>Follow these guidelines to ensure maintainability and ease
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">7.3. Creating a New Publication</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-sandbox-setup.php">Prev</a> </td><th width="60%" align="center">Chapter 7. Publishing Official Documentation</th><td width="20%" align="right"> <a accesskey="n" href="ch-cvs.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-creating-new-pub">7.3. Creating a New Publication</h2></div></div></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="sn-creating-new-pub-prepdirs">7.3.1. General Guidelines</h3></div></div></div><p>Follow these guidelines to ensure maintainability and ease
of use for all publishers.</p><div class="itemizedlist"><ul type="disc"><li><p>Use a short, descriptive name for the document
directory. The module name from its Docs CVS location is
usually appropriate. Good examples include <code class="filename">install-guide/</code> or <code class="filename">example-tutorial/</code>.</p></li><li><p>Under the document directory, include a branch directory
@@ -15,7 +15,7 @@
Fedora release.</p></li><li><p>Under the branch directory (or document directory if no
branches are necessary), make at least a <code class="filename">en_US/</code> directory. Make an
additional directory for each locale that has been fully
- translated.</p></li></ul></div></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="sn-creating-new-pub-content"></a>7.3.2. Adding Content</h3></div></div></div><p>To add content, follow the procedure below. The following
+ translated.</p></li></ul></div></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="sn-creating-new-pub-content">7.3.2. Adding Content</h3></div></div></div><p>To add content, follow the procedure below. The following
commands show an example of adding content for a new document
called the <em class="citetitle">Foobar Tutorial</em>. This document
includes a translation for the "zz_XX" locale and follows
@@ -45,7 +45,7 @@
and point it at
<code class="uri">http://docs.localhost.localdomain/</code>.</p><div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Important: Always Test Changes"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="./stylesheet-images/important.png"></td><th align="left">Always Test Changes</th></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>Do not proceed further until you test all
changes.</em></span> Check that all links and index
- pages work.</p></td></tr></table></div></li></ol></div></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="creating-new-pub-push"></a>7.3.3. Pushing Content to the Web</h3></div></div></div><p>To push your new content to the web site, follow this
+ pages work.</p></td></tr></table></div></li></ol></div></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="creating-new-pub-push">7.3.3. Pushing Content to the Web</h3></div></div></div><p>To push your new content to the web site, follow this
procedure:</p><div class="procedure"><ol type="1"><li><p>Add all the new file content to CVS.</p><pre class="screen">cd ~/fedora/web/html/docs/
cvs add foobar-tutorial
cd foobar-tutorial
Index: sn-cvs-config.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-cvs-config.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- sn-cvs-config.php 16 Sep 2007 19:16:25 -0000 1.3
+++ sn-cvs-config.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,11 +7,11 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">8.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 8. 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-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-cvs-config"></a>8.3. Configuring For CVS Access</h2></div></div></div><a class="indexterm" name="id2623189"></a><a class="indexterm" name="id2606518"></a><a class="indexterm" name="id2611728"></a><a class="indexterm" name="id2596606"></a><a class="indexterm" name="id2586667"></a><a class="indexterm" name="id2589682"></a><a class="indexterm" name="id2640746"></a><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="sn!
-cvs-config-cvsrc"></a>8.3.1. Avoiding Repetitive Typing</h3></div></div></div><a class="indexterm" name="id2593442"></a><p>
- Many <span><strong class="application">CVS</strong></span> commands need certain
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">8.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 8. 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-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-cvs-config">8.3. Configuring For CVS Access</h2></div></div></div><a class="indexterm" name="id382106"></a><a class="indexterm" name="id349227"></a><a class="indexterm" name="id349240"></a><a class="indexterm" name="id349254"></a><a class="indexterm" name="id349263"></a><a class="indexterm" name="id349273"></a><a class="indexterm" name="id349291"></a><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="sn-cvs-config-cvsrc">8.!
3.1. Avoiding Repetitive Typing</h3></div></div></div><a class="indexterm" name="id349314"></a><p>
+ Many <span class="application"><strong>CVS</strong></span> commands need certain
command line switches to operate consistently. Rather than
typing them every time that command is used, you can save the
- switches in a file that <span><strong class="application">CVS</strong></span> will read
+ switches in a file that <span class="application"><strong>CVS</strong></span> will read
before executing your command line.
</p><p>
Create a file named <code class="filename">~/.cvsrc</code> in your home
@@ -21,15 +21,15 @@
diff -uNp
rdiff -uNp
update -dP</code></pre><p>
- </p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-config-anon"></a>8.3.2. Configuring for Read-Only CVS Access</h3></div></div></div><a class="indexterm" name="id2645276"></a><a class="indexterm" name="id2645289"></a><p>
+ </p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="sn-cvs-config-anon">8.3.2. Configuring for Read-Only CVS Access</h3></div></div></div><a class="indexterm" name="id349375"></a><a class="indexterm" name="id349389"></a><p>
If your goal is to download the various Fedora documents and to
render them on your system, you only need read-only access to
- the <span><strong class="application">CVS</strong></span> repository. Follow the
+ the <span class="application"><strong>CVS</strong></span> repository. Follow the
instructions in this section and then skip directly to
- <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-co" title="8.4.1. Checking Out Modules">Section 8.4.1, “Checking Out Modulesâ€</a>.
+ <a class="xref" href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-co" title="8.4.1. Checking Out Modules">Section 8.4.1, “Checking Out Modulesâ€</a>.
</p><p>
Change directories to where you want your files from
- <span><strong class="application">CVS</strong></span> to be located, and execute the
+ <span class="application"><strong>CVS</strong></span> to be located, and execute the
following commands:
</p><pre class="screen"><code class="command">export CVSROOT=:pserver:anonymous at cvs.fedoraproject.org:/cvs/docs</code>
<code class="command">cvs login</code>
@@ -41,25 +41,25 @@
It is stored in the file <code class="filename">CVS/Root</code>
for each directory in your local repository. As long as your
current working directory has a <code class="filename">CVS/</code>
- directory, the <span><strong class="application">CVS</strong></span> program will
+ directory, the <span class="application"><strong>CVS</strong></span> program will
automatically locate the Fedora Documentation Project repository.
- </p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-config-author"></a>8.3.3. Configuring Read/Write CVS Access</h3></div></div></div><a class="indexterm" name="id2644976"></a><a class="indexterm" name="id2644989"></a><p>
+ </p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="sn-cvs-config-author">8.3.3. Configuring Read/Write CVS Access</h3></div></div></div><a class="indexterm" name="id349507"></a><a class="indexterm" name="id349521"></a><p>
To author a new document or to change an existing one, you must
obtain full read/write access to the Fedora Documentation Project
- <span><strong class="application">CVS</strong></span> repository. For the full details
+ <span class="application"><strong>CVS</strong></span> repository. For the full details
on this process, refer to the
- <a href="http://fedoraproject.org/wiki/DocsProject/NewWriters" target="_top"><code class="filename">http://fedoraproject.org/wiki/DocsProject/Join</code>
+ <a class="ulink" href="http://fedoraproject.org/wiki/DocsProject/NewWriters" target="_top"><code class="filename">http://fedoraproject.org/wiki/DocsProject/Join</code>
</a> web site.
</p><p>
Every author has a unique <code class="envar">$CVSROOT</code> to access the
- <span><strong class="application">CVS</strong></span> repository:
+ <span class="application"><strong>CVS</strong></span> repository:
</p><pre class="screen"><code class="command">export CVSROOT=:ext:<em class="replaceable"><code>yourname</code></em>@cvs.fedoraproject.org:/cvs/docs</code>
<code class="command">export CVS_RSH=/usr/bin/ssh</code></pre><p>
With the <code class="envar">$CVSROOT</code> and <code class="envar">$CVS_RSH</code>
environment variables in place, you can access the repository:
</p><pre class="screen"><code class="command">cvs co -c</code></pre><p>
You will be asked for the passphrase for your
- <span><strong class="application">SSH</strong></span> key. Press <span><strong class="keycap">Enter</strong></span>
+ <span class="application"><strong>SSH</strong></span> key. Press <span class="keycap"><strong>Enter</strong></span>
to receive a list of modules already in the repository.
</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sn-cvs-preparation.php">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch-cvs.php">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="sn-cvs-cvscommands.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">8.2. Preparing For CVS Use </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 8.4. Basic CVS Commands</td></tr></table></div>
<?
Index: sn-cvs-cvscommands.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-cvs-cvscommands.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- sn-cvs-cvscommands.php 16 Sep 2007 19:16:25 -0000 1.3
+++ sn-cvs-cvscommands.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">8.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 8. 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-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-cvs-cvscommands"></a>8.4. Basic CVS Commands</h2></div></div></div><a class="indexterm" name="id2645111"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">8.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 8. 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-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-cvs-cvscommands">8.4. Basic CVS Commands</h2></div></div></div><a class="indexterm" name="id349636"></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 align="left" valign="top"><p>
@@ -18,10 +18,10 @@
working directory.
</p><p>
If you have a <code class="filename">CVS/</code> directory,
- <span><strong class="application">CVS</strong></span> ignores any
+ <span class="application"><strong>CVS</strong></span> ignores any
<code class="envar">$CVSROOT</code> or <code class="option">-m</code> command line
switch.
- </p></td></tr></table></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-co"></a>8.4.1. Checking Out Modules</h3></div></div></div><a class="indexterm" name="id2650877"></a><p>
+ </p></td></tr></table></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="sn-cvs-cvscommands-co">8.4.1. Checking Out Modules</h3></div></div></div><a class="indexterm" name="id349714"></a><p>
You only need to checkout a module once. Once a local copy of
the module is on your system, you may continue to use it for
additional work.
@@ -37,9 +37,9 @@
</p><p>
If a branch name is not specified when checking out a module, it
is referred to as the <em class="firstterm">HEAD</em> of the
- <span><strong class="application">CVS</strong></span> module.
- </p><div class="section" lang="en-US"><div class="titlepage"><div><div><h4 class="title"><a name="sn-cvs-cvscommands-co-branch"></a>8.4.1.1. Checking Out Branches of Modules</h4></div></div></div><a class="indexterm" name="id2650968"></a><p>
- Think of a <span><strong class="application">CVS</strong></span> branch as a version
+ <span class="application"><strong>CVS</strong></span> module.
+ </p><div class="section" lang="en-US"><div class="titlepage"><div><div><h4 class="title" id="sn-cvs-cvscommands-co-branch">8.4.1.1. Checking Out Branches of Modules</h4></div></div></div><a class="indexterm" name="id349800"></a><p>
+ Think of a <span class="application"><strong>CVS</strong></span> branch as a version
of the files for a particular version of a manual or package.
</p><p>
To checkout a branch of a module, use the following command:
@@ -79,17 +79,17 @@
Only tags marked as branches in the second column under the
<code class="computeroutput">Existing Tags</code> section can be
checked out as a branch.
- </p></div></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-up"></a>8.4.2. Updating Files</h3></div></div></div><a class="indexterm" name="id2582832"></a><p>
+ </p></div></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="sn-cvs-cvscommands-up">8.4.2. Updating Files</h3></div></div></div><a class="indexterm" name="id349962"></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:
</p><pre class="screen"><code class="command">cvs update</code></pre><p>
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="8.4.8. Resolving Conflicts">Section 8.4.8, “Resolving Conflictsâ€</a>.
- </p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-commit"></a>8.4.3. Committing Files</h3></div></div></div><a class="indexterm" name="id2582882"></a><p>
+ refer to <a class="xref" href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts" title="8.4.8. Resolving Conflicts">Section 8.4.8, “Resolving Conflictsâ€</a>.
+ </p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="sn-cvs-cvscommands-commit">8.4.3. Committing Files</h3></div></div></div><a class="indexterm" name="id350010"></a><p>
After modifying files in your local version of a module, commit
- them to save the changes on the <span><strong class="application">CVS</strong></span>
+ them to save the changes on the <span class="application"><strong>CVS</strong></span>
server:
</p><pre class="screen"><code class="command">cvs commit -m "<em class="replaceable"><code>some log message</code></em>" <em class="replaceable"><code>filename</code></em></code></pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="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 align="left" valign="top"><p>
If you would prefer to write your log message with your
@@ -105,7 +105,7 @@
Using a log message such as <strong class="userinput"><code>updated some
files</code></strong> does not accurately describe what has changed
and will not help you in the future. If you are correcting a
- bug, use the <span><strong class="application">Bugzilla</strong></span> reference.
+ bug, use the <span class="application"><strong>Bugzilla</strong></span> reference.
</p><p>
The <em class="replaceable"><code>filename</code></em> can be one
filename, a series of filenames separated by spaces, or a group
@@ -122,29 +122,29 @@
what files changed.
</p></td></tr></table></div><p>
If you notice a file conflict, refer to
- <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts" title="8.4.8. Resolving Conflicts">Section 8.4.8, “Resolving Conflictsâ€</a>.
- </p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-add"></a>8.4.4. Adding Files</h3></div></div></div><a class="indexterm" name="id2660682"></a><p>
+ <a class="xref" href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts" title="8.4.8. Resolving Conflicts">Section 8.4.8, “Resolving Conflictsâ€</a>.
+ </p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="sn-cvs-cvscommands-add">8.4.4. Adding Files</h3></div></div></div><a class="indexterm" name="id350163"></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"><code class="command">cvs add</code> <em class="replaceable"><code>file-to-add</code></em></pre><p>
After adding the file, you must <code class="command">commit</code> the
<code class="command">add</code> to copy it to the server:
- </p><pre class="screen"><code class="command">cvs commit -m "<em class="replaceable"><code>some log message</code></em>" <em class="replaceable"><code>file-to-add</code></em></code></pre></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-admin"></a>8.4.5. Managing Binary Files</h3></div></div></div><a class="indexterm" name="id2660755"></a><p>
+ </p><pre class="screen"><code class="command">cvs commit -m "<em class="replaceable"><code>some log message</code></em>" <em class="replaceable"><code>file-to-add</code></em></code></pre></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="sn-cvs-cvscommands-admin">8.4.5. Managing Binary Files</h3></div></div></div><a class="indexterm" name="id350236"></a><p>
The most commonly-archived files are simple text files, but
sometimes binary files are also archived. The
- <span><strong class="application">cvs</strong></span> program recognizes most common
+ <span class="application"><strong>cvs</strong></span> program recognizes most common
filename extensions such as <code class="filename">.png</code> or
<code class="filename">.jpg</code>, and usually behaves as the user
intends.
</p><p>
When a copy of a file is checked out of the repository,
- <span><strong class="application">cvs</strong></span> scans it for special keywords
+ <span class="application"><strong>cvs</strong></span> scans it for special keywords
such as <code class="computeroutput">$id:$</code>. The
- <span><strong class="application">cvs</strong></span> program replaces the keyword with
+ <span class="application"><strong>cvs</strong></span> program replaces the keyword with
a generated value such as the file version number.
</p><p>
This keyword substitution usually corrupts binary files, so it
- must be turned off if <span><strong class="application">cvs</strong></span> does not
+ must be turned off if <span class="application"><strong>cvs</strong></span> does not
recognize your file as binary. To mark your file as being
binary, and thus needing the keyword expansion turned off, use
the command:
@@ -160,7 +160,7 @@
it corrupted when it is checked out, do not panic. Use the
<code class="option">admin</code> 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-US"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-rm"></a>8.4.6. Removing Files</h3></div></div></div><a class="indexterm" name="id2639806"></a><p>
+ </p></td></tr></table></div></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="sn-cvs-cvscommands-rm">8.4.6. Removing Files</h3></div></div></div><a class="indexterm" name="id350358"></a><p>
If a file is no longer needed in the module, use the
<code class="command">remove</code> command to remove it from your local
copy and then <code class="command">commit</code> the removal to the
@@ -177,20 +177,20 @@
exact filename.
</p><p>
If you need to rename a file, it is best to rename the file on
- the <span><strong class="application">CVS</strong></span> server so that the history of
+ the <span class="application"><strong>CVS</strong></span> server so that the history of
the file is preserved. If you need to rename a file, send an
email to
- <a href="mailto:cvsdocs-administrator at fedoraproject.org" target="_top">cvsdocs-administrator at fedoraproject.org</a> asking to have the file renamed.
- </p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-status"></a>8.4.7. Status of Files</h3></div></div></div><a class="indexterm" name="id2639928"></a><p>
+ <a class="ulink" href="mailto:cvsdocs-administrator at fedoraproject.org" target="_top">cvsdocs-administrator at fedoraproject.org</a> asking to have the file renamed.
+ </p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="sn-cvs-cvscommands-status">8.4.7. Status of Files</h3></div></div></div><a class="indexterm" name="id350471"></a><p>
Sometimes it is necessary to view the
<em class="firstterm">status</em> of a file in a
- <span><strong class="application">CVS</strong></span> module. To view the status of a
+ <span class="application"><strong>CVS</strong></span> module. To view the status of a
file, use the command:
</p><pre class="screen"><code class="command">cvs status</code> <em class="replaceable"><code>filename</code></em></pre><p>
The status report of a repository file is as follows:
</p><div class="variablelist"><dl><dt><span class="term"><code class="computeroutput">Up-to-date</code></span></dt><dd><p>
Your revision of the file is identical to the latest
- revision on the <span><strong class="application">CVS</strong></span> server.
+ revision on the <span class="application"><strong>CVS</strong></span> server.
</p></dd><dt><span class="term"><code class="computeroutput">Locally Modified</code></span></dt><dd><p>
You have updated to the latest revision from the server,
but then you modified the file on your system.
@@ -221,18 +221,18 @@
except when you tried to issue the <code class="command">cvs
update</code> command, the differences could not be
resolved automatically. Refer to
- <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts" title="8.4.8. Resolving Conflicts">Section 8.4.8, “Resolving Conflictsâ€</a> for
+ <a class="xref" href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts" title="8.4.8. Resolving Conflicts">Section 8.4.8, “Resolving Conflictsâ€</a> for
more information on resolving conflicts.
</p></dd><dt><span class="term"><code class="computeroutput">Unknown</code></span></dt><dd><p>
- The <span><strong class="application">CVS</strong></span> server does not know
+ The <span class="application"><strong>CVS</strong></span> server does not know
anything about this file. It has neither been added nor
removed locally and has never been committed to the
server. This status usually occurs for files you should
- not commit to <span><strong class="application">CVS</strong></span> such as
+ not commit to <span class="application"><strong>CVS</strong></span> such as
<code class="filename">generated-index.sgml</code> or for files
that you want to add to the repository but have not yet
issued the <code class="command">cvs add</code> command.
- </p></dd></dl></div></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-conflicts"></a>8.4.8. Resolving Conflicts</h3></div></div></div><a class="indexterm" name="id2640250"></a><p>
+ </p></dd></dl></div></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="sn-cvs-cvscommands-conflicts">8.4.8. Resolving Conflicts</h3></div></div></div><a class="indexterm" name="id350777"></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
@@ -265,9 +265,9 @@
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-US"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-cvscommands-summary"></a>8.4.9. Summary</h3></div></div></div><a class="indexterm" name="id2640358"></a><p>
+ </p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="sn-cvs-cvscommands-summary">8.4.9. Summary</h3></div></div></div><a class="indexterm" name="id350874"></a><p>
All commands assume you are in the proper directory for the
- <span><strong class="application">CVS</strong></span> module.
+ <span class="application"><strong>CVS</strong></span> module.
</p><div class="table"><a name="tb-cvs-basic-commands"></a><div class="table-contents"><table summary="Basic CVS Commands" border="1"><colgroup><col><col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><code class="command">cvs checkout
<em class="replaceable"><code><module-name></code></em></code>
or <code class="command">cvs co <em class="replaceable"><code><module-name></code></em></code>
@@ -296,16 +296,16 @@
<code class="filename">/usr/share/doc/cvs-<em class="replaceable"><code><version-number></code></em>/cvs.ps</code>
(the CVS version might vary) and visit the CVS webpage available
at
- <a href="http://www.cvshome.org/" target="_top">http://www.cvshome.org/</a>.
+ <a class="ulink" href="http://www.cvshome.org/" target="_top">http://www.cvshome.org/</a>.
</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 align="left" valign="top"><p>
- Since <span><strong class="application">CVS</strong></span> is using
- <span><strong class="application">ssh</strong></span> to connect to the
- <span><strong class="application">CVS</strong></span> server, you will be prompted
+ Since <span class="application"><strong>CVS</strong></span> is using
+ <span class="application"><strong>ssh</strong></span> to connect to the
+ <span class="application"><strong>CVS</strong></span> server, you will be prompted
your password before performing your
- <span><strong class="application">CVS</strong></span> request. If you want to
+ <span class="application"><strong>CVS</strong></span> request. If you want to
configure your machine so that you do not have to enter a
password, refer to the
- <a href="http://redhat.com/docs/manuals/linux/RHL-9-Manual/custom-guide/s1-openssh-client-config.html" target="_top"><em class="citetitle">Red Hat
+ <a class="ulink" href="http://redhat.com/docs/manuals/linux/RHL-9-Manual/custom-guide/s1-openssh-client-config.html" target="_top"><em class="citetitle">Red Hat
Linux 9 Customization Guide</em> </a> for details
about using <code class="command">ssh-agent</code>.
</p></td></tr></table></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sn-cvs-config.php">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch-cvs.php">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="acknowledgments.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">8.3. Configuring For CVS Access </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> Chapter 9. Acknowledgments</td></tr></table></div>
Index: sn-cvs-preparation.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-cvs-preparation.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- sn-cvs-preparation.php 16 Sep 2007 19:16:25 -0000 1.3
+++ sn-cvs-preparation.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,13 +7,13 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">8.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 8. 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-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-cvs-preparation"></a>8.2. Preparing For CVS Use</h2></div></div></div><a class="indexterm" name="id2518532"></a><p>
- Before using <span><strong class="application">CVS</strong></span>, you need to establish
- an account with the <span><strong class="application">CVS</strong></span> server. After
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">8.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 8. 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-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-cvs-preparation">8.2. Preparing For CVS Use</h2></div></div></div><a class="indexterm" name="id396517"></a><p>
+ Before using <span class="application"><strong>CVS</strong></span>, you need to establish
+ an account with the <span class="application"><strong>CVS</strong></span> server. After
you get an account, you do not need to perform these actions
again.
- </p><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-rpm-check"></a>8.2.1. Is CVS Installed On Your System</h3></div></div></div><a class="indexterm" name="id2638019"></a><p>
- You must have the <span><strong class="application">CVS</strong></span>
+ </p><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="sn-cvs-rpm-check">8.2.1. Is CVS Installed On Your System</h3></div></div></div><a class="indexterm" name="id381521"></a><p>
+ You must have the <span class="application"><strong>CVS</strong></span>
<abbr class="abbrev">RPM</abbr> package installed. Verify its presence by
typing the command:
</p><pre class="screen"><code class="command">rpm -q cvs</code></pre><p>
@@ -21,15 +21,15 @@
<code class="computeroutput">cvs-1.11.19-1</code>, then the package
is installed. A message similar to <code class="computeroutput">package cvs
is not installed</code> means you must install the
- <span><strong class="application">cvs</strong></span> package before continuing. If you
+ <span class="application"><strong>cvs</strong></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-US"><div class="titlepage"><div><div><h3 class="title"><a name="sn-cvs-generate-keys"></a>8.2.2. Generating SSH Keys</h3></div></div></div><a class="indexterm" name="id2599495"></a><p>
- The <span><strong class="application">CVS</strong></span> server uses
- <span><strong class="application">SSH</strong></span> Protocol 2 keys to authenticate
+ </p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="sn-cvs-generate-keys">8.2.2. Generating SSH Keys</h3></div></div></div><a class="indexterm" name="id384227"></a><p>
+ The <span class="application"><strong>CVS</strong></span> server uses
+ <span class="application"><strong>SSH</strong></span> Protocol 2 keys to authenticate
users. Thus, you need to generate a pair of keys before applying
- for a <span><strong class="application">CVS</strong></span> account. If you already
- have an <span><strong class="application">SSH</strong></span> <abbr class="abbrev">DSA</abbr> key,
+ for a <span class="application"><strong>CVS</strong></span> account. If you already
+ have an <span class="application"><strong>SSH</strong></span> <abbr class="abbrev">DSA</abbr> key,
you may skip this step.
</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 align="left" valign="top"><p>
You already have a <abbr class="abbrev">DSA</abbr> key if you have the
@@ -40,11 +40,11 @@
generate one that does require a passphrase.
</p></td></tr></table></div><p>
Use the following steps to generate a <abbr class="abbrev">DSA</abbr> key
- used by <span><strong class="application">SSH</strong></span> Protocol 2. It is
+ used by <span class="application"><strong>SSH</strong></span> Protocol 2. It is
required for an
<code class="computeroutput">cvs.fedoraproject.org</code>
- <span><strong class="application">CVS</strong></span> account.
- </p><div class="orderedlist"><a class="indexterm" name="id2590770"></a><a class="indexterm" name="id2654848"></a><ol type="1"><li><p>
+ <span class="application"><strong>CVS</strong></span> account.
+ </p><div class="orderedlist"><a class="indexterm" name="id381924"></a><a class="indexterm" name="id381942"></a><ol type="1"><li><p>
To generate a
<acronym class="acronym">DSA</acronym>
key to work with version 2.0 protocol, at a shell prompt,
@@ -61,7 +61,7 @@
following at a shell prompt.
</p><pre class="screen"><code class="command">cat ~/.ssh/id_dsa.pub >> ~/.ssh/authorized_keys</code></pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="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 align="left" valign="top"><p>
Check this command carefully before you press the
- <span><strong class="keycap">Enter</strong></span> key. If
+ <span class="keycap"><strong>Enter</strong></span> key. If
<code class="filename">~/.ssh/authorized_keys</code> already
exists, the contents of
<code class="filename">~/.ssh/id_dsa.pub</code> will be appended to
@@ -74,8 +74,8 @@
<code class="command">chmod 644 ~/.ssh/authorized_keys</code></pre></li></ol></div><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 align="left" valign="top"><p>
You can have your system remember your passphrase so that you
do not have to type it every time you access the
- <span><strong class="application">CVS</strong></span> server. Refer to the
- documentation of the <span><strong class="application">ssh-add</strong></span>
+ <span class="application"><strong>CVS</strong></span> server. Refer to the
+ documentation of the <span class="application"><strong>ssh-add</strong></span>
program.
</p></td></tr></table></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch-cvs.php">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch-cvs.php">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="sn-cvs-config.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 8. CVS </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 8.3. Configuring For CVS Access</td></tr></table></div>
<?
Index: sn-emacs-additional-resources.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-emacs-additional-resources.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- sn-emacs-additional-resources.php 16 Sep 2007 19:16:25 -0000 1.3
+++ sn-emacs-additional-resources.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,9 +7,9 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">4.6. Additional Resources</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-emacs-examples.php">Prev</a> </td><th width="60%" align="center">Chapter 4. Emacs and PSGML Mode</th><td width="20%" align="right"> <a accesskey="n" href="ch-vim.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-emacs-additional-resources"></a>4.6. Additional Resources</h2></div></div></div><p> Additional Emacs and PSGML references are available at the
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">4.6. Additional Resources</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-emacs-examples.php">Prev</a> </td><th width="60%" align="center">Chapter 4. Emacs and PSGML Mode</th><td width="20%" align="right"> <a accesskey="n" href="ch-vim.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-emacs-additional-resources">4.6. Additional Resources</h2></div></div></div><p> Additional Emacs and PSGML references are available at the
following locations:
- </p><div class="itemizedlist"><ul type="disc"><li><p><a href="http://wks.uts.ohio-state.edu/unix_course/intro-135.html" target="_top">http://wks.uts.ohio-state.edu/unix_course/intro-135.html</a>
+ </p><div class="itemizedlist"><ul type="disc"><li><p><a class="ulink" href="http://wks.uts.ohio-state.edu/unix_course/intro-135.html" target="_top">http://wks.uts.ohio-state.edu/unix_course/intro-135.html</a>
— <em class="citetitle">Emacs Quick Reference Guide</em>
</p></li><li><p>Emacs reference card that comes with the
<code class="filename">emacs</code> package. You can print it out as a
@@ -18,10 +18,10 @@
</p></li><li><p>Read <em class="citetitle">Editing XML with Emacs and
PSGML</em> in
<code class="filename">/usr/share/doc/psgml-<em class="replaceable"><code>version</code></em>/psgml.ps</code>.
- </p></li><li><p><a href="http://www.snee.com/bob/sgmlfree/psgmqref.html" target="_top">http://www.snee.com/bob/sgmlfree/psgmqref.html</a>
+ </p></li><li><p><a class="ulink" href="http://www.snee.com/bob/sgmlfree/psgmqref.html" target="_top">http://www.snee.com/bob/sgmlfree/psgmqref.html</a>
— <em class="citetitle">Emacs/PSGML Quick Reference</em> is
a reference table of Emacs commands for PSGML mode.
- </p></li><li><p><a href="http://www.snee.com/bob/sgmlfree/emcspsgm.html" target="_top">http://www.snee.com/bob/sgmlfree/emcspsgm.html</a>
+ </p></li><li><p><a class="ulink" href="http://www.snee.com/bob/sgmlfree/emcspsgm.html" target="_top">http://www.snee.com/bob/sgmlfree/emcspsgm.html</a>
— <em class="citetitle">PSGML Tricks</em></p></li></ul></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sn-emacs-examples.php">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch-emacs.php">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch-vim.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">4.5. Examples </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> Chapter 5. VIM and DocBook</td></tr></table></div>
<?
Index: sn-emacs-basic-commands.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-emacs-basic-commands.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- sn-emacs-basic-commands.php 16 Sep 2007 19:16:25 -0000 1.3
+++ sn-emacs-basic-commands.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,16 +7,16 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">4.4. Basic Emacs Commands</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-emacs-colors.php">Prev</a> </td><th width="60%" align="center">Chapter 4. Emacs and PSGML Mode</th><td width="20%" align="right"> <a accesskey="n" href="sn-emacs-examples.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-emacs-basic-commands"></a>4.4. Basic Emacs Commands</h2></div></div></div><p>
- The <span><strong class="keycap">Meta</strong></span> key is usually the <span><strong class="keycap">Alt</strong></span>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">4.4. Basic Emacs Commands</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-emacs-colors.php">Prev</a> </td><th width="60%" align="center">Chapter 4. Emacs and PSGML Mode</th><td width="20%" align="right"> <a accesskey="n" href="sn-emacs-examples.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-emacs-basic-commands">4.4. Basic Emacs Commands</h2></div></div></div><p>
+ The <span class="keycap"><strong>Meta</strong></span> key is usually the <span class="keycap"><strong>Alt</strong></span>
key.
- </p><div class="segmentedlist"><a name="tb-emacs-commands"></a><div class="title"><strong><span class="title">Emacs Commands</span></strong></div><table border="0"><thead><tr class="segtitle"><th>Shortcut</th><th>Description</th></tr></thead><tbody><tr class="seglistitem"><td class="seg"><span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">c</strong></span>,
- <span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">p</strong></span></td><td class="seg">Parse DTD</td></tr><tr class="seglistitem"><td class="seg"><span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">c</strong></span>, <span><strong class="keycap">Shift</strong></span>-<span><strong class="keycap">,</strong></span>, <span><strong class="keycap">Tab</strong></span></td><td class="seg">Display list of valid tags</td></tr><tr class="seglistitem"><td class="seg"><span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">c</strong></span>, <span><strong class="keycap">Shift</strong></span>-<span><strong class="keycap">,</strong></span>, type beginning of tag,
- <span><strong class="keycap">Tab</strong></span></td><td class="seg">Complete the tag</td></tr><tr class="seglistitem"><td class="seg"><span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">g</strong></span></td><td class="seg">Cancel a command in the minibuffer</td></tr><tr class="seglistitem"><td class="seg"><span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">c</strong></span>, <span><strong class="keycap">/</strong></span></td><td class="seg">Close tag</td></tr><tr class="seglistitem"><td class="seg"><span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">a</strong></span></td><td class="seg">Move cursor to beginning of line</td></tr><tr class="seglistitem"><td class="seg"><span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">e</strong></span></td><td class="seg">Move cursor to the end of the line</td></tr><tr class="seglistitem"><td class="seg"><span><strong class="keyc!
ap">Ctrl</strong></span>-<span><strong class="keycap">Home</strong></span></td><td class="seg">Move cursor to the beginning of the file</td></tr><tr class="seglistitem"><td class="seg"><span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">End</strong></span></td><td class="seg">Move cursor to the end of the file</td></tr><tr class="seglistitem"><td class="seg"><span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">k</strong></span></td><td class="seg">Cut line</td></tr><tr class="seglistitem"><td class="seg"><span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">y</strong></span></td><td class="seg">Paste line</td></tr><tr class="seglistitem"><td class="seg"><span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">s</strong></span></td><td class="seg">Search forward in the file</td></tr><tr class="seglistitem"><td class="seg"><span><strong class="keycap">Ctrl</strong></span>-<span!
><strong class="keycap">r</strong></span></td><td class="seg">!
Search
ckwards in the file</td></tr><tr class="seglistitem"><td class="seg"><span><strong class="keycap">Meta</strong></span>-<span><strong class="keycap">$</strong></span></td><td class="seg">Check spelling of current word</td></tr><tr class="seglistitem"><td class="seg"><span><strong class="keycap">Meta</strong></span>-<span><strong class="keycap">x</strong></span> ispell-word, <span><strong class="keycap">Enter</strong></span></td><td class="seg">Check spelling of current word</td></tr><tr class="seglistitem"><td class="seg"><span><strong class="keycap">Meta</strong></span>-<span><strong class="keycap">x</strong></span> ispell-buffer, <span><strong class="keycap">Enter</strong></span></td><td class="seg">Check spelling of current buffer</td></tr><tr class="seglistitem"><td class="seg"><span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">x</strong></span>, <span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">f</strong></span></t!
d><td class="seg">Open file</td></tr><tr class="seglistitem"><td class="seg"><span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">x</strong></span>, <span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">s</strong></span></td><td class="seg">Save file</td></tr><tr class="seglistitem"><td class="seg"><span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">x</strong></span>, <span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">c</strong></span></td><td class="seg">Exit <span><strong class="application">Emacs</strong></span> and prompt to save
- files if necessary</td></tr><tr class="seglistitem"><td class="seg"><span><strong class="keycap">Meta</strong></span>-<span><strong class="keycap">q</strong></span></td><td class="seg">Fill paragraph</td></tr><tr class="seglistitem"><td class="seg"><span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">c</strong></span>, <span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">a</strong></span></td><td class="seg">Edit attributes for a tag (for example, you can edit the
+ </p><div class="segmentedlist"><a name="tb-emacs-commands"></a><div class="title"><strong><span class="title">Emacs Commands</span></strong></div><table border="0"><thead><tr class="segtitle"><th>Shortcut</th><th>Description</th></tr></thead><tbody><tr class="seglistitem"><td class="seg"><span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>c</strong></span>,
+ <span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>p</strong></span></td><td class="seg">Parse DTD</td></tr><tr class="seglistitem"><td class="seg"><span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>c</strong></span>, <span class="keycap"><strong>Shift</strong></span>+<span class="keycap"><strong>,</strong></span>, <span class="keycap"><strong>Tab</strong></span></td><td class="seg">Display list of valid tags</td></tr><tr class="seglistitem"><td class="seg"><span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>c</strong></span>, <span class="keycap"><strong>Shift</strong></span>+<span class="keycap"><strong>,</strong></span>, type beginning of tag,
+ <span class="keycap"><strong>Tab</strong></span></td><td class="seg">Complete the tag</td></tr><tr class="seglistitem"><td class="seg"><span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>g</strong></span></td><td class="seg">Cancel a command in the minibuffer</td></tr><tr class="seglistitem"><td class="seg"><span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>c</strong></span>, <span class="keycap"><strong>/</strong></span></td><td class="seg">Close tag</td></tr><tr class="seglistitem"><td class="seg"><span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>a</strong></span></td><td class="seg">Move cursor to beginning of line</td></tr><tr class="seglistitem"><td class="seg"><span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>e</strong></span></td><td class="seg">Move cursor to the end of the line</td></tr><tr class="seglistitem"><td class="seg"><span class="keycap"><str!
ong>Ctrl</strong></span>+<span class="keycap"><strong>Home</strong></span></td><td class="seg">Move cursor to the beginning of the file</td></tr><tr class="seglistitem"><td class="seg"><span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>End</strong></span></td><td class="seg">Move cursor to the end of the file</td></tr><tr class="seglistitem"><td class="seg"><span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>k</strong></span></td><td class="seg">Cut line</td></tr><tr class="seglistitem"><td class="seg"><span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>y</strong></span></td><td class="seg">Paste line</td></tr><tr class="seglistitem"><td class="seg"><span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>s</strong></span></td><td class="seg">Search forward in the file</td></tr><tr class="seglistitem"><td class="seg"><span class="keycap"><strong>Ctrl</strong></span>+<span!
class="keycap"><strong>r</strong></span></td><td class="seg">!
Search
ckwards in the file</td></tr><tr class="seglistitem"><td class="seg"><span class="keycap"><strong>Meta</strong></span>+<span class="keycap"><strong>$</strong></span></td><td class="seg">Check spelling of current word</td></tr><tr class="seglistitem"><td class="seg"><span class="keycap"><strong>Meta</strong></span>+<span class="keycap"><strong>x</strong></span> ispell-word, <span class="keycap"><strong>Enter</strong></span></td><td class="seg">Check spelling of current word</td></tr><tr class="seglistitem"><td class="seg"><span class="keycap"><strong>Meta</strong></span>+<span class="keycap"><strong>x</strong></span> ispell-buffer, <span class="keycap"><strong>Enter</strong></span></td><td class="seg">Check spelling of current buffer</td></tr><tr class="seglistitem"><td class="seg"><span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>x</strong></span>, <span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>f</strong></span></t!
d><td class="seg">Open file</td></tr><tr class="seglistitem"><td class="seg"><span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>x</strong></span>, <span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>s</strong></span></td><td class="seg">Save file</td></tr><tr class="seglistitem"><td class="seg"><span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>x</strong></span>, <span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>c</strong></span></td><td class="seg">Exit <span class="application"><strong>Emacs</strong></span> and prompt to save
+ files if necessary</td></tr><tr class="seglistitem"><td class="seg"><span class="keycap"><strong>Meta</strong></span>+<span class="keycap"><strong>q</strong></span></td><td class="seg">Fill paragraph</td></tr><tr class="seglistitem"><td class="seg"><span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>c</strong></span>, <span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>a</strong></span></td><td class="seg">Edit attributes for a tag (for example, you can edit the
<code class="computeroutput">url</code> attribute of the
- <code class="computeroutput">ulink</code> tag)</td></tr><tr class="seglistitem"><td class="seg"><span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">c</strong></span>,
- <span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">c</strong></span></td><td class="seg">Exit edit attributes</td></tr></tbody></table></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sn-emacs-colors.php">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch-emacs.php">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="sn-emacs-examples.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">4.3. Customizing Emacs </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 4.5. Examples</td></tr></table></div>
+ <code class="computeroutput">ulink</code> tag)</td></tr><tr class="seglistitem"><td class="seg"><span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>c</strong></span>,
+ <span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>c</strong></span></td><td class="seg">Exit edit attributes</td></tr></tbody></table></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sn-emacs-colors.php">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch-emacs.php">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="sn-emacs-examples.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">4.3. Customizing Emacs </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 4.5. Examples</td></tr></table></div>
<?
$template->displayFooter('$Date$');
Index: sn-emacs-colors.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-emacs-colors.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- sn-emacs-colors.php 16 Sep 2007 19:16:25 -0000 1.3
+++ sn-emacs-colors.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">4.3. Customizing Emacs</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-emacs-file.php">Prev</a> </td><th width="60%" align="center">Chapter 4. Emacs and PSGML Mode</th><td width="20%" align="right"> <a accesskey="n" href="sn-emacs-basic-commands.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-emacs-colors"></a>4.3. Customizing Emacs</h2></div></div></div><a class="indexterm" name="id2630793"></a><a class="indexterm" name="id2583310"></a><a class="indexterm" name="id2585426"></a><a class="indexterm" name="id2649944"></a><a class="indexterm" name="id2595008"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">4.3. Customizing Emacs</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-emacs-file.php">Prev</a> </td><th width="60%" align="center">Chapter 4. Emacs and PSGML Mode</th><td width="20%" align="right"> <a accesskey="n" href="sn-emacs-basic-commands.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-emacs-colors">4.3. Customizing Emacs</h2></div></div></div><a class="indexterm" name="id368917"></a><a class="indexterm" name="id368931"></a><a class="indexterm" name="id356209"></a><a class="indexterm" name="id356222"></a><a class="indexterm" name="id356236"></a><p>
The colors, font, and geometry (default size of window) for Emacs
in your <code class="filename">~/.Xresources</code> file. The format for
the settings is <strong class="userinput"><code>emacs.keyword:value</code></strong>.
@@ -25,7 +25,7 @@
emacs.geometry: 90x25</pre></td></tr></table></div><p>
After modifying this file, execute the following command:
</p><pre class="screen"><code class="command">xrdb -merge ~/.Xresources</code></pre><p>
- Then restart <span><strong class="application">Emacs</strong></span> to apply the
+ Then restart <span class="application"><strong>Emacs</strong></span> to apply the
changes.
</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sn-emacs-file.php">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch-emacs.php">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="sn-emacs-basic-commands.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">4.2. Setting Up Your <code class="filename">.emacs</code> File </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 4.4. Basic Emacs Commands</td></tr></table></div>
<?
Index: sn-emacs-examples.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-emacs-examples.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- sn-emacs-examples.php 16 Sep 2007 19:16:25 -0000 1.3
+++ sn-emacs-examples.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,52 +7,52 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">4.5. Examples</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-emacs-basic-commands.php">Prev</a> </td><th width="60%" align="center">Chapter 4. Emacs and PSGML Mode</th><td width="20%" align="right"> <a accesskey="n" href="sn-emacs-additional-resources.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-emacs-examples"></a>4.5. Examples</h2></div></div></div><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">4.5. Examples</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-emacs-basic-commands.php">Prev</a> </td><th width="60%" align="center">Chapter 4. Emacs and PSGML Mode</th><td width="20%" align="right"> <a accesskey="n" href="sn-emacs-additional-resources.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-emacs-examples">4.5. Examples</h2></div></div></div><p>
The table or reference card of Emacs and PSGML commands can be
confusing for beginners. This section provides some examples of
how to use them.
- </p><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="sn-emacs-tag-completion"></a>4.5.1. Tag Completion</h3></div></div></div><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 align="left" valign="top"><p>This section assumes that you have already parsed the DTD
+ </p><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="sn-emacs-tag-completion">4.5.1. Tag Completion</h3></div></div></div><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 align="left" valign="top"><p>This section assumes that you have already parsed the DTD
file.</p></td></tr></table></div><p>
To avoid having to type a tag repeatedly, use the key
- combination <span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">c</strong></span>, followed
- by <span><strong class="keycap"><</strong></span>. At the bottom of the
- <span><strong class="application">Emacs</strong></span> window, the following prompt
+ combination <span class="keycap"><strong>Ctrl</strong></span>-<span class="keycap"><strong>c</strong></span>, followed
+ by <span class="keycap"><strong><</strong></span>. At the bottom of the
+ <span class="application"><strong>Emacs</strong></span> window, the following prompt
appears:
</p><pre class="screen"><code class="prompt">Tag: <</code></pre><p>
To view a list of available tags, use either the
- <span><strong class="keycap">Tab</strong></span> or <span><strong class="keycap">?</strong></span>. If you know the
+ <span class="keycap"><strong>Tab</strong></span> or <span class="keycap"><strong>?</strong></span>. If you know the
first few letters of a tag, enter them, followed by
- <span><strong class="keycap">Tab</strong></span>. If the letters uniquely identify a tag,
+ <span class="keycap"><strong>Tab</strong></span>. If the letters uniquely identify a tag,
that tag appears. If more than one completion exists, a
complete list of possible tags appears.
</p><p>
- If you hit <span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">c</strong></span>, <span><strong class="keycap"><</strong></span>, <span><strong class="keycap">k</strong></span>, a prompt
+ If you hit <span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>c</strong></span>, <span class="keycap"><strong><</strong></span>, <span class="keycap"><strong>k</strong></span>, a prompt
appears similar to the example below:
</p><pre class="screen">Click mouse-2 on a completion to select it.
In this buffer, type RET to select the completion near point.
Possible completions are:
<keycap> <keycode>
-<keycombo> <keysym></pre></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="sn-emacs-tag-closing"></a>4.5.2. Tag Closure</h3></div></div></div><p>
+<keycombo> <keysym></pre></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="sn-emacs-tag-closing">4.5.2. Tag Closure</h3></div></div></div><p>
After you open a tag, you must close it. The easiest way to
close an open tag is to use the key sequence
- <span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">c</strong></span>, <span><strong class="keycap">/</strong></span>. This sequence closes the most
+ <span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>c</strong></span>, <span class="keycap"><strong>/</strong></span>. This sequence closes the most
recently opened tag.
- </p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="sn-emacs-other"></a>4.5.3. Other Emacs Tasks</h3></div></div></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h4 class="title"><a name="sn-emacs-other-one-window"></a>4.5.3.1. Working with One Window</h4></div></div></div><p>Sometimes in <span><strong class="application">Emacs</strong></span>, the window
+ </p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="sn-emacs-other">4.5.3. Other Emacs Tasks</h3></div></div></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h4 class="title" id="sn-emacs-other-one-window">4.5.3.1. Working with One Window</h4></div></div></div><p>Sometimes in <span class="application"><strong>Emacs</strong></span>, the window
becomes split, with tags completions or other text in an
alternate window. To return to a single window, use the key
- sequence <span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">x</strong></span>, <span><strong class="keycap">1</strong></span>.</p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h4 class="title"><a name="sn-emacs-other-save"></a>4.5.3.2. Saving Work</h4></div></div></div><p>To save your work, use the key sequence
- <span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">x</strong></span>, <span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">s</strong></span>.</p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h4 class="title"><a name="sn-emacs-other-clearquit"></a>4.5.3.3. The "Clear/Quit" Command</h4></div></div></div><p>If the tag completion process becomes unwieldy or
- confusing, use the keysequence <span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">g</strong></span> to exit back to the text.
- <span><strong class="application">Emacs</strong></span> clears any prompts and returns
- to the buffer text.</p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h4 class="title"><a name="sn-emacs-other-open"></a>4.5.3.4. Opening a new file</h4></div></div></div><p>To open a new file, use the key sequence
- <span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">x</strong></span>, <span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">f</strong></span>. A prompt appears at the bottom of the
- <span><strong class="application">Emacs</strong></span> window. Enter the file name,
- using <span><strong class="keycap">Tab</strong></span> completion if desired, of the file
- you wish to open.</p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h4 class="title"><a name="sn-emacs-other-close"></a>4.5.3.5. Closing <span><strong class="application">Emacs</strong></span></h4></div></div></div><p>To close <span><strong class="application">Emacs</strong></span> use the key
+ sequence <span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>x</strong></span>, <span class="keycap"><strong>1</strong></span>.</p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h4 class="title" id="sn-emacs-other-save">4.5.3.2. Saving Work</h4></div></div></div><p>To save your work, use the key sequence
+ <span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>x</strong></span>, <span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>s</strong></span>.</p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h4 class="title" id="sn-emacs-other-clearquit">4.5.3.3. The "Clear/Quit" Command</h4></div></div></div><p>If the tag completion process becomes unwieldy or
+ confusing, use the keysequence <span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>g</strong></span> to exit back to the text.
+ <span class="application"><strong>Emacs</strong></span> clears any prompts and returns
+ to the buffer text.</p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h4 class="title" id="sn-emacs-other-open">4.5.3.4. Opening a new file</h4></div></div></div><p>To open a new file, use the key sequence
+ <span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>x</strong></span>, <span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>f</strong></span>. A prompt appears at the bottom of the
+ <span class="application"><strong>Emacs</strong></span> window. Enter the file name,
+ using <span class="keycap"><strong>Tab</strong></span> completion if desired, of the file
+ you wish to open.</p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h4 class="title" id="sn-emacs-other-close">4.5.3.5. Closing <span class="application"><strong>Emacs</strong></span></h4></div></div></div><p>To close <span class="application"><strong>Emacs</strong></span> use the key
sequence
- <span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">x</strong></span>, <span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">c</strong></span>. If you have not saved your work,
- <span><strong class="application">Emacs</strong></span> prompts you to save any
+ <span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>x</strong></span>, <span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>c</strong></span>. If you have not saved your work,
+ <span class="application"><strong>Emacs</strong></span> prompts you to save any
changed files.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sn-emacs-basic-commands.php">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch-emacs.php">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="sn-emacs-additional-resources.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">4.4. Basic Emacs Commands </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 4.6. Additional Resources</td></tr></table></div>
<?
Index: sn-emacs-file.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-emacs-file.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- sn-emacs-file.php 16 Sep 2007 19:16:25 -0000 1.3
+++ sn-emacs-file.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">4.2. Setting Up Your <code class="filename">.emacs</code> File</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-emacs.php">Prev</a> </td><th width="60%" align="center">Chapter 4. Emacs and PSGML Mode</th><td width="20%" align="right"> <a accesskey="n" href="sn-emacs-colors.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-emacs-file"></a>4.2. Setting Up Your <code class="filename">.emacs</code> File</h2></div></div></div><a class="indexterm" name="id2626523"></a><a class="indexterm" name="id2593796"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">4.2. Setting Up Your <code class="filename">.emacs</code> File</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-emacs.php">Prev</a> </td><th width="60%" align="center">Chapter 4. Emacs and PSGML Mode</th><td width="20%" align="right"> <a accesskey="n" href="sn-emacs-colors.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-emacs-file">4.2. Setting Up Your <code class="filename">.emacs</code> File</h2></div></div></div><a class="indexterm" name="id396729"></a><a class="indexterm" name="id379588"></a><p>
For Emacs to parse your DocBook documents correctly, you must have
a <code class="filename">.emacs</code> file. Cut and paste the following
into your existing <code class="filename">.emacs</code> file or create a
@@ -137,13 +137,13 @@
entry (current-word))))</pre><p>
If you have a wheel mouse and are using Emacs version 21, you can
add the following to your <code class="filename">.emacs</code> file so your
- wheel will work in <span><strong class="application">Emacs</strong></span>:
+ wheel will work in <span class="application"><strong>Emacs</strong></span>:
</p><pre class="screen">;; Enable wheelmouse support by default for emacs 21
(cond (window-system
(mwheel-install)
))</pre><p>
If you are using the older version 20 of
- <span><strong class="application">Emacs</strong></span>, add the following instead:
+ <span class="application"><strong>Emacs</strong></span>, add the following instead:
</p><pre class="screen">;; Enable wheelmouse support by default
(require 'mwheel)</pre></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch-emacs.php">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch-emacs.php">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="sn-emacs-colors.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 4. Emacs and PSGML Mode </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 4.3. Customizing Emacs</td></tr></table></div>
<?
Index: sn-getting-files-names.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-getting-files-names.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- sn-getting-files-names.php 16 Sep 2007 19:16:25 -0000 1.3
+++ sn-getting-files-names.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">1.3. Naming Conventions</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-getting-files-fdp.php">Prev</a> </td><th width="60%" align="center">Chapter 1. Prerequisites</th><td width="20%" align="right"> <a accesskey="n" href="ch-how-modules-work.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-getting-files-names"></a>1.3. Naming Conventions</h2></div></div></div><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">1.3. Naming Conventions</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-getting-files-fdp.php">Prev</a> </td><th width="60%" align="center">Chapter 1. Prerequisites</th><td width="20%" align="right"> <a accesskey="n" href="ch-how-modules-work.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-getting-files-names">1.3. Naming Conventions</h2></div></div></div><p>
The Fedora Documentation Project provides the tools, scripts, and stylesheets to
transform your <abbr class="abbrev">XML</abbr> documents into other output
formats such as <abbr class="abbrev">HTML</abbr>. In addition, these tools
@@ -21,7 +21,7 @@
release of Fedora. Contributors can check out single branches
of these modules or the entire module. Each document or branch
may contain multiple XML source files.</p><p>Use the <code class="command">cvs co -c</code> command to view existing
- module names.</p><div class="example"><a name="id2609064"></a><div class="example-contents"><pre class="screen"><strong class="userinput"><code>cd ~/localrepo/fedora-docs/</code></strong>
+ module names.</p><div class="example"><a name="id380185"></a><div class="example-contents"><pre class="screen"><strong class="userinput"><code>cd ~/localrepo/fedora-docs/</code></strong>
<code class="computeroutput">about-fedora about-fedora &docs-common
about-fedora-F-7 &about-fedora-F-7-dir &docs-common
about-fedora-F-7-dir -d about-fedora about-fedora/F-7
@@ -41,7 +41,7 @@
documentation-guide documentation-guide &docs-common</code></pre></div><p class="title"><b>Example 1.1. Partial List of CVS Modules</b></p></div><br class="example-break"><p>The leftmost entry in each line is the name of a module you
can check out from CVS. The rest of the line ensures that
checkouts include the proper branch of a document and the common
- build tools. For more information on CVS, refer to <a href="ch-cvs.php" title="Chapter 8. CVS">Chapter 8, <i>CVS</i></a>.</p><p>Note in the listing above that the
+ build tools. For more information on CVS, refer to <a class="xref" href="ch-cvs.php" title="Chapter 8. CVS">Chapter 8, <i>CVS</i></a>.</p><p>Note in the listing above that the
<code class="systemitem">about-fedora</code> module has two branches
available. One branch is for Fedora 7 and one is for forward
development to match the current work of developers. On the other
@@ -49,7 +49,7 @@
not branched.</p><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Tip: Modules Labeled -dir"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="./stylesheet-images/tip.png"></td><th align="left">Modules Labeled <code class="filename">-dir</code></th></tr><tr><td align="left" valign="top"><p>Modules ending with the suffix <code class="filename">-dir</code> are
not usually helpful to checkout directly. These modules do not
include the common build tools and thus do not provide many of
- the functions contributors require.</p></td></tr></table></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="ch-getting-files-naming-modules"></a>1.3.1. Module Names</h3></div></div></div><p>Choose a module name that accurately reflects your
+ the functions contributors require.</p></td></tr></table></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="ch-getting-files-naming-modules">1.3.1. Module Names</h3></div></div></div><p>Choose a module name that accurately reflects your
document's subject, but avoid any name already taken. The
document title without any use of the word
<em class="wordasword">fedora</em> is a reasonable choice in most
@@ -60,7 +60,7 @@
Do not use the word <em class="wordasword">fedora</em> to name
modules in the Fedora Documentation Project CVS repository.
</p></td></tr></table></div><div class="segmentedlist"><a name="sl-correct-module-naming"></a><div class="title"><strong><span class="title">Correct Module Naming</span></strong></div><table border="0"><thead><tr class="segtitle"><th>Document Name</th><th>CVS Module Name</th></tr></thead><tbody><tr class="seglistitem"><td class="seg">Desktop User Guide</td><td class="seg">desktop-user-guide</td></tr><tr class="seglistitem"><td class="seg">Software Management with
- <span><strong class="application">Yum</strong></span></td><td class="seg">yum-guide</td></tr><tr class="seglistitem"><td class="seg">Using <span><strong class="application">Pup</strong></span></td><td class="seg">pup-tutorial</td></tr></tbody></table></div></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="id2655326"></a>1.3.2. File Names</h3></div></div></div><p>Follow these guidelines for naming files to make
+ <span class="application"><strong>Yum</strong></span></td><td class="seg">yum-guide</td></tr><tr class="seglistitem"><td class="seg">Using <span class="application"><strong>Pup</strong></span></td><td class="seg">pup-tutorial</td></tr></tbody></table></div></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="id358844">1.3.2. File Names</h3></div></div></div><p>Follow these guidelines for naming files to make
collaboration and document reuse easy:</p><div class="itemizedlist"><ul type="disc"><li><p>As with module names, avoid using the word
<em class="wordasword">fedora</em> in file names since it is
redundant.</p></li><li><p>If the document is comprised of many XML files, avoid
Index: sn-id-naming-conventions.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-id-naming-conventions.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- sn-id-naming-conventions.php 16 Sep 2007 19:16:25 -0000 1.3
+++ sn-id-naming-conventions.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,12 +7,12 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">3.2. ID Naming Conventions</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-writing-guidelines.php">Prev</a> </td><th width="60%" align="center">Chapter 3. Fedora Documentation Guidelines</th><td width="20%" align="right"> <a accesskey="n" href="sn-xml-tags.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-id-naming-conventions"></a>3.2. ID Naming Conventions</h2></div></div></div><a class="indexterm" name="id2616402"></a><a class="indexterm" name="id2607432"></a><p>This section explains the ID naming convention. IDs are
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">3.2. ID Naming Conventions</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-writing-guidelines.php">Prev</a> </td><th width="60%" align="center">Chapter 3. Fedora Documentation Guidelines</th><td width="20%" align="right"> <a accesskey="n" href="sn-xml-tags.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-id-naming-conventions">3.2. ID Naming Conventions</h2></div></div></div><a class="indexterm" name="id363277"></a><a class="indexterm" name="id363291"></a><p>This section explains the ID naming convention. IDs are
unique identifiers that allow DocBook XML to cross-reference a
- section, chapter, or other element.</p><a class="indexterm" name="id2656223"></a><a class="indexterm" name="id2649122"></a><p>The following general rules apply to IDs:</p><div class="itemizedlist"><ul type="disc"><li><p>Keep an ID as short and simple as possible.</p></li><li><p>Start the ID with the special short two-character label.
+ section, chapter, or other element.</p><a class="indexterm" name="id363306"></a><a class="indexterm" name="id373846"></a><p>The following general rules apply to IDs:</p><div class="itemizedlist"><ul type="disc"><li><p>Keep an ID as short and simple as possible.</p></li><li><p>Start the ID with the special short two-character label.
This makes URLs and other references to this ID human
readable, by self-identifying the XML container type.</p></li></ul></div><p>
- <a href="sn-id-naming-conventions.php#ex-id-usage" title="Example 3.1. Proper ID Usage">Example 3.1, “Proper ID Usageâ€</a> demonstrates some example ID
+ <a class="xref" href="sn-id-naming-conventions.php#ex-id-usage" title="Example 3.1. Proper ID Usage">Example 3.1, “Proper ID Usageâ€</a> demonstrates some example ID
attributes used properly.
</p><div class="example"><a name="ex-id-usage"></a><div class="example-contents"><pre class="screen"><chapter id="ch-unique-name-of-chapter">
Index: sn-live-previews.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-live-previews.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- sn-live-previews.php 16 Sep 2007 19:16:25 -0000 1.1
+++ sn-live-previews.php 15 Nov 2007 02:10:15 -0000 1.2
@@ -7,16 +7,16 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">3.6. Previewing Your Work</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-screenshots.php">Prev</a> </td><th width="60%" align="center">Chapter 3. Fedora Documentation Guidelines</th><td width="20%" align="right"> <a accesskey="n" href="ch-emacs.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-live-previews"></a>3.6. Previewing Your Work</h2></div></div></div><p>The GNOME <span><strong class="application">Help</strong></span> browser, also known
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">3.6. Previewing Your Work</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-screenshots.php">Prev</a> </td><th width="60%" align="center">Chapter 3. Fedora Documentation Guidelines</th><td width="20%" align="right"> <a accesskey="n" href="ch-emacs.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-live-previews">3.6. Previewing Your Work</h2></div></div></div><p>The GNOME <span class="application"><strong>Help</strong></span> browser, also known
as <code class="command">yelp</code>, and the KDE
- <span><strong class="application">Khelp</strong></span> documentation browser can render
+ <span class="application"><strong>Khelp</strong></span> documentation browser can render
DocBook XML information as needed. Use these applications to
preview your work if you prefer reading your work in a
browser-like environment. Run the following command:</p><pre class="screen">yelp file:///path/to/parent-file.xml</pre><p>Make sure to point the preferred help browser at the top
parent file of your XML document. Once the document loads, you
can add a bookmark for it for ease of use later.</p><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Tip: Using Bookmarks"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="./stylesheet-images/tip.png"></td><th align="left">Using Bookmarks</th></tr><tr><td align="left" valign="top"><p>Keeping your documents in the same place for every checkout
session makes help browser bookmarks more effective.</p></td></tr></table></div><p>Once you have a bookmark stored, it will appear in the help
- browser at every use. You can now hit <span><strong class="keycap">F1</strong></span> during
+ browser at every use. You can now hit <span class="keycap"><strong>F1</strong></span> during
any GUI session to launch the help browser. Then choose your
bookmark from the menu to preview your document at any
time.</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sn-screenshots.php">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch-writing-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">3.5. Screenshots </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> Chapter 4. Emacs and PSGML Mode</td></tr></table></div>
Index: sn-sandbox-setup.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-sandbox-setup.php,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- sn-sandbox-setup.php 16 Sep 2007 19:16:25 -0000 1.2
+++ sn-sandbox-setup.php 15 Nov 2007 02:10:15 -0000 1.3
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">7.2. Setting Up a Web Sandbox</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-publishing.php">Prev</a> </td><th width="60%" align="center">Chapter 7. Publishing Official Documentation</th><td width="20%" align="right"> <a accesskey="n" href="sn-creating-new-pub.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-sandbox-setup"></a>7.2. Setting Up a Web Sandbox</h2></div></div></div><p>To test document publishing, first set up a web sandbox on a
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">7.2. Setting Up a Web Sandbox</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-publishing.php">Prev</a> </td><th width="60%" align="center">Chapter 7. Publishing Official Documentation</th><td width="20%" align="right"> <a accesskey="n" href="sn-creating-new-pub.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-sandbox-setup">7.2. Setting Up a Web Sandbox</h2></div></div></div><p>To test document publishing, first set up a web sandbox on a
local Fedora system.</p><div class="procedure"><ol type="1"><li><p>Install the "Web Server" package group:</p><pre class="screen">su -c 'yum groupinstall "Web Server"'</pre></li><li><p>Create a folder for the web server to access the site
files.</p><pre class="screen">su -c 'mkdir /var/www/fedora'</pre></li><li><p>Change the permissions on this directory to make it
easier to access for your normal user account.</p><pre class="screen">su -c 'chown <em class="replaceable"><code>username</code></em> /var/www/fedora'</pre></li><li><p>Link to the new directory from your home directory.</p><pre class="screen">ln -s /var/www/fedora ~/fedora</pre></li><li><p>Retrieve the web module from CVS.</p><pre class="screen">cd ~/fedora
@@ -17,7 +17,7 @@
access, you can use
<strong class="userinput"><code>:pserver:anonymous</code></strong> in
place of <strong class="userinput"><code>:ext:username</code></strong>
- above. Visit the Fedora Account System at <a href="http://admin.fedoraproject.org/accounts/" target="_top">http://admin.fedoraproject.org/accounts/</a> for more
+ above. Visit the Fedora Account System at <a class="ulink" href="http://admin.fedoraproject.org/accounts/" target="_top">http://admin.fedoraproject.org/accounts/</a> for more
information.</p></td></tr></table></div></li><li><p>Edit the <code class="filename">/etc/hosts</code> file and add the
following line <span class="emphasis"><em>after</em></span> all other
lines:</p><pre class="screen">127.0.0.1 docs.localhost.localdomain</pre></li><li><p>Create a file
Index: sn-screenshots.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-screenshots.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- sn-screenshots.php 16 Sep 2007 19:16:25 -0000 1.3
+++ sn-screenshots.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">3.5. Screenshots</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-xml-admon.php">Prev</a> </td><th width="60%" align="center">Chapter 3. Fedora Documentation Guidelines</th><td width="20%" align="right"> <a accesskey="n" href="sn-live-previews.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-screenshots"></a>3.5. Screenshots</h2></div></div></div><a class="indexterm" name="id2644347"></a><a class="indexterm" name="id2644360"></a><a class="indexterm" name="id2644373"></a><p>Screenshots are illustrations that show the state of a display
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">3.5. Screenshots</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-xml-admon.php">Prev</a> </td><th width="60%" align="center">Chapter 3. Fedora Documentation Guidelines</th><td width="20%" align="right"> <a accesskey="n" href="sn-live-previews.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-screenshots">3.5. Screenshots</h2></div></div></div><a class="indexterm" name="id364486"></a><a class="indexterm" name="id364500"></a><a class="indexterm" name="id364513"></a><p>Screenshots are illustrations that show the state of a display
the user may encounter. Screenshots can be either graphical or
textual. However, screenshots use a great deal of space in a text
document to convey relatively small amounts of information. The
@@ -34,29 +34,29 @@
element, you may need to resize the screenshot in a
following step.</p></li><li><p>To take the screenshot, select the GUI element with
the mouse to bring it to the forefront, or otherwise
- arrange the elements. Press <span><strong class="keycap">Alt</strong></span>-<span><strong class="keycap">Print Screen</strong></span> to capture a
+ arrange the elements. Press <span class="keycap"><strong>Alt</strong></span>+<span class="keycap"><strong>Print Screen</strong></span> to capture a
single GUI window. For capturing the entire desktop use
- <span><strong class="keycap">Print Screen</strong></span>. If the shot includes
+ <span class="keycap"><strong>Print Screen</strong></span>. If the shot includes
multiple elements grouped closely together, crop the
- resulting PNG format image in <span><strong class="application">The
+ resulting PNG format image in <span class="application"><strong>The
GIMP</strong></span>.</p></li><li><p>If necessary, resize the image using
- <span><strong class="application">The GIMP</strong></span>. Open the image,
+ <span class="application"><strong>The GIMP</strong></span>. Open the image,
then right-click on it and choose
- <span><strong class="guimenu">Image</strong></span> → <span><strong class="guimenuitem">Scale Image...</strong></span>. With the chain symbol intact, set the
- <span><strong class="guilabel">New Width</strong></span> to <span><strong class="guilabel">500
- px</strong></span>, and click <span><strong class="guibutton">OK</strong></span>.
- Choose <span><strong class="guimenu">File</strong></span> → <span><strong class="guimenuitem">Save</strong></span> to save changes to the image before
+ <span class="guimenu"><strong>Image</strong></span> → <span class="guimenuitem"><strong>Scale Image...</strong></span>. With the chain symbol intact, set the
+ <span class="guilabel"><strong>New Width</strong></span> to <span class="guilabel"><strong>500
+ px</strong></span>, and click <span class="guibutton"><strong>OK</strong></span>.
+ Choose <span class="guimenu"><strong>File</strong></span> → <span class="guimenuitem"><strong>Save</strong></span> to save changes to the image before
converting it.</p></li><li><p>
- With the image open in <span><strong class="application">The
+ With the image open in <span class="application"><strong>The
GIMP</strong></span>, right-click the image, and select
- <span><strong class="guimenu">File</strong></span> → <span><strong class="guimenuitem">Save As...</strong></span>. Under <span><strong class="guimenu">Determine File
+ <span class="guimenu"><strong>File</strong></span> → <span class="guimenuitem"><strong>Save As...</strong></span>. Under <span class="guimenu"><strong>Determine File
Type:</strong></span>, select
- <span><strong class="guimenuitem">PostScript</strong></span>, then click
- <span><strong class="guibutton">OK</strong></span>. Allow flattening of the image
- by clicking <span><strong class="guibutton">Export</strong></span>.</p><p>A <span><strong class="guilabel">Save as PostScript</strong></span> window
- appears. Select <span><strong class="guilabel">Encapsulated
+ <span class="guimenuitem"><strong>PostScript</strong></span>, then click
+ <span class="guibutton"><strong>OK</strong></span>. Allow flattening of the image
+ by clicking <span class="guibutton"><strong>Export</strong></span>.</p><p>A <span class="guilabel"><strong>Save as PostScript</strong></span> window
+ appears. Select <span class="guilabel"><strong>Encapsulated
PostScript</strong></span>, and click
- <span><strong class="guibutton">OK</strong></span>.</p></li></ol></div></dd><dt><span class="term">Text Screenshot</span></dt><dd><p>Textual screen information is also useful for readers.
+ <span class="guibutton"><strong>OK</strong></span>.</p></li></ol></div></dd><dt><span class="term">Text Screenshot</span></dt><dd><p>Textual screen information is also useful for readers.
Follow these guidelines for textual screenshots:</p><div class="itemizedlist"><ul type="disc"><li><p>If a graphical screenshot illustrates a function,
and the textual mode has identical functions, do not
include both, unless omitting either would make your
@@ -68,7 +68,7 @@
to demonstrate a procedure, use <code class="sgmltag-element">userinput</code> tags to show what
the user types, and use <code class="sgmltag-element">computeroutput</code> tags to show
the resulting output.</p></li></ul></div><p>
- <a href="sn-screenshots.php#ex-text-screenshot-good" title="Example 3.2. Correct Textual Screenshot (XML Source and HTML)">Example 3.2, “Correct Textual Screenshot (XML Source and
+ <a class="xref" href="sn-screenshots.php#ex-text-screenshot-good" title="Example 3.2. Correct Textual Screenshot (XML Source and HTML)">Example 3.2, “Correct Textual Screenshot (XML Source and
HTML)â€</a> is an example of
textual screenshot usage.
</p><div class="example"><a name="ex-text-screenshot-good"></a><div class="example-contents"><pre class="screen"><example id="ex-text-screenshot-good">
Index: sn-tutorial-metadata.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-tutorial-metadata.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- sn-tutorial-metadata.php 16 Sep 2007 19:16:25 -0000 1.3
+++ sn-tutorial-metadata.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,9 +7,9 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.2. The Metadata</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-tutorial.php">Prev</a> </td><th width="60%" align="center">Chapter 6. The Layout of a Tutorial</th><td width="20%" align="right"> <a accesskey="n" href="ch-publishing.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-tutorial-metadata"></a>6.2. The Metadata</h2></div></div></div><a class="indexterm" name="id2595752"></a><p>The <code class="filename">rpm-info.xml</code> file contains all the
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.2. The Metadata</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-tutorial.php">Prev</a> </td><th width="60%" align="center">Chapter 6. The Layout of a Tutorial</th><td width="20%" align="right"> <a accesskey="n" href="ch-publishing.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-tutorial-metadata">6.2. The Metadata</h2></div></div></div><a class="indexterm" name="id370960"></a><p>The <code class="filename">rpm-info.xml</code> file contains all the
required metadata for the document. This metadata includes title,
- authorship, licensing, and revision history. <a href="sn-tutorial-metadata.php#ex-rpminfo" title="Example 6.1. Example rpm-info.xml File">Example 6.1, “Example <code class="filename">rpm-info.xml</code> Fileâ€</a> illustrates the content of this
+ authorship, licensing, and revision history. <a class="xref" href="sn-tutorial-metadata.php#ex-rpminfo" title="Example 6.1. Example rpm-info.xml File">Example 6.1, “Example <code class="filename">rpm-info.xml</code> Fileâ€</a> illustrates the content of this
file:</p><div class="example"><a name="ex-rpminfo"></a><div class="example-contents"><pre class="programlisting"><?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE rpm-info PUBLIC "-//Fedora//DTD Docs RPM-INFO V1.0//EN"
"http://docs.fedoraproject.org/dtds/rpm-info.dtd">
Index: sn-vim-additional-resources.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-vim-additional-resources.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- sn-vim-additional-resources.php 16 Sep 2007 19:16:25 -0000 1.3
+++ sn-vim-additional-resources.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,15 +7,15 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">5.3. Additional VIM Resources</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-vim-keymapping.php">Prev</a> </td><th width="60%" align="center">Chapter 5. VIM and DocBook</th><td width="20%" align="right"> <a accesskey="n" href="ch-tutorial.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-vim-additional-resources"></a>5.3. Additional VIM Resources</h2></div></div></div><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">5.3. Additional VIM Resources</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-vim-keymapping.php">Prev</a> </td><th width="60%" align="center">Chapter 5. VIM and DocBook</th><td width="20%" align="right"> <a accesskey="n" href="ch-tutorial.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-vim-additional-resources">5.3. Additional VIM Resources</h2></div></div></div><p>
Additional information about VIM may be found from:
- </p><div class="itemizedlist"><ul type="disc"><li><p><a href="http://newbiedoc.sourceforge.net/text_editing/vim.html#JESSE-SGMLRC" target="_top">
+ </p><div class="itemizedlist"><ul type="disc"><li><p><a class="ulink" href="http://newbiedoc.sourceforge.net/text_editing/vim.html#JESSE-SGMLRC" target="_top">
Example sgml-vimrc</a> from the <em class="citetitle">Beginner's guide to
Vi Improved (VIM)</em>
- </p></li><li><p>The <a href="http://tnerual.eriogerg.free.fr/vim.html" target="_top">VIM
+ </p></li><li><p>The <a class="ulink" href="http://tnerual.eriogerg.free.fr/vim.html" target="_top">VIM
Quick Reference Card</a>
</p></li><li><p>
- <a href="http://www.pinkjuice.com/howto/vimxml/" target="_top">Vim as XML
+ <a class="ulink" href="http://www.pinkjuice.com/howto/vimxml/" target="_top">Vim as XML
Editor</a>
</p></li><li><p>
The <em class="citetitle">VIM REFERENCE MANUAL</em>, which comes with
Index: sn-vim-keymapping.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-vim-keymapping.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- sn-vim-keymapping.php 16 Sep 2007 19:16:25 -0000 1.3
+++ sn-vim-keymapping.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">5.2. Keymapping with VIM</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-vim.php">Prev</a> </td><th width="60%" align="center">Chapter 5. VIM and DocBook</th><td width="20%" align="right"> <a accesskey="n" href="sn-vim-additional-resources.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-vim-keymapping"></a>5.2. Keymapping with VIM</h2></div></div></div><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">5.2. Keymapping with VIM</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-vim.php">Prev</a> </td><th width="60%" align="center">Chapter 5. VIM and DocBook</th><td width="20%" align="right"> <a accesskey="n" href="sn-vim-additional-resources.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-vim-keymapping">5.2. Keymapping with VIM</h2></div></div></div><p>
VIM can speed up your DocBook creation by mapping frequently typed tags
(or any words or phrases) onto short key combinations. By default, the
keymap leader is the backslash (<code class="literal">\</code>), but it can be
@@ -48,7 +48,7 @@
</p><p>
Unfortunately, there is not currently a complete macro set for all
DocBook commands, so you will need to define them yourself or customize
- the definitions in the examples from <a href="sn-vim-additional-resources.php" title="5.3. Additional VIM Resources">Section 5.3, “Additional VIM Resourcesâ€</a>.
+ the definitions in the examples from <a class="xref" href="sn-vim-additional-resources.php" title="5.3. Additional VIM Resources">Section 5.3, “Additional VIM Resourcesâ€</a>.
</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch-vim.php">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch-vim.php">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="sn-vim-additional-resources.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 5. VIM and DocBook </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 5.3. Additional VIM Resources</td></tr></table></div>
<?
Index: sn-xml-admon.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-xml-admon.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- sn-xml-admon.php 16 Sep 2007 19:16:25 -0000 1.3
+++ sn-xml-admon.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,13 +7,13 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">3.4. Admonitions</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-xml-tags.php">Prev</a> </td><th width="60%" align="center">Chapter 3. Fedora Documentation Guidelines</th><td width="20%" align="right"> <a accesskey="n" href="sn-screenshots.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-xml-admon"></a>3.4. Admonitions</h2></div></div></div><a class="indexterm" name="id2603327"></a><a class="indexterm" name="id2649305"></a><a class="indexterm" name="id2593377"></a><a class="indexterm" name="id2641125"></a><a class="indexterm" name="id2607299"></a><a class="indexterm" name="id2616618"></a><a class="indexterm" name="id2617286"></a><a class="indexterm" name="id2532735"></a><a class="indexterm" name="id2532752"></a><a class="indexterm" name=!
"id2609243"></a><a class="indexterm" name="id2609260"></a><p>There are five types of admonitions in DocBook: <code class="sgmltag-element">caution</code>, <code class="sgmltag-element">important</code>, <code class="sgmltag-element">note</code>, <code class="sgmltag-element">tip</code>, and <code class="sgmltag-element">warning</code>. All of the admonitions have
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">3.4. Admonitions</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-xml-tags.php">Prev</a> </td><th width="60%" align="center">Chapter 3. Fedora Documentation Guidelines</th><td width="20%" align="right"> <a accesskey="n" href="sn-screenshots.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-xml-admon">3.4. Admonitions</h2></div></div></div><a class="indexterm" name="id385130"></a><a class="indexterm" name="id385139"></a><a class="indexterm" name="id385153"></a><a class="indexterm" name="id385166"></a><a class="indexterm" name="id364075"></a><a class="indexterm" name="id364088"></a><a class="indexterm" name="id364102"></a><a class="indexterm" name="id364119"></a><a class="indexterm" name="id364136"></a><a class="indexterm" name="id364153"></a><a !
class="indexterm" name="id364170"></a><p>There are five types of admonitions in DocBook: <code class="sgmltag-element">caution</code>, <code class="sgmltag-element">important</code>, <code class="sgmltag-element">note</code>, <code class="sgmltag-element">tip</code>, and <code class="sgmltag-element">warning</code>. All of the admonitions have
the same structure: an optional <code class="sgmltag-element">title</code> 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 a <code class="sgmltag-element">warning</code> is
- reserved for cases where bodily harm can result.</p><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title"><a name="sn-xml-notesetc"></a>3.4.1. Creating a <code class="sgmltag-element">note</code>,
- <code class="sgmltag-element">tip</code>, <code class="sgmltag-element">caution</code>, <code class="sgmltag-element">important</code>, or <code class="sgmltag-element">warning</code></h3></div></div></div><a class="indexterm" name="id2609367"></a><a class="indexterm" name="id2609381"></a><a class="indexterm" name="id2644147"></a><a class="indexterm" name="id2644161"></a><a class="indexterm" name="id2644174"></a><p>There are several ways to bring attention to text within a
+ reserved for cases where bodily harm can result.</p><div class="section" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="sn-xml-notesetc">3.4.1. Creating a <code class="sgmltag-element">note</code>,
+ <code class="sgmltag-element">tip</code>, <code class="sgmltag-element">caution</code>, <code class="sgmltag-element">important</code>, or <code class="sgmltag-element">warning</code></h3></div></div></div><a class="indexterm" name="id364271"></a><a class="indexterm" name="id364285"></a><a class="indexterm" name="id364298"></a><a class="indexterm" name="id364312"></a><a class="indexterm" name="id364325"></a><p>There are several ways to bring attention to text within a
document. A <span class="emphasis"><em><code class="sgmltag-element">note</code></em></span> is used to bring
additional information to the users' attention. A
<span class="emphasis"><em><code class="sgmltag-element">tip</code></em></span> is
Index: sn-xml-tags.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-xml-tags.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- sn-xml-tags.php 16 Sep 2007 19:16:25 -0000 1.3
+++ sn-xml-tags.php 15 Nov 2007 02:10:15 -0000 1.4
@@ -7,7 +7,7 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">3.3. XML Tags</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-id-naming-conventions.php">Prev</a> </td><th width="60%" align="center">Chapter 3. Fedora Documentation Guidelines</th><td width="20%" align="right"> <a accesskey="n" href="sn-xml-admon.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sn-xml-tags"></a>3.3. XML Tags</h2></div></div></div><a class="indexterm" name="id2614075"></a><p>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">3.3. XML Tags</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-id-naming-conventions.php">Prev</a> </td><th width="60%" align="center">Chapter 3. Fedora Documentation Guidelines</th><td width="20%" align="right"> <a accesskey="n" href="sn-xml-admon.php">Next</a></td></tr></table><hr></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="sn-xml-tags">3.3. XML Tags</h2></div></div></div><a class="indexterm" name="id347748"></a><p>
It is very important that you remember the caveats in this
section. These are learned suggestions or rules that make your
XML experience better.
- Previous message (by thread): web/html/docs/translation-quick-start-guide/en_US generated-index.php, 1.2, 1.3 index.php, 1.6, 1.7 rv-revhistory.php, 1.6, 1.7 sn_accounts.php, 1.6, 1.7 sn_translating_docs.php, 1.6, 1.7 sn_translating_software.php, 1.6, 1.7
- Next message (by thread): web/html/docs/install-guide/f8 index.php,1.1,1.2
- Messages sorted by:
[ date ]
[ thread ]
[ subject ]
[ author ]
More information about the Fedora-websites-list
mailing list