This repository contains a series of scripts to generate DITA documentation out of various technical files.
The Document Information Typing Architecture (DITA) is an XML data model for authoring and publishing. It is an open standard that is defined and maintained by the OASIS DITA Technical Committee.
Once the DITA source files are genereated with any of the scripts available in this repository, they need to be compiled/published into PDF, HTML, eBook and few other formats. To do that use any of the available DITA editors, few of which are listed below.
Free:
Paid:
- Adobe Framemaker
- Oxygen
A comprehensive list of editors is found here and here.
- XML/XSD/RDF technical resource --> DITA technical documentation (source file)
- DITA technical documentation (source file) --> publication format (PDF, HTML, DOC, eBook, etc.)
The general idea is to produce DITA XML files from the technical files such as UML diagrams (XMI format), OWL ontologies, XSD schemas and other assets. Once the DITA source file is generated it can be published in any of the desired output formats.
This repository is intended to provide the means to generate DITA files from other technical files serialised as XML, XSD or RDF.
For XML/XSD technical files use the XSLT transformation stylesheets. Basic instructions on running an XSLT script are found here here.
Script file:
/UML/xmi2dita_00.xslt
Input format:
UML v2.5 (XMI v2.5.1) (tested)
UML v2.1 (XMI v2.1) (tested, no longer supported because of the different namespace definition)
Output format:
Application Profile documentation of the UML model in DITA 1.3 technical documentation standard
If you have a UML class diagram it can be transformed into a DITA document structured as a description of an Application Profile (AP), explained here and described here and here.
The XSLT script generates class descriptions for each class in the model. The following elements are used: class name and documentation, attributes name, documentation and cardinality, generalisation connectors, associative and dependency connectors with their documentation and multiplicity.
The documentation can contain the bold, italic, list and href HTML tags which will be used as such. Note: the line breaks should always be outside any of the formatting tags.
To further generate the HTML/PDF/DOCX/ePub or other (final) format of the documentation please use a DITA editor such as Adobe Framemaker (paid), Oxygen (paid), XMLMind (free) or others.
Releases are distributed under European Union Public License, version 1.2 (EUPL-1.2)