(Marked this version for translation)
m (1 revision: Moving Docbook Primer from UserBase to TechBase)
<?xml version="1.0" ?> <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ <!-- Define an entity for your application if it is not part of KDE CVS --> <!ENTITY <replaceable>kmyapplication</replaceable> "<application>KMyApp</application>"> <!ENTITY kappname "<replaceable>&kmyapplication;</replaceable>"><!-- replace kmyapplication here do *not* replace kappname--> <!ENTITY package "<replaceable>kde-module</replaceable>"><!-- kdebase, kdeadmin, etc. Leave this unchanged if your application is not maintained in KDE CVS --> <!ENTITY % addindex "IGNORE"> <!ENTITY % English "INCLUDE"> <!-- ONLY If you are writing non-English original documentation, change the language here --> ]>
In general, this needs minimal changing from the template. The items you must change are the entities "kappname", "package", and "English".
The entity "kappname" looks like it's redundant (as the comment in the template notes), but it is important. This allows us to use one global text in all documents, and still refer to the specific application by its correct name. So it should be changed to refer to this new entity, but this time you should only change the part in quotes ("&kmyapplication;") as follow:
From: <!ENTITY kappname "&kmyapplication;" -- this only *seems* redundant --> To: <!ENTITY kappname "&kate;" -- this only *seems* redundant -->
In short: change any occurrence of "kmyapplication" to the real name of your application. Do not use "kappname" or "kapp" directly in a document yourself.
The entity "package" is used similarly. It allows us to insert a single piece of "boilerplate" text into every document, and have the correct package name inserted when the document is compiled. Use the cvs module name, in lower case, ⪚ "kdeedu" or "kdebase".
The entity %addindex; is a toggle. If set to "INCLUDE" a document index will be automatically generated. It is normally set instead to "IGNORE", and should not be changed unless you really do want to generate an index. You can find out more about indexes in References, indexes, and glossaries.
<?xml version="1.0" ?> <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ <!ENTITY kappname "&amor;"> <!ENTITY package "kdetoys"> <!ENTITY % addindex "IGNORE"> <!ENTITY % English "INCLUDE"> ]>