Erste Schritte

Dieser Artikel listet wichtige DocBook-Elemente auf. Eine Übersicht aller Elemente finden sich im "DocBook: The Definitive Guide".

Bezeichner

<wordasword>Bezeichner</wordasword>

Ergebnis: Bezeichner

<emphasis role="bold">Bezeichner</emphasis>

Ergebnis: Bezeichner

Bezüge

<xref linkend="bild.png" />

Ergebnis: Abbildung 2.3, „Bildtitel“ (ist beim Ziel xreflabel gesetzt, wird dieser Wert als Text verwendet)

Bilder

Ein Bild mit Titel und Eintrag im Abbildungsverzeichnis:

<figure id="bild.png">
   <title>Bildtitel</title>
   <mediaobject>
      <imageobject>
         <imagedata fileref="images/p3/bild.png" format="PNG" />
      </imageobject>
   </mediaobject>
</figure>

Eine Grafik innerhalb von Text ohne Titel und Eintrag im Verzeichnis:

<inlinegraphic fileref="images/BILD.png" align="left" 
format="PNG" />

Buch

<?xml version="1.0"?>
<!DOCTYPE book SYSTEM "file:/C:/docbook/4.3/docbookx.dtd">
<book lang="de">
   <title>Beispiel-Buch</title>	
   <bookinfo>
      <author>
         <firstname>Karl</firstname>
         <surname>Mustermann</surname>
         <email>karl@mustermann.de</email>
      </author>
   </bookinfo>
   <chapter>
      <title>Kapitel 1</title>
      <section>
         <title>Abschnitt 1</title>
         <para>Und der Text von Abschnitt 1.</para>
      </section>
   </chapter>
</book>

Fußnoten

<footnote><para>Text</para></footnote>

…wird direkt im Fließtext eingefügt.

Glossar

<glossary>
   <title>Titel</title>
   <para>Text</para>
   <glossdiv>
      <title>A</title>
      <glossentry>
         <glossterm>Anton</glossterm>
         <glossdef>
            <para>Beschreibung</para>
         </glossdef>
      </glossentry>
   </glossdiv>
</glossary>

GUI-Elemente

Menüstrukturen:

<menuchoice>
   <guimenu>Bearbeiten</guimenu>
   <guimenuitem>Kopieren</guimenuitem>
</menuchoice>

Schaltflächen:

<guibutton>Enter</guibutton>

Icons:

<guiicon>
   <inlinegraphic fileref="images/bild.png"/>
</guiicon>

Beschriftungen:

<guilabel>Beschriftung</guilabel>

Include

<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="datei.xml" 
      parse="text">
   <xi:fallback>datei.xml</xi:fallback>
</xi:include>

…das Attribut parse legt fest, ob der eingelesene Textabschnitt (der Inhalt der Datei datei.xml) als DocBook-Quellcode verarbeitet werden soll. Der Wert text im Beispiel besagt, das dies nicht geschehen soll und veranlasst den Parser das Ausgangsmaterial entsprechend zu konvertieren.

Indexseiten-Einträge

<indexterm significance="preferred">
   <primary>Klassen</primary>
   <secondary>HistoryEntry</secondary>
</indexterm>

Listen

Eine einfache Aufzählung:

<itemizedlist>
   <listitem>
      <para>Text</para>
   </listitem>
</itemizedlist>

…mit Nummerierung:

<orderedlist>
   <listitem>
      <para>Text</para>
   </listitem>
</orderedlist>

Eine Variablenliste:

<variablelist>
   <title>Titel</title>
   <varlistentry>
      <term>Option A</term>
      <listitem>
         <para>Text</para>
      </listitem>
   </varlistentry>
</variablelist>

Programmabschnitte

<programlisting linenumbering="numbered"><![CDATA[private void setData() {
   return null;
}]]></programlisting>

Der Teil zwischen <![CDATA[ und ]]> kommt „so wie geschrieben“ in der Ausgabe an. Jeder Zeilenumbruch und jedes Leerzeichen wirken sich auf das Ergebnis aus. Des weiteren müssen keine Zeichen auskommentiert werden, so das beispielsweise auch Xml-Code direkt ausgegeben werden kann.

Möchte man die Zeilen kommentieren besteht folgende Möglichkeit. Zuerst definiert man die Zeilen, um diese dann in der calloutlist zu beschreiben.

<programlistingco>
   <areaspec>
      <area id="zeile1" coords='1'/>
      <area id="zeile3" coords='3'/>
   </areaspec>

   <programlisting><![CDATA[private void setData() {
   return null;
}]]></programlisting>

   <calloutlist>
      <callout arearefs="zeile1">
         <para>Text</para>
      </callout>
      <callout arearefs="zeile3">
         <para>Text</para>
      </callout>
   </calloutlist>
</programlistingco>

Tabellen

<table>		
   <title></title>		
   <tgroup cols="3" align="left" colsep="1" rowsep="1">			
      <thead>			
         <row>
            <entry></entry>
            <entry></entry>
            <entry></entry>
         </row>			
      </thead>		
      <tbody>			
         <row>
            <entry></entry>
            <entry></entry>
            <entry></entry>
         </row>
      </tbody>
   </tgroup>
</table>