Add and configure output types

You add and configure output types in the Outputs tab of the Build Manifest window.

For each output type, you define the following information in the Output type information area:
  • Type: Name of the output type from the Output Generator.
    Note: You need to be connected to a running Output Generator before you can define output types. The Build Manifest feature retrieves the list of available output types from the running Output Generator.
  • Status: Specifies whether the output type is enabled or not. This can be useful if you want to configure an output type without generating it right away. When set to DISABLED, the output type will not be generated when you output the Build Manifest.
  • Description: Description of the output type.
You can also override the following values for the output type:
  • Ditaval: Ditaval file that will be used for this output type. If you specify a ditaval file for the output type, the default ditaval file specified in the Default values tab (if any) will be ignored.
  • Languages: Languages that will be used for this output type. If you specify a language for the output type, the default language(s) specified in the Default values tab (if any) will be ignored.
  • User parameters: User parameters that will be used for this output type. These are the user parameters that are defined in the transformation scenario for the output type. If you specify parameters for the output type, the default parameters specified in the Default values tab (if any) will be ignored. The name specified in the Key must match *exactly* the name of the user parameter as defined in the preprocessors.xml file of the Output Generator.
    Important: User parameters are not cumulative. For example, if you set parameter values at the Default level and then set other parameter values at the Output type levels, only the parameters set at the Output type level will be used.
To add output types:
  1. In the Build Manifest window, click the Outputs tab.
    The Output types tab is displayed:
    Build Manifest Outputs tab

    Depending on the Build Manifest template that you are using, one or more output types may already be defined.

  2. To add a new output type, right-click in the Output types area and select Add.
    A new output type is added in the Output types area. By default, the output type is enabled, meaning that it will get generated.
  3. Select the new output type and specify the information for this type in the Output type information area, as follows:
    Option Description
    Type Select the output type
    Note: If the Type field is displayed in red and you cannot select an output type, this means that there is no Output Generator running. You must connect to a running Output Generator before you can configure an output type.
    Status Select one of the following:
    • To generate this output type when you generate the build manifest, select Enabled.
    • Otherwise, select Disabled.
    Description Enter a description for this output type.
  4. To configure a ditaval file, user parameters, or languages specifically for this output type, select the output type and click Override default ditaval/languages/parameters.
    The Overridden output values area appears.
  5. To override a ditaval file:
    1. In the Ditaval field, click the ... button.
      The Ditaval dialog is displayed.
    2. Select the ditaval file to use and click OK.
  6. To override languages, select the languages in the Languages field.
  7. To override user parameters:
    1. In the User parameters area, right-click the area and select Add.
      The User parameters window is displayed.
    2. In the Key field, enter the name of the user parameter.
      Note: The name specified in the Key must match *exactly* the name of the user parameter as defined in the preprocessors.xml file of the Output Generator; for example, ixia.args.rellinks.
    3. In the Value field, enter the value for this user parameter.
    4. Click OK.
      The parameter is added to the window.
    5. Repeat for every default user parameters that must be set.
  8. Repeat this procedure for every output type to generate.
  9. Save the Build Manifest.

The following diagram shows the Output type tab for the CMS User Guide. Six output types are created for this document:

  • 2 Dita2PDF (one oXygen and one XMetaL)
  • 2 Dita2xhtml (one oXygen and one XMetaL)
  • 2 Dita2EclipseHelp (one oXygen and one XMetaL)

This is necessary since the oXygen and XMetaL versions require different ditaval files and user parameters.

Build Manifest Output Type tab (filled)

The final step is to output the Build Manifest.