[kde-doc-english]Bug#42448: docbook authors guide template

Frederik Fouvry fouvry at CoLi.Uni-SB.DE
Fri Oct 11 14:56:37 CEST 2002


| the template.docbook file and the "The KDE DocBook Authors guide" both have wrong entity header content.
| 
| wrong:
| <!ENTITY kappname "&kapp;">
| <!ENTITY kappname "&kapp;" -- this only *seems* redundant -->
| ...
| 
| right:
| <!ENTITY kapp "kappname">
| <!ENTITY kde "KDE">
| ...

No.  The double mention is indeed wrong, but the `correction' is
a lot worse ;-)

1. The general entity &kapp; isn't meant to be defined: it should
   be replaced by the name of the documented application.
   (If it were possible to raise an error in this entity, then I
   would do it.)

2. The general entity &kde; is defined already and must not be
   defined in the preamble again (and certainly not in this
   way!).  Funny how many people seem to want to defined an
   entity for KDE, and always in a way that is much more
   cumbersome than what they get out of it.  _We_ on the other
   hand have done it right ... ;-)

Frederik



More information about the kde-doc-english mailing list