Wiederverwendung von Informationen mit DITA

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

Bei DITA ist alles auf Wiederverwendung ausgerichtet. Das wichtigste Ziel der Entwickler von DITA was es, die Wiederverwendung von Informationen auf allen Ebenen maximal zu unterstützen. Gerade die von den DITA-Entwicklern bei IBM erfahrenen Schwierigkeiten mit SGML ließen sie nach einer Lösung suchen, Informationen möglichst auf mehreren Stufen wiederverwenden zu können.

Bei DITA ist die Wiederverwendung ausgerichtet auf:

  • Inhalte (content reuse)
  • Informationsstrukturen (information design reuse)
  • Verarbeitungsprozesse (processing reuse)

Spricht man von einer Wiederverwendung von Informationen, so ist damit häufig nur die Wiederverwendung von Inhalten gemeint. Zwar ist dies ein wichtiger Bestandteil bei DITA, dennoch wurde darauf geachtet, dass auch die Infrastruktur, das heißt die DTDs und Moduldateien sowie die XSLT-Transformationen und XSLT-Stylesheets, wiederverwendet werden können. Die Möglichkeit der Wiederverwendung von DTDs und Moduldateien erweist sich dann als äußerst hilfreich, wenn neue Informationsstrukturen, wie zum Beispiel neue Topic- oder Maptypen erzeugt werden sollen. Entsprechendes gilt für die XSLT-Transformationen und die XSLT-Stylesheets.

Inhalte

Um Inhalte wiederverwenden zu können, wird bei DITA der Mechanismus der Referenzierung angewendet. Gerade wenn man XML als Basisformat verwendet, ist die Referenzierung von Elementen mitsamt ihren Inhalten auf leichte Weise durchzuführen. Der Vorteil einer solchen Methode ist offensichtlich, denn Inhalte, die referenziert werden können, müssen nur einmal erstellt werden. Ist eine Überarbeitung der Inhalte erforderlich, so werden die Inhalte automatisch überall dort aktualisiert, wo sie referenziert sind.

Mit DITA erfolgt die Referenzierung von Inhalten über Maps und den so genannten conref-Mechanismus. Inhalte wiederverwenden mit Maps und conref stellt die Mechanismen der Wiederverwendung in DITA vor.

Mit Maps werden ganze Topics referenziert. Eine Map stellt ein Inhaltsverzeichnis dar, welches angibt, welche Topics und damit letzten Endes welche Inhalte in einem Dokument aufgenommen werden. Die Zusammenstellung der Topics kann dann gemäß den Anforderungen an das zu erstellende Dokument erfolgen, das heißt Topics können beispielsweise individuell für Zielgruppen oder für Ausgabemedien arrangiert werden.

Einen Spezialfall der Maps stellt die Bookmap dar. Auch hier werden Topics referenziert. Doch wird in einer Bookmap ein Raster vorgegeben, um die Topics „buchgemäß“ anordnen zu können. Platzhalter für Titelei, Copyright, Vorwort usw. sind in einer Bookmap bereits vorgegeben.

In Maps und Bookmaps können Topics beliebig oft referenziert, das heißt wiederverwendet werden. Sind bestimmte Informationen an mehreren Stellen im Handbuch notwendig, so wird das Topic in einer Map einfach mehrfach referenziert. Da Topics aufgrund ihrer Referenzierung nicht an Maps gebunden sind, können Topics in unterschiedlichen Maps referenziert werden.

Eine zweite Methode zur Wiederverwendung von Inhalten bietet DITA mit dem conref-Mechanismus an. Hier können sowohl einzelne Topics referenziert werden als auch die einzelnen Elemente innerhalb eines Topics.

Werden Inhalte über den conref-Mechanismus referenziert, so werden die Inhalte an der Stelle transkludiert, an der sie referenziert werden. Das bedeutet, dass das Element ersetzt wird, welches ein anderes Element mittels des conref-Mechanismus referenziert. Die Methode der Transklusion ist aus dem HyTime (Hypermedia/Time-based Structuring Language) Standard bekannt. HyTime ist ebenso wie HTML eine SGML-Anwendung und wurde 1992 ISO-Standard. Einige für HyTime entwickelten Konzepte wurden später bei HTML und XML übernommen.

Wird ein Element transkludiert, so muss darauf geachtet werden, dass es zu keiner Regelverletzung kommt, wenn das alte Element ersetzt wird. Das heißt, das XML-Dokument muss mit dem inkludierten Element gegenüber der DTD validiert werden können. Unterstützen XML-Editoren den conref-Mechanismus, so muss daher zunächst überprüft werden, ob die Ersetzung des gewünschten Elements zulässig ist, bevor die eigentliche Ersetzung stattfinden kann.

Um Topics oder Elemente referenzieren zu können, müssen sie mit IDs eindeutig gekennzeichnet werden. Topics erhalten immer eine eindeutige ID und alle DITA-konformen Editoren überprüfen, ob dem Topic eine ID vergeben wurde. Elementen hingegen müssen keine IDs vergeben werden, das heißt, hier ist die Vergabe von IDs optional. Eine ID muss erst dann vergeben werden, wenn ein Element dazu bestimmt wird, später einmal referenziert zu werden.

Die Vergabe von IDs, insbesondere bei Elementen, ist immer mit einem bestimmten Verwaltungsaufwand verbunden. Zum einen muss dafür gesorgt werden, dass ein Schema vorgegeben ist, nach welchem Muster die IDs vergeben werden sollen. Zum anderen muss der Zugriff auf die Elemente, die mit einer ID gekennzeichnet sind, leicht möglich sein.

Soll mit dem conref-Mechanismus gearbeitet werden, erfordert dies daher Überlegungen, wie die mit IDs gekennzeichneten Elemente und auch die Topics verwaltet werden sollen. Insbesondere wenn mehrere Technische Redakteure Elemente zur Wiederverwendung erstellen und diese dann tatsächlich wiederverwenden wollen, ist der Aufbau von Systemen für die leistungsfähigen Verwaltung der Inhalte notwendig. Es nützt nichts, Elemente für die Wiederverwendung bereitzustellen, wenn der Technische Redakteur nichts von deren Existenz weiß oder sie nicht finden kann.

Ein solches System oder eine solche Arbeitsumgebung aufzubauen, erfordert immer ein gewisses Maß an Organisation. Häufig wird bei der Einführung von DITA der dafür notwendige Aufwand an organisatorischen Maßnahmen unterschätzt oder nicht berücksichtigt. Als Ergebnis ist dann zu beobachten, dass die Wiederverwendung von Inhalten mit den Mitteln von DITA nicht zum Einsatz kommen. Und dann greift man wieder Copy&Paste zurück.

Informationsstrukturen

Mit DITA lassen sich nicht nur Inhalte wiederverwenden, sondern auch die Inhalte von DITA selbst wiederverwenden. Die DTDs und Moduldateien von DITA bieten dazu das beste Beispiel.

Wie in Flexible Erweiterbarkeit und insbesondere in Spezialisierung gezeigt wird, werden die DTDs, Moduldateien und Entity-Dateien von DITA dazu verwendet, neue, das heißt spezialisierte Informationsstrukturen zu definieren. Soll beispielsweise ein neuer Topictyp definiert werden, so wird eine bestehende Moduldatei kopiert, mit einem neuem Namen versehen und danach gemäß den Bedürfnissen angepasst. Somit muss keine Moduldatei beziehungsweise keine DTD von Grund auf neu entwickelt werden, um einen neuen Topictyp zu definieren. Ähnlich verhält es sich bei Maps und Domains. Auch hier werden bestehende Modul- und Entity-
Dateien verwendet, um spezialisierte Maps oder Domains zu definieren.

Der Mechanismus zur Wiederverwendung von Informationsstrukturen funktioniert deshalb, weil in DITA die spezialisierten Informationsstrukturen immer ein restriktiveres Inhaltsmodell aufweisen als die ursprünglichen Informationsstrukturen. Dadurch können niemals wirklich neue Informationsstrukturen entwickelt werden. So können aus den DITA DTDs, die Topics definieren, keine Informationsstrukturen erzeugt werden, die beispielsweise DocBook ähnlich sind.

Dies erleichtert zum einen die Definition modifizierter DTDs und Moduldateien für neue Informationsstrukturen. Zum anderen fördert es auch die Erstellung von neuen DTDs und Moduldateien. Die Wiederverwendung von Informationsstrukturen sorgt dafür, dass DITA kein starres Set von DTDs und Moduldateien bietet, das nur mit großem Aufwand erweitert werden kann. Damit zeigt sich einmal mehr, wie wirkungsvoll die Wiederverwendung von Informationen sein kann, wenn sie richtig angewendet wird.

Jedoch ist die Wiederverwendung von Informationsstrukturen nur von eingeschränktem Wert, wenn die neuen Topictypen nicht durch bestehende XSLT-Stylesheets verarbeitet werden können oder die Entwicklung von neuen XSLT-Stylesheets mit großem Aufwand verbunden ist. Aber auch hier bietet DITA eine Lösung.

Verarbeitungsprozesse

Die Wiederverwendung von Verarbeitungsprozessen ist ein Merkmal, das DITA relativ deutlich von anderen Standards unterscheidet. Das liegt vor allem daran, dass DITA nicht nur aus einem Satz von DTDs und Moduldateien besteht, sondern dass zu DITA auch das DITA Open Toolkit gehört. Denn mit den XSLT-Stylesheets des DITA Open Toolkits können auch spezialisierte Informationsstrukturen verarbeitet werden, ohne dass eine Anpassung der XSLT-Stylesheets notwendig wäre. In Spezialisierung und DITA Open Toolkit erhalten Sie ausführliche Informationen zu den Verarbeitungsprozessen von DITA.

Ist eine Anpassung der XSLT-Stylesheets notwendig, so können auch diese wiederverwendet werden. Zwar unterscheiden sich die Anpassungsmechanismen der XSLT-Stylesheets für die unterschiedlichen Ausgabemedien, dennoch ist eine Wiederverwendung stets möglich.

Somit können mit DITA nicht nur Informationen wiederverwendet werden, sondern die Elemente von DITA selbst können allesamt wiederverwendet werden. Damit schließt sich der Kreislauf der Wiederverwendung bei DITA.

  

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