More Resources
Table of Contents
More Resources
Set up a Publishing Scenario

Before you can publish with the DITA Open Toolkit, an administrator needs to set up publishing scenarios that will be selected by users to publish DITA topics and maps.
If you’re setting up a publishing scenario with a custom DITA-OT plugin, you’ll need to Upload a Plugin and Upload a DITA-OT before creating the publishing scenario.
You’re logged in as an administrator in the Dashboard interface and want to set up a publishing scenario.
  1. Under Administration, click Plugins.

    Step Information

    Expected Result
    The Plugins interface displays.

  2. Select DITA Open Toolkit.

    Expected Result
    The Configure the DITA Open Toolkit Plugin screen displays and lists all available scenarios, DITA OTs, and plugins.

  3. In the Scenarios list, click New.

    Expected Result
    The Add a New Publishing Scenario screen displays.

  4. In the Add a New Publishing Scenario screen, do the following:

    1. Enter a Scenario Name. This will be visible to end users when selecting a scenario in the Publication Manager
    2. Select the DITA Open Toolkit to use with this scenario.

      Step Information
      Remember:If you’re using a custom plugin in this scenario, you’ll also need to upload the correspending DITA Open Toolkit version the plugin is built on. For more information, see Upload a DITA-OT.
    3. Select an Ant file to run. Click Change, then select the Build file from the File Picker.

      Step Information
      Note:The default Ant script is “build.xml” in the root of the DITA OT folder.

  5. Click Add a Parameter.

    Step Information

    1. Enter a Parameter Name.

      Step Information

      Parameters must be expected by the Ant file you chose to run. If you selected the default build.xml in the DITA OT, there is a link to the DITA OT Parameter Reference in the right column of the Add a New Publishing Scenario screen.

      Example

      A common parameter is transtype. It lists the transformation types available in the toolkit (e.g. PDF, HTML Help, xhtml, etc.).

    2. Select a Parameter Type.

      Step Information

      There are four parameter types:

      1. Simple String Value
      2. User Select Box
      3. File Reference
      4. Runtime File Picker
      Example

      For the parameter transtype the Parameter Type is User Select Box, which will list a drop down of the transform types.

    • For a Simple String Value, enter a Value. You can allow users to modify a simple string value at publish by selecting the User Settable option.
    • For a User Select Box, you will need to add the Options you want to be present in the Select Box. For each option in the list box, click Add Option, then enter the text that will appear for that option in the list.
    • For a File Reference, click Change to choose a file with the File Picker. You may select files or folders with the file reference.
  6. To add additional parameters, click Add a Parameter, and repeat Step 5.
  7. (Optional) Under Select DITA OT Plugins, select a plugin.

    Step Information
    Remember:If you want to use a plugin in this scenario, you’ll need to Upload a Plugin first.
  8. Once you’ve specified all of the parameters for this scenario, click Save.

    Example
    Here’s an example of a publishing scenario:
    Expected Result

    You return to the Configure the DITA Open Toolkit Plugin screen and your new scenario is listed in the Scenarios list.

The new publishing scenario is now available for users to choose when publishing using the DITA Open Toolkit.