Edit online

DITA Open Toolkit Frequently Asked Questions (FAQ)

Read time: 6 minute(s)

I tried to put together below a set of frequently asked questions and useful links about the DITA Open Toolkit.

What is the DITA Open Toolkit?

The DITA Open Toolkit is a publishing tool used to convert DITA content into various output formats. It's official web site, containing download links and documentation can be found here: http://www.dita-ot.org/.

How do I use the DITA Open Toolkit?

You can download, install and build output from DITA content using the command line.

Besides this, there are applications which come with the DITA Open Toolkit bundled. For example Oxygen XML Editor comes bundled usually with the latest bundled DITA Open Toolkit. Oxygen provides visual means to run the bundled DITA Open Toolkit using a concept called transformation scenarios.

What version of DITA Open Toolkit should I use?

You should try to use the latest DITA Open Toolkit release available on the official download page.

What outputs can I obtain using the DITA Open Toolkit?

The entire set of default available output formats is available here: https://www.dita-ot.org/dev/topics/output-formats.html. But the DITA Open Toolkit can be enhanced by installing plugins to provide additional output formats.

What is the general architecture of the DITA Open Toolkit?

The DITA Open Toolkit is a quite large mixture of ANT build scripts, Java libraries and XSLT scripts. It has a pipeline-based architecture which uses plugins to publish DITA content to various output formats. Most of the DITA Open Toolkit customizations that you want to make in order to add new publishing capabilities or to customize existing publishing choices can be made without modifying its internal core.

What is a DITA Open Toolkit plugin?

A DITA Open Toolkit plugin can either provide a new publishing format, customize an existing publishing stage or provide a DITA specialization vocabulary. The plugin can use one of the numerous extension points available in the DITA Open Toolkit: https://www.dita-ot.org/dev/extension-points/plugin-extension-points.html.

Once you have created a plugin you can install it in the DITA Open Toolkit either by manual installation or using the new automated installation procedure.

How do I customize the HTML-based outputs?

There are a number of parameters which can be set to customize the HTML-based outputs:http://www.dita-ot.org/dev/parameters/parameters-base-html.html. For example you can specify your own CSS stylesheet to be used with the generated HTML output.

You can also create a plugin to customize the HTML outputs by adding a custom XSLT stylesheet: Creating a simple DITA Open Toolkit plugin to customize published HTML and PDF content.

How do I customize the PDF output?

Oxygen comes bundled with a DITA Open Toolkit plugin which uses CSS to style the DITA content and produce PDF: https://www.oxygenxml.com/doc/ug-editor/topics/pdf-css-customization.html. This plugin is free to use from inside Oxygen but is part of a commercial product if you want to automate the publishing on the server side. This is our recommended plugin for publishing DITA to PDF.

In addition the DITA Open Toolkit comes bundled with a free PDF generation plugin which uses XSL-FO. The PDF output is obtained by passing the original DITA content to XSL-FO and then generating PDF using an XSL-FO processor. The default bundled and used XSL-FO processor is the Apache FOP but you can also install separately and use commercial PDF processors like Antenna House or RenderX XEP.

You can customize the PDF output either using a PDF customization folder or by creating a PDF customization plugin.

There are a number of other solutions for obtaining PDF from DITA: Possibilities to obtain PDF from DITA.