Login
Home CMS Documentation Home CMS 10 DITA Processing Pipeline in Ingeniux CMS Initial DITA Configuration DITA Administration DITA Open Toolkit Parameters Setting DITA-OT Advanced Parameters

Setting DITA-OT Advanced Parameters

The Advanced Parameters tab contains defines advanced parameters and allows administrators to add any parameters not listed, to modify existing ones, or to remove parameters.
Important
Administrators can get a better understanding of the behavioral implications of each advanced setting by consulting the DITA-OT Parameter Documentation. Keep in mind that these parameters may have nuanced differences from version to version of the DITA-OT, so be sure to match the documentation version you reference with the installed DITA-OT version.
To modify or set a DITA-OT parameter:
  1. Navigate to Administration > DITA > DITA-OT Parameters.
    The Common Parameters and Advanced Parameters tabs display.
  2. Select the Advanced Parameters tab.
    Parameters with defined values currently applied to CMS DITA-OT transformations display in the Advanced Parameters tab.
    Note
    This list also includes your parameters defined from the Common Parameters tab.

    Advanced Parameters Tab

  3. Choose one of the following actions:
    • You can change the initial default values of parameters in the list or change any parameter values you previously set. If you need to modify a predefined parameter, follow these steps:
      1. Click within the parameter's Value field.
      2. Select the appropriate value from the drop-down list.

        See the table below for details about common parameters defined in the list.

      ParameterOutput FormatsDefault ValueDescription
      args.draftGeneralnoSpecifies whether the content of <draft-comment> and <required-cleanup> elements is included in the output. The allowed values are yes and no.
      args.figurelink.styleGeneralNUMBER

      Specifies how cross references to figures are styled in output. The allowed values are NUMBER, TITLE, and NUMTITLE.

      Specifying NUMBER results in "Figure 5"; specifying TITLE results in the title of the figure. Corresponds to the XSLT parameter FIGURELINK.

      args.tablelink.styleGeneralNUMBER

      Specifies how cross references to tables are styled. The allowed values are NUMBER, TITLE, and NUMTITLE.

      Specifying NUMBER results in "Table 5"; specifying TITLE results in the title of the table. Corresponds to the XSLT parameter TABLELINK.

      force-uniqueGeneralfalse

      Generates @copy-to attributes to duplicate <topicref> elements.

      Setting this to true ensures that unique output files are created for each instance of a resource when a map contains multiple references to a single topic.

      org.dita.index.skipPDFnoDisables index processing.
      org.dita.pdf2.chunk.enabledPDFfalse

      Enables chunk attribute processing. The following values are supported:

      • true – Enables chunk processing
      • false – Disables chunk processing
      outer.controlGeneralwarn

      Specifies whether to warn or fail if content is located outside the directory containing the DITA map. The following values are supported:

      • fail – Fail quickly if files are going to be generated or copied outside of the directory.
      • warn – Complete the operation if files will be generated or copied outside of the directory, but log a warning.
      • quiet – Quietly finish without generating warnings or errors.
      pdf.formatterPDFfop

      Specifies the XSL processor. The following values are supported:

      • ah – Antenna House Formatter
      • xep – RenderX XEP Engine
      • fop – Apache FOP
      processing-modeGenerallax

      Specifies how DITA-OT handles errors and error recovery. The following values are supported:

      • strict – When an error is encountered, DITA-OT stops processing
      • lax – When an error is encountered, DITA-OT attempts to recover from it
      • skip – When an error is encountered, DITA-OT continues processing but does not attempt error recovery
    • You can add and configure individual parameters not already included in the Advanced Parameter tab list by following these steps:
      1. Select Add Parameters in the top right-hand corner of the Advanced Parameter tab.

        Add Parameters

        The Add DITA-OT Parameters dialog displays.

      2. In the left All Parameters column, select the DITA-OT parameter(s) you would like to apply. Selected parameters display in the right Selected Parameters to Add column.
        Additional Information
        Keep the following in mind:
        • Refer to DITA-OT documentation for descriptions of parameters not listed here.
        • Use the Search tool to filter parameters in the All Parameters column.

        • To remove individual parameters, select the Remove Parameter icon (X) to the right of the selected parameter in the Selected Parameters to Add column, or clear the selected parameter's checkbox in the All Parameters column.

        • To remove all parameters in the Selected Parameters to Add column, select Remove All.

        Add DITA-OT Parameters Dialog

      3. Select Add Parameters when you finish selecting parameters.
    • You can remove individual parameters from the Advanced Parameters list by selecting the respective Remove Parameter icon in the rightmost column.
      Troubleshooting
      The system prevents removing parameters from this list that are predefined in the Common Parameters tab. If you want to revert your modifications for these common parameters, set the parameters to their default values.

      Remove Parameter