DITA Open Toolkit
website·Indexed 35 days ago
https://www.dita-ot.org/Documentation for the DITA Open Toolkit, covering plug-in development, XSLT processing overrides, and PDF/HTML customization. Includes migration guides for versions 1.5.4, 1.6, 3.1, 4.0, 4.2, 4.3, and 4.4, as well as instructions for internationalization, adding new languages, and implementing Saxon extension functions.
What's inside DITA-OT
- The look and feel of DITA-OT HTML output can be modified by adjusting parameter settings. Available customizations include integrating custom CSS files, adding custom headers and footers, and enabling table-of-contents navigation within topics.
Overview of DITA Open Toolkit (DITA-OT)
DITA Open Toolkit (DITA-OT) is a set of Java-based, open-source tools used to process content authored in the Darwin Information Typing Architecture (DITA). It serves as an independent, open-source implementation of the OASIS DITA standard.Overview of XHTML flagging migration for DITA-OT 1.7
DITA-OT 1.7 introduced a simplified flagging design where DITAVAL elements and CSS-based flagging information are added directly into the topic section. This allows flags to be processed in document order, eliminating the need to manually read DITAVAL files or evaluate flagging logic within element rules. Most migration involves deleting old code that is no longer needed. If an override does not use DITAVAL-based flagging, no migration is required.Overview of DITA Open Toolkit (DITA-OT)
DITA Open Toolkit is a vendor-independent, open-source publishing engine released under the Apache License, Version 2.0. It processes content authored in the Darwin Information Typing Architecture (DITA) standard and converts it into other formats. It supports OASIS DITA specifications 1.0, 1.1, 1.2, and 1.3. Starting with Release 3.0, it also supports Markdown and alternative authoring formats proposed for Lightweight DITA, allowing XML and lightweight markup to be combined in a single map file.Overview of the DITA-OT Store API
The Store API (org.dita.dost.store.Store) is a Java abstraction for temporary file operations introduced in DITA-OT 3.6. It allows the toolkit to handle temporary resources in memory rather than writing them to disk, providing optimizations for XML processing. Instead of usingFileInputStream, developers use the Store API to perform operations, such as retrieving a DOMDocumentdirectly without manual parsing. The API is extendable via Java'sServiceLoaderusing theorg.dita.dost.store.StoreBuilderservice.Overview of the DITA-OT Store API
The Store API (org.dita.dost.store.Store) is a Java abstraction over temporary file operations. It replaces directFileInputStreamusage with a standardized API for reading and writing temporary resources. This allows DITA-OT to optimize storage (e.g., moving from disk to memory) and provides built-in operations for XML processing, such as retrieving a DOMDocumentdirectly without manual parsing. The API is extendable via Java's ServiceLoader using theorg.dita.dost.store.StoreBuilderservice.Overview of map-first pre-processing in DITA-OT
Map-first pre-processing is an alternative to the default
preprocessoperation. Unlike the default routine that switches between map and topic operations, the map-first approach completes nearly all map processing before beginning topic processing. This improves the handling of map-level features (such as keys and key scopes introduced in DITA 1.2 and 1.3), simplifies processing logic, and better handles topics referenced outside the map directory using hashed filenames in temporary directories.As of DITA-OT 4.2, this pipeline also supports additional subject scheme features. It is enabled by default for PDF, HTML Help (since DITA-OT 3.0), and HTML5 and Normalized DITA output (since DITA-OT 4.2).
Overview of map-first pre-processing in DITA-OT
Map-first pre-processing is an alternative to the defaultpreprocessoperation. Unlike the default routine that switches between maps and topics, the map-first approach completes nearly all map processing before beginning topic processing. This improves the handling of map-level features (like keys and key scopes), simplifies processing for filtered topics, and better handles topics referenced outside the map directory using hashed file names in temporary directories. As of DITA-OT 4.2, it also supports additional subject scheme features.Overview of the DITA-OT Store API
The Store API (org.dita.dost.store.Store) is a Java abstraction for temporary file operations introduced in DITA-OT 3.6. It replaces directFileInputStreamusage with a standardized interface, allowing DITA-OT to handle temporary resources in memory rather than writing them to disk. The API includes specialized operations for XML processing, such as methods to retrieve a DOMDocumentdirectly without manual parsing. The API is extendable via theorg.dita.dost.store.StoreBuilderservice using Java's Resource Loader.Overview of DITA Open Toolkit output formats
DITA Open Toolkit provides a set of core transformations to convert DITA content into various output formats. Users can extend the available formats by installing plug-ins from the official plug-in registry at dita-ot.org/plugins.Overview of DITA-OT HTML-based processing pipeline
DITA-OT provides multiple varieties of HTML output. All HTML-based transformations follow a consistent processing pipeline: they start with a common pre-processing module, generate the primary HTML files, and then branch into transformation-specific logic to create the required navigation files.Overview of map-first pre-processing in DITA-OT
Map-first pre-processing is an alternative to the default
preprocessoperation. Unlike the default routine that switches between map and topic operations, the map-first approach completes nearly all map processing before beginning topic processing. This simplifies logic, improves handling of topics referenced outside the map directory, and better supports DITA 1.2/1.3 features like keys and key scopes.As of DITA-OT 4.2, this is enabled by default for PDF, HTML Help, HTML5, and Normalized DITA output.