Skip to content
Branch: develop
Go to file
Code

Latest commit

infotexture committed 13a90fc Jul 2, 2020
Signed-off-by: Roger Sheen <roger@infotexture.net>

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time

README.md

DITA Open Toolkit Docs Build Status Slack

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:

Building the documentation output

⚠️ Important: The maps in this repository contain references to additional topics that are created at build time from the toolkit’s plug-in configuration.

To generate the missing topics and build the HTML and PDF versions of the documentation, 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.

Prerequisites

You must have a JRE and a local installation of DITA-OT. There is no need to download and install Gradle.

Steps

  1. Open a command prompt, and change to the location of your local repository for the documentation source.

  2. Type a variant of the following command for your operating system, adjust the path to your DITA-OT installation, and press Enter:

    • On Linux or macOS, use ./gradlew:

      ./gradlew -PditaHome=/path/to/dita-ot
      
    • On Windows, use gradlew.bat:

      gradlew.bat -PditaHome=C:\path\to\dita-ot
      
    Using a `dita-ot` repository clone
    • If you’re using a clone of the DITA-OT development repository as your toolkit installation alongside your clone of the docs repository, run the build script on Linux or macOS like this:

        ./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
      

Results

If all goes well, you receive a "BUILD SUCCESSFUL" message, and the generated DITA topics are written to the extension-points and parameters directories in the out folder of the docs repository.

This folder is created automatically if it doesn’t exist. (Git ignores the contents so you don’t inadvertently commit these transient output 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 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.

You can’t perform that action at this time.