A few nice bits in CVS

Paul W. Frields stickster at gmail.com
Wed Sep 7 13:25:40 UTC 2005


While I was on and in various planes and hotel rooms in Seattle I
managed to cobble together a couple kibbles 'n' bits in the docs-common
module that should make our documentation easier to read.  

One of the common complaints was that the revision history block on the
title page made readers wade through a lot of material in which they
weren't interested just to get to the real narrative.  The revision
history now is linked in the same manner as the legal notice, so people
can get right to the table of contents as expected.  (You can see the
results in the "yum" and "jargon-buster" documents on the
fedora.redhat.com web site now.)  If you generate a "nochunks" version
of the HTML, the revision history appears inline, just as the legal
notice does.

One tiny drawback is that the build process (i.e. "make") issues a
warning about context.  It's only a warning and does not affect the
efficacy of the build.  I'm sure this is a small problem easily fixed by
someone who understands XSL better than I.  That someone might even find
a better way to accomplish the task, and if so, please have at it.

In the meantime, if you have a docs-common/ module checked out of CVS,
you should update it ("cvs up") now.  If you have no idea what I'm
talking about, then you need to speak up on the list so we can answer
any of your questions and get you working on some of the good stuff! ;-)

-- 
Paul W. Frields, RHCE                          http://paul.frields.org/
  gpg fingerprint: 3DA6 A0AC 6D58 FEC4 0233  5906 ACDB C937 BD11 3717
 Fedora Documentation Project: http://fedora.redhat.com/projects/docs/
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part
Url : http://lists.fedoraproject.org/pipermail/docs/attachments/20050907/ad34f094/attachment.bin 


More information about the docs mailing list