Author: pfrields
Update of /cvs/fedora/web/html/docs/documentation-guide/en_US
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv29796
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
Added Files:
ch-getting-files-build-system-images.php legalnotice-opl.php
sn-adding-docbook-file.php sn-adding-translation.php
sn-module-adding-targets.php
Log Message:
Publish Documentation Guide 0.3.3
***** Error reading new file: [Errno 2] No such file or directory: 'ch-getting-files-build-system-images.php'
***** Error reading new file: [Errno 2] No such file or directory: 'legalnotice-opl.php'
***** Error reading new file: [Errno 2] No such file or directory: 'sn-adding-docbook-file.php'
***** Error reading new file: [Errno 2] No such file or directory: 'sn-adding-translation.php'
***** Error reading new file: [Errno 2] No such file or directory: 'sn-module-adding-targets.php'
Index: ch-cvs.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/ch-cvs.php,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ch-cvs.php 15 Nov 2007 02:10:15 -0000 1.4
+++ ch-cvs.php 15 Dec 2007 22:02:23 -0000 1.5
@@ -19,7 +19,7 @@
<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="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>
+ </p><a class="indexterm" name="id365956"></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="id367485"></a><a class="indexterm" name="id353312"></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 class="application"><strong>CVS</strong></span>, you
Index: ch-emacs.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/ch-emacs.php,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ch-emacs.php 15 Nov 2007 02:10:15 -0000 1.4
+++ ch-emacs.php 15 Dec 2007 22:02:23 -0000 1.5
@@ -7,7 +7,7 @@
?>
-<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>
+<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="id368660"></a><a class="indexterm" name="id372423"></a><a class="indexterm" name="id380803"></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.
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.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ch-getting-files-build-system-targets.php 15 Nov 2007 02:10:15 -0000 1.4
+++ ch-getting-files-build-system-targets.php 15 Dec 2007 22:02:23 -0000 1.5
@@ -7,10 +7,16 @@
?>
-<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>
+<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="sn-module-adding-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="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>
+ </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">help</code></td><td class="seg">This target prints a list of available targets and
+ their descriptions.</td></tr><tr class="seglistitem"><td class="seg"><code class="systemitem">validate-xml</code></td><td class="seg">This target <em class="firstterm">validates</em> the XML files
+ to make sure they are not only well-formed, but follow the
+ DTD. Some viewers of XML documents may not work correctly
+ until you run this target. This target includes copying
+ required entity files so that validating XML viewers work
+ properly</td></tr><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>
document for each defined translation. Output is placed in a
separate directory named <code class="filename"><code class="systemitem">${DOCBASE}</code>-<code class="systemitem">${LANG}</code>/</code>. Each
document section is a separate file within that
@@ -26,73 +32,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" 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
- with a double colon, not a single colon. The double colon
- allows you to specify additional rules for existing targets, or
- to write rules for a new target.
- </p><p>
- 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" 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 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 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
- system recreates the image subdirectory structure in the output
- documents.
- </p><p>
- Images often contain labels or other text which may need to be
- localized. A screenshot of a program, for example, may require
- a version for each translated language. Name language-dependent
- image files such as program screenshots by adding the language
- code to the filename, such as
- <code class="filename">menu-en_US.png</code>. Language-independent
- images, such as <code class="filename">icon.png</code>, do not need
- language codes.
- </p><p>
- Sometimes, a document may require images that do not follow the
- naming convention. To use these images with the document
- building system, create an ordinary text file containing the
- image filenames. This file must be named
- <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 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" 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 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" 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
- translation, follow these steps:</p><div class="procedure"><ol type="1"><li><p>If the <code class="filename">po/</code>
- directory does not exist, create it and add it to
- CVS:</p><pre class="screen">mkdir po && cvs add po/</pre></li><li><p>If it does not exist, create the POT file:</p><pre class="screen">make pot</pre></li><li><p>Add the new translation language to the
- <code class="varname">OTHERS</code> listing in the
- <code class="filename">Makefile</code>.</p></li><li><p>Although translators often copy the POT manually to
- create the new PO file, the following command also
- works:</p><pre class="screen">make po/<em class="replaceable"><code>lang</code></em>.po</pre></li></ol></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sn-build-system.php">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch-how-modules-work.php">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch-writing-guidelines.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">2.2. The Document Build System </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> Chapter 3. Fedora Documentation Guidelines</td></tr></table></div>
+ not work for your document.</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="sn-build-system.php">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch-how-modules-work.php">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="sn-module-adding-targets.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">2.2. The Document Build System </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 2.4. Adding or Changing Targets</td></tr></table></div>
<?
$template->displayFooter('$Date$');
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.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ch-how-modules-work.php 15 Nov 2007 02:10:15 -0000 1.4
+++ ch-how-modules-work.php 15 Dec 2007 22:02:23 -0000 1.5
@@ -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="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
+ document-specific <em class="firstterm">entities</em><sup>[<a name="id361563" href="#ftn.id361563" 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
@@ -54,7 +54,7 @@
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 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
+ 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.id361563" href="#id361563" 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-tutorial.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/ch-tutorial.php,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ch-tutorial.php 15 Nov 2007 02:10:15 -0000 1.4
+++ ch-tutorial.php 15 Dec 2007 22:02:23 -0000 1.5
@@ -10,7 +10,7 @@
<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" 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"
+ 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="id367590"></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.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ch-vim.php 15 Nov 2007 02:10:15 -0000 1.4
+++ ch-vim.php 15 Dec 2007 22:02:23 -0000 1.5
@@ -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">Chapter 5. VIM and DocBook</h2></div></div></div><a class="indexterm" name="id396089"></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="id354918"></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" 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>
+ </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="id364721"></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:
Index: ch-writing-guidelines.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/ch-writing-guidelines.php,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ch-writing-guidelines.php 15 Nov 2007 02:10:15 -0000 1.4
+++ ch-writing-guidelines.php 15 Dec 2007 22:02:23 -0000 1.5
@@ -7,7 +7,7 @@
?>
-<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
+<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="sn-adding-translation.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="id370590"></a><a class="indexterm" name="id363634"></a><a class="indexterm" name="id349647"></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 class="ulink" href="http://www.docbook.org/tdg/en/html/docbook.html"; target="_top">http://www.docbook.org/tdg/en/html/docbook.html</a>.
@@ -16,7 +16,7 @@
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>
+ 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="sn-adding-translation.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.7. Adding a Translation </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>
<?
$template->displayFooter('$Date$');
Index: index.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/index.php,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- index.php 15 Nov 2007 02:10:15 -0000 1.4
+++ index.php 15 Dec 2007 22:02:23 -0000 1.5
@@ -7,7 +7,7 @@
?>
-<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>,
+<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.3 (2007-12-15)</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="pre!
face"><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#sn-file-naming">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="sect!
ion"><a href="sn-build-system.php">2.2. The Document Build Sys!
tem</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><dt><span class="section"><a href="sn-module-adding-targets.php">2.4. Adding or Changing Targets</a></span></dt><dt><span class="section"><a href="ch-getting-files-build-system-images.php">2.5. Using Document Image Files</a></span></dt><dt><span class="section"><a href="sn-adding-docbook-file.php">2.6. Adding a New DocBook XML File</a></span></dt><dt><span class="section"><a href="sn-adding-translation.php">2.7. Adding a Translation</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch-writing-guidelines.php">3. Fedora Documentation Guidel!
ines</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>
<?
Index: rv-revhistory.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/rv-revhistory.php,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- rv-revhistory.php 15 Nov 2007 02:10:15 -0000 1.4
+++ rv-revhistory.php 15 Dec 2007 22:02:23 -0000 1.5
@@ -7,7 +7,11 @@
?>
-<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">
+<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.3</td><td align="left">2007-12-15</td><td align="left">PWF</td></tr><tr><td align="left" colspan="3">
+ <p>
+ Fix some organization and missing targets (#371531)
+ </p>
+ </td></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>
Index: sn-build-system.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-build-system.php,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- sn-build-system.php 15 Nov 2007 02:10:15 -0000 1.4
+++ sn-build-system.php 15 Dec 2007 22:02:23 -0000 1.5
@@ -10,7 +10,7 @@
<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="id358457" href="#ftn.id358457" class="footnote">2</a>]</sup> and shell scripts. Authors need
+ <code class="command">make(1)</code><sup>[<a name="id372793" href="#ftn.id372793" 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" id="sn-makefile">2.2.1. The Document <code class="filename">Makefile</code></h3></div></div></div><p>
@@ -68,7 +68,7 @@
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.id358457" href="#id358457" class="para">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.id372793" href="#id372793" 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-cvs-config.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-cvs-config.php,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- sn-cvs-config.php 15 Nov 2007 02:10:15 -0000 1.4
+++ sn-cvs-config.php 15 Dec 2007 22:02:23 -0000 1.5
@@ -7,7 +7,7 @@
?>
-<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>
+<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="id384528"></a><a class="indexterm" name="id377598"></a><a class="indexterm" name="id377611"></a><a class="indexterm" name="id377625"></a><a class="indexterm" name="id377634"></a><a class="indexterm" name="id377644"></a><a class="indexterm" name="id377662"></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="id377685"></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
@@ -21,7 +21,7 @@
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" 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>
+ </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="id377746"></a><a class="indexterm" name="id377760"></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 class="application"><strong>CVS</strong></span> repository. Follow the
@@ -43,7 +43,7 @@
current working directory has a <code class="filename">CVS/</code>
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" 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>
+ </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="id377878"></a><a class="indexterm" name="id377892"></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 class="application"><strong>CVS</strong></span> repository. For the full details
Index: sn-cvs-cvscommands.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-cvs-cvscommands.php,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- sn-cvs-cvscommands.php 15 Nov 2007 02:10:15 -0000 1.4
+++ sn-cvs-cvscommands.php 15 Dec 2007 22:02:23 -0000 1.5
@@ -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" id="sn-cvs-cvscommands">8.4. Basic CVS Commands</h2></div></div></div><a class="indexterm" name="id349636"></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="id378007"></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>
@@ -21,7 +21,7 @@
<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" id="sn-cvs-cvscommands-co">8.4.1. Checking Out Modules</h3></div></div></div><a class="indexterm" name="id349714"></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="id378084"></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.
@@ -38,7 +38,7 @@
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 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>
+ </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="id378170"></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>
@@ -79,7 +79,7 @@
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" id="sn-cvs-cvscommands-up">8.4.2. Updating Files</h3></div></div></div><a class="indexterm" name="id349962"></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="id378333"></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:
@@ -87,7 +87,7 @@
The latest versions of all the files in the module are
downloaded into your local copy. If you notice a file conflict,
refer to <a 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>
+ </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="id378381"></a><p>
After modifying files in your local version of a module, commit
them to save the changes on the <span class="application"><strong>CVS</strong></span>
server:
@@ -123,13 +123,13 @@
</p></td></tr></table></div><p>
If you notice a file conflict, 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-add">8.4.4. Adding Files</h3></div></div></div><a class="indexterm" name="id350163"></a><p>
+ </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="id378534"></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" id="sn-cvs-cvscommands-admin">8.4.5. Managing Binary Files</h3></div></div></div><a class="indexterm" name="id350236"></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="id378607"></a><p>
The most commonly-archived files are simple text files, but
sometimes binary files are also archived. The
<span class="application"><strong>cvs</strong></span> program recognizes most common
@@ -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" id="sn-cvs-cvscommands-rm">8.4.6. Removing Files</h3></div></div></div><a class="indexterm" name="id350358"></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="id378729"></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
@@ -181,7 +181,7 @@
the file is preserved. If you need to rename a file, send an
email to
<a class="ulink" href="mailto:cvsdocs-administrator@xxxxxxxxxxxxxxxxx"; target="_top">cvsdocs-administrator@xxxxxxxxxxxxxxxxx</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>
+ </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="id378842"></a><p>
Sometimes it is necessary to view the
<em class="firstterm">status</em> of a file in a
<span class="application"><strong>CVS</strong></span> module. To view the status of a
@@ -232,7 +232,7 @@
<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" id="sn-cvs-cvscommands-conflicts">8.4.8. Resolving Conflicts</h3></div></div></div><a class="indexterm" name="id350777"></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="id379148"></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,7 +265,7 @@
the content from the server.
</p><p>
Resolve the conflict by editing your copy, and commit the file.
- </p></div><div class="section" lang="en-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>
+ </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="id379244"></a><p>
All commands assume you are in the proper directory for the
<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
Index: sn-cvs-preparation.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-cvs-preparation.php,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- sn-cvs-preparation.php 15 Nov 2007 02:10:15 -0000 1.4
+++ sn-cvs-preparation.php 15 Dec 2007 22:02:23 -0000 1.5
@@ -7,12 +7,12 @@
?>
-<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>
+<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="id364116"></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" 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>
+ </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="id364154"></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:
@@ -24,7 +24,7 @@
<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" id="sn-cvs-generate-keys">8.2.2. Generating SSH Keys</h3></div></div></div><a class="indexterm" name="id384227"></a><p>
+ </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="id346098"></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
@@ -44,7 +44,7 @@
required for an
<code class="computeroutput">cvs.fedoraproject.org</code>
<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>
+ </p><div class="orderedlist"><a class="indexterm" name="id384347"></a><a class="indexterm" name="id384365"></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,
Index: sn-emacs-colors.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-emacs-colors.php,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- sn-emacs-colors.php 15 Nov 2007 02:10:15 -0000 1.4
+++ sn-emacs-colors.php 15 Dec 2007 22:02:23 -0000 1.5
@@ -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" 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>
+<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="id368846"></a><a class="indexterm" name="id368859"></a><a class="indexterm" name="id372466"></a><a class="indexterm" name="id372479"></a><a class="indexterm" name="id372492"></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>.
Index: sn-emacs-file.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-emacs-file.php,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- sn-emacs-file.php 15 Nov 2007 02:10:15 -0000 1.4
+++ sn-emacs-file.php 15 Dec 2007 22:02:23 -0000 1.5
@@ -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" 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>
+<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="id366284"></a><a class="indexterm" name="id402379"></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
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.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- sn-getting-files-names.php 15 Nov 2007 02:10:15 -0000 1.4
+++ sn-getting-files-names.php 15 Dec 2007 22:02:23 -0000 1.5
@@ -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="id380185"></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="id347890"></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
@@ -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 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
+ <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="sn-file-naming">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.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- sn-id-naming-conventions.php 15 Nov 2007 02:10:15 -0000 1.4
+++ sn-id-naming-conventions.php 15 Dec 2007 22:02:23 -0000 1.5
@@ -7,9 +7,9 @@
?>
-<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
+<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="id371664"></a><a class="indexterm" name="id371677"></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="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.
+ section, chapter, or other element.</p><a class="indexterm" name="id371692"></a><a class="indexterm" name="id373647"></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 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
Index: sn-screenshots.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-screenshots.php,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- sn-screenshots.php 15 Nov 2007 02:10:15 -0000 1.4
+++ sn-screenshots.php 15 Dec 2007 22:02:23 -0000 1.5
@@ -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" 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
+<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="id413596"></a><a class="indexterm" name="id413609"></a><a class="indexterm" name="id413623"></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
Index: sn-tutorial-metadata.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-tutorial-metadata.php,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- sn-tutorial-metadata.php 15 Nov 2007 02:10:15 -0000 1.4
+++ sn-tutorial-metadata.php 15 Dec 2007 22:02:23 -0000 1.5
@@ -7,7 +7,7 @@
?>
-<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
+<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="id348304"></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 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"?>
Index: sn-xml-admon.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-xml-admon.php,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- sn-xml-admon.php 15 Nov 2007 02:10:15 -0000 1.4
+++ sn-xml-admon.php 15 Dec 2007 22:02:23 -0000 1.5
@@ -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" 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
+<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="id355962"></a><a class="indexterm" name="id355971"></a><a class="indexterm" name="id355985"></a><a class="indexterm" name="id355998"></a><a class="indexterm" name="id356012"></a><a class="indexterm" name="id413198"></a><a class="indexterm" name="id413211"></a><a class="indexterm" name="id413228"></a><a class="indexterm" name="id413246"></a><a class="indexterm" name="id413263"></a><a !
class="indexterm" name="id413280"></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" 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
+ <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="id413381"></a><a class="indexterm" name="id413394"></a><a class="indexterm" name="id413408"></a><a class="indexterm" name="id413421"></a><a class="indexterm" name="id413435"></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.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- sn-xml-tags.php 15 Nov 2007 02:10:15 -0000 1.4
+++ sn-xml-tags.php 15 Dec 2007 22:02:23 -0000 1.5
@@ -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" id="sn-xml-tags">3.3. XML Tags</h2></div></div></div><a class="indexterm" name="id347748"></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="id352203"></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.
--
Fedora-websites-list mailing list
Fedora-websites-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/fedora-websites-list
