Chapter 1. Installing XMLmind DITA Converter Previous topic Parent topic Child topic Next topic

Before you begin

XMLmind DITA Converter (ditac for short) requires the Sun or Apple Java™ runtime 1.5 or above.
On Unix, make sure that the Java bin/ directory is referenced in the $PATH and, at the same time, check that the Java runtime in the $PATH has the right version:
$ java -version
java version "1.6.0_16"
Java(TM) SE Runtime Environment (build 1.6.0_16-b01)
Java HotSpot(TM) Server VM (build 14.2-b01, mixed mode)
On Windows and on the Mac, this verification is in principle not needed as the java executable is automatically found in the $PATH when Java has been properly installed.

Procedure

  1. Unzip the distribution in any directory you want.
    C:\> mkdir ditac
    C:\> cd ditac
    C:\ditac> unzip ditac-1_2_0.zip
    C:\ditac> dir ditac-1_2_0
    ... <DIR> bin
    ... <DIR> doc
    ... <DIR> docsrc
    ...
    XMLmind DITA Converter is intended to be used directly from the ditac-1_2_0/ directory. That is, you can run the ditac command by simply executing (in a Command Prompt on windows, a terminal on Unix):
    C:\ditac> ditac-1_2_0\bin\ditac
  2. Depending the output formats you want to generate, you'll need to download and install third-party external tools.
  3. If you have installed any of the above external tools, you need now to instruct ditac where to find them. This can be done using the following command line options: -fop, -xep, -xfc, -jhindexer, -hhc. However, it is much more convenient to specify these command-line options once for all in a ditac.options file.
    1. Create ditac.options, a plain text file encoded using the native encoding of the platform (e.g. Windows-1252 on a Western Windows PC), in the ditac user preferences directory.
      The ditac user preferences directory is:
      • $HOME/.ditac/ on Linux.
      • $HOME/Library/Application Support/XMLmind/ditac/ on the Mac.
      • %APPDATA%\XMLmind\ditac\ on Windows 2000, XP, Vista, 7.
        Example: C:\Documents and Settings\john\Application Data\XMLmind\ditac\ on Windows 2000 and XP. C:\Users\john\AppData\Roaming\XMLmind\ditac\ on Windows Vista and 7.
    2. Add the equivalent of a command-line option for each external tool installed in the preceding step. Use one or more newline characters to separate the options. More information in The ditac.options file.
      -fop E:\opt\fop-0.95\fop.bat
      
      -xfc E:\opt\xfc_perso_java-4_3_1\bin\fo2rtf.bat
      
      -jhindexer E:\opt\javahelp\javahelp\bin\jhindexer.bat
      
      -hhc "C:\Program Files\HTML Help Workshop\hhc.exe"

1. Contents of the installation directory Previous topic Parent topic Child topic Next topic

bin/ditac, ditac.bat
Scripts used to run XMLmind DITA Converter (ditac for short). Use ditac on any Unix system. Use ditac.bat on Windows.
doc/index.html
Contains the documentation of ditac. XMLmind DITA Converter Manual is available in all the output formats supported by ditac. You'll also find there the reference manual of the API of ditac (generated by javadoc).
docsrc/manual/
Contains the DITA source of XMLmind DITA Converter Manual.
LEGAL/, LEGAL.txt
Contains legal information about ditac and about third-party components used in ditac.
lib/
All the (non-system) Java™ class libraries needed to run ditac:
ditac.jar
contains the code of XMLmind DITA Converter.
resolver.jar
is Apache XML Commons Resolver Opens in new window which implements catalog-based entity and URI resolution.
saxon9.jar
is Michael Kay's XSLT 2.0 engine. See http://www.saxonica.com/ Opens in new window.
schema/
Contains the DTD and the W3C XML Schema of DITA 1.1 and DITA 1.0.1. schema/catalog.xml is an XML catalog which points to these local copies.
src/
Contains the Java source code of ditac. src/build.xml is an ant Opens in new window build file which allows to rebuild lib/ditac.jar.
xsl/
Contains the XSLT 2.0 Opens in new window stylesheets used to convert DITA documents to a variety of formats.