Adding boilerplate errata/CVS instructions

Karsten Wade kwade at redhat.com
Fri Nov 19 00:26:31 UTC 2004


On Thu, 2004-11-18 at 12:45, David Malcolm wrote:
> On Wed, 2004-11-17 at 16:39 -0800, Karsten Wade wrote:
> >
> 
> Done, as this one:
> https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=139931
> 
> Should this go on a tracker bug somewhere?

I don't think there is one, just falls in the "all open fedora-docs
bugs" category.

> > Might also want to patch fedora-entities-en.xml to have it make the
> > entity declaration:
> > 
> > <!ENTITY ERRATA-TIP-EN SYSTEM "errata-en.xml">
> 
> Would doing this require that any files using fedora-entities-en.xml
> define the various entities referred to in errata-en.xml ? (and hence
> break all the existing docs, until they get fixed?)

Good question.  I _think_ it would only come into play if explicitly
called by the document.   Here's a test.

I added this to my fedora-entities-en.xml:

<!ENTITY ABOUT-DOC-EN SYSTEM "about-doc-en.xml">

then built a document without any error.

It also validated:

cd /home/kwade/Documents/projects/fedora/fedora-docs/selinux-apache/
nsgmls -wxml -s /home/kwade/lib/psgmlx-0.5/lib/xml.dcl
selinux-apache-en.xml
nsgmls:/home/kwade/lib/psgmlx-0.5/lib/xml.dcl:1:W: SGML declaration was
not implied

SGML validation finished at Thu Nov 18 16:24:42

FWIW, that's the way it normally appears when I validate (in Emacs using
C-c C-v).

> > 
> > > 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.
> 
> Perhaps the file should have a different name; perhaps
> "about-this-document-en.xml" ?

How about about-doc-en.xml?

- 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




More information about the fedora-docs-list mailing list