DITA Open Toolkit 3.3 Release Notes

DITA Open Toolkit 3.3 is a feature release that provides new features and enhancements, including new attribute sets for HTML5 customization, support for custom integration processing, rotated table cells in PDF output, and hazard statements in HTML output.

DITA-OT releases follow Semantic Versioning 2.0.0 guidelines. Version numbers use the major.minor.patch syntax, where major versions may include incompatible API changes, minor versions add functionality in a backwards-compatible manner and patch versions are maintenance releases that include backwards-compatible bug fixes.

Tip: Download the dita-ot-3.3.zip package from the project website at dita-ot.org/download.

Requirements

DITA Open Toolkit Release 3.3 requires the Java Runtime Environment (JRE) version 8 or later.

DITA-OT 3.3 released February 28, 2019

DITA Open Toolkit Release 3.3 includes new attribute sets for HTML5 customization, support for custom integration processing, rotated table cells in PDF output, and hazard statements in HTML output.

Feature Highlights

DITA Open Toolkit Release 3.3 includes the following new features:

  • The @rotate attribute on table <entry> elements, which was added in the DITA 1.3 specification, is now supported in PDF output. #1778, #2717, #3161

  • A new CustomIntegrator interface provides a mechanism for custom plug-ins to extend the default integration process via service provider classes declared via a Java ServiceLoader. #3175

  • HTML5 and XHTML output now provide generic hazard statement styling based on the ISO 3864 and ANSI Z535 standards, with an SVG icon and Sass variables for the corresponding ISO and ANSI color definitions. The ANSI colors are used by default to match the PDF styling previously added in DITA-OT 3.2. #3207, #3231

  • A series of new attribute sets has been added to the default HTML5 transformation to facilitate customization with additional ARIA roles, attributes, or CSS classes. Attribute sets are provided for:
    • article
    • banner
    • footer
    • main
    • navigation
    • toc
    If you have previously copied XSL templates (or template modes) to custom plug-ins only to add classes required by web frameworks such as Bootstrap or Foundation (or your company CSS), you may be able to simplify your customizations by using the new attribute sets instead of overriding the default templates.

Enhancements and changes

DITA Open Toolkit Release 3.3 includes the following enhancements and changes to existing features:

  • The dita command now recognizes a wider range of “truthy” property values, including true, yes, 1, and on and handles inconsistently cased values more gracefully. #2225, #3197
  • Various XSLT files and other resources have been moved from the root of the DITA-OT installation directory to the base plug-in directory plugins/org.dita.base. #3157 (If your plug-ins use the plugin URI scheme as recommended in the Plug-in coding conventions, this change should not require any modifications to custom plug-in code.)
  • The templates key in configuration properties has been deprecated in favor of the <template> element in plugin.xml. #3176
  • In HTML5 output, task <steps> are now wrapped in <section> elements and DITA <example>, <prereq>, and <stepsection> elements are also generated as HTML5 <section> elements. #3177
  • Java code has been refactored to add missing DITA classes to the list of available Java constants and re-sort the constant definitions. #3178
  • Custom <pipeline> modules can now use SAX filters. This makes it possible to configure the module’s behavior at the Ant level and add additional processing to a module. Modules do not have to define nested filters if they prefer not to expose this extension point or do not use SAX internally. #3182
    <pipeline>
      <module class="com.example.Module">
        <filter class="com.example.XmlFilter"/>
      </module>
    </pipeline>
  • New extension points have been added to contribute parameters to the debug-filter, map reader, and topic reader Java preprocessing modules. #3187
    • dita.preprocess.debug-filter.param
    • dita.preprocess.map-reader.param
    • dita.preprocess.topic-reader.param
  • The DITA-OT fork of the jing-trang project used to provide RELAX NG schema validation in DITA-OT 3.2 has been replaced with the upstream code after the patches provided by George Bina were included. #3188
  • Several bundled dependencies have been upgraded to the latest versions. #3191
    • Ant 1.10.5
    • Jackson 2.9.8
    • Saxon-HE 9.8.0-14
    • Xerces-J2 2.12.0
  • An additional keyscope test has been added to test interactions with submaps referenced via <mapref>. #3193
  • The default character set for code references can now be changed by adding the default.coderef-charset key to the configuration.properties file. The character set values are those supported by the Java Charset class. #3195
  • The <ditafileset> now supports nested <includes> and <excludes> elements to more easily control which files get processed (or do not get processed) by each processing step. The copy-files task has been been moved to the end of the preprocessing pipeline to match the order in map-first preprocessing (preprocess2). #3196
  • The Gradle build system has been updated to the latest patch release (5.2.1). #3204
  • When source files contain an empty conref="" attribute value, DITA-OT now provides a meaningful warning and then ignores this construct, which previously resulted in parser errors. #3217
  • Along with the other base plug-in files, the catalog-dita.xml file has been moved from the root of the DITA-OT installation directory to plugins/org.dita.base. External systems that rely on this catalog should be updated with the new location. Ant scripts and DITA-OT plug-ins should use the plug-in directory property to refer to the file as ${dita.plugin.org.dita.base.dir}/catalog-dita.xml. A placeholder with a <nextCatalog> entry is provided in the original location for backwards compatibility, but this file may be removed in an upcoming release. #3230

Bugs

DITA Open Toolkit Release 3.3 provides fixes for the following bugs:

  • In earlier releases, external URIs referenced via @keyref from within relationship tables resulted in links with broken link text. This has been fixed, and metadata including link text or titles is preserved for external URIs referenced by key within a map. #1439, #3179
  • Relative paths in peer or non-DITA key references were not handled correctly in earlier releases. The paths are now adjusted as needed to stay valid in any referencing location. #1951, #2250, #2581, #2620, #3234
  • Several fixes have been added to improve support for the @chunk attribute on topic groups (covering both <topicgroup> and any other <topicref> style container that does not reference a file). #2428, #2730, #2843, #3216
    • In earlier releases, using chunk="to-content" on a grouping element within another branch or map that specified chunk="to-content" would result in a NullPointerException. This error has been fixed.
    • In earlier releases, using chunk="to-content" on a nested map would result in the same NullPointerExceptions when the map reference was inside of a chunked branch or map.
    • In earlier releases, <topicgroup> elements with no title that used chunk="to-content" would result in a generated heading in the output file, such as "Chunk1234567". Chunked containers without a heading will no longer result in a generated heading in the output.
    • In earlier releases, <topichead> elements inside of a chunked branch would result in headings that appeared out of order for PDF. This has been fixed; topic headings will appear where expected in the PDF flow.
  • In earlier versions, references to keys in local scopes were not processed correctly. In certain other cases, files referenced through mapref were parsed with the root scope instead of their parent scope. Keyref parsing has been improved to reliably detect and preserve key scopes to ensure that all key references are resolved in the correct scopes. #2523, #3141, #3194
  • In some recent releases, cross references to local, non-DITA files with formats such as "pdf" or "txt" did not copy those referenced files to the output directory. When appropriate, such as when generating HTML output, these files are now copied to the output directory as they were in earlier releases. #2899
  • On Linux and other systems where the DITA-OT installation directory and temporary directory are not on the same volume, plug-in installation would fail when DITA-OT tried to move a non-empty directory. The installation process has been refactored to ensure that plug-ins are correctly installed in these cases. #3162, #3238, #3239
  • In earlier versions, setting an @id attribute on a <dt> created duplicate IDs in the XSL-FO file, which caused warnings when rendering FO to PDF. #3180, #3185
  • The plugin.rnc RELAX NG Compact Syntax schema used to validate plug-in descriptor files was inadvertently removed from the distribution package and has been restored. #3183, #3220
  • The codeblock normalization process would sometimes fail to recognize certain combinations of characters at the beginning of code blocks, resulting in error messages. These adjacent text events are now merged before the indentation is adjusted. #3198
  • In earlier releases, some indirect key references to glossary entries could result in XSLT errors when more than one possible key target existed. This is corrected by using the single desired target to resolve such links. #3210
  • When the input file set contained resources with different URI schemes (for example local files and external files referenced via HTTPS), earlier versions of DITA-OT would fail with errors. Preprocessing routines have been corrected to ensure the the base directory is correctly calculated in these cases. #3211
  • When generating HTML5 output with the nav-toc parameter set to partial, earlier versions would fail to insert table-of-contents navigation in topics whose names contained spaces. The path normalization process has been corrected to ensure that spaces in file and directory names are correctly URL-encoded as %20, and navigation is included. #3213, #3229
  • In earlier releases, some revision properties were ignored on <tm> elements in PDF output. This is now corrected, so that revision flagging such as text color or background color are properly supported on trademarks. #3214, #3215
  • In documentation and error messages about available transformation types, extensions of an existing transformation could result in duplicate values (such as 3 instances of "pdf"). Duplicates are now removed when listing the available transformation types. #3219
  • In earlier releases, duplicate conditions in DITAVAL properties (such as using two DITAVAL documents for a build that each set up rules for rev="rev3") would generate a warning. This message has been reduced in severity and will now appear only as an informational message with verbose logging. #3223
  • In earlier releases, content references on elements that specified href="-dita-use-conref-target" would evaluate that value as a literal file name. That token (defined in the DITA specification) is now ignored on elements that also use @conref. #3224
  • Revised figures and tables are now marked with change bars in booklists when DITAVAL files define flagging for the corresponding revision values. #3235
  • The command line syntax for the dita --install option has been updated to support the “=” equals sign. #3245
    Both of the following formats are now supported:
    dita --install=plug-in-zip
    dita --install plug-in-zip

Contributors

DITA Open Toolkit Release 3.3 includes code contributions by the following people:

  1. Jarno Elovirta
  2. Robert D Anderson
  3. Roger Sheen
  4. Simen Tinderholt
  5. Eliot Kimber
  6. Eric Sirois

For the complete list of changes since the previous release, see the changelog on GitHub.

Documentation updates

The documentation for DITA Open Toolkit Release 3.3 provides corrections and improvements to existing topics, along with new information in the following topics:

For additional information on documentation issues resolved in DITA Open Toolkit Release 3.3, see the 3.3 milestone in the documentation repository.

DITA Open Toolkit Release 3.3 includes documentation contributions by the following people:

  1. Roger Sheen
  2. Eliot Kimber
  3. Robert D Anderson
  4. Jarno Elovirta
  5. Quick van Rijt

For the complete list of documentation changes since the previous release, see the changelog.