Allgemeine Attribute

(Auszug aus "DocBook-XML: Medienneutrales und plattformunabhängiges Publizieren" von Thomas Schraitle)

DocBook stellt Attribute bereit, die in jedem Element verfügbar sind und in der folgenden Liste aufgeführt werden. Für gewöhnlich sind die Attribute optional. In manchen Elementen werden einige davon jedoch erwartet.

Die Attribute enthalten weitere Informationen zu einem Element wie Sprache, Zielgruppe, Sicherheit, Schwierigkeitsgrad und andere. Dadurch kann ein Element zusätzlich durch diese Attribute von einem anderen, gleichnamigen Element unterschieden werden. Dies ist manchmal praktisch, wenn Sie bestimmte Abschnitte nach Schwierigkeitsgrad filtern, oder Sie eine Übersicht über alle englischsprachigen Zitate in Ihrem Dokument erstellen möchten.

Allgemeine Attribute für alle DocBook-Elemente der Version 4 und 5

arch (Architektur)

spezifiziert die Chip- oder Computerarchitektur eines Elements, wie i386, x86_64 usw.

audience (Zielgruppe)

spezifiziert die vorgesehene Zielgruppe wie Programmierer, Systemadministrator oder Anfänger.

condition (Bedingung)

Eingeführt zur Version 4.0, wird es als "Allzweck-Attribut" verwendet und enthält anwendungsspezifische Bedingungen.

conformance (Konformität)

bezeichnet einen Standard (ISO, IETF, DIN usw.) dem das Zielelement des Attributs entspricht; wird nicht sehr häufig verwendet.

dir (Schreibrichtung)

markiert die Schreibrichtung, die sich gegebenenfalls überschreiben lässt. Dieses Attribut ist erst ab einschließlich DocBook V4.3 verfügbar. Für gewöhnlich wird dieses Attribut selten benötigt und nur verwendet, wenn Ihr Publishing-System die Schreibrichtung nicht selbst aus dem Unicode-Zeichen ermitteln kann.

id (Anker, Markierung, Kennung)

markiert ein Element, um darauf verweisen zu können. Dieses Attribut ist nur für DocBook 4 und früher verfügbar. In DocBook 5 wird id durch xml:id ersetzt. Die meisten Elemente benötigen dieses Attribut nicht, jedoch gibt es einige wenige, für die es erforderlich ist.

Hinweis: Erlaubte Zeichen im Attributwert
Obwohl XML kaum die erlaubten Zeichen beschränkt, sollten Sie sich dennoch auf Buchstaben (a-z, A-Z), Ziffern, den Unterstrich und den Punkt beschränken. Die DocBook-XSLT-Stylesheets können aus dem id -Attributwert Teildateien für (X)HTML erzeugen. Manche XSLT-Tools haben Probleme beim Erzeugen dieser Teildateien, wenn Sie Umlaute enthalten.

lang (Sprache)

kennzeichnet den Sprachcode, wie de für Deutsch, en für Englisch usw. Zusammengesetzte Sprachcodes aus Sprache und Land die ein Bindestrich haben, werden automatisch in einen Unterstrich umgewandelt, das heisst, aus de-DE wird de_DE. Weitere finden Sie unter ISO 639 and ISO 639-2: The Code Lists. Dieses Attribut ist nur für DocBook 4 und früher verfügbar. In DocBook 5 wird lang durch xml:lang ersetzt.
Wird keine Sprache angegeben, ist normalerweise Englisch die Standardsprache. Dies kann jedoch von den verwendeten Programmen abhängig sein. Gegenwärtig werden von den DocBook-XSL-Stylesheets alle handelsüblichen Sprachen erkannt.

linkend/ linkends (nur DocBook 5) (internes Linkziel)

zeigt auf einen Anker, identifiziert durch das Attribut id. Im Gegensatz zu linkend kann linkends (Mehrzahl!) ein oder mehrere Anker aufnehmen, getrennt durch Leerraum. Das Attribut linkends ist nicht in allen Elementen verfügbar.

os (Betriebssystem)

kennzeichnet das Betriebssystem, für welches dieses Element gilt; wird eingesetzt, um Texte zu unterscheiden, die beispielsweise für Linux, Macintosh oder Windows geschrieben sind.

remap (Zuordnung)

enthält einen Elementnamen aus einem semantisch ähnlichen Konstrukt, das von einer anderen Markup-Sprache stammt oder früheren DocBook-Version. Dies kann manchmal erforderlich sein, wenn Sie zwischen verschiedenen XML-Formaten wechseln und diese Information im Ursprungselement festgehalten werden soll. Schreiben Sie Ihre Texte von Grund auf neu, benötigen Sie dieses Attribut kaum.

revision (Revisionsnummer)

gibt eine Revisionsnummer an.

revisionflag (Überarbeitungsstatus)

kennzeichnet den Überarbeitungsstatus eines Elements, wie hinzugefügt, gelöscht, geändert oder ausgeschaltet. Verwenden Sie revisionflag , um Änderungen von einer Version zur nächsten anzuzeigen. Für gewöhnlich wird dieses Attribut nicht manuell gesetzt, sondern von Programmen die XML vergleichen. Der Standardwert ist nicht gesetzt.

role (Rolle)

klassifiziert das Ursprungselement. Das Attribut kann verwendet werden, um Stylesheets oder selbst geschriebenen Programmen (die dieses Attribut auswerten) ein differenziertes Verhalten zu ermöglichen (wie die Unterscheidung zwischen Druck- und Onlinefassung und Ähnliches).

security (Sicherheitsgrad)

kennzeichnet Daten, die zu einem bestimmten Sicherheitsbereich gehören

userlevel (Schwierigkeitsgrad)

bezeichnet den minimalen Grad der Erfahrung, die ein Benutzer haben muss

vendor (Hersteller)

kennzeichnet herstellerspezifische Daten

xreflabel (Querverweisname)

eingefügter Text, wenn ein xref darauf verweist

wordsize (Wortgröße)

bezeichnet die Wortgröße (Breite in Bits) der Computerarchitektur. Dieses Attribut ist erst ab einschließlich DocBook V4.4 verfügbar.

xml:base (Basis-URI)

spezifiziert den Basis-URI des angegebenen Elements und seiner Kindelemente. Dieses Attribut ist erst ab einschließlich DocBook V4.3 verfügbar und wird benötigt, wenn Sie XIncludes verarbeiten, da es von diesem automatisch eingefügt werden kann.

DocBook 5 kennt teilweise die Attribute der XLink-Spezifikation:

Attribute nur für DocBook 5

annotations (Anmerkungen)

identifiziert ein oder mehrere Anmerkungen. Mehr finden Sie in "Blockanmerkungen einfügen".

xml:lang (Sprache)

dieses Attribut wurde für DocBook 5 ist von der Bedeutung identisch zu lang (siehe Attribut lang).

xml:id (Anker, Markierung, Kennung)

dieses sehr häufig benutzte Attribut für DocBook 5 ist von der Bedeutung identisch zu id (siehe Attribut id).

xlink:actuate (Anlass)

spezifiziert wann der Link angezeigt werden soll: beim Laden (onLoad), auf Anforderung (onRequest), überhaupt nicht (none) oder auf eine andere Art (other). Eher für spezielle Anforderungen benötigt.

xlink:arcrole (Rolle für Bogenelemente)

ist von der Semantik identisch mit xlink:role. Im Gegensatz zu xlink:role beschreibt xlink:arcrole Bogenelemente. In XLinks werden Pfade zwischen mehreren Ressourcen als Bögen (arcs ) bezeichnet und durch Bogenelemente dargestellt. Ein Bogenelement enthält im Attribut xlink:arcrole einen absoluten URI. Der URI kennzeichnet die Beziehung der Bogenelemente untereinander. Kaum benötigtes Attribut.

xlink:href (Verweisziel)

zeigt auf die URI die referenziert werden soll

xlink:role (XLink-Rolle)

beschreibt die Bedeutung der Links zueinander durch einen URI. Die URI beschreibt oder erklärt den Link.

xlink:show (Anzeige)

spezifiziert wie der Link geöffnet werden soll: in einem neuen Fenster (new), das alte soll ersetzt werden (replace), eingebettet (embed) oder auf eine andere Art (other).

Beachten Sie, dass manche dieser Werte für bestimmte Ausgabemedien keinen Sinn ergeben.

xlink:title (Linktyp)

bezeichnet den Link. Dies kann nützlich sein, falls das Zielmedium dies beispielsweise als Popup oder auf eine andere Art anzeigen kann. (X)HTML verwendet zur Beschreibung

xlink:type (simple)

spezifiziert den Linktyp, in DocBook 5 ist momentan nur simple zulässig. Ein "Simple-Link" erstellt einen unidirektionalen Verweis im angegebenen Elements zu einem URI. Vereinfacht gesagt, ist dieser Linktyp ähnlich wie ein Link in HTML. Dieses Attribut braucht im Allgemeinen nicht angegeben zu werden.

 

  

<< zurück vor >>
Tipp der data2type-Redaktion:
Zum Thema DocBook bieten wir auch folgende Schulungen zur Vertiefung und professionellen Fortbildung an:

Copyright © 2009 Millin Verlag
Für Ihren privaten Gebrauch dürfen Sie die Online-Version ausdrucken.
Ansonsten unterliegt dieses Kapitel aus dem Buch "DocBook-XML: Medienneutrales und plattformunabhängiges Publizieren" denselben Bestimmungen, wie die gebundene Ausgabe: Das Werk einschließlich aller seiner Teile ist urheberrechtlich geschützt. Alle Rechte vorbehalten einschließlich der Vervielfältigung, Übersetzung, Mikroverfilmung sowie Einspeicherung und Verarbeitung in elektronischen Systemen.

Millin Verlag, Siebengebirgsring 36, 53797 Lohmar, info(at)millin.de