Anmerkungen

Die verschiedenen Anmerkungen haben unterschiedliche Dringlichkeiten

Anmerkungen sind vom Fließtext abgesetzte Kommentare, die sich zwar auf diesen beziehen, doch einer besonderen Hervorhebung bedürfen. DocBook unterscheidet fünf Varianten von Anmerkungen. Die am wenigsten Eindringliche ist die Notiz (note), es folgt Tipp (tip), eine wichtige Anmerkung (important), ein Achtungshinweis (caution) und die Warnung (warning).

Diese fünf Anmerkungstypen sind sich sehr ähnlich, deshalb wird hier nicht getrennt auf Sie eingegangen. Jede Anmerkung kann einen Titel (title) enthalten und mindestens einen, aber auch mehr, Absätze oder andere Blockelemente. Manche Verarbeitungssysteme unterstützen es, Anmerkungen mit kleinen Symbolen zu versehen.

Beispiel 2.21. Verschiedene Beispiele für Anmerkungen

In den folgenden Beispielen folgt auf den Code jeweils die Repräsentation im Dokument.

<!DOCTYPE note PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<note><title>Wussten Sie schon?</title>
<para>
Wussten Sie schon, dass XML-Tags immer geschlossen werden müssen?
</para>
</note>

Wußten Sie schon?

Wußten Sie schon, dass XML-Tags immer geschlossen werden müssen.

<!DOCTYPE tip PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<tip><title>Besseres XML schreiben</title>
<para>
Wenn Sie XML-Tags immer fleißig schließen, wird ihr Dokument
wohlgeformt sein.
</para>
</tip>

Besseres XML schreiben

Wenn Sie XML-Tags immer fleißig schließen, wird ihr Dokument wohlgeformt sein.

<!DOCTYPE important PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<important><title>Nicht vergessen:</title>
<para>
Vergessen Sie nicht, alle XML-Tags zu schließen, sonst wird sich der
XML-Parser beschweren.
</para>
</important>

Nicht vergessen:

Vergessen Sie nicht, alle XML-Tags zu schließen, sonst wird sich der XML-Parser beschweren.

<!DOCTYPE caution PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<caution><title>Problemquelle</title>
<para>
Das Nicht-Schließen von XML-Tags kann eine echte Problemquelle für die
Validität Ihres XML-Dokuments sein.
</para>
</caution>

Problemquelle

Das Nicht-Schließen von XML-Tags kann eine echte Problemquelle für die Validität Ihres XML-Dokuments sein.

<!DOCTYPE warning PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<warning><title>Validität in Gefahr</title>
<para>
Die Validität Ihres XML-Dokuments ist in akuter Gefahr. Schließen Sie 
umgehend alle XML-Tags oder der XML-Parser wird nicht in der Lage sein,
Ihr Dokument auszuwerten.
</para>
</warning>

Validität in Gefahr

Die Validität Ihres XML-Dokuments ist in akuter Gefahr. Schließen Sie umgehend alle XML-Tags oder der XML-Parser wird nicht in der Lage sein, Ihr Dokument auszuwerten.