Die Dateien des DITA Open Toolkits

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

Nach der Installation des vollständigen Pakets finden sich folgenden Dateien und Verzeichnisse im Installationsverzeichnis des DITA Open Toolkits:

  • root, das heißt, das Installationsverzeichnis selbst: Hier sind die ANT System Build-Dateien abgelegt. Diese steuern die Transformationen und den Produktionsprozess für die Ausgabemedien. Diese Dateien sollten Sie niemals verändern.
  • ant: In diesem Verzeichnis sind Beispiele für ANT Build-Dateien abgelegt, mit denen die Ausgabemedien mittels des DITA Open Toolkits produziert werden können. Informationen zur Anpassung der ANT Build-Dateien erhalten Sie in ANT.
  • css: Dieses Verzeichnis enthält einige Beispiele für CSS-Dateien.
  • demo: Dieses Verzeichnis enthält weitere Verzeichnisse, in denen Spezialisierungen, Plugins und Validatoren enthalten sind. Im Einzelnen befinden sich folgende Verzeichnisse im demo-Verzeichnis:
    • book: Enthält Dateien für die Spezialisierung Bookmap.
    • elementref: Enthält Dateien für ein Beispiel einer Topic-Spezialisierung.
    • enote: Enthält Dateien für ein Beispiel einer Spezialisierung einer E-Mail.
    • faq: Enthält Dateien für die Spezialisierung einer FAQ (Frequently Asked Questions).
    • h2d: Plugin, um XHTML-Dateien in DITA-konforme Topics konvertieren zu können.
    • java: Validatoren für die XML-Schemata für DITA.

Wenn das FO-Plugin installiert ist, befindet sich hier das fo-Verzeichnis.

  • doc: Hier befindet sich die Dokumentation des DITA Open Toolkits.
  • dtd: Dieses Verzeichnis enthält alle DTDs, Moduldateien und Entity-Dateien von DITA.
  • lib: Hier befinden sich alle Java-Programme, die das DITA Open Toolkit benötigt, wie zum Beispiel dost.jar.
  • plugins: Dieses Verzeichnis ist für Plugins vorgesehen. Bisher ist es aber leer geblieben.
  • resource: Einige Dateien, die das DITA Open Toolkit zusätzlich benötigt, sind hier untergebracht.
  • samples: In diesem Verzeichnis sind einige Beispieldateien abgelegt.
  • schema: Die zu den DTDs, Moduldateien und Entity-Dateien korrespondierenden XML-Schema-Dateien befinden sich in diesem Verzeichnis.
  • tools: Hier ist ANT abgelegt.
  • xsl: Dieses Verzeichnis enthält weitere Verzeichnisse, die XSLT-Stylesheets für die Produktion der unterschiedlichen Ausgabemedien enthalten. Im Einzelnen befinden sich folgende Verzeichnisse im xsl-Verzeichnis:
    • common: XSLT-Stylesheets, die für alle Verarbeitungsprozesse verwendet werden können, sind hier zu finden.
    • docbook: In diesem Verzeichnis befinden sich XSLT-Stylesheets, um DITA-Topics zu DocBook konvertieren zu können.
    • preprocess: Hier sind die XSLT-Stylesheets abgelegt, die für die bedingte Verarbeitung, den conref-Mechanismus und die Verlinkung zuständig sind.
    • xtroff: Die XSLT-Stylesheets zur Generierung von troff-Dateien bedinden sich hier.
    • xslfo: In diesem Verzeichnis befinden sich alle XSLT-Stylesheets, die XSL-FO-Dateien produzieren müssen.
    • xslhtml: Die XSLT-Styleshheets zur Produktion von XHTML befinden sich hier.
    • xslrtf: Dieses Verzeichnis enthält die XSLT-Stylesheets, die aus DITA-Topics RTF-Dateien erzeugen können.

XSLT-Stylesheets

Die XSLT-Stylesheets im xsl-Verzeichnis des DITA Open Toolkits transformieren die DITA XML-Dateien und erzeugen die Ausgabemedien. Der Typ der möglichen Transformation wird auch als transtype bezeichnet und entspricht dem Namen einer Variablen in einer ANT Build-Datei.

In der folgenden Tabelle sind die mit dem DITA Open Toolkit möglichen Transformationstypen aufgelistet sowie die XSLT-Stylesheets, die die Transformationen steuern. Nicht jeder Transformationstyp kann überschrieben, das heißt, angepasst werden.

Transformationstyp überschreibbar XSLT-Stylesheets
docbook x map2docbook.xsl, dita2docbook.xsl
eclipsecontent map2eclipse.xsl, map2plugin-cp.xsl
eclipsehelp map2eclipse.xsl
htmlhelp map2hhc.xsl, map2hhp.xsl
javahelp x map2javahelpmap.xsl
pdf, pdf2 x dita2fo-shell.xsl
troff dita2troff-step1-shell.xsl, dita2troff-step2-shell.xsl
wordrtf x dita2rtf.xsl
xhtml x dita2xhtml.xsl

Tabelle: Transformationstypen

Informationen zur Anpassung der XSLT-Stylesheets des FO-Plugins und dem Transformationstyp pdf2, erhalten Sie in Idiom FO-Plugin.

Informationen zur Anpassung der XSLT-Stylesheets zur Produktion von XHTML-Dateien, das heißt zu dem Transformationstyp xhtml, erhalten Sie in XHTML und CSS.

Plugins

Für das DITA Open Toolkit stehen zahlreiche Plugins zur Verfügung, mit denen die Funktionalitäten des DITA Open Toolkits erweitert werden können:

  • apiref-0.8: Eine Spezialisierung für APIs (Application Programming Interface).
  • cshelp1.1: Plugin für die Erstellung von kontextsensitiver Hilfe.
  • docbook2dita 1.0: XSLT-Stylesheets für die Tranformation von DocBook zu DITA.
  • FrameMaker Adapter 0.8: Plugin zu Erzeugung von FrameMaker 7.x-Dateien aus DITA XML-Dateien. Bekannt auch als Mekon-Adapter.
  • javaapiref-0.8: Spezialisierung von Topics zur Dokumentation von Java-Klassen.
  • message specialization 1: Spezialisierung von Topics zur Dokumentation von Systemmeldungen.
  • Music 1.1: Beispieldateien, anhand derer demonstiert wird, wie ein Plugin mit Spezialisierungen für das DITA Open Toolkit erstellt werden kann.
  • Thesaurus0.8.1: Eine Spezialisierung zur Klassifikation (Taxonomie) von Inhalten, die sich an SKOS (Simple Knowledge Organization System) orientiert. Über diese Spezialisierung können RDF (Resource Description Framework)-Dateien erstellt werden.
  • troubleshooting 1.0: Eine Spezialisierung zur Dokumentation von Fehlerdiagnosen.

Das FO-Plugin, mit dem PDF-Dateien erzeugt werden können, wird ausführlich in „Idiom FO-Plugin“ beschrieben.

  

  

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