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 [[Documentation Primer/Manual/DocBook Reference/Reference|References, indexes, and glossaries]].

+

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 [[Special:myLanguage/Documentation Primer/Manual/DocBook Reference/Reference|References, indexes, and glossaries]].

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:

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, &eg; "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.

Example: A KDE User Manual Prolog

Here is an example of a completely set up prolog, as it normally looks. This is the prolog from the AMOR documentation

The entity "English" should be changed to reflect your language, if you are either writing original documentation in another language, or you are translating a document. For KDE the original documentation should always be in English, so you should not need to change this when writing. For informational purposes, the currently supported languages are:

Afrikaans

British-English

Bulgarian

Catalan

Czech

Danish

German

Greek

English

Spanish

Estonian

Finnish

Faroese

French

Hebrew

Hungarian

Indonesian

Italian

Japanese

Dutch

Norwegian (Note, this is only for compatibility, either Norwegian-Bokmal or Norwegian-Nynorsk should be used in preference.)