Topics für das Filtern und Kennzeichnen von Inhalten erstellen

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

Bei der bedingten Verarbeitung von Topics und Maps können Inhalte gefiltert (filtering) und gekennzeichnet (flagging) werden.

Sowohl für das Filtern als auch für das Kennzeichnen von Inhalten können Sie folgende Attribute verwenden:

  • audience: Mit diesem Attribut können Sie festlegen, für welche Zielgruppe der Inhalt des entsprechenden Elements ausgelegt ist.
  • platform: Diesem Attribut ist der Ursprung von DITA, nämlich als XML-basierter Standard für die Software-Dokumentation, am deutlichsten anzumerken. Mit dem platform-Attribut können Sie den Inhalt von Elementen kennzeichnen, die Informationen zu bestimmten Betriebssystemen, Hardware-Plattformen usw. enthalten.
  • importance: Mit diesem Attribut können Sie festlegen, in welchem Bereich der Wichtigkeit die Inhalte eines Elements einzuordnen sind. Beispielsweise können Sie mit dem importance-Attribut festlegen, ob ein Handlungsschritt im Topictyp „Aufgabe“ optional oder erforderlich ist.
  • product: Dieses Attribut dient dazu, zu kennzeichnen, zu welchem Produkt oder welcher Produktversion die Inhalte des entsprechendes Elements gehören.
  • rev: Mit diesem Attribut können Sie Elemente mit bestimmten Änderungszuständen kennzeichnen. Elemente, die das rev-Attribut enthalten, können bei der bedingten Verarbeitung speziell gekennzeichnet werden. Informationen zum rev-Attribut erhalten Sie im Abschnitt „Inhalte kennzeichnen“.
  • otherprops: Dieses Attribut ist eine Art Alleskönner, wenn keines der vorhandenen Attribute passt. Häufig wird das otherprops-Attribut verwendet, wenn die standardmäßig vorgegebenen Attribute nicht passen und kein Attribut aus dem props-Attribut spezialisiert wurde.
  • status: Mit diesem Attribut können Sie den Status des aktuellen Elements definieren.
  • props: Das props-Attribut ist ein generisches Attribut, welches als Basis für eine Spezialisierung verwendet wird. „Domain-Attribute“ beschreibt, wie Sie das props-Attribut spezialisieren können.

Für das Filtern von Inhalten können Sie die aufgeführten Attribute praktisch für alle Elemente von DITA verwenden. Für das Kennzeichnen von Inhalten können Sie hingegen die aufgeführten Attribute nur für die Block-Elemente von DITA verwenden.

Jedes Attribut zum Filtern und Kennzeichnen von Inhalten kann ein oder mehrere Werte enthalten. Bei mehreren Werten werden diese durch ein Leerzeichen getrennt.

<steps audience="user expert">...</steps>

Beim Filtern werden Inhalte von Topics oder Maps ausgeschlossen, das heißt, sie werden nicht im Ausgabemedium ausgegeben. Enthält ein Attribut mehrere Werte, müssen alle Werte des Attributs bei der bedingten Verarbeitung ausgeschlossen werden, damit die Inhalte des Elements nicht ausgegeben werden.

Standardmäßig werden alle Inhalte ausgegeben, das heißt, nur über das Filtern ist es möglich, Inhalte für die Ausgabe auszuschließen. Für die Erstellung von Topics und Maps bedeutet dies, dass zunächst alle Inhalte in den Topics oder Maps enthalten sein müssen. Diese Topics und Maps werden auch als Master-Topics und Master-Maps bezeichnet. Mit der bedingten Verarbeitung werden dann die Inhalte aus den Master-Topics und den Master-Maps gemäß den Werten in den Attributen ausgefiltert.

Gekennzeichnete Inhalte werden alle im Ausgabemedium ausgegeben. Dabei können sie mit einer besonderen Formatierung oder mit einer Grafik versehen werden.

Das FO-Plugin unterstützt zurzeit nicht die Verarbeitung von gekennzeichneten Inhalten in DITA XML-Dateien.

  

<< 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