glossary Glossar

Zusammenfassung

Zur zentralen Erläuterung von Begrifflichkeiten kann ein Glossar angelegt werden.

Das Glossar besteht aus einem Bereich (glossary), das die Begrifflichkeiten und deren Erläuterung aufnimmt, sowie aus den Links im Dokument auf diese Erläuterungen.

Das Glossar ist aus den folgenden Elementen aufgebaut:

Elemente eines Glossars

<glossary>

Container-Element für das Glossar. Normalerweise am Ende eines Dokuments.

<glossentry id="">

Nimmt den eigentlichen Glossar-Begriff (<glossterm>) auf sowie die Beschreibung (<glossdef>) auf.

<glossterm id="">

Verweist im Fließtext auf die Begriffserläuterung im Glossar. Über die id werden die Begriffe verlinkt.

Anmerkung

Um ein konsistentes Benennungsschema zu erhalten und mögliche Inferenzen mit anderen ids gering zu halten, können Glossar-ids mit einem Präfix wie "gloss-" versehen werden.

Das Glossar wird automatisch alphabetisch sortiert (dies kann über einen Stylesheet-Parameter definiert werden).

Beispiel A.8. Quelltext-Beispiel: Glossar

Verweis innerhalb des Dokuments auf den Glossareintrag: 

<!-- ... -->
<para>Grundlage bildet die <glossterm linkend="gloss_docbook">DocBook</glossterm>-Datei</para>
<!-- ... -->

Definition des Glossareintrags im Glossar: 

<!-- ... -->
<glossary>
<!-- ... -->
<glossentry id="gloss_docbook">
  <glossterm>DocBook</glossterm>
  <glossdef>
    <para>Definition von DocBook...</para>
  </glossdef>
</glossentry>
<!-- ... -->
<glossary>
<!-- ... -->


Grundlage bildet die DocBook-Datei