lionelmoi / docs

DITA Open Toolkit documentation —

Home Page:http://www.dita-ot.org/dev/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

To generate additional topics and build the HTML and PDF versions of the documentation as included in DITA-OT releases, run the Ant build script from the root level of the docs repository by entering ant on the command line.

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

ant html

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

NOTE: The build script assumes that the $DITA_HOME environment variable or the dita.home Ant property points to a working DITA-OT installation. If neither is set or you need to override the value, you can also set it on the command line.

either:

export DITA_HOME=/path/to/dita-ot
ant ...

or:

ant -Ddita.home=/path/to/dita-ot

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.

About

DITA Open Toolkit documentation —

http://www.dita-ot.org/dev/

License:Apache License 2.0


Languages

Language:XSLT 75.6%Language:CSS 13.4%Language:Shell 9.7%Language:Ruby 1.0%Language:Haskell 0.3%