Attached is a file that supplies boilerplate instructions for reporting
errors/patches with a document.
Also attached is a patch to my Stateless Linux tutorial which pulls in
the file and uses it, with the various sub-entities given sane
definitions.
You can see a usage of this file in an unofficial copy of that tutorial,
located here:
http://people.redhat.com/dmalcolm/stateless/stateless-linux-HOWTO-
en/#errata-tip
I propose adding the first file as "fedora-docs/common/errata-en.xml"
Any thoughts/rewrites? Perhaps the heading should read "About This
Document" instead?
Dave Malcolm
Title: Making changes/additions to this document
This document is available at &PUBLISHED-HTML-URL;.
For reporting errors in the document, or for requesting changes or additions, use this bugzilla
template, which pre-fills most of the bug report.
Ideally, if you are requesting a change or addition, you should attach a patch, generated using diff -u
against the DocBook XML source of the document.
Otherwise, plain text showing before and after is sufficient.
You can obtain the DocBook XML source from anonymous CVS by typing:
export CVSROOT=:pserver:anonymous@xxxxxxxxxxxxxxxxxx:/usr/local/CVS
cvs -z3 login
Press Enter to enter an empty password
cvs -z3 co fedora-docs/common
cvs -z3 co fedora-docs/xsl
cvs -z3 co fedora-docs/stylesheet-images
cvs -z3 co fedora-docs/css
cvs -z3 co fedora-docs/&CVS-SUBDIRECTORY-NAME;
You will find the DocBook XML source in fedora-docs/&CVS-SUBDIRECTORY-NAME;.
You can generate an HTML version of the document from the DocBook XML source by typing:
cd fedora-docs/&CVS-SUBDIRECTORY-NAME;
make
You should then be able to find the generated HTML in fedora-docs/&CVS-SUBDIRECTORY-NAME;/&GENERATED-HTML-SUBDIRECTORY;
You can find more information about working with Fedora documentation here
? stateless-linux-HOWTO-en
Index: stateless-linux-HOWTO-en.xml
===================================================================
RCS file: /usr/local/CVS/fedora-docs/stateless-linux/stateless-linux-HOWTO-en.xml,v
retrieving revision 1.5
diff -u -r1.5 stateless-linux-HOWTO-en.xml
--- stateless-linux-HOWTO-en.xml 30 Sep 2004 20:18:01 -0000 1.5
+++ stateless-linux-HOWTO-en.xml 17 Nov 2004 21:38:40 -0000
@@ -23,6 +23,14 @@
<!ENTITY TestProtosystemAbs "<filename>/srv/stateless/protosystems/&TestProtosystemRel;</filename>">
<!ENTITY StatelessVolumeGroup "<replaceable>VGStateless</replaceable>">
+<!-- Entities for use with cvs-instructions-en.xml -->
+<!ENTITY PUBLISHED-HTML-URL "http://fedora.redhat.com/docs/stateless/";>
+<!ENTITY CVS-SUBDIRECTORY-NAME "stateless-linux">
+<!ENTITY GENERATED-HTML-SUBDIRECTORY "stateless-linux-HOWTO-en">
+<!ENTITY TRACKER-BUG-NUMBER "">
+<!ENTITY ASSIGNED-TO "dmalcolm%40redhat.com">
+<!ENTITY BUG-URL "https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora%20Core&op_sys=Linux&version=fc3&component=fedora-docs&component_text=&rep_platform=All&priority=normal&bug_severity=normal&bug_status=NEW&assigned_to=&ASSIGNED-TO;&cc=&estimated_time=0.0&bug_file_loc=&comment=Description%20of%20change%2Faddition.%20%20If%20a%20change%2C%20include%20the%20original%0D%0Atext%20first%2C%20then%20the%20changed%20text%3A%0D%0A%0D%0A%0D%0A%0D%0A&blocked=&TRACKER-BUG-NUMBER;%20%20&maketemplate=Remember%20values%20as%20bookmarkable%20template&form_name=enter_bug";>
+<!ENTITY ERRATA-TIP-EN SYSTEM "../common/errata-en.xml">
<!-- Generic entities used by all Fedora documentation -->
<!ENTITY % FEDORA-ENTITIES-EN SYSTEM "../common/fedora-entities-en.xml">
@@ -127,6 +135,9 @@
The root filesystem is mounted read-only in the case of the first three
types of clients, since all management will be done on the server.
</para>
+
+ &ERRATA-TIP-EN;
+
</section>
<!-- FIXME: We will be setting up two servers:
