Generating EPUBs From OxygenXML

You can configure a DITA transformation scenario in OxygenXML to generate EPUBs.

You must have the EPUB plugin deployed to the Open Toolkit used by OxygenXML, normally in the frameworks/dita/DITA-OT directory under Oxygen's installation directory. You can also use a different Toolkit by changing the value of the dita.dir Ant parameter. OxygenXML comes with the EPUB transform pre-installed by default.

These instructions reflect Oxygen version 16 and later (at least through version 18):

To set up an EPUB transformation scenario in OxygenXML, do the following.

  1. From either the main editing window or the DITA Maps Manager, open the "Configure Transformation Scenario" dialog (the little wrench and red arrow button in the toolbar).
  2. Select "DITA OT Transformation" from the Scenario Type pulldown.
  3. Select the "DITA Map EPUB" transform and press the Duplicate button.

    The "Edit Scenario" dialog should open.

  4. Adjust the scenario name as you see fit to make it easy find later.
  5. Select the OK button to save the scenario.

    You should see your new scenario in the list of available DITA OT transformation scenarios.

The scenario should be ready to use. You can test it by applying it to any DITA map. The EPUB file is generated in whatever you've configured as the output directory using the normal output location configuration (as specified in the Output tab of the transformation scenario configuration dialog; the default is out/epub in the directory containing the input map).

If you select the "Open in browser" option in the transformation scenario's output options and you have an application associated with .epub files, such as Adobe Digital Editions, the newly-generated EPUB should open in that application. Note that in OxygenXML 12 and later you have the option of associating EPUB files with OxygenXML, which can open them in its Archive Browser. If you have that association, then doing "Open in browser" will open the EPUB in OxygenXML, not in an EPUB viewer.

You can edit the scenario to add additional EPUB parameters as necessary. Simply open the scenario in the Scenario Editor, select the "add parameter" button, and create the parameter. The EPUB-specific parameters are documented in EPUB and Kindle Transformation Parameters.