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

DITA-OT mdBook Demo

Common syntax