Create a DITA-OT Scenario

Administrators can create the DITA-OT publishing scenarios by using the Plugins interface.

Do the following:
  • If needed, upload the plugin that you want to use in the publishing scenario. See Upload a DITA-OT Plugin.
  • If needed, upload the required DITA-OT publishing engine version. See Upload a DITA-OT Publishing Engine.
    Remember: Some DITA-OT plugins may require a specific version of the DITA-OT publishing engine. You can use different DITA-OT publishing engines and plugins in different publishing scenarios.
  1. In the Main Menu , click Plugins.
  2. If needed, select DITA Open Toolkit.
  3. In the Scenarios list, click New.
  4. In the Add a New Publishing Scenario screen, do the following:
    1. Fill in the Scenario Name field.
    2. From the Select DITA Open Toolkit drop-down menu, select a DITA-OT publishing engine version that you want to use.
    3. From the DITA-OT Version drop-down menu, select the version of the DITA-OT that corresponds with the version you just selected.
    4. Near the Select Ant File to Run field, click Change and select the build file.
      Tip: The default ANT file is the build.xml file in the main directory of a DITA-OT publishing engine.
  5. Add publishing scenario parameters by doing the following:
    1. Click Add a Parameter.
    2. Fill in the Parameter Name field.
      For more information on available parameters, see https://dita-ot.org.
      A common parameter is transtype. It lists transformation types. Enter pdf, html5, or htmlhelp).
    3. From the Select Parameter Type drop-down menu, select a parameter type set the related options.
      Simple String Value
      Enables you to enter a value for a parameter. By default the value cannot be changed while publishing.

      The User Settable? option enables you to change the value while publishing.

      User Select Box
      Enables you to provide different values of a given parameter. You can choose from these values while publishing.

      The Add Option button enables you to add more values. The X icon icon enables you to remove a value.

      Figure 1. User Select Box Parameter.

      In the following example, the args.draft parameter values yes or no can be selected while publishing.

      User select box parameter
      File Reference
      Enables you to provide a path to a file as a value of a given parameter. The value cannot be edited while publishing.
      Figure 2. File Reference Parameter.

      In the following example, the args.css parameter value is a file path to the custom.css file.

      File Reference Paramter
      Runtime File Picker
      Enables you to select a file used as the parameter value while publishing.
      Figure 3. Runtime File Picker Parameter.

      In the following example, the args.filters value can be set while publishing by selecting a file.

      Runtime File Picker Parameter example
  6. If needed, add another parameter by repeating 5.
  7. If needed, remove a parameter by clicking the corresponding "X" icon.
  8. If you use custom plugins in the publishing scenario, in the Select DITA OT Plugins pane on the right, ensure that the custom plugins are selected.
  9. Click Save.
Your publishing scenario is now available in the publishing interface.