docbook Kurzreferenz

Das docbook file ist vom Typ .xml und kann mit jedem beliebigen Texteditor geöffnet und bearbeitet werden.

Einzelne Abschnitte werden durch Sektionen gekennzeichnet: Möglichkeiten hierfür: <section>...</section> (implizit) oder <sect1>...</sect1> bis <sect5>...</sect5> (explizit)

Eine schöne Tabellenform stellt <informaltable>dar. Die Ausgabe erfolgt sowohl bei .pdf wie auch bei .html in einer umrandetet Tabelle mit Zeilen und Spalten.

		
			<para>		
			<informaltable>
			<tgroup cols="2">

				<thead>
					<row>
					<entry>Version</entry>
					<entry>Datum</entry>
				</thead>
				
				<tbody>
					<row>
					<entry>1.0</entry>
					<entry>15.06.2007</entry>
					</row>
				</tbody>
			</tgroup>
			</informaltable>
			</para>
		
		

Die Struktur einer einfachen DNS-Tabelle ist fast gleich wie die der Informaltable, der Unterschied liegt in der Ausgabe: In .pdf werden zwar die Zeilen und Spalten dargestellt, eine Umrandung jedoch fehlt. In .html werden gar keine Linien und Umrandungen dargestellt, die Formatierung jedoch bleibt erhalten.

Ein Vorteil der einfachen DNS-Tabelle ist die Möglichkeit, ihr einen Namen bzw. Titel zuzuweisen, der dann am Dokumentenanfang ähnlich einer Inhaltsangabe angegeben wird (List of Tables).

		
			<table frame="none">
				<title>DNS-Tabelle</title>
				<tgroup>
					<thead>
						...
					</thead>
					<tbody>
						...
					</tbody>
				</tgroup>
			</table>
		
		

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.

		
			<itemizedlist>
				<title>...</title>
				
				<listitem>
				<para>Beschreibung></para>
					<itemizedlist>
						<listitem>
						<para>Text</para>
						</listitem>
					</itemizedlist>
				</listitem>
			</itemizedlist>
		
		

Geordnete Listen können 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”.

		
			<orderedlist numeration="upperroman">
				<title>Überschrift</title>
					
				<listitem>
					<para>Inhalt A</para>
				</listitem>
				<listitem>
					<para>Inhalt B</para>
				</listitem>
			</orderedlist>
		
		

Da diese beiden Listenarten in unserem Benutzerhandbuch nicht verwendet werden, verweisen wir an dieser Stelle nur auf die entsprechenden Elemente <segmentedlist> und <variablelist>.