Anhang A. DocBook-Elemente

Inhaltsverzeichnis

Kommentare
Menüstrukturen menuchoice
Programmname application und Produktname trademark
Glossar
callout
Fußnoten footnote
Indexterm indexterm
Abbildung figure
Einbindung via figure
Einbindung via figure mit Untertitel (caption)
Einbindung via screenshot
Abbildung inlinemediaobject
Links
IDs
xref
link
ulink
Geordnete Liste orderedlist
Ungeordnete Liste itemizedlist
Warnungen warning
Tipps tip
Anmerkungen note
Tabellen table

Dieser Anhang stellt einige der gebräuchlichsten DocBook-Elemente sowie der Eingabe mit Serna Free und im Quelltext vor.

Die im Folgenden aufgelisteten DocBook-Tags werden bisher in den DEMO-Dokumentationen verwendet und für diese Tags sind entsprechende Stylesheetangaben für die unterschiedlichen Ausgabeformat hinterlegt. Werden DocBook-Tags verwendet, für die noch keine Stylesheetangaben festgelegt sind, so erscheinen - bzw. dessen Inhalte - in den Ausgabeformaten in einer Standardformatierung. Es handelt sich um eine Auswahl der wichtigsten Tags:

  • book - Definiert ein Buch; hier: ein Dokument.

  • preface - Ein Vorwort. Kann nur direkt für den book-Tag verwendet werden.

  • chapter - Ein Kapitel. Kapitel können nicht verschachtelt werden. Sollen Kapitel weiter untergliedert werden, so geschieht dies durch eine oder mehrere sections.

  • section - Eine Unterteilung eines Kapitels.

  • title - Ein Titel. Titel sind u.a. für chapter und section sowie Abbildungen, Tabellen etc. notwendig. Diese Titel erscheinen ebenfalls in den generierten Verzeichnissen.

  • para - Ein Absatz. Der Standard-Tag für Fließtext.

  • itemizedlist - Eine ungeordnete (Bullet-)Liste.

  • orderedlist - Eine geordnete (standardmäßig durchnummerierte) Liste.

  • figure, screenshot, figure(screenshot) - Abbildungen, Fotos, Screenshots u.ä. Siehe unten.

  • table - Eine Tabelle. Siehe unten.

  • keycap, keysym - Eine Taste.

  • keycombo - Eine Tastenkombination, bestehend aus Tasten im keycap Tag.

  • ulink - Ein externer Link. Siehe unten.

  • xref, link - Ein interner Link. Siehe unten.

Kommentare

Kommentare im Sinne von XML-Kommentaren erscheinen nicht in den Ausgabeformaten.

Anmerkung

Kommentare im DocBook-Quelltext sind für die Zusammenarbeit mit anderen Redakteuren sowie für eigene Notizen im Dokument sinnvoll und zur Kommentierung wird ausdrücklich aufgerufen. Auf Quelltext-Ebene wird ein Kommentar in XML-Syntax (<!-- Kommentar /--> eingegeben.