Domain-Attribute

(Auszug aus "DITA - Der neue Standard für Technische Dokumentation" von Johannes Hentrich)

Mit DITA Version 1.1 wurde die Möglichkeit geschaffen, das base- und das props-Attribut zu spezialisieren. Beide Attribute werden als Meta-Daten in DITA verwendet.

Das props-Attribut dient zur Auszeichnung von Inhalten, die bei der bedingten Verarbeitung entweder gefiltert oder gekennzeichnet werden. Durch die Spezialisierung des props-Attributs können zu den bestehenden Attributen audience, platform, importance, product, rev, otherprops und status neue Attribute für die bedingte Verarbeitung definiert werden. Weitere Informationen zur bedingten Verarbeitung erhalten Sie in „Bedingte Verarbeitung“.

Als Platzhalter dient das base-Attribut. Mit diesem Attribut und dessen Spezialisierungen können ebenso wie mit dem props-Attribut Inhalte ausgezeichnet werden. Jedoch werden die mit einem base-Attribut ausgezeichneten Inhalte bei der bedingten Verarbeitung nicht berücksichtigt.

Die Vorgehensweise bei der Spezialisierung des base- und des props-Attributs ist wie folgt:

  1. Erstellen Sie eine neue ent-Datei, in der das spezialisierte base- oder props-Attribut definiert wird.
  2. Referenzieren Sie die neue ent-Datei in einer Mantel-DTD, in der das spezialisierte Attribut bekannt sein soll.

Im folgenden Beispiel wird gezeigt, wie Sie die Spezialisierung eines props-Attributs durchführen können. Es wird ein hersteller-Attribut definiert, mit dem es möglich ist, Inhalte auszuzeichnen, die einem bestimmten Hersteller zugeordnet werden sollen.

Im ersten Schritt wird eine ent-Datei erstellt, in der das spezialisierte Attribut definiert wird. Gehen Sie dabei wie folgt vor:

  1. Erstellen Sie eine neue ent-Datei mit dem Namen herstellerDomain.ent.
  2. Fügen Sie folgende beiden Deklarationen in die herstellerDomain.ent-Datei ein:
<!ENTITY % hersteller-props-attribut "hersteller CDATA #IMPLIED">
<!ENTITY hersteller-d-att "a(props hersteller)">

In der ersten <ENTITY>-Deklaration wird das hersteller-Attribut definiert. Spezialisierte props-Attribute verwenden immer den Datentyp CDATA #IMPLIED. Dies gilt ebenso für spezialisierte base-Attribute.

Um das neue Attribut später in einer Mantel-DTDs referenzieren zu können, wird eine Parameter-Entität % hersteller-props-attribut definiert. In einer Mantel-DTD ist im DOMAIN ATTRIBUTE EXTENSIONS-Abschnitt eine <!ENTITY % props-attribute-extensions "">-Entität enthalten, in der auf das spezialisierte Attribut über die Parameter-Entität % hersteller-props-attribut verwiesen wird. Für spezialisierte base-Attribute muss in der Mantel-DTD ein entsprechender Eintrag in der <!ENTITY % base-attribute-exten-sions "">-Entität vorgenommen werden.

In der zweiten <ENTITY>-Deklaration wird ein Name für die Domain vergeben, die das spezialisierte Attribut enthält. Dieser Name wird in der Mantel-DTD im DOMAINS ATTRIBUTE OVERRIDE-Abschnitt benötigt. Im Wert der <ENTITY>-Deklaration zeigt das Schlüsselwort props an, dass ein props-Attribut spezialisiert wurde. Entsprechend würde bei einer Spezialisierung des base-Attributs das Schlüsselwort base verwendet werden. Das a vor der Klammer zeigt an, dass der Wert ein Attribut ist.

Sollen mehrere Attribute spezialisiert werden, so empfiehlt es sich, für jede Attribut-Spezialisierung eine separate Datei zu erstellen. Damit ist eine maximale Modularität gewährleistet, was die Wiederverwendbarkeit der einzelnen spezialisierten Domain-Attribute in unterschiedlichen Mantel-DTDs erhöht.

Im nächsten Schritt wird die neue ent-Datei in einer Mantel-DTD referenziert. Als Grundlage einer Mantel-DTD kann jede DTD von DITA verwendet werden. Im Folgenden wird die concept.dtd von DITA als Basis für die Mantel-DTD verwendet. Gehen Sie dabei wie folgt vor:

  1. Erstellen Sie eine Kopie der concept.dtd-Datei und vergeben Sie der Kopie einen neuen Namen, zum Beispiel special_concepts.dtd.
  2. Finden Sie den DOMAIN ATTRIBUTE DECLARATIONS-Abschnitt in der special_concepts.dtd-Datei.
  3. Fügen Sie folgenden Eintrag in den DOMAIN ENTITY DECLARATIONS-Abschnitt der Mantel-DTD ein:
<!ENTITY % hersteller-d-dec SYSTEM „herstellerDomain.ent“ >
%hersteller-d-dec;

Damit wird auf die herstellerDomain.ent-Datei verwiesen.

  1. Fügen Sie im DOMAIN ATTRIBUTE EXTENSIONS-Abschnitt folgenden Eintrag hinzu:
<!ENTITY % props-attribute-extensions "%herstellerprops-attribut;" >

Dabei ist %hersteller-props-attribut der Name der Parameter-Entität, wie sie in der herstellerDomain.ent-Datei definiert wurde. Mit diesem Eintrag wird das hersteller-Attribut zur %selection-atts-Parameter-Entität hinzugefügt, die wiederum zur %univ-atts-Parameter-Entität gehört. Die in DITA definierte %selection-atts-Parameter-Entität enthält die Definition der Attribute für die bedingte Verarbeitung. In der %univ-atts-Parameter-Entität werden Attribute definiert, die in praktisch allen Elementen zur Verfügung stehen.

  1. Fügen Sie im DOMAINS ATTRIBUTE OVERRIDE-Abschnitt die Referenz zum Namen Domain ein, die das spezialisierte Attribut enthält. Der Name der Domain wurde in der herstellerDomain.ent-Datei definiert und lautet hersteller-d-att.
<!ENTITY included-domains "&ui-d-att; &hi-d-att; &pr-datt; &sw-d-att; &ut-d-att; &indexing &hersteller-d-att">

Jetzt steht in allen Topics, die mit der special_concepts.dtd-Mantel-DTD erstellt werden, das hersteller-Attribut zur Verfügung.

  

  

<< zurück vor >>

 

 

 

Tipp der data2type-Redaktion:
Zum Thema DITA bieten wir auch folgende Schulungen zur Vertiefung und professionellen Fortbildung an:

Copyright © 2008 XLcontent Verlag
Für Ihren privaten Gebrauch dürfen Sie die Online-Version ausdrucken.
Ansonsten unterliegt dieses Kapitel aus dem Buch "DITA - Der neue Standard für Technische Dokumentation" 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.

XLcontent Verlag, Pflegerstraße 40, 81247 München