Navigationskomponenten

Zu den Navigationskomponenten zählen Inhaltsverzeichnisse, Tabellen- Beispiel- Medienverzeichnisse und Stichwortverzeichnisse.

Inhaltsverzeichnisse

Inhaltsverzeichnisse werden automatisch eingefügt

Inhaltsverzeichnisse müssen in der Regel nicht separat erstellt werden, da Sie währen der Verarbeitung der Dokumente automatisch an den richtigen Stellen eingefügt werden. Sollten Sie dennoch an einer bestimmten Stelle ein Inhaltsverzeichnis wünschen, z.B. ein Inhaltsverzeichnis für eine ganz bestimmtes Kapitel, so kann man es mit toc (Table of Contents) einfügen.

Beispiel 2.5. Inhaltsverzeichnis für ein Kapitel

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<chapter>
  <title>Beispielkapitel</chapter>
  <toc />
  <section>
    <title>Abschnitt1</title>
    <para>
      Inhalt des ersten Abschnitts
    </para>
  </section>
  <section>
    <title>Abschnitt2</title>
    <para>
      Inhalt des zweiten Abschnitts
    </para>
  </section>
</chapter>

Ressourcenverzeichnisse

Ressourcenverzeichnisse werden in der Regel automatisch einfügt

Ressourcenverzeichnisse nenne ich die Abbildungsverzeichnisse, Tabellenverzeichnisse, Formellisten und Beispielverzeichnisse, die am Anfang dieses Buches erschienen. Sie werden alle mit dem Element lot (List of Tables) erzeugt, auch wenn es sich nicht nur auf Tabellen bezieht. In der Regel werden Ressourcenverzeichnisse automatisch erzeugt, aber es besteht auch die Möglichkeit, selbst ein Ressourcenverzeichnis anzulegen.

Achtung

Um ein lot selbst zu erstellen, müssen die Seitenzahlen bekannt sein.

Wenn Sie selbst ein Ressourcenverzeichnis anlegen müssen, können Sie ihm einen title geben und danach folgt im wesentlichen eine Auflistung der Einträge des Ressourcenverzeichnisses (lotentry). lotentry erwartet die Seitenzahl der jeweiligen Ressource als Wert des Attributs pagenum und der Textinhalt von lotentry sollte der Titel des Beispiels, der Tabelle oder der Abbildung sein.

Beispiel 2.6. Ein explizites Tabellenverzeichnis

<!DOCTYPE lot PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<lot><title>Tabellenverzeichnis</title>
<lotentry pagenum='5'>Die Postleitzahlbereiche der Bundesrepublik
  Deutschland</lotentry>
<lotentry pagenum='1025'>Die Zahlen von 1 bis 100 und ihre 
    Primfaktoren</lotentry>
<!-- ... -->
</lot>

Stichwortverzeichnisse

Stichwortverzeichnisse werden halbautomatisch erzeugt

Stichwortverzeichnisse werden in der Regel halbautomatisch vom Verarbeitungssystem erzeugt und müssen daher nicht komplett eingegeben werden. Es reicht in der Regel, an der gewünschten Stelle im Dokument das index-Element zu schreiben und die Punkte im Dokument zu markieren, die im Stichwortverzeichnis aufgeführt werden sollen.

Ein Stichwortverzeichnis kann einen title haben und nach dem Titel können noch einführende Erläuterungen aufgeführt werden, z.B. mit einer Reihe von Absätzen (para).

Beispiel 2.7. Ein Stichwortverzeichnis mit Einleitung

<!DOCTYPE index PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<index>
  <title>Stichwortverzeichnis</index>
  <para>Alles was Sie in diesem Verzeichnis nicht finden,
  muss noch geschrieben werden.</para>
</index>

Tipp

Markieren Sie entscheidende Punkte des Dokuments mit indexterm

Um einen Stichpunkt im Dokument für das Stichwortverzeichnis zu markieren, fügen Sie an der betreffenden Stelle das Element indexterm ein. In indexterm fügen sie für die primäre, sekundäre und tertiäre Stichwortebene die Elemente primary, secondary und tertiary ein, wobei nur primary vorhanden sein muss. Diese Elemente tragen als Inhalt das Wort oder die Wortgruppe, die im Stichwortverzeichnis erscheinen soll und der Eintrag verweist auf die Seite, an der indexterm steht. Wenn es mehrere Stellen im Dokument gibt, bei denen auf einen Stichpunkt Bezug genommen wird, markieren Sie die wichtigste, indem Sie das Attribut significance mit des indexterm dem Wert „preferred“ belegen.

Beispiel 2.8. Markieren von Stichworten

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<para>
Der Tiger<indexterm>
<primary>Großkatzen</primary>
<secondary>Tiger</secondary></indexterm>
ist eine wirklich große Katze.
</para>

Im Dokument sähe das folgendermaßen aus:

Der Tiger ist eine wirklich große Katze.

Markieren von Bereichen als Stichwortreferenz

Es ist außerdem möglich, einen ganzen Bereich des Dokuments als Sprungziel für den Index anzugeben. Dies erfolgt, indem am Beginn des interessanten Bereichs ein indexterm mit dem Attribut class=„startofrange“ gesetzt wird. Dann gibt man diesem indexterm eine eindeutige id (ebenfalls als Attribut) und fügt am Ende des interessanten Bereichs einen weiteren indexterm ein, wobei class hier den Wert „endofrange“ hat und ein Attribut startref (als Referenz auf den Beginn des Bereichs) mit dem Wert der id des ersten indexterm erscheinen muss.

Achtung

Die Konstruktion von indexterm erlaubt auch das Erstellen völlig unsinniger und nicht verarbeitbarer Referenzen. Dies sollte im Interesse der Lesbarkeit des Dokuments vermieden werden.

Die dritte Möglichkeit, Stichworte zu markieren kann verwendet werden, um mehrere über den Text verteilte Abschnitte als wichtig zu markieren. Voraussetzung dabei ist, dass in allen Elementen, auf die verwiesen werden soll, das Attribut id einen Wert hat, damit die Elemente eindeutig identifiziert werden können. Danach kann z.B. im bookinfo eines Buches, also völlig außerhalb des Textflusses der indexterm markiert werden, indem das Attribut zone als Wert eine durch Leerzeichen getrennte Liste der Element-IDs hat.