DITA Getting Started
This section helps you to get started with DITA if you are completely new to DITA. One of the disadvantages of DITA is, that the releveant information is quite fragmented and cluttered over various websites. Let this page be your compass guiding you through what’s really relevant for you.
Core concepts
Maybe you are at the very beginning right now and would like to ensure that DITA is really the right technology for you to learn. In this case, you maybe want to work through the quite comprehensive dita-introduction, which I have created for you. It explains the basics of XML, DITA, the DITA history, and the unique functions which make DITA so powerful.
You can also find a recording of a presentation of this DITA introduction on Youtube:
Write the Docs: Stefan Eike - DITA Introduction
Learning DITA
If you are now sure that DITA is the right technology for you to learn, you should work through LearningDITA. This is a comprehensive, well-designed and free e-learning, which has been crafted by Scriptorium.
This will give you a good base. You should also give read some parts of the DITA 1.3 Specification. This may sound a bit strange, but the specification actually contains many useful examples that will help you.
Specializing DITA
DITA ships a couple of specialized topic types, which are specialized from the core <topic> topic:
- Concept topic
- Reference topic
- General task topic
- (Strict) task topic
- Machinery task topic
- Troubleshooting topic
- Glossary entry topic
- Glossary group topic
Specialization helps you to add or remove XML elements and attributes or restrict their usage. By default, the DITA topics contains hundreds of elements, and probably you only need a subset. Let’s assume that you don’t need dedicated XML elements for explaining a software (because you create physical products). All DITA XML elements for explaining software are grouped in the Software domain. If you want to remove the entire domain and all its elements, you need to specialize new topic types (e.g. extending the concept and task topics). The concept of specialization is for sure the unique selling point of DITA. It allows you to create company-specific DITA grammars which are still fully compatible to the DITA specification.
Info: Maybe you don’t want to work with all these semantic XML elements. If you just need a very lightweight DITA environment, you might be interested in the Lightweight DITA project.
If you are sure you want to specialize DITA, you should read the chapter Configuration, specialization, generalization, and constraints of the specification. If you can understand German, the data2type DITA specialization tutorials will be useful for you. A little bit outdated, but still useful, are the (Xiruss - DITA specialization tutorials by W. Eliot Kimber.
- Blogs
- DITA-Transformations
- Style Guides
- Youtube-Channels
- Books
- OASIS Feature Articles and Whitepapers
- XSLT
- Other
DITA-Transformations
- Scripto: DITA-to-PDF (Dita2pdf): there is more than the DITA Open Toolkit - Alternative PDF publication method
Style Guides
- The DITA Style Guide Best Practices for Authors - The DITA Style Guide is designed to help DITA authors implement DITA consistently by providing an authoritative reference.
- Microsoft Manual of Style
Books
- DITA for Practitioners Volume 1: Architecture and Technology (Eliot Kimber) - The most famous DITA book about the DITA basics.
- DITA for Print (Leigh W. White) - A DITA-OT Workbook for customizing the output of the org.dita.pdf2 plugin.
- The Dita Style Guide: Best Practices for Authors (Tony Self) - Contains best practices and real world DITA examples and comprehensive, practical explanations of DITA elements and attributes.
OASIS Feature Articles and Whitepapers
- DITA 1.3 Feature Article: About the DITA 1.3 release management domain
- DITA 1.3 Feature Article: Using DITA 1.3 Troubleshooting
- DITA 1.3 Feature Article: Understanding Scoped Keys in DITA 1.3
- DITA 1.2 Feature Article: Using XLIFF to Translate DITA Projects
- DITA 1.2 Feature Article: Roles and Responsibilities of a DITA Adoption
- DITA 1.2 Feature Article: Acronym Best Practices
- DITA 1.2 Feature Overview: Domain and topic integration
- DITA Feature Article: Short Descriptions Shouldn’t Be a Tall Order: WritingEffective Short Descriptions
- DITA 1.2 Feature Description: Improved glossary and terminology handling
XSLT
DITA Communities
-
DITA Awareness Group (Linkedin) - DITA community on Linkedin.
-
DITA Group (Xing) - DITA community on Xing.
-
DITA For Publishers - The general goal of the DITA for Publishers project is to make creating and using DITA-based solutions for Publishing-specific business challenges as quick and easy as possible by providing a solid base from which you can start immediately.
-
DITA-Community - The DITA-Community is a place for DITA-OT plugins and sample files.
-
DITANAUTS - The goal of the DITANAUTS project is to provide relevant, actionable information that helps others with the implementation of DITA.
-
DITA Chicks - DITA Chicks is a blog of Karen Lowe and Lu Hall covering various DITA related topics.
-
oXygen XML DITA Forum - The DITA forum of the oXygen XML editor is an important information resource and has great supporters and moderators.
Mailing Lists
- dita-users (Yahoo) - Biggest DITA mailing list
- oxygen-users - Mailing list of the oXygen XML editor
- dita-ot-users (Google) - Another DITA mailing list, focussed on the DITA-OT.
Here we present tools, that can be used to create, edit and process DITA files.
Editors
-
oXygen XML (Commercial) - The leading DITA XML editor.
-
FrameMaker (Commercial) - DITA XML editor with powerful desktop publishing features.
-
Xopus (Commercial) - Web-based DITA XML editor
-
Xeditor (Commercial) - Web-based DITA XML editor
-
XMetaL Author (Commercial) - XML editor
-
XMLMind (free for personal use) - Commercial XML editor, uses own DITA processing engine (not DITA-OT)
-
Arbortext Editor (Commercial) - XML editor
-
Atom (Open Source - MIT) - Modern, customizable text editor, can be customized to work as a basic XML editor
-
FontoXML (Commercial) - Modern, web-based XML editor.
You can use FontoXML for free, when using it with Google Drive or Microsoft OneDrive. It is also possible to setup a Git repository and keep that in your Google Drive or Microsoft OneDrive to collaborate with others.
-
Codex (Free for commercial and non-commercial use) - Simple DITA editor
-
Eclipse (Open Source - EPL) - Can be enhanced to be used as a DITA editor, see Adding DITA to Eclipse by Ron Wheeler
-
jEdit (Open Source - GPL2) - Customizable text editor. Install the XML plugin and then add the catalog-dita.xml in the plugin settings to make DITA validation work.
Content Management Systems
- Astoria CMS (Commercial)
- CloudDrafts (Commercial)
- Componize DITA CMS (Commercial)
- DITA Exchange DX4 (Commercial)
- DITAToo CMS (Commercial)
- DITAworks (Commercial)
- DocZone DITA CCMS (Commercial)
- easyDITA (Commercial)
- Empolis Smart Content Express (Commercial)
- IXIASOFT DITA CMS (Commercial)
- RSI Content Solutions RSuite (Commercial)
- SDL Knowledge Center (Commercial)
- Vasont DITA CMS (Commercial)
- XDocs CCMS (Commercial)
- XML Documentation Add-on for Adobe Experience Manager (Commercial)
- XPLM Publisher (Commercial)
Controlled Version Systems
- oxygen-git-plugin (Open Source - APL2) - oXygen XML plugin that provides a simple Git client
Conversion
- Migrate (Commercial) - Cloud service with automatic conversion of various formats, e.g. FrameMaker or Word to DITA.
- oxygen-resources-convertor (Open Source - APL2) - oXygen XML plugin to convert resources from various formats (e.g. HTML, Markdown) to DITA
Comparison
- DeltaXML (Commercial) - Tool to compare and merge DITA
Translation
- Fluenta DITA Translation Manager (Commercial) - Tool to convert DITA to XLIFF for sending it to a translator. Contains a small translation management system.
- Translation-Package-Builder (Open Source - APL2) - oXygen XML plugin to generate translation packages from DITA
Online Platforms and Publishing Solutions
- 4Dpubs (Open Source - MIT) - Renders DITA directly in the browser with XSLT.
- DITAweb (Commercial)
- ePublisher (Commercial)
- Fluid Topics (Commercial) - Online Platform for hosting DITA content.
- oXygen XML WebHelp (Commercial)
- SuiteHelp (Commercial)
- Zoomin Docs (Commercial) - Portal for documentation and knowledge bases.
Print Solutions
- DITA InPrint™ (Commercial)
- IdXML – DITA to Adobe InDesign (Commercial)
- MiramoPDF (Commercial)
- TopLeaf XML Publisher (Commercial)
Metadata/Search
- oxygen-dita-prolog-updater (Open Source - APL2) - oXygen XML plugin to update metadata information in topics and maps
- ditasearch - DITA-OT plugin to build a search index and search box for HTML5 output
Analytics/Metrics
- dita-metrics-report (Open Source - MPL2) - DITA-OT plugin that creates metrics reports from DITA projects