[Kde-games-devel] Entities docupdate and docversion in the documentation

Burkhard Lück lueck at hube-lueck.de
Mon Feb 23 12:05:53 CET 2009


Hi,

many games documentation define the entities docupdate and docversion in the 
header of the index.docbook.

Some problems with this approach:

The entities are untranslatable, so docupdate (a date format) is not localized 
in the translations.

Quoting the comment in templates.docbook in kdelibs:
"Please respect the format of the date (YYYY-MM-DD) and of the version
(V.MM.LL), it could be used by automation scripts."

<date>&docupdate;</date> in kdegames is not consistent with the documentation 
in other modules.
Every script needs an exception for the games documentation.

The entities are only used once in the docbooks, it does not really make sense 
to define an entity and use it only once.

I suggest to remove these entities.

-- 
Burkhard Lück


More information about the kde-games-devel mailing list