On Wed, 2004-11-17 at 13:59, David Malcolm wrote:
> Attached is a file that supplies boilerplate instructions for reporting
> errors/patches with a document.
This is a stellar idea, thanks!
I suggest a few changes, new file attached.
* Added a <!-- comment --> explaining how to obtain and format the URL
from bugzilla/
* Some fill-column because I can't help myself. :)
* Changed the <screen> code to match the current FDP style (flush left,
<command> on same line, not in <para> block).
> I propose adding the first file as "fedora-docs/common/errata-en.xml"
Recommend an RFE bug report.
Might also want to patch fedora-entities-en.xml to have it make the
entity declaration:
<!ENTITY ERRATA-TIP-EN SYSTEM "errata-en.xml">
> Any thoughts/rewrites? Perhaps the heading should read "About This
> Document" instead?
Yes, that is more of an accurate title. Changed that in the attachment.
________________________________________________________________________
- Karsten
--
Karsten Wade, RHCE, Tech Writer
a lemon is just a melon in disguise
http://people.redhat.com/kwade/
gpg fingerprint: 2680 DBFD D968 3141 0115 5F1B D992 0E06 AD0E 0C41
Title: About 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 at
http://fedora.redhat.com/projects/docs/.
