Bücher erstellen: die Bookmap
(Auszug aus "DITA - Der neue Standard für Technische Dokumentation" von Johannes Hentrich)
Um von einer Ansammlung von Topics zu einem kompletten Buch zu kommen, ist es ein weiter Weg. Neben dem eigentlichen Inhalt, der aus den Topictypen „Aufgabe“, „Referenz“ und „Konzept“ zusammengestellt sein kann und dem so genannten Buchblock zugeordnet wird, finden sich in einem Buch unter anderem noch folgende Komponenten:
- Titelei
- Widmungsseite
- Inhaltsverzeichnis
- Vorwort
- Anhänge
- Glossar
- Indexverzeichnis
Mit einer einfachen Map kann eine solche Struktur in DITA nicht wiedergegeben werden. Daher wurde mit DITA 1.1 eine Bookmap eingeführt, über die ein konventionelles Buch erstellt werden kann.
Komponenten eines Buches
Eine Bookmap wird über das <bookmap>-Element definiert. Innerhalb des <bookmap>-Elements werden die Komponenten eines Buchs in fünf Blöcke aufgeteilt. Für die Definition der Blöcke werden folgende Elemente verwendet:
- <booktitle>: Enthält sämtliche Informationen zum Titel des Buchs.
- <frontmatter>: Enthält weitere Informationen zur Titelei, dem Inhaltsverzeichnis und dem Vorwort.
- <part>, <chapter>, <topicref>: Diese Elemente definieren die Struktur des Buchblocks, das heißt die Anzahl der Buchteile, der Kapitel und der darin enthaltenen Topics.
- <appendix>: Referenziert einen möglichen Anhang im Buch.
- <backmatter>: Enthält weitere Listen und Verzeichnisse wie Indexverzeichnis, Glossar usw.
Damit sieht eine Bookmap in ihrer Struktur wie folgt aus:
<bookmap id="beispiel_struktur">
<booktitle></booktitle>
<frontmatter></frontmatter>
<part>
<chapter>
<topicref/>
...
</chapter>
</part>
<appendix></appendix>
<backmatter></backmatter>
</bookmap>Die Informationen in den einzelnen Blöcken werden durch weitere Elemente spezifiziert, die im Folgenden vorgestellt werden.
Das <booktitle>-Element enthält folgende Elemente:
- <booklibrary>: Im <booklibrary>-Element werden bibliothekarische Informationen abgelegt.
- <mainbooktitle>: Enthält den Titel des Buchs.
- <booktitlealt>: Enthält den Subtitel des Buchs.
Als Beispiel für die Verwendung der Elemente seien die Daten dieses Buchs verwendet:
<booktitle>
<booklibrary>Die Deutsche Bibliothek - CIP-Einheitsaufnahme...</booklibrary>
<mainbooktitle>DITA</mainbooktitle>
<booktitlealt>Der neue Standard für Technische Dokumentation </booktitlealt>
</booktitle>Das <frontmatter>-Element enthält folgende Elemente:
- <booklists>: Über das <booklists>-Element können Sie Verzeichnisse in ein Buch einbinden. Das <booklists>-Element können Sie sowohl im <frontmatter>-Element als auch im <backmatter>-Element, also am Ende des Buchs, verwenden. Wird das <booklists>-Element im <frontmatter>-Element verwendet, so wird darüber ein Inhaltsverzeichnis eingebunden. Das Inhaltsverzeichnis selbst wird mit dem <toc>-Element ausgezeichnet.Das <toc>-Element zeigt dem DITA Open Toolkit an, an welcher Stelle das automatisch generierte Inhaltsverzeichnis eingefügt werden soll. Somit wird ein Inhaltsverzeichnis wie folgt eingebunden:
<booklists>
<toc/>
</booklists>- <notices>: In diesem Element werden Informationen zum Verlag, Autor, Herausgeber, Copyright usw. referenziert, das heißt, das <notices>-Element referenziert die Informationen der Impressumseite. Weitere Seiten der Titelei, das heißt die zweite Seite (Frontispiz-Seite) und die dritte Seite (Titelblatt) können über das bekannte <topicref>-Element eingebunden werden. Ebenso wie beim <topicref>-Element werden beim <notices>-Element die Topics über das href-Attribut referenziert.
<notices href="impressum.dita"/> - <dedication>: Referenziert ein Topic mit einer Widmung, wie zum Beispiel:
<dedication href="widmung.dita"/> - <preface>: Referenziert ein Vorwort oder eine Einleitung für das Buch, wie zum Beispiel:
<preface href="vorwort.dita"/> - <bookabstract>: Referenziert eine kurze Zusammenfassung, die an den Anfang des Buchs gestellt wird, wie zum Beispiel
<bookabstract href="zusammenfassung.dita"/> Der Buchblock, in dem sich der eigentliche Inhalt des Buchs befindet, wird durch folgende Elemente strukturiert:
- <part>: Das <part>-Element ermöglicht die Unterteilung eines Buchs in mehrere Teile.
- <chapter>: Einzelne Kapitel werden mit dem <chapter>-Element abgegrenzt.
- <topicref>: Die einzelnen Topics innerhalb eines Kapitels werden mit dem bekannten <topicref>-Element referenziert.
Als Beispiel für einen Buchblock wird die Struktur dieses Buchs verwendet:
<topicref href="dita_im_uerblick.dita"/>
<part href="konzepte_hinter_dita.dita">
<chapter href="verwendung_bekannter_technologien.dita">
<topicref href="charles_darwin.dita"/>
<topicref href="zielsetzung.dita"/>
...
</chapter>
......
</part>
<part href="arbeiten_mit_dita.dita">
<chapter href="topics_erstellen.dita">
<topicref href="generisches_topic.dita">
...
</topicref>
...
</chapter>
</part>
...Für Anhänge im Buch steht das <appendix>-Element zur Verfügung. Innerhalb dieses Elements können über das <topicref>-Element weitere Topics referenziert werden, wie zum Beispiel:
<appendix href="anhang_a_dita_elemente.dita">
<topicref href="elemente_fuer_bookmaps.dita"/>
</appendix>Als letzter Block in einer Bookmap folgen die Elemente in dem <backmatter>-Element. Hier stehen folgende Elemente zur Verfügung:
- <booklists>: Ebenso wie beim <frontmatter>-Element können Sie hier Verzeichnisse und Listen einfügen, beispielsweise mit dem <glossarylist>-Element für ein Glossar und mit dem <indexlist>-Element für ein Stichwortverzeichnis. Sowohl das <glossarylist>-Element als auch das <indexlist>-Element zeigen dem DITA Open Toolkit an, wo die automatisch generierten Verzeichnisse im Buch platziert werden sollen. Somit werden ein Glossar und ein Stichwortverzeichnis wie folgt eingebunden:
<booklists>
<glossarylist/>
<indexlist/>
</booklists>- <colophon>: Ein <colophon>-Element referenziert ein Topic, in dem beschrieben wird, wie das Buch produziert wurde.
- <amendments>: Sollten Ergänzung notwendig sein, so können Sie diese über das <amendments>-Element referenzieren.
Setzt man die Elemente aller Blöcke zusammen, so erhält man eine vollständige Bookmap. Die Elemente, die die einzelnen Blöcke abgrenzen, sind in dem folgenden Beispiel fett ausgezeichnet.
<bookmap id="dita_buch">
<booktitle>
<booklibrary>Die Deutsche Bibliothek – CIP-Einheitsaufnahme...</booklibrary>
<mainbooktitle>DITA</mainbooktitle>
<booktitlealt>Der neue Standard für Technische Dokumentation</mainbooktitle>
</booktitle>
<frontmatter>
<notices href="impressum.dita"/>
<booklists>
<toc/>
</booklists>
<preface href="vorwort.dita"/>
</frontmatter>
<topicref href="dita_im_uerblick.dita"/>
<part href="konzepte_hinter_dita.dita">
<chapter href="verwendung_bekannter_technologien.dita">
<topicref href="charles_darwin.dita"/>
<topicref href="zielsetzung.dita"/>
</chapter>
</part>
<part href="arbeiten_mit_dita.dita">
<chapter href="topics_erstellen.dita">
<topicref href="generisches_topic.dita">
</topicref>
</chapter>
</part>
...
<appendix href="anhang_a_dita_elemente.dita">
<topicref href="elemente_fuer_bookmaps.dita"/>
</appendix>
<backmatter>
<booklists>
<glossarylist/>
<indexlist/>
</booklists>
</backmatter>
</bookmap>Meta-Daten für ein Buch
Neben den eigentlichen im Buch enthaltenen Informationen können Sie in DITA noch zahlreiche Meta-Daten zum Buch erfassen. Dies geschieht über das <bookmeta>-Element.
In der Struktur einer Bookmap ist das <bookmeta>-Element wie folgt platziert:
<bookmap id="beispiel_struktur">
<booktitle></booktitle>
<bookmeta><bookmeta/>
<frontmatter></frontmatter>
<part>
<chapter>
<topicref/>
......
</chapter>
</part>
<appendix></appendix>
<backmatter></backmatter>
</bookmap>Das <bookmeta>-Element enthält zahlreiche Elemente, von denen zu den wichtigsten die folgenden gehören:
- <bookid>: Das <bookid>-Element enthält Elemente, in denen Verlagsinformationen abgelegt sind. Zu diesen Elementen gehören:
- <isbn>: Enthält die ISBN-Nummer.
- <booknumber>: Enthält eine verlagsinterne Buchnummer.
- <maintainer>: Enthält Informationen darüber, wer das Buch pflegt. Dies kann entweder eine Person sein, gekennzeichnet durch das <person>-Element, oder eine Organisation, gekennzeichnet durch das <organization>-Element. - <bookrights>: Das <bookrights>-Element enthält weitere Elemente, in denen Informationen zum Copyright abgelegt sind. Zu diesen Elementen gehören:
- <copyrfirst>: Enthält die erste Jahreszahl innerhalb eines <year>-Elements, wenn ein Bereich von Copyright-Jahreszahlen angegeben wird. Soll nur eine Jahreszahl angegeben werden, so wird dazu das <copyrfirst>-Element verwendet.
- <copyrlast>: Enthält die letzte Jahreszahl innerhalb eines <year>-Elements, wenn ein Bereich von Copyright-Jahreszahlen angegeben wird.
- <bookowner>: Enthält Informationen darüber, wem das Copyright gehört.
Das folgende Beispiel zeigt, wie die einzelnen Elemente für dieses Buch verwendet werden:
<bookmeta>
<bookid>
<isbn>978-3981143003</isbn>
<booknumber>XL-1</booknumber>
<maintainer>
<organization>XLcontent Verlag</organization>
<person>Johannes Hentrich</person>
</maintainer>
</bookid>
<bookrights>
<copyrfirst>
<year>2008</year>
</copyrfirst>
<bookowner>
<organization>XLcontent Verlag</organization>
</bookowner>
</bookrights>
</bookmeta>Die Informationen über den Autor werden im <authorinformation>-Element abgespeichert, welches der xNAL-Domain zugehört. Die xNAL-Domain gehört seit der Version 1.1 zu DITA und bietet zahlreiche Elemente zur Erfassung von Adressinformationen. Innerhalb des <authorinformation>-Elements wird das <personinfo>-Element dazu benutzt, die Personendaten zu erfassen. Unter anderem werden dazu folgende Elemente verwendet:
- <namedetails>: Das <namedetails>-Element ist weiter verschachtelt, wobei innerhalb des <personame>-Elements Daten zum Autor erfasset werden, wie der Vorname im <firstname>-Element und der Nachname im <lastname>-Element.
- <addressdetails>: Auch das <addressdetails>-Element enthält weitere Informationen zur Adressee. Im <thoroughfare>-Element werden Informationen zur Straße abgelegt. Im <locality>-Element wird im <localityname>-Element der Stadtname und im <postalcode>-Element die Postleitzahl hinterlegt. Im <country>-Element schließlich befindet sich der Ländername.
- <contactnumbers>: Enthält Telefonnummern, wobei eine einzelne Telefonnummer im <contactnumber>-Element abgespeichert wird.
- <emailaddresses>: Enthält E-Mail-Adressen, wobei eine einzelne E-Mail-Adresse im <emailaddress>-Element abgespeichert wird.
Weitere Informationen zu den Elementen der xNAL-Domain erhalten Sie im Abschnitt „xNAL-Domain“.
Das folgende Beispiel zeigt, wie die einzelnen Elemente für dieses Buch verwendet werden:
<authorinformation>
<personinfo>
<namedetails>
<personname>
<firstname>Johannes</firstname>
<lastname>Hentrich</lastname>
</personname>
</namedetails>
<addressdetails>
<thoroughfare>Pflegerstraße 40</thoroughfare>
<locality>
<localityname>München</localityname>
<postalcode>81247</postalcode>
</locality>
<country>Deutschland</country>
</addressdetails>
<contactnumbers>
<contactnumber>++49 89 89161590</contactnumber>
</contactnumbers>
<emailaddresses>
<emailaddress>info@xlcontentverlag.de</emailaddress>
</emailaddresses>
</personinfo>
</authorinformation>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