Listen

Es gibt fünf verschiedene Listentypen

In DocBook werden mehrere Arten von Listen unterschieden: Angestrichene Listen, bei denen jeder Eintrag einen Punkt oder Anstrich hat, geordnete Listen, bei denen jedem Listeneintrag eine Nummerierung vergeben wird, unterteilte Listen, bei denen jeder Listeneintrag ein Datensatz darstellt und Listen, in denen Variablen erklärt werden.

simplelist ist eine Aufzählung.

Eine Besonderheit stellt die simplelist dar. Sie ist eigentlich kein Blockelement, sondern wird für Aufzählungen verwendet. Sie kann daher in der Zeile erscheinen, oder nach Zeilen oder Spalten sortiert. Für dieses Element sind zwei Attribute interessant: type gibt an, wie die Liste dargestellt werden soll, wobei der Wert „inline“ bedeutet, dass die Einträge durch Kommata getrennt als Aufzählung dargestellt werden, „horiz“ bedeutet, dass die Werte von oben nach unten aufgelistet werden und „vert,“ dass sie von links nach rechts gelistet werden. Wenn type den Wert „horiz“ oder „vert“ hat, so gibt das Attribut columns an, wie viele Spalten die Auflistung haben soll.

Die einzelne Punkte der Aufzählung werden in das Element member gefasst.

Beispiel 2.16. Einfache Listen in allen Variationen

Die folgenden Beispiele listen die Zahlen von eins bis zehn auf. Nach dem Sourcecode folgt sofort die Darstellung im Dokument.

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<para>
Das ist eine einfache Aufzählung im Textfluss: 
<simplelist type='inline'>
<member>eins</member>
<member>zwei</member>
<member>drei</member>
<member>vier</member>
<member>fünf</member>
<member>sechs</member>
<member>sieben</member>
<member>acht</member>
<member>neun</member>
<member>zehn</member>
</simplelist>
</para>

Das ist eine einfache Aufzählung im Textfluss: eins, zwei, drei, vier, fünf, sechs, sieben, acht, neun, zehn

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<para>
Das ist eine einfache vertikale Aufzählung : 
<simplelist type='vert' columns="3">
<member>eins</member>
<member>zwei</member>
<member>drei</member>
<member>vier</member>
<member>fünf</member>
<member>sechs</member>
<member>sieben</member>
<member>acht</member>
<member>neun</member>
<member>zehn</member>
</simplelist>
</para>

Das ist eine einfache Aufzählung im Textfluss:

einsfünfneun
zweisechszehn
dreisieben 
vieracht 
<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<para>
Das ist eine einfache horizontale Aufzählung : 
<simplelist type='horiz' columns="3">
<member>eins</member>
<member>zwei</member>
<member>drei</member>
<member>vier</member>
<member>fünf</member>
<member>sechs</member>
<member>sieben</member>
<member>acht</member>
<member>neun</member>
<member>zehn</member>
</simplelist>
</para>

Das ist eine einfache Aufzählung im Textfluss:

einszweidrei
vierfünfsechs
siebenachtneun
zehn  

Angestrichene Listen

Angestrichene Listen, also Listen, bei denen vor jedem Eintrag eine Dekoration in Form eines Punktes oder eines Anstriches erfolgt, werden mit dem Element itemizedlist erstellt. Eine itemizedlist kann einen Titel haben, danach muss aber mindestens ein Listeneintrag in Form des listitem-Elements folgen. Der Inhalt des listitem wird in den meisten Fällen ein Absatz sein, es kann aber fast jedes andere Blockelement eingefügt werden, insbesondere andere Listen, wenn eine Mehrfachschachtelung erwünscht ist.

Angestrichene Listen können unterschiedlich formatiert werden

Sie können das Erscheinungsbild der Liste mit den Attributen mark und spacing beeinflussen. Der Wert des Attributs mark soll beschreiben, welche Dekoration für die Listenpunkte verwendet werden soll, daher ist es wichtig zu wissen, welche Werte das Verarbeitungssystem hier unterstützt. Wenn Sie den Wert von spacing auf „compact“ setzen, wird das Verarbeitungssystem angewiesen, den Freiraum zwischen den einzelnen listitem zu minimieren.

Beispiel 2.17. Angestrichene Liste

<!DOCTYPE itemizedlist PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<itemizedlist>
<title>Fakultäten der Universität Potsdam</title>
<listitem>
<para>
Juristische Fakultät
</para>
</listitem>
<listitem>
<para>
Philosophische Fakultät
</para>
</listitem>
<listitem>
<para>
Humanwissenschaftliche Fakultät
</para>
</listitem>
<listitem>
<para>
Wirtschafts- und Sozialwissenschaftliche Fakultät
</para>
</listitem>
<listitem>
<para>
Mathematisch-Naturwissenschaftliche Fakultät
</para>
</listitem>
</itemizedlist>

Und die entsprechende Umsetzung im Dokument sähe folgendermaßen aus:

Fakultäten der Universität Potsdam

  • Juristische Fakultät

  • Philosophische Fakultät

  • Humanwissenschaftliche Fakultät

  • Wirtschafts- und Sozialwissenschaftliche Fakultät

  • Mathematisch-Naturwissenschaftliche Fakultät

Geordnete Listen

Geordnete Listen unterstützen verschiedene Nummerierungstypen

Geordnete Listen sind den angestrichenen Listen sehr ähnlich. Sie werden mit dem Element orderedlist erstellt und haben das gleiche Inhaltsmodell wie itemizedlist, sie können also title und listitem enthalten. Außer dem schon bekannten Attribut spacing können geordnete Listen noch das Attribut numeration tragen, welches bestimmt, wie die Nummerierung zu erfolgen hat, in Arabischen Ziffern („arabic“), in Kleinbuchstaben („loweralpha“), in Großbuchstaben („upperalpha“) oder in Römischen Zahlen, die ihrerseits in Großbuchstaben („upperroman“) oder Kleinbuchstaben („lowerroman“) geschrieben werden können.

Wenn mehrere geordnete Listen aufeinander folgen, oder ineinander geschachtelt sind, stellt sich die Frage, ob die Nummerierung fortgesetzt werden soll, dann muss das Attribut continuation auf „continues“ gesetzt werden und wenn bei geschachtelten Listen die vorherige Nummerierung weitergegeben werden soll, so setzt man das Attribut inheritnum auf „inherit“.

Beispiel 2.18. Geordnete Liste

<!DOCTYPE orderedlist PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<orderedlist numeration="upperroman">
<title>Fakultäten der Universität Potsdam</title>
<listitem>
<para>
Juristische Fakultät
</para>
</listitem>
<listitem>
<para>
Philosophische Fakultät
</para>
</listitem>
<listitem>
<para>
Humanwissenschaftliche Fakultät
</para>
</listitem>
<listitem>
<para>
Wirtschafts- und Sozialwissenschaftliche Fakultät
</para>
</listitem>
<listitem>
<para>
Mathematisch-Naturwissenschaftliche Fakultät
</para>
</listitem>
</orderedlist>

Und die entsprechende Umsetzung im Dokument sähe folgendermaßen aus:

Fakultäten der Universität Potsdam

  1. Juristische Fakultät

  2. Philosophische Fakultät

  3. Humanwissenschaftliche Fakultät

  4. Wirtschafts- und Sozialwissenschaftliche Fakultät

  5. Mathematisch-Naturwissenschaftliche Fakultät

Unterteilte Listen

Unterteilte Listen (segmentedlist) weisen jedem Punkt der Liste mehrere Einträge zu. Deshalb folgt nach einem optionalen title die Definition der Unterpunkte, die jeder Listenpunkt haben soll mittels segtitle. Die einzelnen Listenpunkte bestehen aus seglistitems und so vielen seg, wie segtitle definiert wurden. Da dies nicht wirklich anschaulich ist, soll gleich ein Beispiel helfen, den Sachverhalt zu klären.

Beispiel 2.19. Die Beneluxländer als unterteilte Liste

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<para>
Was sind eigentlich die Benelux-Länder? Diese Liste soll
Klarheit verschaffen.

<segmentedlist><title>Die Benelux-Staaten</title>
<segtitle>Staat</segtitle>
<segtitle>Hauptstadt</segtitle>
<seglistitem><seg>Luxemburg</seg><seg>Luxemburg</seg></seglistitem>
<seglistitem><seg>Niederlande</seg><seg>Amsterdam</seg></seglistitem>
<seglistitem><seg>Belgien</seg><seg>Brüssel</seg></seglistitem>
</segmentedlist>
</para>

Und im Dokument würde dieser Ausschnitt so erscheinen:

Was sind eigentlich die Beneluxländer? Diese Liste soll Klarheit verschaffen.

Staat: Luxemburg

Hauptstadt: Luxemburg

Staat: Niederlande

Hauptstadt: Amsterdam

Staat: Belgien

Hauptstadt: Brüssel

Variablenlisten

Variablenlisten sind gut geeignet für Definitionen

Variablenlisten ordnen einer Variable, z.B. einer Abkürzung oder einem Fremdwort einen Wert, z.B. die ausgeschriebene Bezeichnung oder die Erklärung zu. Variablenlisten lassen sich mit variablelist erstellen und mit varlistentry lassen sich die einzelnen Einträge erstellen. Im Element varlistentry erscheinen die Elemente term für das zu definierende Wort und listitem für die Erklärung. Es kann für eine Erklärung mehrere term geben.

Beispiel 2.20. Variablenliste

<!DOCTYPE variablelist PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<variablelist><title>zwei neue Fremdwörter</title>
<varlistentry>
<term>mefitisch</term>
<listitem>
<para>
zu Schwefelquellen gehörend,
daraus stammend, stinkend</para>
</listitem>
</varlistentry>
<varlistentry><term>Popelin</term>
              <term>Popeline</term>
<listitem>
<para>
fester Baumwollstoff für Hemden, Mäntel und ähnliches.
</para>
</listitem>
</varlistentry>
</variablelist>

Es folgt die Darstellung des Beispielcodes im Dokument:

mefitisch

zu Schwefelquellen gehörend, daraus stammend, stinkend

Popelin, Popeline

fester Baumwollstoff für Hemden, Mäntel und ähnliches.