Description of problem: Current entities must be repetitively entered by authors/editors, inducing usage skew. (Yes, I just made that term up. Sorry, it's early.) Version-Release number of selected component (if applicable): N/A Actual results: Authors/editors must enter their own entities manually. Mistakes abound, and everyone uses different entities. Expected results: Standard entities for the most common terms, such as Fedora, Fedora Project, Fedora Core, Fedora Documentation Project, et al. Additional info: Karsten Wade introduced the attached entities file to the fedora-docs-list. See http://www.redhat.com/archives/fedora-docs-list/2004-July/msg00046.html for more information.
Created attachment 102562 [details] Fedora standard entities source, should be in common/ All tutorials, whether book or article, should now reference this source document with the following XML code: <!ENTITY % FEDORA-ENTITIES-EN SYSTEM "../common/fedora-entities-en.xml"> %FEDORA-ENTITIES-EN; Get this into CVS please!
We should also add an entity for Bugzilla under an appropriate section. I think "Fedora common entities" is where this should go, but I could also see it under "other common names" if there's an objection. <!ENTITY BZ "Bugzilla"> <!-- Bugzilla --> <!ENTITY BZ-URL "<ulink url='http://bugzilla.redhat.com/'>http://bugzilla.redhat.com/</ulink>"> <!-- Bugzilla URL -->
I have added the file to CVS and will start fixing the Documentation Guide to reflect this change.
example-tutorial/example-tutorial-en.xml in CVS has been changed to use the common entities file and verison 0.2.3 of the Docs Guide has been changed to show this in the example tutorial section.
Tammy, I reopened the bug just to get your attentions for comment #2 above. I think the BZ* entities are probably very useful as well. My updfstab-tutorial references Bugzilla a couple times to remind users that if they find unknown usb-storage devices, adding the information to Bugzilla might help them find their way into the next release. I'll bet other docs writers reference Bugzilla also. Is this sensible?
*Tickle, tickle!*
The Bugzilla and Bugzilla URL entities have been added in CVS to version 1.3 of the fedora-entities-en.xml file.
Ticket moved to allow products to be removed from BZ.