Glossar
(Auszug aus "DITA - Der neue Standard für Technische Dokumentation" von Johannes Hentrich)
Mit DITA 1.1 ist der Topictyp „Glossar“ zu den Topictypen „Aufgabe“, „Konzept“ und „Referenz“ hinzugekommen. Dabei stellt der Topictyp „Glossar“ eine Spezialisierung des Topictyps „Konzept“ dar.
Zuvor wurden zwei Methoden angewendet, um Glossareinträge aufnehmen zu können:
- es wurden die Elemente für die Definitionsliste verwendet,
- es wurde das generische Topic mit den Elementen <topic>, <body>, <dl>, <dlentry>, <dt> und <dd> spezialisiert. Im Buch Introduction to DITA: A User Guide to the Darwin Information Typing Architecture zeigen die beiden Autorinnen Jennifer Linton und Kylene Bruski, wie diese Spezialisierung vorgenommen wird.
Bei der DITA Version 1.1 wurde nicht das generische Topic spezialisiert, sondern der Topictyp „Konzept“.
Das folgende Beispiel zeigt, wie ein einzelner Glossareintrag in DITA aufgebaut ist:
Wie alle anderen DITA-Topic beginnt auch das Topic vom Typ „Glossar“ mit einer XML- und der DOCTYPE-Deklaration. In der DOCTYPE-Deklaration wird auf die glossary.dtd verwiesen.
Das Wurzel-Element des Topictyps „Glossar“ ist das <glossentry>-Element. Im Wurzel-Element <glossentry> muss eine eindeutige Kennung, das heißt, eine ID zugewiesen werden.
Ein einzelner Glossareintrag enthält kein <title>-Element.
Im <glossterm>-Element wird der zu definierende Glossareintrag erfasst.
Die Definition beziehungsweise die Beschreibung des Glossareintrags wird im <glossdef>-Element vorgenommen.
Ein Glossar besteht in der Regel nicht nur aus einem einzigen Glossareintrag, sondern aus einer ganzen Anzahl. Das folgende Beispiel zeigt, wie mehrere Glossareinräge in einem Topic zusammengefasst werden können.
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Composite//EN" "../dtd/ditabase.dtd">
<topic id="gesammtes_glossar">
<title>Glossar</title>
<glossentry id="gloss_1">
<glossterm>HTML</glossterm>
<glossdef>Hypertext Markup Language</glossdef>
</glossentry>
<glossentry id="gloss_2">
<glossterm>SGML</glossterm>
<glossdef>Standard Generalized Markup Language
</glossdef>
</glossentry>
<glossentry id="gloss_3">
<glossterm>XML</glossterm>
<glossdef>eXtensible markup Language</glossdef>
</glossentry>
</topic>Copyright © 2008 XLcontent Verlag
Für Ihren privaten Gebrauch dürfen Sie die Online-Version ausdrucken.
Ansonsten unterliegt dieses Kapitel aus dem Buch "DITA - Der neue Standard für Technische Dokumentation" denselben Bestimmungen, wie die gebundene Ausgabe: Das Werk einschließlich aller seiner Teile ist urheberrechtlich geschützt. Alle Rechte vorbehalten einschließlich der Vervielfältigung, Übersetzung, Mikroverfilmung sowie Einspeicherung und Verarbeitung in elektronischen Systemen.
XLcontent Verlag, Pflegerstraße 40, 81247 München