This project has been archived by its maintainers, and is no longer receiving any updates.
AsciiDoc DITA Tool
👉 Complete documentation and tutorials: https://rolfedh.github.io/asciidoc-dita-toolkit/
📋 Prerequisites
Option 1: Python Package
- Python 3.8+ - Required for the package installation (we recommend upgrading to Python 3.8+)
- pip - Python package manager
- Note: If you're using Python 3.7, please use the container option below
Option 2: Container
- Docker or Podman - Container runtime
- curl - For downloading the wrapper script
- Recommended for users on Python 3.7 or those who prefer containerized tools
🚀 Quick Start
A command-line toolkit for technical writers to review and fix AsciiDoc content for DITA-based publishing workflows.
What is this?
The AsciiDoc DITA Toolkit helps you:
- Find and fix common issues in
.adocfiles before publishing - Apply automated checks and transformations using a plugin system
- Ensure consistency across large documentation projects
- Integrate with your existing documentation workflow
� Documentation
👉 Complete documentation and tutorials: https://rolfedh.github.io/asciidoc-dita-toolkit/
🚀 Quick Start
Option 1: Python Package (Recommended)
# Install
pip install asciidoc-dita-toolkit
# Use
adt --help
adt --list-plugins
Option 2: Container
# One-time setup: Download and install adt wrapper
curl -sSL https://raw.githubusercontent.com/rolfedh/asciidoc-dita-toolkit/main/scripts/adt-docker -o /usr/local/bin/adt && chmod +x /usr/local/bin/adt
# Use
adt --help
adt --list-plugins
� Basic Usage
# Fix HTML entity references
adt EntityReference -r
# Add content type labels
adt ContentType -r
🛠️ Troubleshooting
If you encounter issues like "Failed to load module" or "No module named 'modules'" errors, see our Troubleshooting Guide for solutions.
Common fixes:
- Remove conflicting packages:
pip uninstall adt-core - Clear package cache:
pip cache purge - Reinstall:
pip install --upgrade asciidoc-dita-toolkit
🤝 Contributing
- Documentation: https://rolfedh.github.io/asciidoc-dita-toolkit/
- Issues: https://github.com/rolfedh/asciidoc-dita-toolkit/issues
- Contributing Guide: docs/CONTRIBUTING.md
- Troubleshooting: docs/TROUBLESHOOTING.md
📄 License
MIT License - see LICENSE file for details.
Release files for asciidoc-dita-toolkit 2.1.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| asciidoc_dita_toolkit-2.1.5.tar.gz | 309.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| asciidoc_dita_toolkit-2.1.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 423.9 kB
Release files / asciidoc_dita_toolkit-2.1.5.tar.gz
| Download URL | asciidoc_dita_toolkit-2.1.5.tar.gz |
|---|---|
| Size | 309.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
751a7294c98932063903f457d7885f4add9c6b5348ef5db461b620088e9dee1f
|
|
BLAKE2b-256 checksum How to use checksums |
b1f34b6152bce4c6f0adc82aa25fd2c09207e065f61da24ad349f6dc2cf0ace3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.13
|
Release files / asciidoc_dita_toolkit-2.1.5-py3-none-any.whl
| Download URL | asciidoc_dita_toolkit-2.1.5-py3-none-any.whl |
|---|---|
| Size | 114.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d145a367dacc53413d05a8455ace0b6e2d8eb3cad5a03af6f3039a37024c1932
|
|
BLAKE2b-256 checksum How to use checksums |
402fd99fa628d27791487218ed5c507d771ba992eab680bf59de319f9ea32919
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.13
|
