[kde-doc-english]update

Frederik Fouvry fouvry at CoLi.Uni-SB.DE
Thu Nov 28 22:02:26 CET 2002


Hi,

I've updated the DTD and the template.  The DocBook version that
should be used from now on is 4.2.  The old version (4.1.2) will
remain available for some time, to make sure that old documents
can be validated as well.  The version before that has been
removed.

If you update a document, please also adapt the FPI from 4.1.2 to
4.2.

One extension (which was the only one) has been removed, which
makes that the DTD is again a strict subset of DocBook, i.e. all
KDE documentation that uses the new FPI will be valid DocBook
documents (you will only be able to perform the validation though
when you have all general entity definitions).

Two changes for names:

You can surround the author name(s) with the tags <personname>.
The <affiliation><address> tags can go.  <email> is now allowed
in author :-) An example of the simplified format is in
template.docbook.

You may well ask why on earth you'd add <personname>.  This
concerns the second change.  For documentation contributors,
there's now a file entities/contributors.entities where you can
define an entity for your name and email address.  (Two examples
are given in that file.  More will undoubtedly follow.)  That is
only possible in XML because of the introduction of <personname>.
The author information is now much more friendly-looking (IMHO ;-):

<author>&FirstName.M.LastName; &FirstName.M.LastName.mail;</author>

The same goes for the other contributors.  These entities can
also be used (almost) anywhere else in the text.  This should
greatly help to keep emailaddresses up-to-date, but also to have
a consistent markup of personnames in the documentation.

Translators will have to do the same for in
<lg>/contributor.entities, but that is not set up yet (of course,
user.entities can be used for the time being).

A number of general entities have been removed.  If your document
compilation complains about missing entities, please don't just
add them - they might just have been deleted.

Once we're without problems for this change, I will start
preparing for the introduction of XML catalogues.

Frederik




More information about the kde-doc-english mailing list