Darwin Information Typing Architecture

Die Darwin Information Typing Architecture (DITA) ist ein Dokumentenformat, ähnlich dem bekannten DocBook. DITA wird von der Firma IBM und OASIS als freie Architektur entwickelt und steht als Dokumenttypdefinition (DTD) kostenlos zur Verfügung. DITA basiert auf XML: im Gegensatz zum genannten DocBook gibt es für DITA keine SGML-basierte DTD.

Nach der offiziellen Definition aus der Architekturspezifikation ist DITA '„… an architecture for creating topic-oriented, information-typed content that can be reused and single-sourced in a variety of ways. It is also an architecture for creating new information types and describing new information domains based on existing types and domains. This allows groups to create very specific, targeted document type definitions using a process called specialization, while still sharing common output transforms and design rules developed for more general types and domains.“ (aus DITA Architectural Specification Chapter 2, „An Introduction to DITA.“)

Am 3. Mai 2005 wurde DITA 1.0 (englisch) als OASIS Standard verabschiedet.

Am 13. August 2007 wurde DITA 1.1 (englisch) als OASIS Standard verabschiedet.

Am 1. Dezember 2010 wurde die DITA-Spezifikation 1.2 als OASIS-Standard verabschiedet, die über zahlreiche Neuerungen verfügt. Es stehen nun drei verschiedene Architekturen zur Verfügung, zudem existieren neue Domains und Topics.

Einführung

Der Name Darwin Information Typing Architecture kommt folgendermaßen zustande:

• Darwin – Charles Darwin stand Pate für diese Architektur. Als Begründer der Evolutionstheorie hat er insbesondere die Vererbung untersucht. Erweiterung durch Vererbung ist eine der wichtigsten Eigenschaften von DITA.
• Information Typing – Informationen werden in DITA typisiert. Somit ist ein hohes Maß an Wiederverwendung garantiert.
• Architecture – DITA ist eine Architektur. Sie ist nicht nur einfach eine DTD, sondern beinhaltet auch Regeln für die Erstellung von Informationseinheiten. Zusätzlich wird sie ständig weiterentwickelt und kann in gewissen Grenzen erweitert werden.

DITA ist eine XML-basierte Architektur für die Erstellung, Verteilung und Wiederverwendung von technischen Informationen. Die Architektur besteht aus einer Menge an Designregeln, die es erlauben, „typisierte“ Informationsmodule auf der Ebene sogenannter „Topics“ zu erstellen.

Ziel von DITA ist es, den „unique transclusion mechanism“ (siehe auch „Transklusion“) zu unterstützen, der im Rahmen einer DTD Verarbeitungsregel angegeben wird: ein Element „can replace itself with the content of a like element elsewhere, either in the current topic or in a separate topic that shares the same content models. DITA’s conref ‚transclusion‘ mechanism is similar to the SGML conref mechanism, which uses an empty element as a reference to a complete element elsewhere. However, DITA requires that at least a minimal content model for the referencing element be present, and performs checks during processing to ensure that the replacement element is valid in its new context. This mechanism goes beyond standard XInclude, in that content can be incorporated only when it is equivalent: If there is a mismatch between the reusing and reused element types, the conref is not resolved. It also goes beyond standard entity reuse, in that it allows the reused content to be in a valid XML file with a DTD. The net result is that reused content gets validated at authoring time, rather than at reuse time, catching problems at their source.“

Geschichte

Das Unternehmen IBM erstellte in den 90er Jahren eigene komplexe SGML DTDs (u. a. IBMIDDoc) für die Dokumentation ihrer zahlreichen Produkte. Während der Weiterentwicklung stellte sich die Frage, einen neuen Standard für technischen Dokumentationen zu entwerfen, der vor allem ein hohes Maß an Wiederverwendung unterstützen sollte. Dabei wurden IBMIDDoc oder andere XML DTD wie DocBook, TEI oder XHTML untersucht. Als Resultat entschied man sich, mit DITA ein neues Dokumentenformat zu entwickeln.

Eigenschaften und Hintergründe

DITA zeichnet sich vor allem durch folgende Eigenschaften aus:

• Themenzentrierung – Das höchste Abstraktionslevel von DITA ist das Topic. Weitere Strukturen, die oberhalb eines Topics angesiedelt sind, sind dann eher Informationen die dem Prozess eines solchen Topics angehören. Beispielsweise könnte es sich dabei um die Navigation einer Hilfeseite handeln. Weiterhin sind Topics nicht mehr weiter geschachtelt. Für die Organisation von Topics bieten sich die „Sections“ an, welche die Topics mit Inhalten versehen.
• Wiederverwendung – Ein Ziel von DITA ist die Reduktion von redundanten Inhalten und den Aufwänden von Kopieren von Informationen. Dabei können Informationen an verschiedenen Stellen verwendet werden, der Inhalt liegt jedoch nur einmal vor.

Definitionen (aus DITA Architectural Specification Chapter 2, „An Introduction to DITA.“):

• Topic: Ein Topic ist eine Informationseinheit, die durch Titel und Inhalt bestimmt wird. Diese Einheit muss knapp genug sein, um ein einzelnes Thema zu behandeln oder eine einzige Frage zu beantworten. Sie muss jedoch auch ausreichend genug sein, um alleine sinnvoll stehen zu können und dabei alleine weiterentwickelt zu werden.
• Map: Maps sind Dokumente, in denen einzelne Referenzen zu Topics sinnvoll gesammelt und organisiert sind. Sie bilden damit die logische Einheit und Klammer über bestimmte Topics. Sie können damit auch als Gliederung oder Inhaltsverzeichnis für DITA Ergebnisse und somit als „build manifests“ für komplette DITA Projekte dienen.
• Spezialisierung: Die Spezialisierung erlaubt die Definition neuer „Informationstypen“ („structural types“ oder „new domains of information“). Dabei sollte jedoch der größte Anteil der Informationen wiederverwendet werden, damit die Kosten für Austausch, Migration und Wartung minimiert werden können.
• Integration: Jede Spezialisierung besitzt ihr eigenes Designmodul. Diese Module können in kombinierter Form wiederum weitere Dokumententypen generieren. Der Prozess der Erstellung neuer Dokumententypen aus der Kombination verschiedener Module wird Integration genannt.
• Anpassung: Für den Fall, dass ausschließlich der Ergebnisoutput in unterschiedlicher Form benötigt wird, kann eine Anpassung von DITA verwendet werden. Damit wird der Standardoutput angepasst, ohne die Übertragbarkeit und den Austausch zu verschlechtern.

Vorteile und Vergleich gegenüber DocBook

Im Vergleich zu DocBook gilt DITA als einfacher zu erlernen. Während DocBook eher als Vorlage für komplexe Bücher und Dokumentationen im Buchformat gedacht ist, verfolgt DITA das Ziel, technische Informationen als Topics abzubilden, die in verschiedenen Kontexten weiterverwendet werden können. DITA verwendet darüber hinaus viele Elemente aus HTML.

Nachfolgend ein Vergleich nach Namahn, 2001:

Vorteil von DITA gegenüber DocBook

• DocBook ist primär für die Erstellung und Auslieferung von Büchern gedacht, während DITA dagegen auf die Erstellung und Auslieferung auf Topics fokussiert. Diese Topics können jedoch danach als Sammlung in Bücher übergehen oder verlinkt werden und damit als Helpsets, Webseiten oder etwa als Zusammenfassungen für PDAs dienen.
• DocBook ist strikt hierarchisch und stellt keine Mechanismen zur Verfügung, um Inhalt vom Kontext zu trennen. Dabei ist DITA wesentlich flexibler und kann kontextsensitive Informationen in verschiedenen Dokumenten gruppieren. DITA kann Topics mit jedem Level von definierter Struktur ablegen.
• DocBook ist eine feste Menge von Elementen und Attributen. DITA ist erweiterbar und kann auf die individuellen Bedürfnisse und Anforderungen angepasst werden: Spezialisierungsregeln definieren die Struktur von individuellen Informationstypen, die dabei auf die vorhandenen Standardelemente zurückgreifen können.

Vorteil von DocBook gegenüber DITA

• DocBook wird seit mehr als 10 Jahren aktiv erweitert und ständig gepflegt.
• DocBook ist ausführlich dokumentiert und in vielen Praxisfällen erfolgreich getestet. Das Feedback der großen DocBook-Community ist überall verfügbar.
• DocBook unterstützt durch die DocBook-Stylesheets bereits eine Vielzahl an Zielformaten wie Eclipse, EPUB, FO, HTML, HTMLHelp, Javahelp, Manpages, Webhelp und XHTML.
• Ab Version 5 stellt DocBook ein topic-Element bereit.
• Ab Version 5.1 (in Entwicklung) wird es ein assembly-Element geben (ähnlich einer Map in DITA), das die Wiederverwertung verbessert.

Beispiel

<topic id="maintaining" xml:lang="en-us">
   <title>Maintaining</title>
   <shortdesc>
      You maintain your solution to ensure that all components are operating at maximum efficiency.
   </shortdesc>
   <body>
      <p>
         Maintenance is a task that you perform along with configuration to get the most from your solution.
      </p>
   </body>
</topic>

Siehe auch

• mumasy, ein VDMA-standardisiertes XML-Schema für technische Dokumentation

Literatur

• Sissi Closs: Single Source Publishing. Topicorientierte Strukturierung und DITA, Entwickler-Press, 2007 ISBN 978-3935042987
• Johannes Hentrich: DITA – Der neue Standard für technische Dokumentation, XLcontent-Verlag, 2008 ISBN 978-3981143003
• Jennifer Linton, Kylene Bruski: Introduction to DITA: A User Guide to the Darwin Information Typing Architecture. Comtech Services, Colorado 2006

Weblinks

• OASIS Technical Committee (englisch)
• IBM DITA Spezifikation (englisch)
• IBM DITA FAQ (englisch)
• IBM DITA Download (englisch)
• DITA Open Toolkit (englisch)
• Referenzen (englisch)