Skip to content
The DITA Open Toolkit is an implementation of the OASIS DITA specification.
Branch: develop
Clone or download
jelovirt Merge pull request #3289 from dita-ot/feature/accept-array-project-input
Support both single values and arrays are input value
Latest commit 4b9165f Apr 24, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Default to org-level community health files Mar 16, 2019
.travis Fix registry update script dependency version Mar 1, 2019
gradle Add license information for SnakeYAML Mar 30, 2019
src Use empty list instead of null for inputs and profiles Apr 23, 2019
.gitattributes Configure text file formats Jun 6, 2016
.gitignore Move messages back to root config directory Dec 12, 2018
.gitmodules Inline integration test submodule Sep 11, 2016
.travis.yml Pass all Maven deployment properties in Travis configuration Jan 20, 2019
LICENSE
README.markdown Default to org-level community health files Mar 16, 2019
build.gradle Remove obsolete demo build script Apr 22, 2019
gradlew Bump Gradle wrapper to latest patch release (5.2.1) Feb 9, 2019
gradlew.bat Bump Gradle wrapper to latest patch release (5.2.1) Feb 9, 2019
settings.gradle Move HTMLHelp Java code to plugin Jun 18, 2017

README.markdown

DITA Open Toolkit Build Slack

DITA Open Toolkit, or DITA-OT for short, is an open-source publishing engine for XML content authored in the Darwin Information Typing Architecture.

Visit the project website at dita-ot.org for documentation, information about releases, and download packages.

For information on additional DITA and DITA-OT resources, see SUPPORT. To report a bug or suggest a feature, create an issue. For more information on how you can help contribute to the project, see CONTRIBUTING.

Prerequisites: Java 8

  • To build DITA-OT, you’ll need Java Development Kit (JDK), version 8 or newer
  • To run DITA-OT, the Java Runtime Environment (JRE) is sufficient

You can download the Oracle JRE or JDK from oracle.com/technetwork/java.

Installing

  1. Download the distribution package from dita-ot.org/download.
  2. Extract the contents of the package to the directory where you want to install DITA-OT.

Installing on macOS via Homebrew

On macOS, you can also install DITA-OT using the Homebrew package manager:

brew install dita-ot

Homebrew will automatically download the latest version of the toolkit, install it in a subfolder of the local package Cellar and symlink the dita command to /usr/local/bin/dita.

Building output

You can generate output using the dita command-line tool included with DITA Open Toolkit.

  1. On the command line, change to the bin folder of the DITA-OT installation directory:

    cd path/to/dita-ot-dir/bin
    
  2. Run the dita command to generate output:

    dita --input=input-file --format=format [options]
    

    where:

    • input-file is the DITA map or DITA file that you want to process
    • format is the output format (or “transformation type”)

See the documentation for arguments and options.

For developers

Building the toolkit from source code and compiling the distribution package
  1. Clone the DITA-OT Git repository:

    git clone git://github.com/dita-ot/dita-ot.git
    
  2. Change to the DITA-OT directory:

    cd dita-ot
    
  3. Fetch the submodules:

    git submodule update --init --recursive
    
  4. In the root directory, run Gradle to compile the Java code and install plugins:

    ./gradlew
    

Distribution builds

  1. In the root directory, set up the build environment:

    ./gradlew
    
  2. Build the distribution packages:

    ./gradlew dist
    

    Distribution packages are built in the build/distributions directory.

    If Gradle throws an error like java.lang.OutOfMemoryError: Java heap space, you probably need to increase the maximum Java heap size. One way to do this is to set the GRADLE_OPTS environment variable to a value like -Xmx1024m.

    For more information on the -Xmx option, see the Java SE Documentation.

License

DITA Open Toolkit is licensed for use under the Apache License 2.0.

You can’t perform that action at this time.