PrevKDE DocBook ReferenceNext

The Prologue


<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN dtd/kdedbx45.dtd" [
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE"> <!-- ONLY If you are writing non-English
                                     original documentation, change
                                     the language here -->
]>

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 the section called “References, indexes, and glossaries”.

Example A.2. 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

<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN dtd/kdedbx45.dtd" [
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE">
]>

Note

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.)

  • Norwegian-Bokmal

  • Norwegian-Nynorsk

  • Polish

  • Portuguese

  • Brasilian-Portuguese

  • Romanian

  • Russian

  • Slovak

  • Slovenian

  • Serbian

  • Swedish

  • Turkish

  • Ukrainian

  • Walloon

  • Xhosa

  • Continental-Chinese

  • Traditional-Chinese