Overview of the Output Generator process

IXIASOFT CCMS Output Generator is the component that executes the transformation processes, which transform content in DITA files to a specified output type, such as PDF, HTML, XML, or CHM.

Transformation processes are called transformation scenarios in CCMS Output Generator. The basic CCMS Output Generator installation provides five default transformation scenarios:

  • The Dita2Pdf scenario generates PDF documents.
  • The Dita2EclipseHelp scenario generates Eclipse help.
  • The Dita2htmlhelp scenario generates HTML help (.chm file).
  • The Dita2xhtml scenario generates HTML files.
  • The Export scenario exports topics so that they can be reused in another project.
    Note: If you are using the DRM module, use the Export[DRM] transformation scenario.

This section describes the process for generating outputs. Understanding this process will help you configure CCMS Output Generator for your transformation requirements.

There are three main concepts in the process for generating outputs:
  • Output Generation dialog box
  • Configuration files
  • Output directories

Output Generation dialog

To generate the output of their DITA files, users select the map, topic, or image to transform and right-click Generate Output in IXIASOFT CCMS Desktop. In IXIASOFT CCMS Web, users can only generate output from maps. This command triggers the process that will transform source DITA files into one of the output types configured.

The following diagram shows a typical Output Generator dialog for CCMS Desktop and CCMS Web, displayed when users select Generate Output:

Sample Output Generator dialog: Desktop
Sample Output Generator dialog: Web

This dialog allows users to specify the following:

  • Output type: Type of output into which the source DITA files will be transformed, such as PDF, Eclipse Help, HTML, or Export. (Mandatory.)
  • User parameters: Parameters that can be specified by users when generating the output. For example, they can be used to determine which cover page to use on a PDF file. These parameters are set up in the CCMS Output Generator configuration files. (Optional.)
  • DITAVAL: Ditaval file to apply to the source DITA files to transform them. These files are created using the IXIASOFT CCMS. Note that if there are no ditaval files created, this field does not appear on the Generate Output dialog. (Optional.)

Configuration files

CCMS Output Generator uses three main configuration files to determine the transformation scenario to execute:
  • Output type file (outputtypes.xml): Defines the types of output into which users can transform their DITA files (for example, PDF, HTML help, Eclipse help, etc.).
  • Preprocessor file (preprocessors.xml): Defines user parameters and links the output type selected by the user to the conductor file used to transform the content.
  • Conductor file (for example conductor-ot.xml): Contains the Apache Ant tasks (called targets) that will be executed to transform the source file.

Output directories

Two main directories are used during the process for generating outputs:
  • Temporary working directory (also called job directory): Contains the source files extracted from IXIASOFT TEXTML Server.
  • Output directory: Contains the result of the output generation process (for example, the PDF file, or HTML output) and may also contain the log files. This directory will be returned to the user.

Output Generator process

The following diagram show at a high-level how CCMS Output Generator interacts with the other IXIASOFT CCMS components to generate the output:
High-level Output Generator process
  1. In CCMS Desktop or CCMS Web, the user selects Generate Output for an object.
  2. The CCMS retrieves the available output types from CCMS Output Generator and displays the dialog to the user.
  3. The user selects the output type, user parameters, and Ditaval file, as appropriate, and clicks Create.
  4. The CCMS sends the output information to CCMS Output Generator.
  5. CCMS Output Generator retrieves the files to transform from the TEXTML Server.
  6. The transformation scenario is executed.

  7. (For CCMS Desktop) CCMS Output Generator returns the zipped output to the user.

    (For CCMS Web) CCMS Output Generator saves the output to the app server.

  8. In CCMS Desktop, a dialog appears in which the user can select where to save the job.

    In CCMS Web, the user can access the My Outputs page to download the output as a ZIP file.