Author: pfrields
Update of /cvs/fedora/web/html/docs/documentation-guide/en_US
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv23211
Modified Files:
acknowledgments.php ch-cvs.php ch-emacs.php
ch-getting-files-build-system-images.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 legalnotice-opl.php
rv-revhistory.php sn-adding-docbook-file.php
sn-adding-translation.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-module-adding-targets.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:
Update to new DocGuide 0.4
Index: acknowledgments.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/acknowledgments.php,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- acknowledgments.php 15 Dec 2007 22:02:23 -0000 1.5
+++ acknowledgments.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Chapter 10. Acknowledgments</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="index.php" title="Fedora Documentation Guide">
+<link rel="prev" href="sn-l10n-postat.php" title="9.4. Checking Statistics">
+<link rel="next" href="generated-index.php" title="Index">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,32 +19,73 @@
?>
-<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>
+
+<div class="navheader">
+<table width="100%" summary="Navigation header">
+<tr><th colspan="3" align="center">Chapter 10. Acknowledgments</th></tr>
+<tr>
+<td width="20%" align="left">
+<a accesskey="p" href="sn-l10n-postat.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 10. 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).
- </p><p>
+ </p>
+<p>
A patch from Roozbeh Pournader (roozbeh at sharif.edu) has been applied to
fix a few typos and explain that anonymous CVS access does not allow
commits.
- </p><p>
+ </p>
+<p>
Patches from Gavin Henry (ghenry at suretecsystems.com) have been applied
to add the trailing slashes to the <code class="command">figure</code> tag example
in <code class="filename">docs-xml-tags.xml</code>.
- </p><p>
+ </p>
+<p>
A patch from Joshua Daniel Franklin (joshuadfranklin at yahoo.com) has been
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>
+ </p>
+<p>
A patch from Karsten Wade (kwade at redhat.com) has been applied to add
<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>
+ </p>
+<p>
A patch from Tommy Reynolds (Tommy.Reynolds at MegaCoder.com) has been
applied to more fully explaing the document building system.
- </p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sn-cvs-cvscommands.php">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="generated-index.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">8.4. Basic CVS Commands </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> Index</td></tr></table></div>
+ </p>
+</div>
+<div class="navfooter">
+<hr>
+<table width="100%" summary="Navigation footer">
+<tr>
+<td width="40%" align="left">
+<a accesskey="p" href="sn-l10n-postat.php">Prev</a>Â </td>
+<td width="20%" align="center">Â </td>
+<td width="40%" align="right">Â <a accesskey="n" href="generated-index.php">Next</a>
+</td>
+</tr>
+<tr>
+<td width="40%" align="left" valign="top">9.4. Checking Statistics </td>
+<td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td>
+<td width="40%" align="right" valign="top">Â Index</td>
+</tr>
+</table>
+</div>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
Index: ch-cvs.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/ch-cvs.php,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- ch-cvs.php 15 Dec 2007 22:02:23 -0000 1.5
+++ ch-cvs.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Chapter 8. CVS</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="index.php" title="Fedora Documentation Guide">
+<link rel="prev" href="sn-creating-new-pub.php" title="7.3. Creating a New Publication">
+<link rel="next" href="sn-cvs-preparation.php" title="8.2. Preparing For CVS Use">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,7 +19,23 @@
?>
-<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>
+
+<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
@@ -19,7 +47,10 @@
<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="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>
+ </p>
+<a class="indexterm" name="id546244"></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="id563494"></a><a class="indexterm" name="id576030"></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
@@ -27,14 +58,16 @@
file system. After modifying one or more files, you
<em class="firstterm">commit</em> them back to the central
<span class="application"><strong>CVS</strong></span> repository server.
- </p><p>
+ </p>
+<p>
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 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.
- </p><p>
+ </p>
+<p>
When you commit changes, only changes to files the server knows
about are committed. In other words, if you created a file in your
local checkout of a module, the new file is not automatically
@@ -44,7 +77,8 @@
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 class="xref" href="sn-cvs-cvscommands.php" title="8.4. Basic CVS Commands">Section 8.4, â??Basic CVS Commandsâ??</a>.
- </p><p>
+ </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 class="application"><strong>CVS</strong></span> will try to merge the changes into
@@ -58,10 +92,31 @@
files frequently. It is a good practice to update them right
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>
+ </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>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
Index: ch-emacs.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/ch-emacs.php,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- ch-emacs.php 15 Dec 2007 22:02:23 -0000 1.5
+++ ch-emacs.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Chapter 4. Emacs and PSGML Mode</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="index.php" title="Fedora Documentation Guide">
+<link rel="prev" href="sn-live-previews.php" title="3.6. Previewing Your Work">
+<link rel="next" href="sn-emacs-file.php" title="4.2. Setting Up Your .emacs File">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,14 +19,55 @@
?>
-<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>
+
+<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="id544844"></a><a class="indexterm" name="id549839"></a><a class="indexterm" name="id568508"></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" 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>
+ </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$');
?>
+</html>
Index: ch-getting-files-build-system-images.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/ch-getting-files-build-system-images.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ch-getting-files-build-system-images.php 15 Dec 2007 22:02:23 -0000 1.1
+++ ch-getting-files-build-system-images.php 10 Apr 2008 02:37:06 -0000 1.2
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>2.5. Using Document Image Files</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-how-modules-work.php" title="Chapter 2. How Modules Work">
+<link rel="prev" href="sn-module-adding-targets.php" title="2.4. Adding or Changing Targets">
+<link rel="next" href="sn-adding-docbook-file.php" title="2.6. Adding a New DocBook XML File">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,23 +19,42 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.5. Using Document Image Files</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-module-adding-targets.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-adding-docbook-file.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-images">2.5. Using Document Image Files</h2></div></div></div><p>
+
+<div class="navheader">
+<table width="100%" summary="Navigation header">
+<tr><th colspan="3" align="center">2.5. Using Document Image Files</th></tr>
+<tr>
+<td width="20%" align="left">
+<a accesskey="p" href="sn-module-adding-targets.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-adding-docbook-file.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-images">2.5. Using Document Image Files</h2></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>
+ </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>
+ </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>
+ </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
@@ -32,23 +63,50 @@
<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>
+ </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>
+ </p>
+<p>
<a class="xref" href="ch-getting-files-build-system-images.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
+ </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="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sn-module-adding-targets.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-adding-docbook-file.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">2.4. Adding or Changing Targets </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 2.6. Adding a New DocBook XML File</td></tr></table></div>
+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="navfooter">
+<hr>
+<table width="100%" summary="Navigation footer">
+<tr>
+<td width="40%" align="left">
+<a accesskey="p" href="sn-module-adding-targets.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-adding-docbook-file.php">Next</a>
+</td>
+</tr>
+<tr>
+<td width="40%" align="left" valign="top">2.4. Adding or Changing Targets </td>
+<td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td>
+<td width="40%" align="right" valign="top"> 2.6. Adding a New DocBook XML File</td>
+</tr>
+</table>
+</div>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
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.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- ch-getting-files-build-system-targets.php 15 Dec 2007 22:02:23 -0000 1.5
+++ ch-getting-files-build-system-targets.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>2.3. Build System Actions</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-how-modules-work.php" title="Chapter 2. How Modules Work">
+<link rel="prev" href="sn-build-system.php" title="2.2. The Document Build System">
+<link rel="next" href="sn-module-adding-targets.php" title="2.4. Adding or Changing Targets">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,35 +19,125 @@
?>
-<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>
+
+<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">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
+ </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>
+ 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
- directory.</td></tr><tr class="seglistitem"><td class="seg"><code class="systemitem">html-nochunks</code></td><td class="seg">This target builds the "non-chunked" <abbr class="abbrev">HTML</abbr>
+ directory.</td>
+</tr>
+<tr class="seglistitem">
+<td class="seg"><code class="systemitem">html-nochunks</code></td>
+<td class="seg">This target builds the "non-chunked" <abbr class="abbrev">HTML</abbr>
document for each defined translation. Output is placed in a
single file: <code class="filename"><code class="systemitem">${DOCBASE}</code>-<code class="systemitem">${LANG}</code>.html</code>; no
- other files are created.</td></tr><tr class="seglistitem"><td class="seg"><code class="systemitem">pdf</code></td><td class="seg">This target builds only the <abbr class="abbrev">PDF</abbr> document
+ other files are created.</td>
+</tr>
+<tr class="seglistitem">
+<td class="seg"><code class="systemitem">pdf</code></td>
+<td class="seg">This target builds only the <abbr class="abbrev">PDF</abbr> document
for all document languages. <abbr class="abbrev">PDF</abbr> production is
- currently erratic and may not work for your document.</td></tr><tr class="seglistitem"><td class="seg"><code class="systemitem">tarball</code></td><td class="seg">This target builds only the <code class="command">tar(1)</code>
- archive for all document languages.</td></tr><tr class="seglistitem"><td class="seg"><code class="systemitem">all</code></td><td class="seg">This target builds all targets listed above.</td></tr><tr class="seglistitem"><td class="seg"><code class="systemitem">clean</code></td><td class="seg">This target deletes any temporary, or generated files, but
+ currently erratic and may not work for your document.</td>
+</tr>
+<tr class="seglistitem">
+<td class="seg"><code class="systemitem">tarball</code></td>
+<td class="seg">This target builds only the <code class="command">tar(1)</code>
+ archive for all document languages.</td>
+</tr>
+<tr class="seglistitem">
+<td class="seg"><code class="systemitem">all</code></td>
+<td class="seg">This target builds all targets listed above.</td>
+</tr>
+<tr class="seglistitem">
+<td class="seg"><code class="systemitem">clean</code></td>
+<td class="seg">This target deletes any temporary, or generated files, but
does <span class="emphasis"><em>not</em></span> erase any <abbr class="abbrev">HTML</abbr>,
- <abbr class="abbrev">PDF</abbr>, or archive files.</td></tr><tr class="seglistitem"><td class="seg"><code class="systemitem">distclean</code></td><td class="seg">This target erases all <abbr class="abbrev">HTML</abbr>,
+ <abbr class="abbrev">PDF</abbr>, or archive files.</td>
+</tr>
+<tr class="seglistitem">
+<td class="seg"><code class="systemitem">distclean</code></td>
+<td class="seg">This target erases all <abbr class="abbrev">HTML</abbr>,
<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><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>
+ 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>
+<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$');
?>
+</html>
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.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- ch-getting-files-fdp.php 15 Dec 2007 22:02:23 -0000 1.5
+++ ch-getting-files-fdp.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>1.2. Fedora Documentation Tools</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-getting-files.php" title="Chapter 1. Prerequisites">
+<link rel="prev" href="ch-getting-files.php" title="Chapter 1. Prerequisites">
+<link rel="next" href="sn-getting-files-names.php" title="1.3. Naming Conventions">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,19 +19,37 @@
?>
-<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>
+
+<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 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
+ </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
<em class="firstterm">Extensible Markup Language</em>, or
<acronym class="acronym">XML</acronym>. XML allows authors to mark pieces of
content with descriptive tags. The following output is an example
- of DocBook XML:</p><pre class="screen"><article>
+ of DocBook XML:</p>
+<pre class="screen"><article>
<title>A Very Short Article</title>
<para>This very short article is a
demonstration of DocBook XML in
@@ -28,7 +58,8 @@
the content they surround, and how
that content fits into the meaning
of the text as a written work.</para>
-</article></pre><p>This example article, entitled <em class="citetitle">A Very Short
+</article></pre>
+<p>This example article, entitled <em class="citetitle">A Very Short
Article</em>, consists of only a single paragraph. The
tags, or markup, surround elements of content to define the sense
in which they are used. A paragraph, for example, is marked with
@@ -36,24 +67,54 @@
marked with <code class="sgmltag-element">emphasis</code> tags. The author does not
worry about the visual formatting such as italics or font size.
Fedora Documentation Project build tools automatically perform all formatting
- tasks.</p><p>The custom tools built by the Fedora Documentation Project render DocBook source into
+ tasks.</p>
+<p>The custom tools built by the Fedora Documentation Project render DocBook source into
a variety of formats for publication and distribution. They also
allow translators to create localized versions of the XML
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
+ purposes, like reusable code for a programmer.</p>
+<p>DocBook is itself very well documented. For more information
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.
+ 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><p>Contributors who use the Microsoft Windows operating system
+ 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>
+ 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$');
?>
+</html>
Index: ch-getting-files.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/ch-getting-files.php,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- ch-getting-files.php 15 Dec 2007 22:02:23 -0000 1.5
+++ ch-getting-files.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Chapter 1. Prerequisites</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="index.php" title="Fedora Documentation Guide">
+<link rel="prev" href="ch-intro.php" title="Introduction">
+<link rel="next" href="ch-getting-files-fdp.php" title="1.2. Fedora Documentation Tools">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,26 +19,71 @@
?>
-<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>
+
+<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" id="sn-system-packages">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">
+ </p>
+<pre class="screen">
<strong class="userinput"><code>su -c 'yum groupinstall "Authoring and Publishing"'</code></strong>
-</pre><p>
+</pre>
+<p>
Next, install the <code class="filename">cvs</code> package, which is used to
handle revision control on files in the official repository:
- </p><pre class="screen">
+ </p>
+<pre class="screen">
<strong class="userinput"><code>su -c 'yum install cvs'</code></strong>
-</pre><p>If you plan to use <span class="application"><strong>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>
+ 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>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
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.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- ch-how-modules-work.php 15 Dec 2007 22:02:23 -0000 1.5
+++ ch-how-modules-work.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Chapter 2. How Modules Work</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="index.php" title="Fedora Documentation Guide">
+<link rel="prev" href="sn-getting-files-names.php" title="1.3. Naming Conventions">
+<link rel="next" href="sn-build-system.php" title="2.2. The Document Build System">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,13 +19,34 @@
?>
-<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
+
+<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" 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
+ 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/
+ 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/
|
|-- en_US/
| |-- example-doc.xml
@@ -31,16 +64,41 @@
| |-- example-doc.pot
| `-- pt.po
|
- `-- Makefile</code></pre></div><p class="title"><b>Example 2.1. Example Module Structure</b></p></div><br class="example-break"><div class="segmentedlist"><a name="sg-module-contents"></a><div class="title"><strong><span class="title">CVS Module Contents</span></strong></div><table border="0"><thead><tr class="segtitle"><th>Component</th><th>Type</th><th>Usage Notes</th></tr></thead><tbody><tr class="seglistitem"><td class="seg">Primary language directory</td><td class="seg">required</td><td class="seg">This is the only directory absolutely required. It is named
+ `-- Makefile</code></pre></div>
+<p class="title"><b>Example 2.1. Example Module Structure</b></p>
+</div>
+<br class="example-break"><div class="segmentedlist">
+<a name="sg-module-contents"></a><div class="title"><strong><span class="title">CVS Module Contents</span></strong></div>
+<table border="0">
+<thead><tr class="segtitle">
+<th>Component</th>
+<th>Type</th>
+<th>Usage Notes</th>
+</tr></thead>
+<tbody>
+<tr class="seglistitem">
+<td class="seg">Primary language directory</td>
+<td class="seg">required</td>
+<td class="seg">This is the only directory absolutely required. It is named
for the original language of the document, such as <code class="filename">en_US</code> (US English). The
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="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
+ document-specific <em class="firstterm">entities</em><sup>[<a name="id545559" href="#ftn.id545559" 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
- be stored in a language directory.</td></tr><tr class="seglistitem"><td class="seg">Translation (PO) directory</td><td class="seg">optional</td><td class="seg">The <code class="filename">po/</code> directory
+ be stored in a language directory.</td>
+</tr>
+<tr class="seglistitem">
+<td class="seg">Translation (PO) directory</td>
+<td class="seg">optional</td>
+<td class="seg">The <code class="filename">po/</code> directory
contains specially formatted Portable Object, or
<acronym class="acronym">PO</acronym>, files created and used by translators.
The Fedora Documentation Project build tools use these files to create translated
@@ -49,19 +107,65 @@
<code class="filename">po/</code> directory also
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 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
+ 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 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 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
+ 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.id545559" href="#id545559" 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
- usage.</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-getting-files-names.php">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="sn-build-system.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">1.3. Naming Conventions </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 2.2. The Document Build System</td></tr></table></div>
+ usage.</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-getting-files-names.php">Prev</a>Â </td>
+<td width="20%" align="center">Â </td>
+<td width="40%" align="right">Â <a accesskey="n" href="sn-build-system.php">Next</a>
+</td>
+</tr>
+<tr>
+<td width="40%" align="left" valign="top">1.3. Naming Conventions </td>
+<td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td>
+<td width="40%" align="right" valign="top"> 2.2. The Document Build System</td>
+</tr>
+</table>
+</div>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
Index: ch-intro.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/ch-intro.php,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- ch-intro.php 15 Dec 2007 22:02:23 -0000 1.5
+++ ch-intro.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Introduction</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="index.php" title="Fedora Documentation Guide">
+<link rel="prev" href="index.php" title="Fedora Documentation Guide">
+<link rel="next" href="ch-getting-files.php" title="Chapter 1. Prerequisites">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,20 +19,63 @@
?>
-<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>
+
+<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:
- </p><div class="itemizedlist"><ul type="disc"><li><p>DocBook XML v4.4</p></li><li><p>Custom XSLT stylesheets for both print and HTML
- versions</p></li><li><p>Custom scripts to generate HTML output (use
- <code class="command">xmlto</code>)</p></li><li><p>Emacs with PSGML mode (optional, but recommended)</p></li></ul></div><p>
+ </p>
+<div class="itemizedlist"><ul type="disc">
+<li><p>DocBook XML v4.4</p></li>
+<li><p>Custom XSLT stylesheets for both print and HTML
+ versions</p></li>
+<li><p>Custom scripts to generate HTML output (use
+ <code class="command">xmlto</code>)</p></li>
+<li><p>Emacs with PSGML mode (optional, but recommended)</p></li>
+</ul></div>
+<p>
This document explains the tools used by the Fedora Documentation Project. It provides
writing and tagging guidelines to ensure Fedora documentation is
consistent and easy-to-follow.
- </p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="index.php">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch-getting-files.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Fedora Documentation Guide </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> Chapter 1. Prerequisites</td></tr></table></div>
+ </p>
+</div>
+<div class="navfooter">
+<hr>
+<table width="100%" summary="Navigation footer">
+<tr>
+<td width="40%" align="left">
+<a accesskey="p" href="index.php">Prev</a>Â </td>
+<td width="20%" align="center">Â </td>
+<td width="40%" align="right">Â <a accesskey="n" href="ch-getting-files.php">Next</a>
+</td>
+</tr>
+<tr>
+<td width="40%" align="left" valign="top">Fedora Documentation Guide </td>
+<td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td>
+<td width="40%" align="right" valign="top"> Chapter 1. Prerequisites</td>
+</tr>
+</table>
+</div>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
Index: ch-publishing.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/ch-publishing.php,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ch-publishing.php 15 Dec 2007 22:02:23 -0000 1.4
+++ ch-publishing.php 10 Apr 2008 02:37:06 -0000 1.5
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Chapter 7. Publishing Official Documentation</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="index.php" title="Fedora Documentation Guide">
+<link rel="prev" href="sn-tutorial-metadata.php" title="6.2. The Metadata">
+<link rel="next" href="sn-sandbox-setup.php" title="7.2. Setting Up a Web Sandbox">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,27 +19,68 @@
?>
-<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
+
+<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" 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
+ 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
the newest content for the website. Instead, it pulls files with
the CVS tag <code class="systemitem">LIVE</code> to populate the
- website.</p><p>Each publisher sets up a local testing website on an available
+ website.</p>
+<p>Each publisher sets up a local testing website on an available
Fedora system. This site, sometimes called a
<em class="firstterm">sandbox</em>, allows the publisher to test and
view changes to documents, and ensure stability on the public
- site.</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sn-tutorial-metadata.php">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="sn-sandbox-setup.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">6.2. The Metadata </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 7.2. Setting Up a Web Sandbox</td></tr></table></div>
+ site.</p>
+</div>
+</div>
+<div class="navfooter">
+<hr>
+<table width="100%" summary="Navigation footer">
+<tr>
+<td width="40%" align="left">
+<a accesskey="p" href="sn-tutorial-metadata.php">Prev</a>Â </td>
+<td width="20%" align="center">Â </td>
+<td width="40%" align="right">Â <a accesskey="n" href="sn-sandbox-setup.php">Next</a>
+</td>
+</tr>
+<tr>
+<td width="40%" align="left" valign="top">6.2. The Metadata </td>
+<td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td>
+<td width="40%" align="right" valign="top"> 7.2. Setting Up a Web Sandbox</td>
+</tr>
+</table>
+</div>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
Index: ch-tutorial.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/ch-tutorial.php,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- ch-tutorial.php 15 Dec 2007 22:02:23 -0000 1.5
+++ ch-tutorial.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Chapter 6. The Layout of a Tutorial</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="index.php" title="Fedora Documentation Guide">
+<link rel="prev" href="sn-vim-additional-resources.php" title="5.3. Additional VIM Resources">
+<link rel="next" href="sn-tutorial-metadata.php" title="6.2. The Metadata">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,10 +19,30 @@
?>
-<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
+
+<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="id367590"></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="id588028"></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">
@@ -36,10 +68,31 @@
</section>
<index id="generated-index"/>
</article>
-</pre></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sn-vim-additional-resources.php">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="sn-tutorial-metadata.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">5.3. Additional VIM Resources </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 6.2. The Metadata</td></tr></table></div>
+</pre>
+</div>
+</div>
+<div class="navfooter">
+<hr>
+<table width="100%" summary="Navigation footer">
+<tr>
+<td width="40%" align="left">
+<a accesskey="p" href="sn-vim-additional-resources.php">Prev</a>Â </td>
+<td width="20%" align="center">Â </td>
+<td width="40%" align="right">Â <a accesskey="n" href="sn-tutorial-metadata.php">Next</a>
+</td>
+</tr>
+<tr>
+<td width="40%" align="left" valign="top">5.3. Additional VIM Resources </td>
+<td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td>
+<td width="40%" align="right" valign="top"> 6.2. The Metadata</td>
+</tr>
+</table>
+</div>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
Index: ch-vim.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/ch-vim.php,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- ch-vim.php 15 Dec 2007 22:02:23 -0000 1.5
+++ ch-vim.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Chapter 5. VIM and DocBook</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="index.php" title="Fedora Documentation Guide">
+<link rel="prev" href="sn-emacs-additional-resources.php" title="4.6. Additional Resources">
+<link rel="next" href="sn-vim-keymapping.php" title="5.2. Keymapping with VIM">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,7 +19,23 @@
?>
-<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>
+
+<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="id559436"></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,11 +43,15 @@
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="id364721"></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="id558591"></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:
-</p><pre class="screen">
+</p>
+<pre class="screen">
<code class="computeroutput">" Turn off vi compatibility settings like limited undo
set nocompatible
" Syntax highlighting based on file extension
@@ -30,8 +62,15 @@
set autoindent
" Match SGML tags with %
source $VIMRUNTIME/macros/matchit.vim</code>
-</pre><p>
- </p><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>
+</pre>
+<p>
+ </p>
+<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>
Some of these features require the <code class="filename">vim-enhanced</code>
package to be installed. If you are using or the
<code class="filename">vim-minimal</code> package, or if you are using an older
@@ -39,10 +78,32 @@
<code class="filename">$VIMRUNTIME/macros/matchit.vim</code> file. You can still
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>
+ </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>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
Index: ch-writing-guidelines.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/ch-writing-guidelines.php,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- ch-writing-guidelines.php 15 Dec 2007 22:02:23 -0000 1.5
+++ ch-writing-guidelines.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Chapter 3. Fedora Documentation Guidelines</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="index.php" title="Fedora Documentation Guide">
+<link rel="prev" href="sn-adding-translation.php" title="2.7. Adding a Translation">
+<link rel="next" href="sn-id-naming-conventions.php" title="3.2. ID Naming Conventions">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,19 +19,71 @@
?>
-<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,
+
+<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="id565316"></a><a class="indexterm" name="id546620"></a><a class="indexterm" name="id545036"></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>.
- </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
+ </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" 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
+ 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="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>
+ 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$');
?>
+</html>
Index: generated-index.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/generated-index.php,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- generated-index.php 15 Dec 2007 22:02:23 -0000 1.5
+++ generated-index.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,14 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Index</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="index.php" title="Fedora Documentation Guide">
+<link rel="prev" href="acknowledgments.php" title="Chapter 10. Acknowledgments">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,19 +18,270 @@
?>
-<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-cv
s-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 conve!
ntions, <a class="indexterm" href="sn-id-naming-conventions.ph!
p">ID Na
ming 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>
+
+<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 Commands</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.php#sn-cvs-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 conventions, <a class="indexterm" href="sn-id-naming-conventions.php">ID Naming 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 10. 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$');
?>
+</html>
Index: index.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/index.php,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- index.php 15 Dec 2007 22:02:23 -0000 1.5
+++ index.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,13 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Fedora Documentation Guide</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="next" href="ch-intro.php" title="Introduction">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,11 +17,177 @@
?>
-<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 Guide!
lines</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></span
></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 Docum!
entation</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-prepar!
ation.php">8.2. Preparing For CVS Use</a></span></dt><dd><dl><!
dt><span
class="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. Res!
olving Conflicts</a></span></dt><dt><span class="section"><a h!
ref="sn-
cvs-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.4 (2008-04-09)</p></div>
+<div><p class="copyright">Copyright © 2003, 2004, 2005, 2006, 2007, 2008 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="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#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="section"><a href="sn-build-system.php">2.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>
+<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 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-examples.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. Closing <span class="application"><strong>Emacs</strong></span></a></span></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 Documentation</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-preparation.php">8.2. Preparing For CVS Use</a></span></dt>
+<dd><dl>
+<dt><span class="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. Resolving Conflicts</a></span></dt>
+<dt><span class="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-summary">8.4.9. Summary</a></span></dt>
+</dl></dd>
+</dl></dd>
+<dt><span class="chapter"><a href="ch-l10n.php">9. Localization (L10n)</a></span></dt>
+<dd><dl>
+<dt><span class="section"><a href="ch-l10n.php#sn-l10n-po-files">9.1. PO Files</a></span></dt>
+<dt><span class="section"><a href="sn-l10n-make-pot.php">9.2. Creating or Updating a POT</a></span></dt>
+<dt><span class="section"><a href="sn-l10n-make-po.php">9.3. Updating PO Files</a></span></dt>
+<dt><span class="section"><a href="sn-l10n-postat.php">9.4. Checking Statistics</a></span></dt>
+</dl></dd>
+<dt><span class="chapter"><a href="acknowledgments.php">10. 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$');
?>
+</html>
Index: legalnotice-opl.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/legalnotice-opl.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- legalnotice-opl.php 15 Dec 2007 22:02:23 -0000 1.1
+++ legalnotice-opl.php 10 Apr 2008 02:37:06 -0000 1.2
@@ -1,3 +1,10 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Legal Notice</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+</head>
<?
include("site.inc");
@@ -7,26 +14,36 @@
?>
-<div class="legalnotice"><p><a name="opl.permission"></a>
+<div class="legalnotice">
+<p><a name="opl.permission"></a>
Permission is granted to copy, distribute, and/or modify this
document under the terms of the Open Publication Licence, Version
1.0, or any later version. The terms of the OPL are set out below.
- </p><div class="orderedlist"><a name="opl.terms"></a><ol type="I"><li><a name="opl.require"></a><h2><a name="id413162"></a>REQUIREMENTS ON BOTH UNMODIFIED AND MODIFIED
- VERSIONS</h2><p>
+ </p>
+<div class="orderedlist">
+<a name="opl.terms"></a><ol type="I">
+<li>
+<a name="opl.require"></a><h2>
+<a name="id596394"></a>REQUIREMENTS ON BOTH UNMODIFIED AND MODIFIED
+ VERSIONS</h2>
+<p>
Open Publication works may be reproduced and distributed in
whole or in part, in any medium physical or electronic, provided
that the terms of this license are adhered to, and that this
license or an incorporation of it by reference (with any options
elected by the author(s) and/or publisher) is displayed in the
reproduction.
- </p><p>
+ </p>
+<p>
Proper form for an incorporation by reference is as follows:
- </p><p>
+ </p>
+<p>
Copyright (c) <year> by <author's name or designee>.
This material may be distributed only subject to the terms and
conditions set forth in the Open Publication License, vX.Y or
later (the latest version is presently available at <a class="ulink" href="http://www.opencontent.org/openpub/"; target="_top">http://www.opencontent.org/openpub/</a>).
- </p><p>
+ </p>
+<p>
The reference must be immediately followed with any options
elected by the author(s) and/or publisher of the document (see
section VI). Commercial redistribution of Open
@@ -37,100 +54,149 @@
surfaces of the book the original publisher's name shall be as
large as the title of the work and cited as possessive with
respect to the title.
- </p></li><li><a name="opl.copyright"></a><h2><a name="id299222"></a>COPYRIGHT</h2><p>
+ </p>
+</li>
+<li>
+<a name="opl.copyright"></a><h2>
+<a name="id556955"></a>COPYRIGHT</h2>
+<p>
The copyright to each Open Publication is owned by its author(s)
or designee.
- </p></li><li><a name="opl.scope"></a><h2><a name="id299235"></a>SCOPE OF LICENSE</h2><p>
+ </p>
+</li>
+<li>
+<a name="opl.scope"></a><h2>
+<a name="id556969"></a>SCOPE OF LICENSE</h2>
+<p>
The following license terms apply to all Open Publication works,
unless otherwise explicitly stated in the document.
- </p><p>
+ </p>
+<p>
Mere aggregation of Open Publication works or a portion of an
Open Publication work with other works or programs on the same
media shall not cause this license to apply to those other
works. The aggregate work shall contain a notice specifying the
inclusion of the Open Publication material and appropriate
copyright notice.
- </p><p>
+ </p>
+<p>
SEVERABILITY. If any part of this license is found to be
unenforceable in any jurisdiction, the remaining portions of the
license remain in force.
- </p><p>
+ </p>
+<p>
NO WARRANTY. Open Publication works are licensed and provided
"as is" without warranty of any kind, express or implied,
including, but not limited to, the implied warranties of
merchantability and fitness for a particular purpose or a
warranty of non-infringement.
- </p></li><li><a name="opl.modified.works"></a><h2><a name="id405399"></a>REQUIREMENTS ON MODIFIED WORKS</h2><p>
+ </p>
+</li>
+<li>
+<a name="opl.modified.works"></a><h2>
+<a name="id607782"></a>REQUIREMENTS ON MODIFIED WORKS</h2>
+<p>
All modified versions of documents covered by this license,
including translations, anthologies, compilations and partial
documents, must meet the following requirements:
- </p><div class="orderedlist"><ol type="1"><li><p>
+ </p>
+<div class="orderedlist"><ol type="1">
+<li><p>
The modified version must be labeled as such.
- </p></li><li><p>
+ </p></li>
+<li><p>
The person making the modifications must be identified and
the modifications dated.
- </p></li><li><p>
+ </p></li>
+<li><p>
Acknowledgement of the original author and publisher if
applicable must be retained according to normal academic
citation practices.
- </p></li><li><p>
+ </p></li>
+<li><p>
The location of the original unmodified document must be
identified.
- </p></li><li><p>
+ </p></li>
+<li><p>
The original author's (or authors') name(s) may not be used
to assert or imply endorsement of the resulting document
without the original author's (or authors') permission.
- </p></li></ol></div></li><li><a name="opl.good-practice"></a><h2><a name="id357103"></a>GOOD-PRACTICE RECOMMENDATIONS</h2><p>
+ </p></li>
+</ol></div>
+</li>
+<li>
+<a name="opl.good-practice"></a><h2>
+<a name="id587708"></a>GOOD-PRACTICE RECOMMENDATIONS</h2>
+<p>
In addition to the requirements of this license, it is requested
from and strongly recommended of redistributors that:
- </p><div class="orderedlist"><ol type="1"><li><p>
+ </p>
+<div class="orderedlist"><ol type="1">
+<li><p>
If you are distributing Open Publication works on hardcopy
or CD-ROM, you provide email notification to the authors of
your intent to redistribute at least thirty days before your
manuscript or media freeze, to give the authors time to
provide updated documents. This notification should describe
modifications, if any, made to the document.
- </p></li><li><p>
+ </p></li>
+<li><p>
All substantive modifications (including deletions) be
either clearly marked up in the document or else described
in an attachment to the document.
- </p></li><li><p>
+ </p></li>
+<li><p>
Finally, while it is not mandatory under this license, it is
considered good form to offer a free copy of any hardcopy
and CD-ROM expression of an Open Publication-licensed work
to its author(s).
- </p></li></ol></div></li><li><a name="opl.options"></a><h2><a name="id384872"></a>LICENSE OPTIONS</h2><p>
+ </p></li>
+</ol></div>
+</li>
+<li>
+<a name="opl.options"></a><h2>
+<a name="id609159"></a>LICENSE OPTIONS</h2>
+<p>
The author(s) and/or publisher of an Open Publication-licensed
document may elect certain options by appending language to the
reference to or copy of the license. These options are
considered part of the license instance and must be included
with the license (or its incorporation by reference) in derived
works.
- </p><p>
+ </p>
+<p>
A. To prohibit distribution of substantively modified versions
without the explicit permission of the author(s). "Substantive
modification" is defined as a change to the semantic content of
the document, and excludes mere changes in format or
typographical corrections.
- </p><p>
+ </p>
+<p>
To accomplish this, add the phrase 'Distribution of
substantively modified versions of this document is prohibited
without the explicit permission of the copyright holder.' to the
license reference or copy.
- </p><p>
+ </p>
+<p>
B. To prohibit any publication of this work or derivative works
in whole or in part in standard (paper) book form for commercial
purposes is prohibited unless prior permission is obtained from
the copyright holder.
- </p><p>
+ </p>
+<p>
To accomplish this, add the phrase 'Distribution of the work or
derivative of the work in any standard (paper) book form is
prohibited unless prior permission is obtained from the
copyright holder.' to the license reference or copy.
- </p></li></ol></div></div>
+ </p>
+</li>
+</ol>
+</div>
+</div>
<?
$template->displayFooter('$Date$');
?>
+</html>
Index: rv-revhistory.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/rv-revhistory.php,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- rv-revhistory.php 15 Dec 2007 22:02:23 -0000 1.5
+++ rv-revhistory.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,10 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Revision History</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+</head>
<?
include("site.inc");
@@ -7,43 +14,104 @@
?>
-<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">
+<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.4</td>
+<td align="left">2008-04-09</td>
+<td align="left">PWF</td>
+</tr>
+<tr><td align="left" colspan="3">
+ <p>
+ Add L10n chapter (#441190)
+ </p>
+ </td></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">
+ </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>
- </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">
+ </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">PWF</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">PWF</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">PWF</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">PWF</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">TFJFSMPWF</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>
- </td></tr></table></div>
+ </td></tr>
+</table></div>
<?
$template->displayFooter('$Date$');
?>
+</html>
Index: sn-adding-docbook-file.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-adding-docbook-file.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- sn-adding-docbook-file.php 15 Dec 2007 22:02:23 -0000 1.1
+++ sn-adding-docbook-file.php 10 Apr 2008 02:37:06 -0000 1.2
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>2.6. Adding a New DocBook XML File</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-how-modules-work.php" title="Chapter 2. How Modules Work">
+<link rel="prev" href="ch-getting-files-build-system-images.php" title="2.5. Using Document Image Files">
+<link rel="next" href="sn-adding-translation.php" title="2.7. Adding a Translation">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,17 +19,57 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.6. Adding a New DocBook XML File</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch-getting-files-build-system-images.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-adding-translation.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-adding-docbook-file">2.6. Adding a New DocBook XML File</h2></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
+
+<div class="navheader">
+<table width="100%" summary="Navigation header">
+<tr><th colspan="3" align="center">2.6. Adding a New DocBook XML File</th></tr>
+<tr>
+<td width="20%" align="left">
+<a accesskey="p" href="ch-getting-files-build-system-images.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-adding-translation.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-adding-docbook-file">2.6. Adding a New DocBook XML File</h2></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="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch-getting-files-build-system-images.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-adding-translation.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">2.5. Using Document Image Files </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 2.7. Adding a Translation</td></tr></table></div>
+ the language directory name.</p></li>
+</ol></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-images.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-adding-translation.php">Next</a>
+</td>
+</tr>
+<tr>
+<td width="40%" align="left" valign="top">2.5. Using Document Image Files </td>
+<td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td>
+<td width="40%" align="right" valign="top"> 2.7. Adding a Translation</td>
+</tr>
+</table>
+</div>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
Index: sn-adding-translation.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-adding-translation.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- sn-adding-translation.php 15 Dec 2007 22:02:23 -0000 1.1
+++ sn-adding-translation.php 10 Apr 2008 02:37:06 -0000 1.2
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>2.7. Adding a Translation</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-how-modules-work.php" title="Chapter 2. How Modules Work">
+<link rel="prev" href="sn-adding-docbook-file.php" title="2.6. Adding a New DocBook XML File">
+<link rel="next" href="ch-writing-guidelines.php" title="Chapter 3. Fedora Documentation Guidelines">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,20 +19,71 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.7. Adding a Translation</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sn-adding-docbook-file.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="sn-adding-translation">2.7. Adding a Translation</h2></div></div></div><p>Translations are stored as PO (portable object) files, which
+
+<div class="navheader">
+<table width="100%" summary="Navigation header">
+<tr><th colspan="3" align="center">2.7. Adding a Translation</th></tr>
+<tr>
+<td width="20%" align="left">
+<a accesskey="p" href="sn-adding-docbook-file.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="sn-adding-translation">2.7. Adding a Translation</h2></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>
+ 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
+ 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
+ <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 class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sn-adding-docbook-file.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.6. Adding a New DocBook XML File </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>
+ works:</p>
+<pre class="screen">make po/<em class="replaceable"><code>lang</code></em>.po</pre>
+</li>
+</ol></div>
+</div>
+<div class="navfooter">
+<hr>
+<table width="100%" summary="Navigation footer">
+<tr>
+<td width="40%" align="left">
+<a accesskey="p" href="sn-adding-docbook-file.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.6. Adding a New DocBook XML File </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>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
Index: sn-build-system.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-build-system.php,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- sn-build-system.php 15 Dec 2007 22:02:23 -0000 1.5
+++ sn-build-system.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>2.2. The Document Build System</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-how-modules-work.php" title="Chapter 2. How Modules Work">
+<link rel="prev" href="ch-how-modules-work.php" title="Chapter 2. How Modules Work">
+<link rel="next" href="ch-getting-files-build-system-targets.php" title="2.3. Build System Actions">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,22 +19,45 @@
?>
-<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>
+
+<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="id372793" href="#ftn.id372793" class="footnote">2</a>]</sup> and shell scripts. Authors need
+ <code class="command">make(1)</code><sup>[<a name="id550379" href="#ftn.id550379" 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>
+ </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>
+ </p>
+<p>
<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
+ </p>
+<div class="example">
+<a name="ex-makefile"></a><div class="example-contents"><pre class="screen">DOCBASE = example-doc
PRI_LANG = en_US
DOC_ENTITIES = doc-entities
@@ -35,19 +70,45 @@
for d in docs-common ../docs-common ../../docs-common; do
if [ -f $$d/Makefile.common ]; then echo "$$d/Makefile.common"; break; fi; done
endef
-include $(shell $(find-makefile-common))</pre></div><p class="title"><b>Example 2.2. Sample Document Makefile</b></p></div><br class="example-break"><p>
+include $(shell $(find-makefile-common))</pre></div>
+<p class="title"><b>Example 2.2. Sample Document Makefile</b></p>
+</div>
+<br class="example-break"><p>
Do not be concerned with some of the more complicated syntax
such as the <code class="command">XMLFILES_template</code> stanza. An
explanation for this template appears a few paragraphs
- below.</p><div class="segmentedlist"><a name="sg-makefile-variables"></a><div class="title"><strong><span class="title">Makefile Variables</span></strong></div><table border="0"><thead><tr class="segtitle"><th>Variable</th><th>Explanation</th></tr></thead><tbody><tr class="seglistitem"><td class="seg"><code class="systemitem">DOCBASE</code></td><td class="seg">This variable contains the name for the main (parent) XML
+ below.</p>
+<div class="segmentedlist">
+<a name="sg-makefile-variables"></a><div class="title"><strong><span class="title">Makefile Variables</span></strong></div>
+<table border="0">
+<thead><tr class="segtitle">
+<th>Variable</th>
+<th>Explanation</th>
+</tr></thead>
+<tbody>
+<tr class="seglistitem">
+<td class="seg"><code class="systemitem">DOCBASE</code></td>
+<td class="seg">This variable contains the name for the main (parent) XML
document. Follow convention by naming your document after
- the module name.</td></tr><tr class="seglistitem"><td class="seg"><code class="systemitem">PRI_LANG</code></td><td class="seg">This variable contains the ISO code for the original
+ the module name.</td>
+</tr>
+<tr class="seglistitem">
+<td class="seg"><code class="systemitem">PRI_LANG</code></td>
+<td class="seg">This variable contains the ISO code for the original
version of the document, such as
- <code class="systemitem">en_US</code>.</td></tr><tr class="seglistitem"><td class="seg"><code class="systemitem">DOC_ENTITIES</code></td><td class="seg">This variable contains a listing of any files containing
+ <code class="systemitem">en_US</code>.</td>
+</tr>
+<tr class="seglistitem">
+<td class="seg"><code class="systemitem">DOC_ENTITIES</code></td>
+<td class="seg">This variable contains a listing of any files containing
entity definitions. The Fedora Documentation Project uses a special XML format to
record document-specific entities, so they can be translated
and built on the fly like any other XML document. An
- example is shown later in this guide. </td></tr><tr class="seglistitem"><td class="seg"><code class="systemitem">XMLFILES_template</code></td><td class="seg">This template allows the build tools to work with the
+ example is shown later in this guide. </td>
+</tr>
+<tr class="seglistitem">
+<td class="seg"><code class="systemitem">XMLFILES_template</code></td>
+<td class="seg">This template allows the build tools to work with the
document in multiple languages once it is translated. The
<code class="systemitem">${1}</code> marking is a
variable used to substitute the appropriate language. This
@@ -55,29 +116,71 @@
duplicate this section exactly except for the actual
filenames. Prepend the text <code class="systemitem">${1}/</code>, in place of the language
code directory name, to each filename in your document.
- </td></tr></tbody></table></div><div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Important: Files Exempt From Listing"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="./stylesheet-images/important.png"></td><th align="left">Files Exempt From Listing</th></tr><tr><td align="left" valign="top"><p>Do not include the document-specific entities XML file or
+ </td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Important: Files Exempt From Listing">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="./stylesheet-images/important.png"></td>
+<th align="left">Files Exempt From Listing</th>
+</tr>
+<tr><td align="left" valign="top"><p>Do not include the document-specific entities XML file or
the <code class="filename">rpm-info.xml</code> file, which will be
- discussed later in this guide.</p></td></tr></table></div><p>
+ discussed later in this guide.</p></td></tr>
+</table></div>
+<p>
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 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" 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
+ </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.id372793" href="#id372793" 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.id550379" href="#id550379" 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
for that command. To read the manpage for
<code class="command">make(1)</code>, use the command <code class="command">man 1
- make</code>.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch-how-modules-work.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-getting-files-build-system-targets.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 2. How Modules Work </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 2.3. Build System Actions</td></tr></table></div>
+ make</code>.</p></div>
+</div>
+</div>
+<div class="navfooter">
+<hr>
+<table width="100%" summary="Navigation footer">
+<tr>
+<td width="40%" align="left">
+<a accesskey="p" href="ch-how-modules-work.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-getting-files-build-system-targets.php">Next</a>
+</td>
+</tr>
+<tr>
+<td width="40%" align="left" valign="top">Chapter 2. How Modules Work </td>
+<td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td>
+<td width="40%" align="right" valign="top"> 2.3. Build System Actions</td>
+</tr>
+</table>
+</div>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
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.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- sn-creating-new-pub.php 15 Dec 2007 22:02:23 -0000 1.4
+++ sn-creating-new-pub.php 10 Apr 2008 02:37:06 -0000 1.5
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>7.3. Creating a New Publication</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-publishing.php" title="Chapter 7. Publishing Official Documentation">
+<link rel="prev" href="sn-sandbox-setup.php" title="7.2. Setting Up a Web Sandbox">
+<link rel="next" href="ch-cvs.php" title="Chapter 8. CVS">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,31 +19,77 @@
?>
-<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
+
+<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
+ 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
if the document references specific features of a particular
- Fedora release.</p></li><li><p>Under the branch directory (or document directory if no
+ 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" 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
+ 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
- specifics of each Fedora release.</p><div class="procedure"><ol type="1"><li><p>Make the required directory structure.</p><pre class="screen">cd ~/fedora/web/html/docs/
+ specifics of each Fedora release.</p>
+<div class="procedure"><ol type="1">
+<li>
+<p>Make the required directory structure.</p>
+<pre class="screen">cd ~/fedora/web/html/docs/
mkdir foobar-tutorial
mkdir foobar-tutorial/f7
-mkdir foobar-tutorial/f7/{en_US,zz_XX}</pre></li><li><p>Build the HTML version of each translation of the
- document from Docs CVS.</p><pre class="screen">cd <em class="replaceable"><code>~/my-docs/foobar-tutorial/F-7/</code></em>
-make html-en_US html-zz_XX</pre></li><li><p>Copy the HTML content to the web sandbox.</p><pre class="screen">cd ~/fedora/web/html/docs/foobar-tutorial/f7/
+mkdir foobar-tutorial/f7/{en_US,zz_XX}</pre>
+</li>
+<li>
+<p>Build the HTML version of each translation of the
+ document from Docs CVS.</p>
+<pre class="screen">cd <em class="replaceable"><code>~/my-docs/foobar-tutorial/F-7/</code></em>
+make html-en_US html-zz_XX</pre>
+</li>
+<li>
+<p>Copy the HTML content to the web sandbox.</p>
+<pre class="screen">cd ~/fedora/web/html/docs/foobar-tutorial/f7/
cp -r ~/my-docs/foobar-tutorial/F-7/foobar-tutorial-en_US/ en_US/
-cp -r ~/my-docs/foobar-tutorial/F-7/foobar-tutorial-zz_XX/ zz_XX/</pre></li><li><p>Convert the HTML in each directory to PHP using the
+cp -r ~/my-docs/foobar-tutorial/F-7/foobar-tutorial-zz_XX/ zz_XX/</pre>
+</li>
+<li>
+<p>Convert the HTML in each directory to PHP using the
provided <code class="filename">docbookhtml2php.py</code>
- script.</p><pre class="screen">cd en_US/
+ script.</p>
+<pre class="screen">cd en_US/
~/fedora/web/scripts/docbookhtml2php.py *html && rm -f *html
cd ../zz_XX/
-~/fedora/web/scripts/docbookhtml2php.py *html && rm -f *html</pre></li><li><p>Create any necessary <code class="filename">index.php</code>
+~/fedora/web/scripts/docbookhtml2php.py *html && rm -f *html</pre>
+</li>
+<li>
+<p>Create any necessary <code class="filename">index.php</code>
files for the overall directories. Each document and branch
directory must have an <code class="filename">index.php</code> file
directing users to appropriate content. In this example,
@@ -40,13 +98,34 @@
<code class="filename">foobar-tutorial/f7/index.php</code>. You do
not need to write these files from scratch. Copy an existing
file from another document, and change it as needed to suit
- the new document.</p><p>Depending on content, publication may include changing
- a higher-level <code class="filename">index.php</code> file.</p></li><li><p>To test the changes in your sandbox, open a web browser
+ the new document.</p>
+<p>Depending on content, publication may include changing
+ a higher-level <code class="filename">index.php</code> file.</p>
+</li>
+<li>
+<p>To test the changes in your sandbox, open a web browser
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
+ <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" 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/
+ 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
cvs add f7
@@ -59,12 +138,43 @@
cd ../../
cvs add foobar-tutorial/index.php
cvs add foobar-tutorial/f7/index.php
-</pre></li><li><p>Commit the changes to CVS. Use a message that describes
- the document being committed.</p><pre class="screen">cvs ci -m '<em class="replaceable"><code>message about document</code></em>' foobar-tutorial/</pre></li><li><p>Tag the content <code class="systemitem">LIVE</code> in
- CVS.</p><pre class="screen">cvs tag -F LIVE foobar-tutorial/</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-sandbox-setup.php">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch-publishing.php">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch-cvs.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">7.2. Setting Up a Web Sandbox </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> Chapter 8. CVS</td></tr></table></div>
+</pre>
+</li>
+<li>
+<p>Commit the changes to CVS. Use a message that describes
+ the document being committed.</p>
+<pre class="screen">cvs ci -m '<em class="replaceable"><code>message about document</code></em>' foobar-tutorial/</pre>
+</li>
+<li>
+<p>Tag the content <code class="systemitem">LIVE</code> in
+ CVS.</p>
+<pre class="screen">cvs tag -F LIVE foobar-tutorial/</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-sandbox-setup.php">Prev</a>Â </td>
+<td width="20%" align="center"><a accesskey="u" href="ch-publishing.php">Up</a></td>
+<td width="40%" align="right">Â <a accesskey="n" href="ch-cvs.php">Next</a>
+</td>
+</tr>
+<tr>
+<td width="40%" align="left" valign="top">7.2. Setting Up a Web Sandbox </td>
+<td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td>
+<td width="40%" align="right" valign="top"> Chapter 8. CVS</td>
+</tr>
+</table>
+</div>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
Index: sn-cvs-config.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-cvs-config.php,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- sn-cvs-config.php 15 Dec 2007 22:02:23 -0000 1.5
+++ sn-cvs-config.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>8.3. Configuring For CVS Access</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-cvs.php" title="Chapter 8. CVS">
+<link rel="prev" href="sn-cvs-preparation.php" title="8.2. Preparing For CVS Use">
+<link rel="next" href="sn-cvs-cvscommands.php" title="8.4. Basic CVS Commands">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,35 +19,63 @@
?>
-<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>
+
+<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="id616414"></a><a class="indexterm" name="id616428"></a><a class="indexterm" name="id616441"></a><a class="indexterm" name="id616455"></a><a class="indexterm" name="id616465"></a><a class="indexterm" name="id616474"></a><a class="indexterm" name="id616492"></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="id616516"></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 class="application"><strong>CVS</strong></span> will read
before executing your command line.
- </p><p>
+ </p>
+<p>
Create a file named <code class="filename">~/.cvsrc</code> in your home
directory. It should contain the following commands, one per
line:
- </p><pre class="screen"><code class="computeroutput">cvs -z3
+ </p>
+<pre class="screen"><code class="computeroutput">cvs -z3
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="id377746"></a><a class="indexterm" name="id377760"></a><p>
+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="id616576"></a><a class="indexterm" name="id616590"></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
instructions in this section and then skip directly to
<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>
+ </p>
+<p>
Change directories to where you want your files from
<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@xxxxxxxxxxxxxxxxxxxxx:/cvs/docs</code>
+ </p>
+<pre class="screen"><code class="command">export CVSROOT=:pserver:anonymous@xxxxxxxxxxxxxxxxxxxxx:/cvs/docs</code>
<code class="command">cvs login</code>
<code class="command">cvs checkout</code> <em class="replaceable"><code>module-name</code></em>
<code class="command">cvs checkout</code> <em class="replaceable"><code>module-name</code></em>
-<code class="command">cd</code> <em class="replaceable"><code>module-name</code></em></pre><p>
+<code class="command">cd</code> <em class="replaceable"><code>module-name</code></em></pre>
+<p>
Once you have checked the module out, the value of your
<code class="envar">$CVSROOT</code> environment variable does not matter.
It is stored in the file <code class="filename">CVS/Root</code>
@@ -43,28 +83,58 @@
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="id377878"></a><a class="indexterm" name="id377892"></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="id613289"></a><a class="indexterm" name="id613302"></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
on this process, refer to the
<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>
+ </p>
+<p>
Every author has a unique <code class="envar">$CVSROOT</code> to access the
<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>
+ </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>
+ </p>
+<pre class="screen"><code class="command">cvs co -c</code></pre>
+<p>
You will be asked for the passphrase for your
<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>
+ </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>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
Index: sn-cvs-cvscommands.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-cvs-cvscommands.php,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- sn-cvs-cvscommands.php 15 Dec 2007 22:02:23 -0000 1.5
+++ sn-cvs-cvscommands.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>8.4. Basic CVS Commands</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-cvs.php" title="Chapter 8. CVS">
+<link rel="prev" href="sn-cvs-config.php" title="8.3. Configuring For CVS Access">
+<link rel="next" href="ch-l10n.php" title="Chapter 9. Localization (L10n)">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,64 +19,112 @@
?>
-<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>
+
+<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="ch-l10n.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="id613418"></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>
+ </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>
To see if you need a correctly-set <code class="envar">$CVSROOT</code>
variable, or the <code class="option">-m </code>
<em class="replaceable"><code>repository</code></em> command line switch, see
if you have a <code class="filename">CVS/</code> subdirectory in your
working directory.
- </p><p>
+ </p>
+<p>
If you have a <code class="filename">CVS/</code> directory,
<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="id378084"></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="id613496"></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.
- </p><p>
+ </p>
+<p>
To checkout a module, use the following command:
- </p><pre class="screen"><code class="command">cvs co <em class="replaceable"><code>module-name</code></em></code></pre><p>
+ </p>
+<pre class="screen"><code class="command">cvs co <em class="replaceable"><code>module-name</code></em></code></pre>
+<p>
For example, to checkout the
<code class="computeroutput">example-tutorial</code> module, change
to your work directory, and execute the following command:
- </p><pre class="screen"><code class="command">cvs co example-tutorial</code></pre><p>
+ </p>
+<pre class="screen"><code class="command">cvs co example-tutorial</code></pre>
+<p>
A directory called <code class="filename">example-tutorial/</code> is
created in the current directory.
- </p><p>
+ </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 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="id378170"></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="id613583"></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>
+ </p>
+<p>
To checkout a branch of a module, use the following command:
- </p><pre class="screen"><code class="command">cvs co -d <em class="replaceable"><code>directory</code></em> -r <em class="replaceable"><code>branchname</code></em> <em class="replaceable"><code>module-name</code></em></code></pre><p>
+ </p>
+<pre class="screen"><code class="command">cvs co -d <em class="replaceable"><code>directory</code></em> -r <em class="replaceable"><code>branchname</code></em> <em class="replaceable"><code>module-name</code></em></code></pre>
+<p>
A directory named <em class="replaceable"><code>directory</code></em>
is created, and the files for the
<em class="replaceable"><code>branchname</code></em> branch of the
<em class="replaceable"><code>module-name</code></em> module are
copied in the directory.
- </p><p>
+ </p>
+<p>
For example, to checkout a branch named
<code class="systemitem">BRANCH-VERSION-1.2</code> from the
<code class="computeroutput">mymodule</code> module, use the
command:
- </p><pre class="screen"><code class="command">cvs co -d mymodule-1.2 -r BRANCH-VERSION-1.2 mymodule</code></pre><p>
+ </p>
+<pre class="screen"><code class="command">cvs co -d mymodule-1.2 -r BRANCH-VERSION-1.2 mymodule</code></pre>
+<p>
The BRANCH-VERSION-1.2 branch of the module is checked out in
the <code class="filename">mymodule-1.2</code> directory on your
system.
- </p><p>
+ </p>
+<p>
To determine which branches and tags exist for a file, use the
command:
- </p><pre class="screen"><code class="command">cvs status -v <em class="replaceable"><code>filename</code></em></code></pre><p>
+ </p>
+<pre class="screen"><code class="command">cvs status -v <em class="replaceable"><code>filename</code></em></code></pre>
+<p>
For example, the status of the file
<code class="filename">foo.xml</code> is as follows:
- </p><pre class="screen">
+ </p>
+<pre class="screen">
<code class="computeroutput">===================================================================
File: foo.xml Status: Up-to-date
@@ -75,23 +135,42 @@
Sticky Options: (none)
Existing Tags:
- BRANCH-VERSION-1.2 (branch: 1.25.2)</code></pre><p>
+ BRANCH-VERSION-1.2 (branch: 1.25.2)</code></pre>
+<p>
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="id378333"></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="id613745"></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>
+ </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 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="id378381"></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="id613793"></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:
- </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>
+ </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
favorite text editor, as defined by the <code class="envar">$VISUAL</code>
or the <code class="envar">$EDITOR</code> environment variable, just omit
@@ -99,68 +178,106 @@
message</code></em>"</code></strong>. The buffer will
already contain comments describing the change. You do not
need to delete them as you enter your own text.
- </p></td></tr></table></div><p>
+ </p></td></tr>
+</table></div>
+<p>
The log message should be as descriptive as possible so that you
and anyone else working on the module understands what changed.
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 class="application"><strong>Bugzilla</strong></span> reference.
- </p><p>
+ </p>
+<p>
The <em class="replaceable"><code>filename</code></em> can be one
filename, a series of filenames separated by spaces, or a group
of filenames specified using wildcards such as
<code class="filename">*.png</code> or <code class="filename">foo-*.xml</code>.
- </p><p>
+ </p>
+<p>
If no filename or group of filenames is specified in the
<code class="command">commit</code> command, all outstanding changes of
any kind are committed to the server. The command is recursive
and will include changes in any subdirectories of the
- module.</p><div class="caution" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Caution: Committing Changes"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="./stylesheet-images/caution.png"></td><th align="left">Committing Changes</th></tr><tr><td align="left" valign="top"><p>
+ module.</p>
+<div class="caution" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Caution: Committing Changes">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="./stylesheet-images/caution.png"></td>
+<th align="left">Committing Changes</th>
+</tr>
+<tr><td align="left" valign="top"><p>
Use caution when issuing the <code class="command">commit</code> command
without any filenames because you might not remember exactly
what files changed.
- </p></td></tr></table></div><p>
+ </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="id378534"></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="id613946"></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>
+ </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="id378607"></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="id614019"></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
filename extensions such as <code class="filename">.png</code> or
<code class="filename">.jpg</code>, and usually behaves as the user
intends.
- </p><p>
+ </p>
+<p>
When a copy of a file is checked out of the repository,
<span class="application"><strong>cvs</strong></span> scans it for special keywords
such as <code class="computeroutput">$id:$</code>. The
<span class="application"><strong>cvs</strong></span> program replaces the keyword with
a generated value such as the file version number.
- </p><p>
+ </p>
+<p>
This keyword substitution usually corrupts binary files, so it
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:
- </p><pre class="screen"><code class="command">cvs admin -kk <em class="replaceable"><code>filename</code></em></code></pre><p>
+ </p>
+<pre class="screen"><code class="command">cvs admin -kk <em class="replaceable"><code>filename</code></em></code></pre>
+<p>
Note that the file must already be checked in to the
<abbr class="abbrev">CVS</abbr> repository before the
<code class="option">admin</code> command can be used. This is acceptable,
since the keyword expansion is done as the file is checked out
and copied to the local directory, not when the file is
committed to the repository.
- </p><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Tip: Recovering a binary file"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="./stylesheet-images/tip.png"></td><th align="left">Recovering a binary file</th></tr><tr><td align="left" valign="top"><p>
+ </p>
+<div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Tip: Recovering a binary file">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="./stylesheet-images/tip.png"></td>
+<th align="left">Recovering a binary file</th>
+</tr>
+<tr><td align="left" valign="top"><p>
If you check a binary file into the repository and then find
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="id378729"></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="id614141"></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
@@ -168,62 +285,92 @@
the module, an archived copy is still kept on the server and can
be retrieved at any time with the <code class="command">add</code>
command.
- </p><pre class="screen"><code class="command">cvs rm -f</code> <em class="replaceable"><code>file-to-remove</code></em></pre><p>
+ </p>
+<pre class="screen"><code class="command">cvs rm -f</code> <em class="replaceable"><code>file-to-remove</code></em></pre>
+<p>
After removing the file, you must <code class="command">commit</code> the
removal:
- </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-remove</code></em></code></pre><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-remove</code></em></code></pre>
+<p>
You can not use wildcards in the <code class="command">commit</code>
command to identify removed files. They must be specified with a
exact filename.
- </p><p>
+ </p>
+<p>
If you need to rename a file, it is best to rename the file on
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 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="id378842"></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="id614254"></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
file, use the command:
- </p><pre class="screen"><code class="command">cvs status</code> <em class="replaceable"><code>filename</code></em></pre><p>
+ </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>
+ </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 class="application"><strong>CVS</strong></span> server.
- </p></dd><dt><span class="term"><code class="computeroutput">Locally Modified</code></span></dt><dd><p>
+ </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.
- </p></dd><dt><span class="term"><code class="computeroutput">Locally Added</code></span></dt><dd><p>
+ </p></dd>
+<dt><span class="term"><code class="computeroutput">Locally Added</code></span></dt>
+<dd><p>
You added the file with the <code class="command">cvs add</code>
command but have not yet committed the addition of the
file.
- </p></dd><dt><span class="term"><code class="computeroutput">Locally Removed</code></span></dt><dd><p>
+ </p></dd>
+<dt><span class="term"><code class="computeroutput">Locally Removed</code></span></dt>
+<dd><p>
You removed the file with the <code class="command">cvs
remove</code> command but have not yet committed the
removal.
- </p></dd><dt><span class="term"><code class="computeroutput">Needs Checkout</code></span></dt><dd><p>
+ </p></dd>
+<dt><span class="term"><code class="computeroutput">Needs Checkout</code></span></dt>
+<dd><p>
A newer version of the file is on the server and needs to
be retrieved. Even though the status includes the word
checkout, it really means that you need to update your
files with the <code class="command">cvs update</code> command.
- </p></dd><dt><span class="term"><code class="computeroutput">Needs Patch</code></span></dt><dd><p>
+ </p></dd>
+<dt><span class="term"><code class="computeroutput">Needs Patch</code></span></dt>
+<dd><p>
The revision in your local checkout needs a patch to be
the latest revision from the server. Issue the
<code class="command">cvs update</code> command to resolve.
- </p></dd><dt><span class="term"><code class="computeroutput">Needs Merge</code></span></dt><dd><p>
+ </p></dd>
+<dt><span class="term"><code class="computeroutput">Needs Merge</code></span></dt>
+<dd><p>
A newer revision exists on the server and your local
version contains modification not yet committed. This
status usually occurs if you don't have the latest
revision of the file and edit it anyway.
- </p></dd><dt><span class="term"><code class="computeroutput">File had conflicts on merge</code></span></dt><dd><p>
+ </p></dd>
+<dt><span class="term"><code class="computeroutput">File had conflicts on merge</code></span></dt>
+<dd><p>
Similar to <code class="computeroutput">Needs Merge</code>,
except when you tried to issue the <code class="command">cvs
update</code> command, the differences could not be
resolved automatically. 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
more information on resolving conflicts.
- </p></dd><dt><span class="term"><code class="computeroutput">Unknown</code></span></dt><dd><p>
+ </p></dd>
+<dt><span class="term"><code class="computeroutput">Unknown</code></span></dt>
+<dd><p>
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
@@ -232,30 +379,39 @@
<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="id379148"></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="id614560"></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
your local copy of the module:
- </p><pre class="screen"><code class="computeroutput">RCS file: /cvs/docs/module-name/filename.sgml,v
+ </p>
+<pre class="screen"><code class="computeroutput">RCS file: /cvs/docs/module-name/filename.sgml,v
retrieving revision 1.12
retrieving revision 1.13
Merging differences between 1.12 and 1.13 into filename.sgml
rcsmerge: warning: conflicts during merge
cvs server: conflicts found in filename.sgml
-C filename.sgml</code></pre><p>
+C filename.sgml</code></pre>
+<p>
To resolve the conflict, open the file, search for
<code class="computeroutput"><<<<<<<</code>
and determine which version of the content is correct. For
example:
- </p><pre class="screen"><code class="computeroutput"><para>
+ </p>
+<pre class="screen"><code class="computeroutput"><para>
Some sentence.
<<<<<<< filename.sgml
A sentence that was changed in the working copy.
=======
A same sentence that was changed differently and committed.
>>>>>>> 1.13
-</para></code></pre><p>
+</para></code></pre>
+<p>
The content between the
<code class="computeroutput"><<<<<<<</code>,
and the <code class="computeroutput">=======</code> is the content
@@ -263,55 +419,153 @@
<code class="computeroutput">=======</code> and the
<code class="computeroutput">>>>>>>></code> is
the content from the server.
- </p><p>
+ </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="id379244"></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="id614657"></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
+ </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>
- </td><td>Creates a directory called
+ </td>
+<td>Creates a directory called
<em class="replaceable"><code><module-name></code></em> with the contents of the
- module in the directory</td></tr><tr><td><code class="command">cvs co -d <em class="replaceable"><code><directory></code></em> -r <em class="replaceable"><code><branchname></code></em><em class="replaceable"><code><module-name></code></em></code>
- </td><td>Creates the <em class="replaceable"><code><directory></code></em> directory
+ module in the directory</td>
+</tr>
+<tr>
+<td>
+<code class="command">cvs co -d <em class="replaceable"><code><directory></code></em> -r <em class="replaceable"><code><branchname></code></em><em class="replaceable"><code><module-name></code></em></code>
+ </td>
+<td>Creates the <em class="replaceable"><code><directory></code></em> directory
with the contents of the <em class="replaceable"><code><branchname></code></em>
- branch of the <em class="replaceable"><code><module-name></code></em> module</td></tr><tr><td><code class="command">cvs update</code> or <code class="command">cvs up</code>
- </td><td>Update your files with the latest files from the CVS server</td></tr><tr><td><code class="command">cvs add <em class="replaceable"><code><filename></code></em></code>
- </td><td>Add a new file "filename" to the CVS server</td></tr><tr><td><code class="command">cvs commit -m "My message"
+ branch of the <em class="replaceable"><code><module-name></code></em> module</td>
+</tr>
+<tr>
+<td>
+<code class="command">cvs update</code> or <code class="command">cvs up</code>
+ </td>
+<td>Update your files with the latest files from the CVS server</td>
+</tr>
+<tr>
+<td>
+<code class="command">cvs add <em class="replaceable"><code><filename></code></em></code>
+ </td>
+<td>Add a new file "filename" to the CVS server</td>
+</tr>
+<tr>
+<td>
+<code class="command">cvs commit -m "My message"
<em class="replaceable"><code><filename></code></em></code>
- </td><td>Update file <em class="replaceable"><code><filename></code></em> with the
- latest copy from your computer</td></tr><tr><td><code class="command">cvs log <em class="replaceable"><code><filename></code></em></code>
- </td><td>View the commit messages for the file <em class="replaceable"><code><filename></code></em>
- </td></tr><tr><td><code class="command">cvs status <em class="replaceable"><code><filename></code></em></code>
- </td><td>View status of the file, such as <code class="computeroutput">Locally
+ </td>
+<td>Update file <em class="replaceable"><code><filename></code></em> with the
+ latest copy from your computer</td>
+</tr>
+<tr>
+<td>
+<code class="command">cvs log <em class="replaceable"><code><filename></code></em></code>
+ </td>
+<td>View the commit messages for the file <em class="replaceable"><code><filename></code></em>
+ </td>
+</tr>
+<tr>
+<td>
+<code class="command">cvs status <em class="replaceable"><code><filename></code></em></code>
+ </td>
+<td>View status of the file, such as <code class="computeroutput">Locally
Modified</code>
- </td></tr><tr><td><code class="command">cvs status -v <em class="replaceable"><code><filename></code></em></code>
- </td><td>View existing tags and branches for file</td></tr><tr><td><code class="command">cvs diff <em class="replaceable"><code><filename></code></em></code>
- </td><td>Show diff of the working copy of the file and the latest
- version of the file for the branch</td></tr><tr><td><code class="command">cvs diff -r1.1 -r1.2 <em class="replaceable"><code><filename></code></em></code>
- </td><td>Show diff of version 1.1 and 1.2 for file</td></tr></tbody></table></div><p class="title"><b>Table 8.1. Basic CVS Commands</b></p></div><br class="table-break"><p>
+ </td>
+</tr>
+<tr>
+<td>
+<code class="command">cvs status -v <em class="replaceable"><code><filename></code></em></code>
+ </td>
+<td>View existing tags and branches for file</td>
+</tr>
+<tr>
+<td>
+<code class="command">cvs diff <em class="replaceable"><code><filename></code></em></code>
+ </td>
+<td>Show diff of the working copy of the file and the latest
+ version of the file for the branch</td>
+</tr>
+<tr>
+<td>
+<code class="command">cvs diff -r1.1 -r1.2 <em class="replaceable"><code><filename></code></em></code>
+ </td>
+<td>Show diff of version 1.1 and 1.2 for file</td>
+</tr>
+</tbody>
+</table></div>
+<p class="title"><b>Table 8.1. Basic CVS Commands</b></p>
+</div>
+<br class="table-break"><p>
For more information, read the CVS manual available on your
system at
<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 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>
+ </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 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 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 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>
+ password, refer to the <a class="ulink" href="http://www.redhat.com/docs/manuals/enterprise/RHEL-5-manual/en-US/RHEL510/Deployment_Guide/ch-openssh.html"; target="_top"><em class="citetitle">Red Hat Enterprise Linux
+ Deployment 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="ch-l10n.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. Localization (L10n)</td>
+</tr>
+</table>
+</div>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
Index: sn-cvs-preparation.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-cvs-preparation.php,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- sn-cvs-preparation.php 15 Dec 2007 22:02:23 -0000 1.5
+++ sn-cvs-preparation.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>8.2. Preparing For CVS Use</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-cvs.php" title="Chapter 8. CVS">
+<link rel="prev" href="ch-cvs.php" title="Chapter 8. CVS">
+<link rel="next" href="sn-cvs-config.php" title="8.3. Configuring For CVS Access">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,16 +19,37 @@
?>
-<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>
+
+<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="id580410"></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="id364154"></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="id580448"></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>
+ </p>
+<pre class="screen"><code class="command">rpm -q cvs</code></pre>
+<p>
If you see output similar to
<code class="computeroutput">cvs-1.11.19-1</code>, then the package
is installed. A message similar to <code class="computeroutput">package cvs
@@ -24,42 +57,73 @@
<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="id346098"></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="id563178"></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 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>
+ </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
file <code class="filename">~/.ssh/id_dsa.pub</code> on the system.
- </p><p>
+ </p>
+<p>
If your existing <abbr class="abbrev">DSA</abbr> key does not require a
<em class="wordasword">passphrase</em>, you are strongly urged to
generate one that does require a passphrase.
- </p></td></tr></table></div><p>
+ </p>
+</td></tr>
+</table></div>
+<p>
Use the following steps to generate a <abbr class="abbrev">DSA</abbr> key
used by <span class="application"><strong>SSH</strong></span> Protocol 2. It is
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="id384347"></a><a class="indexterm" name="id384365"></a><ol type="1"><li><p>
+ </p>
+<div class="orderedlist">
+<a class="indexterm" name="id616233"></a><a class="indexterm" name="id616251"></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,
type the command:
- </p><pre class="screen"><code class="command">ssh-keygen -t dsa</code></pre><p>
+ </p>
+<pre class="screen"><code class="command">ssh-keygen -t dsa</code></pre>
+<p>
Accept the default file location of
<code class="filename">~/.ssh/id_dsa</code>. You are strongly urged
to define and use a <em class="firstterm">passphrase</em> to
enhance the security of your key. Enter a passphrase
different than your account password and confirm it by
entering it again.
- </p></li><li><p>
+ </p>
+</li>
+<li>
+<p>
Copy your new key to the correct file by typing the
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>
+ </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 class="keycap"><strong>Enter</strong></span> key. If
<code class="filename">~/.ssh/authorized_keys</code> already
@@ -67,20 +131,56 @@
<code class="filename">~/.ssh/id_dsa.pub</code> will be appended to
the end of the <code class="filename">~/.ssh/authorized_keys</code>
file.
- </p></td></tr></table></div></li><li><p>
+ </p></td></tr>
+</table></div>
+</li>
+<li>
+<p>
Change the permissions of your <code class="filename">~/.ssh</code>
directory and your keys with the commands:
- </p><pre class="screen"><code class="command">chmod 700 ~/.ssh</code>
-<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>
+ </p>
+<pre class="screen"><code class="command">chmod 700 ~/.ssh</code>
+<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 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>
+ </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>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
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.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- sn-emacs-additional-resources.php 15 Dec 2007 22:02:23 -0000 1.5
+++ sn-emacs-additional-resources.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>4.6. Additional Resources</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-emacs.php" title="Chapter 4. Emacs and PSGML Mode">
+<link rel="prev" href="sn-emacs-examples.php" title="4.5. Examples">
+<link rel="next" href="ch-vim.php" title="Chapter 5. VIM and DocBook">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,25 +19,68 @@
?>
-<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
+
+<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 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>
+ </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
+ </p></li>
+<li><p>Emacs reference card that comes with the
<code class="filename">emacs</code> package. You can print it out as a
reference. â??
<code class="filename">/usr/share/emacs/<em class="replaceable"><code>version</code></em>/etc/refcard.ps</code>
- </p></li><li><p>Read <em class="citetitle">Editing XML with Emacs and
+ </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 class="ulink" 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 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>
+ </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>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
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.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- sn-emacs-basic-commands.php 15 Dec 2007 22:02:23 -0000 1.5
+++ sn-emacs-basic-commands.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>4.4. Basic Emacs Commands</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-emacs.php" title="Chapter 4. Emacs and PSGML Mode">
+<link rel="prev" href="sn-emacs-colors.php" title="4.3. Customizing Emacs">
+<link rel="next" href="sn-emacs-examples.php" title="4.5. Examples">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,19 +19,198 @@
?>
-<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>
+
+<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 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 b
ackwards 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></!
td><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
+ </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"><strong>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 backwards 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>
+</td>
+<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 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>
+ <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$');
?>
+</html>
Index: sn-emacs-colors.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-emacs-colors.php,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- sn-emacs-colors.php 15 Dec 2007 22:02:23 -0000 1.5
+++ sn-emacs-colors.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>4.3. Customizing Emacs</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-emacs.php" title="Chapter 4. Emacs and PSGML Mode">
+<link rel="prev" href="sn-emacs-file.php" title="4.2. Setting Up Your .emacs File">
+<link rel="next" href="sn-emacs-basic-commands.php" title="4.4. Basic Emacs Commands">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,30 +19,80 @@
?>
-<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>
+
+<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="id549737"></a><a class="indexterm" name="id549750"></a><a class="indexterm" name="id549763"></a><a class="indexterm" name="id554125"></a><a class="indexterm" name="id554138"></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>.
- </p><p>
+ </p>
+<p>
The following is a sample <code class="filename">~/.Xresources</code> file.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note: Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="./stylesheet-images/note.png"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>If you have other settings in your
+ </p>
+<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note: Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="./stylesheet-images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+<p>If you have other settings in your
<code class="filename">~/.Xresources</code>, add the following to the end
of the file.
- </p><pre class="screen">emacs.background: light gray
+ </p>
+<pre class="screen">emacs.background: light gray
emacs.foreground: black
emacs.pointerColor: blue
emacs.cursorColor: blue
emacs.bitmapIcon: on
emacs.font: fixed
-emacs.geometry: 90x25</pre></td></tr></table></div><p>
+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>
+ </p>
+<pre class="screen"><code class="command">xrdb -merge ~/.Xresources</code></pre>
+<p>
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>
+ </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>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
Index: sn-emacs-examples.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-emacs-examples.php,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- sn-emacs-examples.php 15 Dec 2007 22:02:23 -0000 1.5
+++ sn-emacs-examples.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>4.5. Examples</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-emacs.php" title="Chapter 4. Emacs and PSGML Mode">
+<link rel="prev" href="sn-emacs-basic-commands.php" title="4.4. Basic Emacs Commands">
+<link rel="next" href="sn-emacs-additional-resources.php" title="4.6. Additional Resources">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,56 +19,135 @@
?>
-<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>
+
+<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" 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>
+ </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 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>
+ </p>
+<pre class="screen"><code class="prompt">Tag: <</code></pre>
+<p>
To view a list of available tags, use either 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 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>
+ </p>
+<p>
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.
+ </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" id="sn-emacs-tag-closing">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 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" 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
+ </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 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
+ 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
+ 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
+ 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 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>
+ 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>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
Index: sn-emacs-file.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-emacs-file.php,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- sn-emacs-file.php 15 Dec 2007 22:02:23 -0000 1.5
+++ sn-emacs-file.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>4.2. Setting Up Your .emacs File</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-emacs.php" title="Chapter 4. Emacs and PSGML Mode">
+<link rel="prev" href="ch-emacs.php" title="Chapter 4. Emacs and PSGML Mode">
+<link rel="next" href="sn-emacs-colors.php" title="4.3. Customizing Emacs">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,12 +19,29 @@
?>
-<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>
+
+<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="id565448"></a><a class="indexterm" name="id564170"></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
new one that contains the following lines:
- </p><pre class="screen">;; turn on auto-fill in `text-mode' and derived modes
+ </p>
+<pre class="screen">;; turn on auto-fill in `text-mode' and derived modes
;;(mail, news, etc)
(add-hook 'text-mode-hook 'turn-on-auto-fill)
@@ -134,21 +163,45 @@
(global-set-key [(f1)] (lambda () (interactive) (manual-
- entry (current-word))))</pre><p>
+ 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 class="application"><strong>Emacs</strong></span>:
- </p><pre class="screen">;; Enable wheelmouse support by default for emacs 21
+ </p>
+<pre class="screen">;; Enable wheelmouse support by default for emacs 21
(cond (window-system
(mwheel-install)
-))</pre><p>
+))</pre>
+<p>
If you are using the older version 20 of
<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>
+ </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>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
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.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- sn-getting-files-names.php 15 Dec 2007 22:02:23 -0000 1.5
+++ sn-getting-files-names.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>1.3. Naming Conventions</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-getting-files.php" title="Chapter 1. Prerequisites">
+<link rel="prev" href="ch-getting-files-fdp.php" title="1.2. Fedora Documentation Tools">
+<link rel="next" href="ch-how-modules-work.php" title="Chapter 2. How Modules Work">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,21 +19,41 @@
?>
-<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>
+
+<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
can build your document into a <abbr class="abbrev">RPM</abbr> package. To
take advantage of these services, follow the conventions in this
section to name your files.
- </p><p>On the CVS server, directories that contain document files are
+ </p>
+<p>On the CVS server, directories that contain document files are
called <em class="firstterm">modules</em>. Each module represents a
single document. Each document may consist of several
<em class="firstterm">branches</em> if that document changes with each
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="id347890"></a><div class="example-contents"><pre class="screen"><strong class="userinput"><code>cd ~/localrepo/fedora-docs/</code></strong>
+ 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="id494113"></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
@@ -38,39 +70,116 @@
developer-guide developer-guide &docs-common
docs .
docs-common docs-common
-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
+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 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
+ 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
hand, the <code class="systemitem">documentation-guide</code> module is
- 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 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" id="ch-getting-files-naming-modules">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
cases. Use the length descriptors
<em class="wordasword">tutorial</em> or
<em class="wordasword">guide</em> in the module name where
- appropriate.</p><div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Important: Avoid Redundancy"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="./stylesheet-images/important.png"></td><th align="left">Avoid Redundancy</th></tr><tr><td align="left" valign="top"><p>
+ appropriate.</p>
+<div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Important: Avoid Redundancy">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="./stylesheet-images/important.png"></td>
+<th align="left">Avoid Redundancy</th>
+</tr>
+<tr><td align="left" valign="top"><p>
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="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
+ </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="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
+ redundant.</p></li>
+<li><p>If the document is comprised of many XML files, avoid
repeating the name of the document when naming the
- constituent files.</p></li><li><p>Avoid numbering files to show order, since editors and
+ constituent files.</p></li>
+<li><p>Avoid numbering files to show order, since editors and
authors often rearrange documents or reuse their files in
- other documents.</p></li></ul></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-fdp.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="ch-how-modules-work.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">1.2. Fedora Documentation Tools </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> Chapter 2. How Modules Work</td></tr></table></div>
+ other documents.</p></li>
+</ul></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-fdp.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="ch-how-modules-work.php">Next</a>
+</td>
+</tr>
+<tr>
+<td width="40%" align="left" valign="top">1.2. Fedora Documentation Tools </td>
+<td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td>
+<td width="40%" align="right" valign="top"> Chapter 2. How Modules Work</td>
+</tr>
+</table>
+</div>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
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.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- sn-id-naming-conventions.php 15 Dec 2007 22:02:23 -0000 1.5
+++ sn-id-naming-conventions.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>3.2. ID Naming Conventions</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-writing-guidelines.php" title="Chapter 3. Fedora Documentation Guidelines">
+<link rel="prev" href="ch-writing-guidelines.php" title="Chapter 3. Fedora Documentation Guidelines">
+<link rel="next" href="sn-xml-tags.php" title="3.3. XML Tags">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,25 +19,116 @@
?>
-<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
+
+<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="id504606"></a><a class="indexterm" name="id550032"></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="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.
+ section, chapter, or other element.</p>
+<a class="indexterm" name="id550045"></a><a class="indexterm" name="id550059"></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>
+ 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
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">
+ </p>
+<div class="example">
+<a name="ex-id-usage"></a><div class="example-contents"><pre class="screen"><chapter id="ch-unique-name-of-chapter">
<section id="sn-install-make-disks">
-<figure id="fig-redhat-config-kickstart-basic"></pre></div><p class="title"><b>Example 3.1. Proper ID Usage</b></p></div><br class="example-break"><div class="segmentedlist"><a name="sg-id-two-char-naming-conventions"></a><div class="title"><strong><span class="title">Two-Character Naming Conventions</span></strong></div><table border="0"><thead><tr class="segtitle"><th>Tag</th><th>Prefix</th></tr></thead><tbody><tr class="seglistitem"><td class="seg"><code class="sgmltag-element">preface</code></td><td class="seg"><code class="literal">pr-</code></td></tr><tr class="seglistitem"><td class="seg"><code class="sgmltag-element">chapter</code></td><td class="seg"><code class="literal">ch-</code></td></tr><tr class="seglistitem"><td class="seg"><code class="sgmltag-element">section</code></td><td class="seg"><code class="literal">sn-</code></td></tr><tr class="seglistitem"><td class="seg"><code class="sgmltag-element">figure</code></td><td class="seg"><code class="litera!
l">fig-</code></td></tr><tr class="seglistitem"><td class="seg"><code class="sgmltag-element">table</code></td><td class="seg"><code class="literal">tb-</code></td></tr><tr class="seglistitem"><td class="seg"><code class="sgmltag-element">appendix</code></td><td class="seg"><code class="literal">ap-</code></td></tr><tr class="seglistitem"><td class="seg"><code class="sgmltag-element">part</code></td><td class="seg"><code class="literal">pt-</code></td></tr><tr class="seglistitem"><td class="seg"><code class="sgmltag-element">example</code></td><td class="seg"><code class="literal">ex-</code></td></tr></tbody></table></div><p>Use the title of the item as the ID. Make your titles unique
- within a document to prevent conflicts. For example:</p><pre class="screen"><chapter id="ch-how-to-fold-laundry">
+<figure id="fig-redhat-config-kickstart-basic"></pre></div>
+<p class="title"><b>Example 3.1. Proper ID Usage</b></p>
+</div>
+<br class="example-break"><div class="segmentedlist">
+<a name="sg-id-two-char-naming-conventions"></a><div class="title"><strong><span class="title">Two-Character Naming Conventions</span></strong></div>
+<table border="0">
+<thead><tr class="segtitle">
+<th>Tag</th>
+<th>Prefix</th>
+</tr></thead>
+<tbody>
+<tr class="seglistitem">
+<td class="seg"><code class="sgmltag-element">preface</code></td>
+<td class="seg"><code class="literal">pr-</code></td>
+</tr>
+<tr class="seglistitem">
+<td class="seg"><code class="sgmltag-element">chapter</code></td>
+<td class="seg"><code class="literal">ch-</code></td>
+</tr>
+<tr class="seglistitem">
+<td class="seg"><code class="sgmltag-element">section</code></td>
+<td class="seg"><code class="literal">sn-</code></td>
+</tr>
+<tr class="seglistitem">
+<td class="seg"><code class="sgmltag-element">figure</code></td>
+<td class="seg"><code class="literal">fig-</code></td>
+</tr>
+<tr class="seglistitem">
+<td class="seg"><code class="sgmltag-element">table</code></td>
+<td class="seg"><code class="literal">tb-</code></td>
+</tr>
+<tr class="seglistitem">
+<td class="seg"><code class="sgmltag-element">appendix</code></td>
+<td class="seg"><code class="literal">ap-</code></td>
+</tr>
+<tr class="seglistitem">
+<td class="seg"><code class="sgmltag-element">part</code></td>
+<td class="seg"><code class="literal">pt-</code></td>
+</tr>
+<tr class="seglistitem">
+<td class="seg"><code class="sgmltag-element">example</code></td>
+<td class="seg"><code class="literal">ex-</code></td>
+</tr>
+</tbody>
+</table>
+</div>
+<p>Use the title of the item as the ID. Make your titles unique
+ within a document to prevent conflicts. For example:</p>
+<pre class="screen"><chapter id="ch-how-to-fold-laundry">
<title>How To Fold Laundry</title>
<section id="sn-folding-shirts">
- <title>Folding Shirts</title></pre></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch-writing-guidelines.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="sn-xml-tags.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 3. Fedora Documentation Guidelines </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 3.3. XML Tags</td></tr></table></div>
+ <title>Folding Shirts</title></pre>
+</div>
+<div class="navfooter">
+<hr>
+<table width="100%" summary="Navigation footer">
+<tr>
+<td width="40%" align="left">
+<a accesskey="p" href="ch-writing-guidelines.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="sn-xml-tags.php">Next</a>
+</td>
+</tr>
+<tr>
+<td width="40%" align="left" valign="top">Chapter 3. Fedora Documentation Guidelines </td>
+<td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td>
+<td width="40%" align="right" valign="top"> 3.3. XML Tags</td>
+</tr>
+</table>
+</div>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
Index: sn-live-previews.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-live-previews.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- sn-live-previews.php 15 Dec 2007 22:02:23 -0000 1.3
+++ sn-live-previews.php 10 Apr 2008 02:37:06 -0000 1.4
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>3.6. Previewing Your Work</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-writing-guidelines.php" title="Chapter 3. Fedora Documentation Guidelines">
+<link rel="prev" href="sn-screenshots.php" title="3.5. Screenshots">
+<link rel="next" href="ch-emacs.php" title="Chapter 4. Emacs and PSGML Mode">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,22 +19,68 @@
?>
-<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
+
+<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 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
+ 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
+ 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 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>
+ 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>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
Index: sn-module-adding-targets.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-module-adding-targets.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- sn-module-adding-targets.php 15 Dec 2007 22:02:23 -0000 1.1
+++ sn-module-adding-targets.php 10 Apr 2008 02:37:06 -0000 1.2
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>2.4. Adding or Changing Targets</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-how-modules-work.php" title="Chapter 2. How Modules Work">
+<link rel="prev" href="ch-getting-files-build-system-targets.php" title="2.3. Build System Actions">
+<link rel="next" href="ch-getting-files-build-system-images.php" title="2.5. Using Document Image Files">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,21 +19,58 @@
?>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.4. Adding or Changing Targets</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">Chapter 2. How Modules Work</th><td width="20%" align="right"> <a accesskey="n" href="ch-getting-files-build-system-images.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-module-adding-targets">2.4. Adding or Changing Targets</h2></div></div></div><p>
+
+<div class="navheader">
+<table width="100%" summary="Navigation header">
+<tr><th colspan="3" align="center">2.4. Adding or Changing Targets</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">Chapter 2. How Modules Work</th>
+<td width="20%" align="right">Â <a accesskey="n" href="ch-getting-files-build-system-images.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-module-adding-targets">2.4. Adding or Changing Targets</h2></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>
+ </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="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"><a accesskey="u" href="ch-how-modules-work.php">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch-getting-files-build-system-images.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"> 2.5. Using Document Image Files</td></tr></table></div>
+ </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-build-system-targets.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-getting-files-build-system-images.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"> 2.5. Using Document Image Files</td>
+</tr>
+</table>
+</div>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
Index: sn-sandbox-setup.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-sandbox-setup.php,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- sn-sandbox-setup.php 15 Dec 2007 22:02:23 -0000 1.4
+++ sn-sandbox-setup.php 10 Apr 2008 02:37:06 -0000 1.5
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>7.2. Setting Up a Web Sandbox</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-publishing.php" title="Chapter 7. Publishing Official Documentation">
+<link rel="prev" href="ch-publishing.php" title="Chapter 7. Publishing Official Documentation">
+<link rel="next" href="sn-creating-new-pub.php" title="7.3. Creating a New Publication">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,22 +19,73 @@
?>
-<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
-cvs -d :ext:<em class="replaceable"><code>username</code></em>@cvs.fedoraproject.org:/cvs/fedora co web</pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note: Web CVS Access"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="./stylesheet-images/note.png"></td><th align="left">Web CVS Access</th></tr><tr><td align="left" valign="top"><p>You must have access to the
+
+<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
+cvs -d :ext:<em class="replaceable"><code>username</code></em>@cvs.fedoraproject.org:/cvs/fedora co web</pre>
+<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note: Web CVS Access">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="./stylesheet-images/note.png"></td>
+<th align="left">Web CVS Access</th>
+</tr>
+<tr><td align="left" valign="top"><p>You must have access to the
<code class="systemitem">cvsweb</code> module through the Fedora
Account System to check in changes. If you do not have
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 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
+ 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
+ lines:</p>
+<pre class="screen">127.0.0.1 docs.localhost.localdomain</pre>
+</li>
+<li>
+<p>Create a file
<code class="filename">/etc/httpd/conf.d/fpo.conf</code> with the
- following content:</p><pre class="screen">NameVirtualHost *:80
+ following content:</p>
+<pre class="screen">NameVirtualHost *:80
<VirtualHost *:80>
ServerName docs.localhost.localdomain
DocumentRoot /var/www/fedora/web/html/docs
@@ -30,13 +93,46 @@
Alias /css /var/www/fedora/web/html/css
Alias /include /var/www/fedora/web/include
Options Indexes FollowSymLinks
-</Virtualhost></pre></li><li><p>Create a file <code class="filename">/etc/php.d/fpo.ini</code> with
- the following content:</p><pre class="screen">include_path = ".:/var/www/fedora/web/include"</pre></li><li><p>Start the web server using the following command:</p><pre class="screen">su -c '/sbin/service httpd start'</pre><p>To have the web server start at every boot, use the
- following command:</p><pre class="screen">su -c '/sbin/chkconfig httpd on'</pre></li></ol></div><p>To test the new sandbox site, open a Web browser and point it
- at the URL <code class="uri">http://docs.localhost.localdomain</code>.</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch-publishing.php">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch-publishing.php">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="sn-creating-new-pub.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 7. Publishing Official Documentation </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 7.3. Creating a New Publication</td></tr></table></div>
+</Virtualhost></pre>
+</li>
+<li>
+<p>Create a file <code class="filename">/etc/php.d/fpo.ini</code> with
+ the following content:</p>
+<pre class="screen">include_path = ".:/var/www/fedora/web/include"</pre>
+</li>
+<li>
+<p>Start the web server using the following command:</p>
+<pre class="screen">su -c '/sbin/service httpd start'</pre>
+<p>To have the web server start at every boot, use the
+ following command:</p>
+<pre class="screen">su -c '/sbin/chkconfig httpd on'</pre>
+</li>
+</ol></div>
+<p>To test the new sandbox site, open a Web browser and point it
+ at the URL <code class="uri">http://docs.localhost.localdomain</code>.</p>
+</div>
+<div class="navfooter">
+<hr>
+<table width="100%" summary="Navigation footer">
+<tr>
+<td width="40%" align="left">
+<a accesskey="p" href="ch-publishing.php">Prev</a>Â </td>
+<td width="20%" align="center"><a accesskey="u" href="ch-publishing.php">Up</a></td>
+<td width="40%" align="right">Â <a accesskey="n" href="sn-creating-new-pub.php">Next</a>
+</td>
+</tr>
+<tr>
+<td width="40%" align="left" valign="top">Chapter 7. Publishing Official Documentation </td>
+<td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td>
+<td width="40%" align="right" valign="top"> 7.3. Creating a New Publication</td>
+</tr>
+</table>
+</div>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
Index: sn-screenshots.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-screenshots.php,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- sn-screenshots.php 15 Dec 2007 22:02:23 -0000 1.5
+++ sn-screenshots.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>3.5. Screenshots</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-writing-guidelines.php" title="Chapter 3. Fedora Documentation Guidelines">
+<link rel="prev" href="sn-xml-admon.php" title="3.4. Admonitions">
+<link rel="next" href="sn-live-previews.php" title="3.6. Previewing Your Work">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,71 +19,114 @@
?>
-<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
+
+<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="id597306"></a><a class="indexterm" name="id597320"></a><a class="indexterm" name="id597333"></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
same space in the document can hold a greater amount of more
descriptive and helpful information. Therefore, authors should
avoid screenshots whenever possible in favor of descriptive
- text.</p><p>One of the isolated instances in which screenshots are useful
+ text.</p>
+<p>One of the isolated instances in which screenshots are useful
is to demonstrate a physical screen layout that is unfamiliar to a
reader. <span class="emphasis"><em>This does not mean that illustrations of dialog
boxes are good uses of screenshots.</em></span> On the contrary,
dialogs are simply instances of a user interface element with
which a reader is already familiar. An annotated diagram in
certain cases, however, explains to the reader where to find
- functional landmarks on the screen such as menu bars.</p><p>The steps for taking a graphical screenshot illustrate how
+ functional landmarks on the screen such as menu bars.</p>
+<p>The steps for taking a graphical screenshot illustrate how
using text to describe a procedure is more concise than a series
- of screenshots.</p><div class="variablelist"><dl><dt><span class="term">Graphical Screenshot</span></dt><dd><div class="procedure"><ol type="1"><li><p>Create a new user account to make screenshots. The
+ of screenshots.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Graphical Screenshot</span></dt>
+<dd><div class="procedure"><ol type="1">
+<li><p>Create a new user account to make screenshots. The
new account uses the distribution default theme, fonts,
and element sizes. The resulting screenshot has an
appearance familiar to the largest number of readers,
- and makes Fedora Documentation Project documents consistent.</p></li><li><p>Before taking the screenshot, if possible, resize
+ and makes Fedora Documentation Project documents consistent.</p></li>
+<li><p>Before taking the screenshot, if possible, resize
the targeted GUI element(s) to the smallest possible
size. The target image should be 500 pixels wide or
less. If the screenshot includes more than one GUI
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
+ 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 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 class="keycap"><strong>Print Screen</strong></span>. If the shot includes
multiple elements grouped closely together, crop the
resulting PNG format image in <span class="application"><strong>The
- GIMP</strong></span>.</p></li><li><p>If necessary, resize the image using
+ GIMP</strong></span>.</p></li>
+<li><p>If necessary, resize the image using
<span class="application"><strong>The GIMP</strong></span>. Open the image,
then right-click on it and choose
<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>
+ converting it.</p></li>
+<li>
+<p>
With the image open in <span class="application"><strong>The
GIMP</strong></span>, right-click the image, and select
<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 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
+ 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 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,
+ <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
- description unclear.</p></li><li><p>Make the information generic over specific, and omit
+ description unclear.</p></li>
+<li><p>Make the information generic over specific, and omit
any username and machine information if possible. Do not
include the shell prompt unless it is vital to the
- demonstration.</p></li><li><p>Separate what the user types from sample command
- output.</p></li><li><p>When using <code class="sgmltag-element">screen</code>
+ demonstration.</p></li>
+<li><p>Separate what the user types from sample command
+ output.</p></li>
+<li><p>When using <code class="sgmltag-element">screen</code>
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>
+ the resulting output.</p></li>
+</ul></div>
+<p>
<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">
+ </p>
+<div class="example">
+<a name="ex-text-screenshot-good"></a><div class="example-contents">
+<pre class="screen"><example id="ex-text-screenshot-good">
<title>Correct Textual Screenshot</title>
<para>To find all the currently active ssh sessions,
execute the following command:</para>
@@ -81,15 +136,45 @@
3092 ? S 0:00 /usr/bin/ssh-agent /etc/X11/xinit/Xclients
8032 pts/0 S 0:00 ssh user@xxxxxxxxxxxxxxxx
8032 pts/1 S 0:00 ssh root@xxxxxxxxxxxxxxxxxx</computeroutput></screen>
-</example></pre><p>To find all the currently active ssh sessions, execute the
- following command:</p><pre class="screen"><strong class="userinput"><code>ps ax | grep ssh</code></strong></pre><p>Output appears similar to the following:</p><pre class="screen"><code class="computeroutput"> 2564 ? S 0:23 /usr/sbin/sshd
+</example></pre>
+<p>To find all the currently active ssh sessions, execute the
+ following command:</p>
+<pre class="screen"><strong class="userinput"><code>ps ax | grep ssh</code></strong></pre>
+<p>Output appears similar to the following:</p>
+<pre class="screen"><code class="computeroutput"> 2564 ? S 0:23 /usr/sbin/sshd
3092 ? S 0:00 /usr/bin/ssh-agent /etc/X11/xinit/Xclients
8032 pts/0 S 0:00 ssh user@xxxxxxxxxxxxxxxx
- 8032 pts/1 S 0:00 ssh root@xxxxxxxxxxxxxxxxxx</code></pre></div><p class="title"><b>Example 3.2. Correct Textual Screenshot (XML Source and
- HTML)</b></p></div><br class="example-break"></dd></dl></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sn-xml-admon.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="sn-live-previews.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">3.4. Admonitions </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 3.6. Previewing Your Work</td></tr></table></div>
+ 8032 pts/1 S 0:00 ssh root@xxxxxxxxxxxxxxxxxx</code></pre>
+</div>
+<p class="title"><b>Example 3.2. Correct Textual Screenshot (XML Source and
+ HTML)</b></p>
+</div>
+<br class="example-break">
+</dd>
+</dl></div>
+</div>
+<div class="navfooter">
+<hr>
+<table width="100%" summary="Navigation footer">
+<tr>
+<td width="40%" align="left">
+<a accesskey="p" href="sn-xml-admon.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="sn-live-previews.php">Next</a>
+</td>
+</tr>
+<tr>
+<td width="40%" align="left" valign="top">3.4. Admonitions </td>
+<td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td>
+<td width="40%" align="right" valign="top"> 3.6. Previewing Your Work</td>
+</tr>
+</table>
+</div>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
Index: sn-tutorial-metadata.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-tutorial-metadata.php,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- sn-tutorial-metadata.php 15 Dec 2007 22:02:23 -0000 1.5
+++ sn-tutorial-metadata.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>6.2. The Metadata</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-tutorial.php" title="Chapter 6. The Layout of a Tutorial">
+<link rel="prev" href="ch-tutorial.php" title="Chapter 6. The Layout of a Tutorial">
+<link rel="next" href="ch-publishing.php" title="Chapter 7. Publishing Official Documentation">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,10 +19,28 @@
?>
-<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
+
+<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="id552572"></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"?>
+ 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">
@@ -37,13 +67,36 @@
<details>First draft</details>
</revision>
</changelog>
-</rpm-info></pre></div><p class="title"><b>Example 6.1. Example <code class="filename">rpm-info.xml</code> File</b></p></div><br class="example-break"><p>If you are not familiar with XML editing, copy and paste this
+</rpm-info></pre></div>
+<p class="title"><b>Example 6.1. Example <code class="filename">rpm-info.xml</code> File</b></p>
+</div>
+<br class="example-break"><p>If you are not familiar with XML editing, copy and paste this
file from an existing module and then edit the values for the
various elements as appropriate. Consult Fedora Documentation Project members and help
- channels for more assistance if needed.</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch-tutorial.php">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch-tutorial.php">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch-publishing.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 6. The Layout of a Tutorial </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> Chapter 7. Publishing Official Documentation</td></tr></table></div>
+ channels for more assistance if needed.</p>
+</div>
+<div class="navfooter">
+<hr>
+<table width="100%" summary="Navigation footer">
+<tr>
+<td width="40%" align="left">
+<a accesskey="p" href="ch-tutorial.php">Prev</a>Â </td>
+<td width="20%" align="center"><a accesskey="u" href="ch-tutorial.php">Up</a></td>
+<td width="40%" align="right">Â <a accesskey="n" href="ch-publishing.php">Next</a>
+</td>
+</tr>
+<tr>
+<td width="40%" align="left" valign="top">Chapter 6. The Layout of a Tutorial </td>
+<td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td>
+<td width="40%" align="right" valign="top"> Chapter 7. Publishing Official Documentation</td>
+</tr>
+</table>
+</div>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
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.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- sn-vim-additional-resources.php 15 Dec 2007 22:02:23 -0000 1.5
+++ sn-vim-additional-resources.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>5.3. Additional VIM Resources</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-vim.php" title="Chapter 5. VIM and DocBook">
+<link rel="prev" href="sn-vim-keymapping.php" title="5.2. Keymapping with VIM">
+<link rel="next" href="ch-tutorial.php" title="Chapter 6. The Layout of a Tutorial">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,25 +19,67 @@
?>
-<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>
+
+<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 class="ulink" 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 class="ulink" 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>
+ </p></li>
+<li><p>
<a class="ulink" href="http://www.pinkjuice.com/howto/vimxml/"; target="_top">Vim as XML
Editor</a>
- </p></li><li><p>
+ </p></li>
+<li><p>
The <em class="citetitle">VIM REFERENCE MANUAL</em>, which comes with
the <code class="filename">vim-common</code> package â??
<code class="filename">/usr/share/vim/<em class="replaceable"><code><version></code></em>/doc/intro.txt</code>
or type <strong class="userinput"><code>:help intro</code></strong> from within VIM
- </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-vim-keymapping.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="ch-tutorial.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">5.2. Keymapping with VIM </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> Chapter 6. The Layout of a Tutorial</td></tr></table></div>
+ </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-vim-keymapping.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="ch-tutorial.php">Next</a>
+</td>
+</tr>
+<tr>
+<td width="40%" align="left" valign="top">5.2. Keymapping with VIM </td>
+<td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td>
+<td width="40%" align="right" valign="top"> Chapter 6. The Layout of a Tutorial</td>
+</tr>
+</table>
+</div>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
Index: sn-vim-keymapping.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-vim-keymapping.php,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- sn-vim-keymapping.php 15 Dec 2007 22:02:23 -0000 1.5
+++ sn-vim-keymapping.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>5.2. Keymapping with VIM</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-vim.php" title="Chapter 5. VIM and DocBook">
+<link rel="prev" href="ch-vim.php" title="Chapter 5. VIM and DocBook">
+<link rel="next" href="sn-vim-additional-resources.php" title="5.3. Additional VIM Resources">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,7 +19,23 @@
?>
-<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>
+
+<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
@@ -17,7 +45,8 @@
can save it in a separate file and load it with a
<strong class="userinput"><code>source</code></strong> command in your
<code class="filename">.vimrc</code>.
-</p><pre class="screen">
+</p>
+<pre class="screen">
let mapleader = ","
" skip ahead to after next tag without leaving insert mode
@@ -44,15 +73,37 @@
" entities
imap <leader>> &gt;
imap <leader>< &lt;
-</pre><p>
- </p><p>
+</pre>
+<p>
+ </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 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>
+ </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>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
Index: sn-xml-admon.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-xml-admon.php,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- sn-xml-admon.php 15 Dec 2007 22:02:23 -0000 1.5
+++ sn-xml-admon.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>3.4. Admonitions</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-writing-guidelines.php" title="Chapter 3. Fedora Documentation Guidelines">
+<link rel="prev" href="sn-xml-tags.php" title="3.3. XML Tags">
+<link rel="next" href="sn-screenshots.php" title="3.5. Screenshots">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,13 +19,33 @@
?>
-<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
+
+<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="id578353"></a><a class="indexterm" name="id578363"></a><a class="indexterm" name="id578376"></a><a class="indexterm" name="id578390"></a><a class="indexterm" name="id578403"></a><a class="indexterm" name="id578417"></a><a class="indexterm" name="id578430"></a><a class="indexterm" name="id578447"></a><a class="indexterm" name="id578464"></a><a class="indexterm" name="id578482"></a><a class="indexterm" name="id578499"></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="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
+ 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="id578600"></a><a class="indexterm" name="id578613"></a><a class="indexterm" name="id578627"></a><a class="indexterm" name="id578640"></a><a class="indexterm" name="id578654"></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
@@ -27,26 +59,88 @@
information could be vital. A <span class="emphasis"><em><code class="sgmltag-element">warning</code></em></span> is used to show
the reader that their current setup will change or be altered,
such as files being removed, and they should not choose this
- operation unless they are alright with the consequences.</p><p>The following lines of code show the basic setup for each
- case mentioned above, along with its appearance in HTML.</p><pre class="screen"><note>
+ operation unless they are alright with the consequences.</p>
+<p>The following lines of code show the basic setup for each
+ case mentioned above, along with its appearance in HTML.</p>
+<pre class="screen"><note>
<title>Note</title>
<para>Body of text goes here.</para>
-</note></pre><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>Body of text goes here.</p></td></tr></table></div><pre class="screen"><tip>
+</note></pre>
+<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>Body of text goes here.</p></td></tr>
+</table></div>
+<pre class="screen"><tip>
<title>Tip</title>
<para>Body of text goes here.</para>
-</tip></pre><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>Body of text goes here</p></td></tr></table></div><pre class="screen"><caution>
+</tip></pre>
+<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>Body of text goes here</p></td></tr>
+</table></div>
+<pre class="screen"><caution>
<title>Caution</title>
<para>Body of text goes here.</para>
-</caution></pre><div class="caution" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Caution: Caution"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="./stylesheet-images/caution.png"></td><th align="left">Caution</th></tr><tr><td align="left" valign="top"><p>Body of text goes here.</p></td></tr></table></div><pre class="screen"><important>
+</caution></pre>
+<div class="caution" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Caution: Caution">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="./stylesheet-images/caution.png"></td>
+<th align="left">Caution</th>
+</tr>
+<tr><td align="left" valign="top"><p>Body of text goes here.</p></td></tr>
+</table></div>
+<pre class="screen"><important>
<title>Important</title>
<para>Body of text goes here.</para>
-</important></pre><div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Important: Important"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="./stylesheet-images/important.png"></td><th align="left">Important</th></tr><tr><td align="left" valign="top"><p>Body of text goes here.</p></td></tr></table></div><pre class="screen"><warning>
+</important></pre>
+<div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Important: Important">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="./stylesheet-images/important.png"></td>
+<th align="left">Important</th>
+</tr>
+<tr><td align="left" valign="top"><p>Body of text goes here.</p></td></tr>
+</table></div>
+<pre class="screen"><warning>
<title>Warning</title>
<para>Body of text goes here.</para>
-</warning></pre><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Warning: Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="./stylesheet-images/warning.png"></td><th align="left">Warning</th></tr><tr><td align="left" valign="top"><p>Body of text goes here.</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-xml-tags.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="sn-screenshots.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">3.3. XML Tags </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 3.5. Screenshots</td></tr></table></div>
+</warning></pre>
+<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Warning: Warning">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="./stylesheet-images/warning.png"></td>
+<th align="left">Warning</th>
+</tr>
+<tr><td align="left" valign="top"><p>Body of text goes here.</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-xml-tags.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="sn-screenshots.php">Next</a>
+</td>
+</tr>
+<tr>
+<td width="40%" align="left" valign="top">3.3. XML Tags </td>
+<td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td>
+<td width="40%" align="right" valign="top"> 3.5. Screenshots</td>
+</tr>
+</table>
+</div>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
Index: sn-xml-tags.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/en_US/sn-xml-tags.php,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- sn-xml-tags.php 15 Dec 2007 22:02:23 -0000 1.5
+++ sn-xml-tags.php 10 Apr 2008 02:37:06 -0000 1.6
@@ -1,3 +1,15 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>3.3. XML Tags</title>
+<link rel="stylesheet" href="fedora.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.php" title="Fedora Documentation Guide">
+<link rel="up" href="ch-writing-guidelines.php" title="Chapter 3. Fedora Documentation Guidelines">
+<link rel="prev" href="sn-id-naming-conventions.php" title="3.2. ID Naming Conventions">
+<link rel="next" href="sn-xml-admon.php" title="3.4. Admonitions">
+<link rel="copyright" href="ln-legalnotice-opl.php" title="Legal Notice">
+</head>
<?
include("site.inc");
@@ -7,42 +19,124 @@
?>
-<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>
+
+<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="id578041"></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.
- </p><div class="variablelist"><dl><dt><span class="term">Do Not Use Trademark Entities</span></dt><dd><p>Do not use the trademark entities <code class="sgmltag-genentity">&trade;</code>, <code class="sgmltag-genentity">&copy;</code>, or <code class="sgmltag-genentity">&reg;</code> because the do not produce
+ </p>
+<div class="variablelist"><dl>
+<dt><span class="term">Do Not Use Trademark Entities</span></dt>
+<dd>
+<p>Do not use the trademark entities <code class="sgmltag-genentity">&trade;</code>, <code class="sgmltag-genentity">&copy;</code>, or <code class="sgmltag-genentity">&reg;</code> because the do not produce
HTML output that works for all charsets. The HTML output
produces by these entities are declared in the DTD and
- cannot be changed via the stylesheet.</p><p>Instead, use the <code class="sgmltag-element">trademark</code> tag and its
- associates classes as follows:</p><div class="segmentedlist"><table border="0"><thead><tr class="segtitle"><th>DocBook XML source</th><th>Rendered content</th></tr></thead><tbody><tr class="seglistitem"><td class="seg"><code class="code"><trademark>trademark symbol after
- me</trademark></code></td><td class="seg"><span class="trademark">trademark symbol after
- me</span>â?¢</td></tr><tr class="seglistitem"><td class="seg"><code class="code"><trademark
+ cannot be changed via the stylesheet.</p>
+<p>Instead, use the <code class="sgmltag-element">trademark</code> tag and its
+ associates classes as follows:</p>
+<div class="segmentedlist"><table border="0">
+<thead><tr class="segtitle">
+<th>DocBook XML source</th>
+<th>Rendered content</th>
+</tr></thead>
+<tbody>
+<tr class="seglistitem">
+<td class="seg"><code class="code"><trademark>trademark symbol after
+ me</trademark></code></td>
+<td class="seg">
+<span class="trademark">trademark symbol after
+ me</span>â?¢</td>
+</tr>
+<tr class="seglistitem">
+<td class="seg"><code class="code"><trademark
class="registered">registered trademark symbol after
- me</trademark></code></td><td class="seg"><span class="trademark">registered trademark
- symbol after me</span>®</td></tr><tr class="seglistitem"><td class="seg"><code class="code"><trademark class="copyright">copyright
- symbol after me</trademark></code></td><td class="seg"><span class="trademark">copyright symbol after
- me</span>©</td></tr></tbody></table></div></dd><dt><span class="term">Content inside <code class="sgmltag-element">para</code> tags</span></dt><dd><p>In general, use <code class="sgmltag-element">para</code> tags
+ me</trademark></code></td>
+<td class="seg">
+<span class="trademark">registered trademark
+ symbol after me</span>®</td>
+</tr>
+<tr class="seglistitem">
+<td class="seg"><code class="code"><trademark class="copyright">copyright
+ symbol after me</trademark></code></td>
+<td class="seg">
+<span class="trademark">copyright symbol after
+ me</span>©</td>
+</tr>
+</tbody>
+</table></div>
+</dd>
+<dt><span class="term">Content inside <code class="sgmltag-element">para</code> tags</span></dt>
+<dd>
+<p>In general, use <code class="sgmltag-element">para</code> tags
around anything other than a simple paragraph. Doing so will
create additional white space within the text itself in the
PDF version.
- </p><p>Specifically, do not use <code class="sgmltag-element">para</code> tags
+ </p>
+<p>Specifically, do not use <code class="sgmltag-element">para</code> tags
around the following (or, to put this another way, do not
embed the following within <code class="sgmltag-element">para</code> elements):
- </p><div class="itemizedlist"><ul type="disc"><li><p><code class="sgmltag-element">screen</code></p></li><li><p><code class="sgmltag-element">itemizedlist</code></p></li><li><p><code class="sgmltag-element">orderedlist</code></p></li><li><p><code class="sgmltag-element">variablelist</code></p></li><li><p><code class="sgmltag-element">table</code></p></li></ul></div></dd><dt><span class="term">Content inside <code class="sgmltag-element">para</code> elements within
- <code class="sgmltag-element">listitem</code> tags</span></dt><dd><p>Content inside <code class="sgmltag-element">para</code>
+ </p>
+<div class="itemizedlist"><ul type="disc">
+<li><p><code class="sgmltag-element">screen</code></p></li>
+<li><p><code class="sgmltag-element">itemizedlist</code></p></li>
+<li><p><code class="sgmltag-element">orderedlist</code></p></li>
+<li><p><code class="sgmltag-element">variablelist</code></p></li>
+<li><p><code class="sgmltag-element">table</code></p></li>
+</ul></div>
+</dd>
+<dt><span class="term">Content inside <code class="sgmltag-element">para</code> elements within
+ <code class="sgmltag-element">listitem</code> tags</span></dt>
+<dd><p>Content inside <code class="sgmltag-element">para</code>
elements within <code class="sgmltag-element">listitem</code>
elements <span class="emphasis"><em>must</em></span> start immediately after
the beginning <code class="sgmltag-starttag"><para></code> tag
- to avoid extra white space in the PDF version.</p></dd><dt><span class="term">Content inside <code class="sgmltag-element">screen</code> tags</span></dt><dd><p>The content inside <code class="sgmltag-element">screen</code> tags
+ to avoid extra white space in the PDF version.</p></dd>
+<dt><span class="term">Content inside <code class="sgmltag-element">screen</code> tags</span></dt>
+<dd><p>The content inside <code class="sgmltag-element">screen</code> tags
(<code class="sgmltag-starttag"><screen></code> and <code class="sgmltag-endtag"></screen></code>)
<span class="emphasis"><em>must</em></span> be flush left in the XML file;
otherwise, the extraneous whitespace will appear in the HTML
version.
- </p></dd></dl></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sn-id-naming-conventions.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="sn-xml-admon.php">Next</a></td></tr><tr><td width="40%" align="left" valign="top">3.2. ID Naming Conventions </td><td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td><td width="40%" align="right" valign="top"> 3.4. Admonitions</td></tr></table></div>
+ </p></dd>
+</dl></div>
+</div>
+<div class="navfooter">
+<hr>
+<table width="100%" summary="Navigation footer">
+<tr>
+<td width="40%" align="left">
+<a accesskey="p" href="sn-id-naming-conventions.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="sn-xml-admon.php">Next</a>
+</td>
+</tr>
+<tr>
+<td width="40%" align="left" valign="top">3.2. ID Naming Conventions </td>
+<td width="20%" align="center"><a accesskey="h" href="index.php">Home</a></td>
+<td width="40%" align="right" valign="top"> 3.4. Admonitions</td>
+</tr>
+</table>
+</div>
+
<?
$template->displayFooter('$Date$');
?>
+</html>
--
Fedora-websites-list mailing list
Fedora-websites-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/fedora-websites-list
