[kde-doc-english] [Bug 256418] Docbook entities are probably misused

[Burkhard Lueck]

https://bugs.kde.org/show_bug.cgi?id=256418





--- Comment #3 from Burkhard Lueck <lueck hube-lueck de>  2010-11-09 18:17:10 ---
(In reply to comment #0)
> Created an attachment (id=53266)
 --> (http://bugs.kde.org/attachment.cgi?id=53266) [details]
> A list of files in kde-l10n sources declaring entities in a suspicious way
> 
> Version:           unspecified (using Devel) 
> OS:                unspecified
> 
> I stumbled upon this analyzing bug reports like
> 
> https://bugs.gentoo.org/show_bug.cgi?id=343523
> 
> where docbook complains about entities not declared. According to
> 
> http://www.w3schools.com/dtd/dtd_entities.asp
> 
> you declare an entity using syntax like
> 
> <!ENTITY kappname "kate">
> 
That is an exception, only 7 of 156 entity definitions in docbooks use this
form

> and then use the entity as &kappname; on the rest of the document. It looks
> like a widespread practice on the translation documents of kde-l10n to use a
> syntax similar to 
> 
> <!ENTITY kappname "&kate;">
> 
That is the major use case, 149 of 156 entity definitions in docbooks use this
form

> and then use &kate; on the rest of the documents. 

No, that is wrong, we then use &kappname; in the document. 
This entitiy &kappname; is expanded in this way:
&kappname; -> &kate; -> <application>Kate</application>
Where an entity like &kate; is defined in general.entities in kdelibs
And &kate; used in the document is expanded via general.entities to
<application>Kate</application>