DITA Open Toolkit, version 1.8.M2

Chapter 1: Getting Started
- 1.1.1: Installing the full-easy-install package
- 1.1.2: Running the demo build
- 1.1.3: Building your own content using the demo build
Chapter 2: User Guide
- 2.2.1: Overview of the DITA Open Toolkit
  - 2.2.1.1: Release notes
  - 2.2.1.2: DITA 1.2 Specification Support
  - 2.2.1.3: Tested platforms and tools
- 2.2.2: Installing the DITA-OT
  - 2.2.2.1: Distribution packages
  - 2.2.2.2: Prerequisite software
  - 2.2.2.3: Installing the full-easy-install package
  - 2.2.2.4: Installing the minimal or standard package on Linux or Mac OSX
  - 2.2.2.5: Installing the minimal or standard package on Windows
- 2.2.3: Publishing DITA content
  - 2.2.3.1: DITA-OT transformations
    - 2.2.3.1.1: DITA to Docbook
    - 2.2.3.1.2: DITA to Eclipse Content
    - 2.2.3.1.3: DITA to Eclipse help
    - 2.2.3.1.4: DITA to HTML Help (CHM)
    - 2.2.3.1.5: DITA to legacy PDF
    - 2.2.3.1.6: DITA to ODT
    - 2.2.3.1.7: DITA to PDF (PDF2)
    - 2.2.3.1.8: DITA to RTF
    - 2.2.3.1.9: DITA to TocJS
    - 2.2.3.1.10: DITA to Troff
    - 2.2.3.1.11: DITA to XHTML
  - 2.2.3.2: Publishing DITA content from Ant
    - 2.2.3.2.1: Ant
    - 2.2.3.2.2: Building output using Ant
    - 2.2.3.2.3: Creating an Ant build script
  - 2.2.3.3: Publishing DITA content from the command-line tool
    - 2.2.3.3.1: Command-line tool
    - 2.2.3.3.2: Building output using the command-line tool
- 2.2.4: Globalizing DITA content
  - 2.2.4.1: Globalization support offered by the DITA-OT
  - 2.2.4.2: Supported languages: HTML-based transformations
  - 2.2.4.3: Supported languages: PDF transformations
- 2.2.5: Error messages and troubleshooting
  - 2.2.5.1: Error messages
  - 2.2.5.2: Other error messages
  - 2.2.5.3: Log files
  - 2.2.5.4: Accessing help from the command-line tool
  - 2.2.5.5: Determing the version of the DITA Open Toolkit
  - 2.2.5.6: Enabling debug mode
  - 2.2.5.7: Increasing Java memory allocation
- 2.2.6: Reference
  - 2.2.6.1: Ant parameters
    - 2.2.6.1.1: All transformations
    - 2.2.6.1.2: All HTML-based transformations
    - 2.2.6.1.3: Eclipse content
    - 2.2.6.1.4: Eclipse help
    - 2.2.6.1.5: HTML Help
    - 2.2.6.1.6: JavaHelp
    - 2.2.6.1.7: Legacy PDF
    - 2.2.6.1.8: ODT
    - 2.2.6.1.9: Other
    - 2.2.6.1.10: PDF
    - 2.2.6.1.11: XHTML
  - 2.2.6.2: Command-line tool parameters
    - 2.2.6.2.1: All transformations
    - 2.2.6.2.2: All HTML-based transformations
    - 2.2.6.2.3: Eclipse content
    - 2.2.6.2.4: Eclipse help
    - 2.2.6.2.5: HTML help
    - 2.2.6.2.6: JavaHelp
    - 2.2.6.2.7: ODT
    - 2.2.6.2.8: PDF transformation
    - 2.2.6.2.9: XHTML
  - 2.2.6.3: lib/configuration.properties file
Chapter 3: Developer Reference
- 3.3.1: DITA Open Toolkit Architecture
  - 3.3.1.1: Processing modules in the DITA-OT
  - 3.3.1.2: Processing order within the DITA-OT
  - 3.3.1.3: DITA-OT pre-processing architecture
    - 3.3.1.3.1: Generate lists (gen-list)
    - 3.3.1.3.2: Debug and filter (debug-filter)
    - 3.3.1.3.3: Copy related files (copy-files)
    - 3.3.1.3.4: Conref push (conrefpush)
    - 3.3.1.3.5: Conref (conref)
    - 3.3.1.3.6: Move metadata (move-meta-entries)
    - 3.3.1.3.7: Resolve keyref (keyref)
    - 3.3.1.3.8: Resolve code references (codref)
    - 3.3.1.3.9: Resolve map references (mapref)
    - 3.3.1.3.10: Pull content into maps (mappull)
    - 3.3.1.3.11: Chunk topics (chunk)
    - 3.3.1.3.12: Map based linking (maplink and move-links)
    - 3.3.1.3.13: Pull content into topics (topicpull)
    - 3.3.1.3.14: Flagging in the toolkit
      - 3.3.1.3.14.1: XHTML migration for flagging updates in DITA-OT 1.7
  - 3.3.1.4: Generating XHTML with navigation
    - 3.3.1.4.1: Default XHTML output
    - 3.3.1.4.2: Eclipse help output (transform type "eclipsehelp")
    - 3.3.1.4.3: TocJS output path
    - 3.3.1.4.4: Compiled Help (CHM) output
    - 3.3.1.4.5: Javahelp output
  - 3.3.1.5: PDF output pipeline
  - 3.3.1.6: ODT Transform type (Open Document Format)
- 3.3.2: Extending the DITA Open Toolkit
  - 3.3.2.1: Installing plug-ins
  - 3.3.2.2: Removing plug-ins
  - 3.3.2.3: Rebuilding the DITA-OT documentation
- 3.3.3: Configuring the DITA Open Toolkit
  - 3.3.3.1: integrator.properties file
  - 3.3.3.2: lib/org.dita.dost.platform/plugin.properties file
- 3.3.4: Creating DITA-OT plug-ins
  - 3.3.4.1: Plug-in configuration file
  - 3.3.4.2: Extending the XML Catalog
  - 3.3.4.3: Adding new targets to the Ant build process
  - 3.3.4.4: Adding Ant targets to the pre-process pipeline
  - 3.3.4.5: Integrating a new transform type
  - 3.3.4.6: Override styles with XSLT
  - 3.3.4.7: Modifying or adding generated text
  - 3.3.4.8: Passing parameters to existing XSLT steps
  - 3.3.4.9: Adding Java libraries to the classpath
  - 3.3.4.10: Adding diagnostic messages
  - 3.3.4.11: Managing plug-in dependencies
  - 3.3.4.12: Version and support information
  - 3.3.4.13: Creating a new plug-in extension point
  - 3.3.4.14: Example plugin.xml file
- 3.3.5: Customizing PDF output
- 3.3.6: Internal Ant properties
- 3.3.7: Implementation dependent features
- 3.3.8: Extended functionality
- 3.3.9: Topic merge
- 3.3.10: Creating Eclipse help from within Eclipse
Appendix A: DITA-OT release history
- A.4.1 DITA Open Toolkit Release 1.8
- A.4.2 DITA Open Toolkit Release 1.7
- A.4.3 DITA Open Toolkit Release 1.6
- A.4.4 DITA Open Toolkit Release 1.5.4
- A.4.5 DITA Open Toolkit Release 1.5.3
- A.4.6 DITA Open Toolkit Release 1.5.2
- A.4.7 DITA OT Release 1.5.1
- A.4.8 DITA OT release 1.5
- A.4.9 DITA OT release 1.4.3
- A.4.10 DITA OT release 1.4.2.1
- A.4.11 DITA OT release 1.4.2
- A.4.12 DITA OT release 1.4.1
- A.4.13 DITA OT release 1.4
- A.4.14 DITA OT release 1.3.1
- A.4.15 DITA OT release 1.3
- A.4.16 DITA OT release 1.2.2
- A.4.17 DITA OT release 1.2.1
- A.4.18 DITA OT release 1.2
- A.4.19 DITA OT release 1.1.2.1
- A.4.20 DITA OT release 1.1.2
- A.4.21 DITA OT release 1.1.1
- A.4.22 DITA OT release 1.1
- A.4.23 DITA OT release 1.0.2
- A.4.24 DITA OT release 1.0.1
- A.4.25 DITA OT release 1.0
- A.4.26 DITA history on developerWorks (pre-Open Source)
Appendix B: Project Management Guidelines
Appendix C: developerWorks articles

Other error messages

In addition to error messages generated by the DITA Open Toolkit, you might also encounter error messages generated by Java or other tools.

Out of Memory error

In some cases, you might receive a message stating the build has failed due to an Out of Memory error. Try the following approaches to resolve the problem:

(For custom-configured environments, not the DITA-OT Full Easy Install) If you use Xalan as the default XSLT processor, switch to Saxon.
Increase the memory available to Java; see Increasing Java memory allocation.
Reduce memory consumption by setting the generate-debug-attributes option to false. This option is set in the lib/configuration.properties file. This will disable debug attribute generation (used to trace DITA-OT error messages back to source files) and will reduce memory consumption.
Set dita.preprocess.reloadstylesheet Ant property to true. This will allow the XSLT processor to release memory when converting multiple files.
Run the transformation again.

java.io.IOException: Can't store Document

After running a JavaHelp transformation, you may receive a java.io.IOException: Can't store Document message.

This problem occurs when HTML files unrelated to the current transformation are found in the output directory. Delete the content of the output directory and run the transformation again.

Stack Overflow error

If you receive an error about a stack memory overflow, increase the JVM and run the transformation again. See Increasing Java memory allocation.

Was this helpful?