Proposal for document entities

Patrick Barnes nman64 at n-man.com
Fri Nov 18 22:21:46 UTC 2005


Paul W. Frields wrote:
> Currently, our documents have entities like this (please pardon the MUA
> mangling):
>
> <!ENTITY % FEDORA-ENTITIES-EN SYSTEM
> "../docs-common/common/fedora-entities-en.ent">
> %FEDORA-ENTITIES-EN;
> <!ENTITY BOOKID "foo-tutorial-0.15 (2005-01-01)"> <!-- change version of
> manual and date here -->
>
>
> I would like to see this instead as a standard:
>
> <!ENTITY BOOKNAME "foo-tutorial">
> <!ENTITY BOOKVERSION "0.15"> <!-- change version number here -->
> <!ENTITY BOOKDATE "2005-01-01"> <!-- change revision date here -->
> <!ENTITY BOOKID "&BOOKNAME;-&BOOKVERSION; (&BOOKDATE;)">
> <!ENTITY BUG-NUM "000000"> <!-- only used while in draft -->
>
>
> Any input?
>
>   
+1

It is usually considered best practice to track a package's name,
version and revision date separately.  No sense in making an exception
for docs.  :-)

-- 
Patrick "The N-Man" Barnes
nman64 at n-man.com

www.n-man.com
-- 



-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 189 bytes
Desc: OpenPGP digital signature
Url : http://lists.fedoraproject.org/pipermail/docs/attachments/20051118/183967c3/attachment.bin 


More information about the docs mailing list