A focused desktop application for DITA document processing with plugin-based format conversion support.
Orlando Toolkit provides a streamlined interface for working with DITA (Darwin Information Typing Architecture) documents.
| Feature | Description |
|---|---|
| DITA-Only Mode | Native DITA archive (.zip) processing and editing |
| Structure Editing | Visual tree-based topic and section management |
| Live Preview | Real-time DITA document rendering |
| Plugin Architecture | Extensible format conversion via plugins |
flowchart LR
A["DITA Archive"] --> B["Orlando Toolkit"]
C["External Format"] --> D["Plugin"] --> B
B --> E["Structure Editing"]
B --> F["Live Preview"]
E --> G["Export DITA Package"]
F --> G
- Open and edit existing DITA archives
- Import from external formats (via plugins)
- Structure manipulation and topic organization
- Export ready-to-use DITA packages
Download and run the Windows Installer
Click to expand installation steps
- Python 3.7 or higher
- Git (for cloning the repository)
-
Clone the repository
git clone https://github.com/Orsso/orlando-toolkit cd orlando-toolkit -
Install dependencies
python -m pip install -r requirements.txt
-
Run the application
python run.py
- Ensure Python is in your PATH
- On Unix systems, you may need to install additional dependencies
- Check the Support section for common issues
Orlando Toolkit uses a plugin architecture for extensible format conversion. Plugins are installed directly from GitHub repositories.
| Step | Action |
|---|---|
| 1 | Open Plugin Management from the splash screen |
| 2 | Enter a GitHub repository URL |
| 3 | Click "Import Plugin" to download and install |
| 4 | Activate the plugin to enable functionality |
| 5 | Restarting the app migh be needed for some plugins |
Official Plugins
| Plugin | Repository | Description |
|---|---|---|
| DOCX Plugin | orlando-docx-plugin | Convert Microsoft Word documents to DITA |
| Video Library Plugin | orlando-video-plugin | Convert video files to DITA with inline preview |
Interested in creating your own plugin? See the Plugin Development Guide for detailed instructions.
Technical Details
- Unix:
~/.orlando_toolkit/plugins/ - Windows:
%LOCALAPPDATA%\OrlandoToolkit\plugins
- Each plugin is a standalone GitHub repository
- Complete packaging with dependencies
- Version management through repository tags
Warning: Plugins are primarily tested on Windows. Unix-based systems may require additional configuration. ¯_(ツ)_/¯
flowchart TD
A["Start Orlando Toolkit"] --> B{"Choose Mode"}
B --> C["DITA-Only Mode"]
B --> D["Plugin Mode"]
C --> E["Open DITA Archive"]
D --> F["Install Plugin"]
F --> G["Convert Document"]
E --> H["Structure Editing"]
G --> H
H --> I["Live Preview"]
I --> J["Export DITA Package"]
DITA-Only Mode - Work with existing DITA archives
- Launch Orlando Toolkit
- Select "Process DITA Archive"
- Choose your
.zipDITA archive - Edit structure and content
- Export updated archive
Plugin Mode - Convert from external formats
- Install required plugins for your format
- Select "Convert Document"
- Choose your source file (DOCX, PDF, etc.)
- Review and edit the conversion
- Export as DITA archive
| Feature | Description |
|---|---|
| Structure Editing | Use the tree interface to reorganize topics and sections |
| Live Preview | See changes in real-time |
| Export | Generate complete DITA packages for downstream publishing |
| Document | Description |
|---|---|
| User Guide | Complete guide for end users |
| Installation Guide | Setup and installation instructions |
| Document | Description |
|---|---|
| Plugin Development Guide | Build your own format converters |
| Architecture Overview | System architecture and design |
| Runtime Flow | Application execution flow |
| Component | Documentation |
|---|---|
| Core | orlando_toolkit/core/README.md |
| UI | orlando_toolkit/ui/README.md |
| Configuration | orlando_toolkit/config/README.md |
| Resource | Purpose |
|---|---|
| GitHub Issues | Report bugs and request features |
| Documentation | Comprehensive guides and references |
Contributions are welcome! Please see documentation for:
MIT License — see LICENSE for full text.
Orlando Toolkit is an independent, open-source project and is not affiliated with "Orlando TechPubs" or Infotel. "Orlando" may be a trademark of its owner; references are for identification only.