DITA Open Toolkit Docs

This repository tracks the documentation source files for the DITA Open Toolkit project.

Contribution Guidelines

We welcome contributions to the DITA-OT documentation. Please review the guidelines for contributing to this repository before creating issues or opening pull requests.

For best results, follow the coding guidelines and best practices outlined in the docs project wiki:

• Test before committing
• Commit related changes
• Commit often
• Write good commit messages
• Sign your work

Building the documentation output

To generate additional topics and build the HTML and PDF versions of the documentation as included in DITA-OT releases, run the Gradle build script from the root level of the docs repository and pass the path to your DITA-OT installation as a parameter:

./gradlew -PditaHome=../dita-ot/src/main

You can also specify a single output format. To build HTML output, enter the following on the command line:

./gradlew -PditaHome=../dita-ot/src/main html

Note: On Windows, use gradlew.bat and adjust the path to your DITA-OT installation:

gradlew -PditaHome=..\dita-ot\src\main

Output will be generated in the out folder of the docs repository. This folder is created automatically if it doesn't exist. (Git ignores the contents of this folder so you don't inadvertently commit these transient files.)

Building with development versions of DITA Open Toolkit

The develop branch of the documentation repository may depend on features from recent development versions of the DITA Open Toolkit.

To use these features when building the documentation, you may either download the latest development version of the distribution package, or clone the DITA-OT repository and install the bundled plug-ins via dita --install.