1.
DITA Open Toolkit 4.1
2.
Release Notes
2.1.
Release history
3.
Installing DITA-OT
3.1.
Prerequisite software
3.2.
Checking the version
3.3.
Building output
3.4.
Installing via Homebrew
4.
Building output
4.1.
Using the dita command
4.1.1.
Using a properties file
4.1.2.
Migrating Ant builds
4.1.3.
Using a project file
4.1.3.1.
XML project files
4.1.3.2.
JSON project files
4.1.3.3.
YAML project files
4.2.
Using Docker images
4.2.1.
Custom images
4.3.
Using GitHub Actions
4.4.
Using Ant
4.4.1.
Ant
4.4.2.
Building output using Ant
4.4.3.
Creating an Ant build script
4.5.
Using the Java API
5.
Authoring formats
5.1.
Standard DITA XML
5.2.
Markdown input
5.3.
Lightweight DITA
6.
Output formats
6.1.
PDF
6.2.
HTML5
6.3.
Eclipse help
6.4.
HTML Help
6.5.
Markdown
6.6.
Normalized DITA
6.7.
XHTML
7.
Parameters
7.1.
DITA command arguments
7.2.
DITA-OT parameters
7.2.1.
Common
7.2.2.
PDF
7.2.3.
HTML-based output
7.2.4.
HTML5
7.2.5.
XHTML
7.2.6.
HTML Help
7.2.7.
Eclipse Help
7.2.8.
Other
7.3.
Configuration properties
7.3.1.
local.properties
7.3.2.
plugin.properties
7.3.3.
configuration.properties
7.3.4.
Internal Ant properties
8.
Customizing HTML
8.1.
Setting HTML parameters
8.1.1.
Adding navigation
8.1.2.
Adding custom CSS
8.1.3.
Headers and footers
8.1.4.
Handling content outside the map directory
8.2.
Using a properties file
9.
Customizing PDF
9.1.
Customization approaches
9.2.
Generating revision bars
9.3.
PDF themes
9.3.1.
Sample theme file
9.3.2.
Page settings
9.3.3.
Header and footer
9.3.4.
Styles
9.3.5.
Variables
9.3.6.
Extending themes
9.3.7.
Syntactic sugar
10.
Adding plug-ins
10.1.
Installing plug-ins
10.2.
Removing plug-ins
10.3.
Plug-in registry
10.4.
Rebuilding documentation
11.
Creating plug-ins
11.1.
Plug-in benefits
11.2.
Plug-in descriptor file
11.3.
Coding conventions
11.4.
Plug-in dependencies
11.4.1.
Referencing files from other plug-ins
11.5.
Plug-in use cases
11.5.1.
Setting parameters
11.5.2.
Adding a new Ant target
11.5.3.
Adding a pre-processing step
11.5.4.
Adding a new output format
11.5.5.
Processing topics with XSLT
11.5.6.
Adding new parameters
11.5.7.
Overriding XSLT steps
11.5.8.
Adding a Java library
11.5.9.
Adding new messages
11.5.10.
New extension points
11.5.11.
Extending an XML catalog file
11.5.12.
Rewriting file names
11.5.13.
Saxon customizations
11.5.13.1.
Saxon extensions
11.5.13.2.
Custom collation URI resolvers
11.6.
Custom HTML plug-ins
11.6.1.
Bundling custom CSS
11.6.2.
Embedding web fonts
11.6.3.
Inserting JavaScript
11.7.
Custom PDF plug-ins
11.7.1.
Types of PDF plug-ins
11.7.2.
PDF plug-in structure
11.7.2.1.
Custom artwork
11.7.2.2.
Index configuration
11.7.2.3.
Variable overrides
11.7.2.4.
Custom attributes
11.7.2.5.
Internationalization
11.7.2.6.
Custom stylesheets
11.7.3.
Simple PDF plug-in
11.7.4.
PDF plug-in resources
11.8.
Globalizing DITA content
11.8.1.
Globalization support
11.8.2.
Supported languages
11.8.3.
Customizing generated text
11.8.3.1.
Adding new strings
11.8.3.2.
Overriding strings
11.8.3.3.
Adding new languages
11.9.
Migrating customizations
11.9.1.
To 4.1
11.9.2.
To 4.0
11.9.3.
To 3.7
11.9.4.
To 3.6
11.9.5.
To 3.5
11.9.6.
To 3.4
11.9.7.
To 3.3
11.9.8.
To 3.2
11.9.9.
To 3.1
11.9.10.
To 3.0
11.9.11.
To 2.5
11.9.12.
To 2.4
11.9.13.
To 2.3
11.9.14.
To 2.2
11.9.15.
To 2.1
11.9.16.
To 2.0
11.9.17.
To 1.8
11.9.18.
To 1.7
11.9.18.1.
Flagging updates
11.9.19.
To 1.6
11.9.20.
To 1.5.4
12.
Troubleshooting
12.1.
Logging
12.2.
Enabling debug mode
12.3.
DITA-OT error messages
12.4.
Other error messages
12.5.
Command line help
12.6.
Increasing Java memory
12.7.
Speeding up builds
13.
Reference
13.1.
DITA-OT architecture
13.1.1.
Processing structure
13.1.2.
Map-first preprocessing
13.1.3.
Processing modules
13.1.4.
Processing order
13.1.5.
Store API
13.1.6.
Pre-processing modules
13.1.6.1.
Generate lists (gen-list)
13.1.6.2.
Debug and filter (debug-filter)
13.1.6.3.
Resolve map references (mapref)
13.1.6.4.
Branch filtering (branch-filter)
13.1.6.5.
Resolve key references (keyref)
13.1.6.6.
Copy topics (copy-to)
13.1.6.7.
Conref push (conrefpush)
13.1.6.8.
Resolve content references (conref)
13.1.6.9.
Filter conditional content (profile)
13.1.6.10.
Resolve topic fragments and code references (topic-fragment)
13.1.6.11.
Chunk topics (chunk)
13.1.6.12.
Move metadata (move-meta-entries) and pull content into maps (mappull)
13.1.6.13.
Map-based linking (maplink)
13.1.6.14.
Pull content into topics (topicpull)
13.1.6.15.
Flagging (flag-module)
13.1.6.16.
Map cleanup (clean-map)
13.1.6.17.
Copy related files (copy-files)
13.1.7.
HTML-based processing modules
13.1.7.1.
Common HTML-based processing
13.1.7.2.
XHTML processing
13.1.7.3.
HTML5 processing
13.1.7.4.
Eclipse help processing
13.1.7.5.
HTML Help processing
13.1.8.
PDF processing modules
13.1.8.1.
History of the PDF transformation
13.2.
DITA specification support
13.2.1.
DITA 1.2 support
13.2.2.
DITA 1.3 support
13.2.3.
DITA 2.0 preview
13.2.4.
Implementation-dependent features
13.2.5.
Codeblock extensions
13.2.6.
DITA features in docs
13.3.
Extension points
13.3.1.
All extension points
13.3.2.
General extension points
13.3.3.
Pre-processing extension points
13.3.4.
XSLT-import extension points
13.3.5.
XSLT-parameter extension points
13.3.6.
Version and support information
13.3.7.
Plug-in extension points
13.3.7.1.
Common processing
13.3.7.2.
PDF
13.3.7.3.
HTML-based output
13.3.7.4.
HTML5
13.3.7.5.
HTML Help
13.3.7.6.
Eclipse Help
13.3.7.7.
Markdown
13.4.
Markdown formats
13.4.1.
Markdown DITA syntax
13.4.1.1.
Common syntax
13.4.2.
MDITA syntax
13.4.2.1.
Common syntax
13.4.3.
Format comparison
13.4.4.
Markdown schemas
13.4.5.
Custom schemas
13.5.
License
13.5.1.
Third-party software
13.6.
Glossary
13.6.1.
argument
13.6.2.
DITA Open Toolkit
13.6.3.
extension point
13.6.4.
option
13.6.5.
output format
13.6.6.
parameter
13.6.7.
plug-in
13.6.8.
processor
13.6.9.
property
13.6.10.
template
13.6.11.
transformation type
13.6.12.
variable
13.6.13.
XSL template
14.
Resources
14.1.
DITA-OT Day Videos
14.1.1.
2022 Rotterdam
14.1.2.
2019 Brussels
14.1.3.
2018 Rotterdam
14.1.4.
2017 Berlin
14.1.5.
2016 Munich
14.1.6.
2015 Munich
14.1.7.
2014 Munich
14.2.
Books
Light
Rust
Coal
Navy
Ayu
DITA-OT mdBook Demo
Error messages and troubleshooting
This section contains information about problems that you might encounter and how to resolve them.