Step 1 (optional): Download another version of the DITA-OT

The DITA Open Toolkit (DITA-OT) website provides all the DITA-OT versions.

When you download a new version of the DITA Open Toolkit, it must be stored in the %OutputGenDir%/data folder, with the following naming convention:
  • DITA-OT 1.x family: DITA-OTversion
  • DITA-OT 2.x and 3.x family: dita-ot-version
Note: These folder names are those defined by the DITA-OT. IXIASOFT CCMS Output Generator assumes that the DITA-OT files are stored in a directory that follows this naming convention. In other words, leave the folder name as-is when you extract the zip file.

Where version is the DITA-OT version number. For example:

C:\Ixiasoft\OutputGenerators\OutputGen_Prod_[version]\data\DITA-OT1.8.5
C:\Ixiasoft\OutputGenerators\OutputGen_Prod_[version]\data\dita-ot-2.5.4
C:\Ixiasoft\OutputGenerators\OutputGen_Prod_[version]\data\dita-ot-3.4.1

Where [version] is replaced by the CCMS Output Generator release version number.

To download another version of the DITA-OT:

  1. Go to the DITA Open Toolkit download website:

    http://www.dita-ot.org/download.html

  2. Download the package for the version of the DITA-OT that you need.
    The DITA-OT is packaged as a .zip (Windows) or .tar.gz (Unix) file.
  3. Extract the file to the %OutputGenDir%/data folder, keeping the folder name as-is.
  4. Copy the following plugins from the %OutputGenDir%/data/dita-ot-2.5.4/plugins directory (or whichever DITA-OT you have been using) to the %OutputGenDir%/data/%NewOT_Dir%/plugins directory (for example, %OutputGenDir%/data/dita-ot-3.4.1/plugins):
    • com.ixiasoft.dita13.dtd (if you are using DITA 1.2, you will see com.ixiasoft.dita.dtd instead)
    • com.ixiasoft.images
    • com.ixiasoft.pdf.review20
    • org.w3c.mathml3 (present only if you are using DITA 1.2)
    • org.oasis-open.dita.mathml.doctypes (present only if you are using DITA 1.2)
    • org.w3c.svg1.0
    • org.w3c.svg1.1
    • org.w3c.html.doctypes
    • org.w3c.xhtml.doctypes
  5. Copy your custom plugins from your previous DITA-OT plugins folder to the plugins folder of the new DITA-OT.

    For example, your custom DTD plugin and your custom output plugins.

    Note: If your output plugins were developed for an earlier version of the DITA-OT, it is possible they will not work with a newer version. You might need to upgrade your plugins to use a newer version of the DITA-OT.
  6. Copy any custom DITA-OT changes from %OutputGenDir%/data/%OldOT_Dir%/resource to %OutputGenDir%/data/%NewOT_Dir%/resource.
    Note: See the DITA-OT documentation for more information.
  7. Make a copy of one of the following .bat (Windows) or .sh (Linux) file in the %OutputGenDir%/data/ subfolder of the CCMS Output Generator
    • On Windows: copy one of the _DITA-OT-x.x.x-integrator.bat or _DITA-OT-x.x.x-install.bat files
    • On Linux: copy one of the _DITA-OT-x.x.x-integrator.sh or _DITA-OT-x.x.x-install.sh files
  8. Change the file's name to reflect the version of the new DITA-OT you are installing.
  9. Edit the file to change the DITA-OT version number.
    • On Windows: its line 23 of the .bat file.
    • On Linux: its line 19 of the .sh file.
  10. Run the DITA-OT integrator.
    This step depends on the DITA-OT family:
    DITA-OT 1.x family:
    • If lower than 1.6.2, contact IXIASOFT Customer Support.
    • On Windows: In the %OutputGenDir%/data/ directory, double-click the _DITA-OT-1.x.x-integrator.bat file.
    • On Linux:
      1. In the %OutputGenDir%/data/%OT_Dir%/ directory, run the following command as root:
        startcmd.sh
      2. At the command prompt, enter:
        ant -f integrator.xml

    The integration build runs and you should soon see BUILD SUCCESSFUL.
    DITA-OT 2.x and 3.x family:
    • On Windows: In the %OutputGenDir%/data/ directory, double-click the _DITA-OT-x.x.x-install.bat.
    • On Linux: In the %OutputGenDir%/data/ directory, double-click the _DITA-OT-x.x.x-install.sh.

    The integration build runs and you should soon see BUILD SUCCESSFUL.
    Note: If a message similar to the following is displayed:
    Unable to locate tools.jar. Expected to find it in C:\Program Files\Java\jre6\lib\tools.jar
    This message means that you are using a JRE instead of a JDK to run CCMS Output Generator. You can ignore this message if you do not need to compile Java classes in your plugin. Otherwise, you must configure CCMS Output Generator to run the JDK instead of the JRE. Update this information in the wrapper.conf file. For more information, see Installing IXIASOFT CCMS Output Generator .