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

[David E. Narvaez]

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





--- Comment #4 from David E. Narvaez <david narvaez computer org>  2010-11-09 18:57:03 ---
(In reply to comment #3)
> > 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>
> 
> From http://docbook.org/tdg/en/html/ch01.html#s-entities:
> <!ENTITY ora "O'Reilly &amp; Associates">
> You see in this example that using an entity ("&amp;") in an entity definition
> is valid docbook syntax.

Thanks for the interest and for the explanation. I didn't know of the existence
of the general.entities file, but as long as the &kate; entity (in this
example) is defined somewhere I agree it's fine to expand kappname to another
entity. I'm not sure if "we then use"  means "we should use" or "in fact, we
use" but taking a look at, e.g., 

http://websvn.kde.org/trunk/l10n-kde4/ca/docs/kdelibs/sonnet/index.docbook?view=markup

you can easily check &kappname; does not appear in the document (which wouldn't
really break anything, since the sonnet entity was already declared) but then
it may all be just a matter of style or convenience and we could close this
report.

> That is not the reason for Gentoo Bug 343523.
> 
> In #343523 I see too different issues:
> 
> 1) Entity 'kdf' not defined
> en_GB-4.4.5/docs/kdeutils/kinfocenter/blockdevices/index.docbook -> that is a
> broken language docbook.
> 
> 2) Entity 'kpat' not defined
> We had a problem in the kde archiv with man-kpat.6.docbook switching from DTD
> 4.1 to DTD 4.2; the entity &kpat; had to be replaced with &kpatience; to make
> this docbook man page compilable. I have no idea why this was necessary,
> man-kpat.6.docbook is unchanged since < 4.0.
> 
> I have no 4.4 kde source environment available any more, so I can't dig into
> that issue further. My guess is that this is a Gentoo issue related to  mixing
> DTD 4.1/4.2

I was actually treating both things separately but your insight on the kpat
issue is great and I'll be investigating down that line.

Thanks again.

-- 
Configure bugmail: https://bugs.kde.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.