dita-cleanup 0.9.1

Clean up DITA topics after conversion from AsciiDoc.

dita-cleanup

dita-cleanup is a command-line utility that allows you to clean up DITA topics after conversion from AsciiDoc.

In combination with asciidoctor-dita-vale, asciidoctor-dita-topic, and dita-convert, this project can be used to rapidly convert AsciiDoc content to DITA:

1. Identify incompatible markup in the AsciiDoc source file:

   vale source_file.adoc
   

2. Convert the AsciiDoc file to a generic DITA topic:

   asciidoctor -r dita-topic -b dita-topic -S secure source_file.adoc
   

3. Convert the generic DITA topic to a specialized DITA concept, reference, or task:

   dita-convert -g source_file.dita -o output_file.dita
   

4. Clean up the resulting DITA file:

   dita-cleanup -iI -D ../images -X . output_file.dita
   

Installation

Install the dita-cleanup Python package:

python3 -m pip install --upgrade dita-cleanup

Usage

• Remove unresolved AsciiDoc attribute references from element IDs:

  dita-cleanup -i *.dita
  

• Remove unresolved AsciiDoc include directives:

  dita-cleanup -I *.dita
  

• Replace unresolved AsciiDoc attribute references with reusable content references:

  dita-cleanup -C 'topic.dita#topic-id' *.dita
  

• Add a directory path to all image references:

  dita-cleanup -D ../images/ *.dita
  

• Update invlid cross references based on DITA files present in the supplied directory:

  dita-cleanup -X . *.dita
  

• Print the updated files to standard output instead of overwriting the supplied files:

  dita-cleanup -iI -D ../images/ -X . -o - *.dita
  

For a complete list of available command-line options, run dita-cleanup with the -h option:

dita-cleanup -h

Copyright

Copyright © 2025 Jaromir Hradilek

This program is free software, released under the terms of the MIT license. It is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.