Calls to the DITA Open Toolkit

IXIA CCMS Output Generator calls the DITA Open Toolkit (DITA-OT) in the same way as the DITA-OT dita command and passes a properties file and either a Windows build.bat file or a Linux build.sh file.

The CCMS Output Generator calls the DITA-OT in the following sequence:
  1. CCMS Output Generator creates the build.bat or build.sh file required to build a DITA-OT output. A typical build.bat file created by the CCMS Output Generator for a PDF transformation might look as follows:
    @echo off
    "C:\OutputGenerators\20200310_6.1.36\data\dita-ot-3.4\bin\dita" ¶
    -i "C:\OutputGenerators\20200310_6.1.36\temp\PDF-34.whitel.43.1585236018430\content\authoring\pbn1584670547359.ditamap" ¶
    -f pdf -o "C:\OutputGenerators\20200310_6.1.36\temp\PDF-34.whitel.43.1585236018430\out" ¶
    -propertyfile "C:\OutputGenerators\20200310_6.1.36\temp\PDF-34.whitel.43.1585236018430\build.properties" -v
    Note: The ¶ symbol indicates a line break inserted in the code sample for clarity and ease of reading. In an actual build.bat file, all the information is on a single line.

    A typical build.sh file might look as follows:

    [need example]

    This file functions as a command line that specifies the DITA OT to use, the input ditamap, the transformation type, the output location, and the properties file to use. It also specifies that the log file should be verbose, to ensure you get all the troubleshooting information you need.

  2. CCMS Output Generator also creates a build.properties file similar to the following:
    #Ant properties
    #Thu Mar 26 10:20:20 CDT 2020
    args.draft=yes
    args.filter=C\:\\OutputGenerators\\20200310_6.1.36\\temp\\PDF-34.whitel.43.1585236018430\\pbn1584670547359.ditaval
    args.rellinks=none
    clean.temp=yes
    dita.dir=C\:\\OutputGenerators\\20200310_6.1.36\\data\\dita-ot-3.4
    dita.temp.dir=C\:\\OutputGenerators\\20200310_6.1.36\\temp\\PDF-34.whitel.43.1585236018430\\temp
    pdf.formatter=fop
    retain.topic.fo=yes
    transtype=pdf

    This file specifies the ditaval file to use (if you selected one) and additional build properties, such as the PDF renderer, the transformation type, whether the output is draft or should include related links, and more.

  3. CCMS Output Generator then forks a shell environment that is equivalent to the DITA-OT dita command and executes the build.bat or build.sh file it just created.