Blockanmerkungen einfügen
(Auszug aus "DocBook-XML: Medienneutrales und plattformunabhängiges Publizieren" von Thomas Schraitle)
Das Element annotation wird verwendet, um einem Element umfangreiche Anmerkungen anzufügen. Blockanmerkungen lassen sich in einem Dokument an beliebiger Stelle platzieren und dürfen im Gegensatz zu Inlineanmerkungen fast alle Block-Elemente von DocBook enthalten. Eine einfache Blockanmerkung besitzt folgenden Aufbau (siehe folgendes Beispiel):
Beispiel: Eine einfache Blockanmerkung
<annotation>
<title>XML-Namensraum</title>
<para>...</para>
</annotation>Um einem Element eine Blockanmerkung anzufügen, gibt es zwei Auszeichnungsmethoden:
- Das Start-Tag <annotation> enthält ein Attribut xml:id. Das entsprechende Element, das die Blockanmerkung enthalten soll, fügt ein Attribut annotates ein. Der Wert von annotates zeigt auf das Attribut xml:id.
- Das Start-Tag <annotation> enthält ein Attribut annotates. Das entsprechende Element, das die Blockanmerkung enthalten soll, benötigt das Attribut xml:id.
Bei der Methode 1 enthält die Anmerkung einen Anker (siehe folgendes Beispiel).
Beispiel: Anker im Start-Tag annotation
<annotation xml:id="an_db">
<title>DocBook</title>
<para>DocBook 5, jetzt neu! Zu finden unter <link xlink:href="http://www.docbook.org"/></para>
</annotation>
<!-- ... -->
<para>Für Dokumentationen wird <phrase annotations="an_db">DocBook</phrase> verwendet, das ...</para>Bei der Methode 2 enthält das entsprechende Element den Anker. Die Anmerkung muss sozusagen selbst wissen, worauf sie sich beziehen möchte (siehe folgendes Beispiel).
Beispiel: Anker im Start-Tag des zu referenzierenden Elements
<annotation annotates="p_db">
<title>DocBook</title>
<para>DocBook 5, jetzt neu! Zu finden unter <link xlink:href="http://www.docbook.org"/></para>
</annotation>
<!-- ... -->
<para>Für Dokumentationen wird <phrase xml:id="p_db">DocBook</phrase> verwendet, das ...</para>Beide obigen Beispiele führen zum gleichen Ergebnis. Wenn auf das entsprechende Bild nach dem Wort DocBook geklickt wird, öffnet sich die Anmerkung (siehe folgende Abbildung).
Abbildung: Geöffnete Anmerkung in (X)HTML
Der Unterschied zwischen beiden Methoden ist, dass eine Anmerkung mit einem Anker sich mehrmals verwenden lässt. Für gewöhnlich ist Methode 1 (Anmerkung mit Anker) die flexibelste.
Hinweis: Mehrfache Anmerkungen
Soll ein Element mehr als eine Anmerkung erhalten, fügen Sie die entsprechenden Ankerwerte im Attribut annotates ein. Dieses Attribut erlaubt mehr als einen Verweis. Trennen Sie die Ankerwerte durch Leerzeichen:
<phrase annotates="annot_1 annot_2">...</phrase>
| << zurück | vor >> |
Copyright © 2009 Millin Verlag
Für Ihren privaten Gebrauch dürfen Sie die Online-Version ausdrucken.
Ansonsten unterliegt dieses Kapitel aus dem Buch "DocBook-XML: Medienneutrales und plattformunabhängiges Publizieren" 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.
Millin Verlag, Siebengebirgsring 36, 53797 Lohmar, info(at)millin.de