Inhaltsverzeichnis
application
Programmnamecallout
Annotationenfigure
Grafikeinbindungfootnote
Fußnoteglossary
Glossarindexterm
Indexeintrag inlinemediaobject
Grafikeinbindung (inline)itemizedlist
Ungeordnete Listekeycap/keysym
Tastensymbolelink
Allgemeiner Linkmenuchoice
Menüstrukturen note
Anmerkungenorderedlist
Geordnete Liste table
Tabellentip
Tippstrademark
Produktnameulink
Externer Linkwarning
Warnungenxref
Interner LinkDocBook-Elemente: Übersicht
Dieser Anhang stellt einige der gebräuchlichsten DocBook-Elemente vor.
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
section
s.
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.
Typografisches [2] .
Für kursiv gesetzten Text kann <emphasis>...</emphasis> verwendet werden.
Ausgabebeispiel: Dieser Text ist <emphasis>.
Für Text in Fettdruck kann <emphasis role="strong"> ...</emphasis> verwendet werden.
Ausgabebeispiel: Dieser Text ist fett gedruckt..
Für Text in dicktengleicher Schrift bzw. Monospace-Schriften können, je nach inhaltlicher Anforderung, unterschiedliche Elemente verwendet werden. Beispielsweise:
<literal>...</literal>
<computeroutput>...</computeroutput>
<filename>...</filename>
<code>...</code>
<programlisting>...</programlisting>
Ein DocBook-Dokument enthält ausschließlich inhaltliches Markup und kein Markup zur Präsentation. Zeilen- und Seitenumbrüche werden daher im Stylesheet für das jeweilige Ausgabemedium berechnet. Zeilen- oder Seitenumbrüche können jedoch erzwungen werden:
<?linebreak?>
<?hard-pagebreak?>
Links. Für Verlinkungen in einem Docbook-Dokument stehen drei Möglichekiten zur Verfügung:
Für die Verlinkung auf andere Bereiche im selben Dokument ist der Zielbereich mit einer id
zu identifizeren.
ID
sMit einer id
kann ein eindeutiger Identifizierer innerhalb eines Dokument für ein Element vergeben werden. Über Links wie link
oder xref
können diese identifizierbaren Elemente angesprungen werden. Im Folgenden ein Quelltext-Beispiel:
Beispiel A.1. ID
-Vergabe/Verlinkung von Elementen
<section id="anker"> <title>Beispieltitel</title> <para>Nullam consequat. Phasellus iaculis.</para> <para> Nam accumsan tincidunt elit. Suspendisse rutrum luctus nisi. Siehe auch <link linkend="anker">Linkziel</link>.</para> </section>
Zusammenfassung
Programnamen können mit den entsprechenden DocBook-Elementen ausgezeichnet werden.
[2] DocBook dient der inhaltlichen Auszeichnung des Textes und nicht der Formatierung. Daher kommen diese typographischen Elemente nur dort zum Einsatz, wo es inhaltlich erforderlich ist - beispielsweise um Begrifflichkeiten oder Vorgänge zu betonen.