ANT

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

Mit ANT (Another Neat Tool) können aus einzelnen Komponenten Anwendungen erstellt werden. Ein ähnliches Konzept wie bei ANT wird beim Unix-Befehl make verwendet, mit dem installierbare Software-Programme aus einem existierenden Quelltext, Bibliotheken und sonstigen Dateien erstellt werden können. Beim DITA Open Toolkit wird ANT dazu verwendet, um aus den DITA XML-Dateien, den Maps, den XSLT-Stylesheets und sonstigen Stylesheets Ausgabemedien zu produzieren.

ANT wird über eine so genannte Build-Dateien gesteuert, welche XML-Dateien sind. Dabei sind das <target>-Element und das <property>-Element die beiden wichtigsten Elemente in einer ANT Build-Datei.

Im <target>-Element wird definiert, welches Ausgabemedium erzeugt werden soll.

Im <property>-Element wird definiert, welche Eigenschaften beziehungsweise mit welchen Bedingungen das Ausgabemedium zu erzeugen ist. Im <property>-Element mit dem Namen transtype wird der Transformationstyp festgelegt, der bestimmt, welches Ausgabemedium produziert werden soll.

Das DITA Open Toolkit stellt zahlreiche ANT Build-Dateien als Beispiel zur Verfügung, sodass Sie die Syntax der ANT Build-Dateien nicht im Detail kennenlernen müssen.

Beim DITA Open Toolkit werden zwei Arten von ANT Build-Dateien unterschieden:

  • System ANT Build-Dateien: Die System ANT Build-Dateien liegen im Wurzelverzeichnis des DITA Open Toolkits. Diese Dateien werden vom DITA Open Toolkit benötigt, um die Transformationen zu Ausgabemedien zu ermöglichen. Diese Datein sollten Sie nicht verändern.
  • Nutzer ANT Build-Dateien: Beispiele für ANT Build-Dateien, mit denen ein Nutzer mit dem DITA Open Toolkit das gewünschte Ausgabemedium erzeugen kann, liegen im ant-Verzeichnis des DITA Open Toolkits.

In den folgenden beiden Abschnitten wird gezeigt, wie Sie die Beispiel ANT Build-Dateien für die Produktion der Ausgabemedien XHTML, das heißt den Transformationstyp xhtml, und PDF, das heißt dem Transformationstyp pdf beziehungsweise pdf2, gemäß Ihren Anforderungen anpassen können. Des Weiteren stehen noch Beispiel ANT Build-Dateien für folgende Transformationstypen zur Verfügung:

  • docbook
  • eclipsehelp
  • htmlhelp
  • javahelp
  • wordrtf

Die Anpassung der Beispiel-ANT Build-Dateien für die aufgelisteten Transformationstypen verläuft wie in den beiden folgenden Abschnitten dargestellt analog.

ANT Build-Datei zur Produktion von XHTML

Als Vorlage für die ANT Build-Datei wird die Datei template_xhtml.xml aus dem ant-Verzeichnis des DITA Open Toolkits verwendet.

Die template_xhtml.xml-Datei hat folgenden Inhalt:

<?xml version="1.0" encoding="UTF-8"?>
<project name="@PROJECT.NAME@_xhtml" default="@DELIVERABLE.NAME@2xhtml" basedir=".">
  <property name="dita.dir" value="${basedir}${file.separator}.."/>
  <import file="${dita.dir}${file.separator}integrator.xml"/>
  <target name="@DELIVERABLE.NAME@2xhtml" depends="integrate">    
    <ant antfile="${dita.dir}${file.separator}build.xml" target="init">
      <property name="args.input" value="@DITA.INPUT@">
      <property name="output.dir" value="@OUTPUT.DIR@"/>
      <property name="transtype" value="xhtml"/>
    </ant>
  </target>
</project>

Um die template.xhtml-Datei für Ihr Projekt anzupassen, sind die Platzhalter wie folgt zu ersetzen:

  • @PROJECT.NAME@_xhtml: Geben Sie hier den Dateinamen ohne Dateiendung ein, den Sie der ANT Build-Datei vergeben. Zum Beispiel mein_projekt.
  • @DELIVERABLE.NAME@2xhtml: Den Namen des zu produzierenden Ausgabemediums können Sie frei wählen.
  • @DITA.INPUT@: Geben Sie hier den Pfad zu dem Verzeichnis an, in dem sich die Map befindet, die verarbeitet werden soll. Verwenden Sie als Trennzeichen ${file.separator} zwischen den Verzeichnis- und Dateinamen.
  • @OUTPUT.DIR@: Geben Sie hier das Verzeichnis an, in dem die erstellten XHTML-Dateien abgespeichert werden sollen. Verwenden Sie als Trennzeichen ${file.separator} zwischen den Verzeichnis- und Dateinamen.

In <property name="dita.dir" value="${basedir}${file.separator}.."/> ist der Pfad zum DITA Open Toolkit angegeben. ${basedir} ist dabei das Installationsverzeichnis des DITA Open Toolkits. Da die template_xhtml.xml-Datei im ant-Verzeichnis des DITA Open Toolkits liegt, verweist der Wert auf das nächsthöhere Verzeichnis. Abhängig davon, wo Sie Ihre ANT Build-Datei ablegen, ist dieser Wert zu ändern.

Mit dem vollständigen Paket des DITA Open Toolkits starten Sie eine Produktion der XHTML-Dateien wie folgt:

  1. Starten Sie die startcmd.bat-Datei.
  2. Wechseln Sie in das Verzeichnis, in dem Ihre ANT Build-Datei liegt.
  3. Geben Sie ant -f mein_projekt.xml ein.
  4. Bestätigen Sie Ihre Eingabe.

Nach einer erfolgreichen Verarbeitung wird die Meldung BUILD SUCCESSFUL angezeigt.

ANT Build-Datei zur Produktion von PDF

Als Vorlage für die ANT Build-Datei zur Produktion von PDF wird die template_pdf.xml Datei aus dem ant-Verzeichnis des DITA Open Toolkits verwendet.

<?xml version="1.0" encoding="UTF-8"?>
<project name="@PROJECT.NAME@_pdf" default="@DELIVERABLE.NAME@2pdf" basedir=".">
  <property name="dita.dir" value="${basedir}${file.separator}.."/>
  <import file="${dita.dir}${file.separator}integrator.xml"/>
  <target name="@DELIVERABLE.NAME@2pdf" depends="integrate">
    <ant antfile="${dita.dir}${file.separator}build.xml" target="init">
      <property name="args.input" value="@DITA.INPUT@"/>
      <property name="output.dir" value="@OUTPUT.DIR@"/>
      <property name="transtype" value="pdf"/>
    </ant>
  </target>
</project>

Um die template_pdf.xml-Datei für Ihr Projekt anzupassen, sind die Platzhalter wie folgt zu ersetzen:

  • @PROJECT.NAME@_xhtml: Geben Sie hier den Dateinamen ohne Dateiendung ein, den Sie der ANT Build-Datei vergeben. Zum Beispiel mein_projekt.
  • @DELIVERABLE.NAME@2xhtml: Den Namen des zu produzierenden Ausgabemediums können Sie frei wählen.
  • @DITA.INPUT@: Geben Sie hier den Pfad zu dem Verzeichnis an, in dem sich die Map befindet, die verarbeitet werden soll. Verwenden Sie als Trennzeichen ${file.separator} zwischen den Verzeichnis- und Dateinamen.
  • @OUTPUT.DIR@: Geben Sie hier das Verzeichnis an, in dem die erstellten XHTML-Dateien abgespeichert werden sollen. Verwenden Sie als Trennzeichen ${file.separator} zwischen den Verzeichnis- und Dateinamen.

In <property name="dita.dir" value="${basedir}${file.separator}.."/> ist der Pfad zum DITA Open Toolkit angegeben. ${basedir} ist dabei das Installationsverzeichnis des DITA Open Toolkits. Da die template_xhtml.xml-Datei im ant-Verzeichnis des DITA Open Toolkits liegt, verweist der Wert auf das nächsthöhere Verzeichnis. Abhängig davon, wo Sie Ihre ANT Build-Datei ablegen, ist dieser Wert zu ändern.

Mit <property name="transtype" value="pdf"/> wird angegeben, dass die PDF-Dateien mit dem Standardmechanismus zur Generierung von PDF-Dateien erzeugt werden, das heißt mit den XSLT-Stylesheets des DITA Open Toolkits und dem Apache FOP.

Wenn Sie den Wert für den Transformationstyp auf pdf2 setzen, also <property name="transtype" value="pdf2"/>, so werden die PDF-Dateien über das FO-Plugin erzeugt, insofern es installiert ist.

Mit dem vollständigen Paket des DITA Open Toolkits starten Sie die Produktion der PDF-Datei wie folgt:

  1. Starten Sie die startcmd.bat-Datei.
  2. Wechseln Sie in das Verzeichnis, in dem Ihre ANT Build-Datei liegt.
  3. Geben Sie ant -f mein_projekt.xml ein.
  4. Bestätigen Sie Ihre Eingabe.

Nach einer erfolgreichen Verarbeitung wird die Meldung BUILD SUCCESSFUL angezeigt.

  

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