This topic explains how to install the DITA Toolkit processing environment.
You can download and install the Java Development Kit (JDK) 1.5 (available onhttp://java.sun.com/j2se/index.jsp) into a directory of your choice.
You can download and extract Saxon (available at http://saxon.sourceforge.net/) or the Xalan-J (available at http://xml.apache.org/xalan-j/downloads.html) into a directory of your choice.
The following steps guide you to set up the DITA Toolkit processing environment.
For example: c:\pkg\DITA-OT1.0
set JAVA_HOME=<JDK_dir>
Option | Description |
---|---|
If you use the Saxon, |
|
If you use the Xalan, |
|
JavaHelp is free software that can build online help for operating systems, applications, and devices. If you have set up JavaHelp, the DITA Open Toolkit can build online Java help by invoking JavaHelp software. To download and install JavaHelp software, go to http://java.sun.com/products/javahelp/download_binary.html
FOP (Formatting Objects Processor) is a Java application and is the print formatter driven by XSL formatting objects (XSL-FO). FOP reads a formatting object tree and transforms the object to PDF output. If you have set up FOP, the DITA Open Toolkit can build PDF output by invoking FOP. To download and install the binary distribution for FOP, go to http://xml.apache.org/fop/download.html
Microsoft HTML Help Workshop is a program designed to create and compile .CHM help files using HTML source files. If you have set up Microsoft HTML Help Workshop, the DITA Open Toolkit can build .CHM help files by invoking the Workshop. To download and install Microsoft HTML Help Workshop, go to http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp
If you have installed one or more of these optional build tools, you should choose the following options to set up.
Option | Description |
---|---|
If you have installed the JavaHelp, | set
up the environment variable JHHOME to
your installation directory for JavaHelp. For example: set JHHOME=<javahelp_dir> |
If you have installed the FOP, | set
up your environment variable CLASSPATH to include the
fop.jar, batik.jar and avalon.jar files in the FOP
directory. For example: set CLASSPATH=%CLASSPATH%;<fop_dir>\build;<fop_dir>\lib |
If you want to build HTML Help output, | install Microsoft HTML Help Workshop to the default directory. |
You can do the following steps under the command prompt to test whether the DITA Toolkit and the XSLT engine are successfully installed.
For example:c:\pkg\DITA-OT1.0\doc>java org.apache.xalan.xslt.Process -in DITA-readme.xml -xsl ..\xsl\pretty.xsl -out ..\DITA-readme.xml
For example:c:\pkg\DITA-OT1.0\doc>java com.icl.saxon.StyleSheet DITA-readme.xml ..\xsl\pretty.xsl > ..\DITA-readme.xml
Run all demo in the DITA Toolkit directory.
For example: c:\pkg\DITA-OT1.0>ant all
Or you can run specific file individually.
For example:c:\pkg\DITA-OT1.0\ant samples.web
The software that DITA OT depend on are redistributed. The full distribution package of DITA OT after 1.3 includes the software, so the configuration process is streamlined.
The following steps guide you to set up the DITA Toolkit processing environment in Linux.
export JAVA_HOME=<JDK_dir>
export PATH=$JAVA_HOME/bin:$JAVA_HOME/jre/bin:$PATH
export CLASSPATH=$CLASSPATH:$JAVA_HOME/lib:$JAVA_HOME/jre/lib:<dita_dir>/lib/dost.jar
Option | Description |
---|---|
If you use the Saxon, |
|
If you use the Xalan, |
|
Option | Description |
---|---|
If you have installed the JavaHelp, | set
up the environment variable JHHOME to your installation
directory for JavaHelp. For example: export JHHOME=<javahelp_dir> |
If you have installed the FOP, | set
up your environment variable CLASSPATH to include
the fop.jar, batik.jar and avalon.jar files in
the FOP directory. For example: export CLASSPATH=$CLASSPATH:<fop_dir>/build:<fop_dir>/lib |
If you want to build HTML Help output, | install Microsoft HTML Help Workshop to the default directory. |