DITA Open Toolkit User Guide and Reference

Search | A-Z Index | Site Map | Help

Member? Login

Home > Resources > OT User Guide

Open Toolkit User Guide and Reference

by Anna van Raaphorst and Dick Johnson

DITA Open Toolkit User Guide

DITA Open Toolkit User Guide and Reference
Colophon
Release 1.3 information
- Release notes
- System requirements and supported applications
- What's new
Release history
Introduction
- About Darwin Information Typing Architecture (DITA)
- About DITA Open Toolkit (DITA OT)
- About this document
Getting started
Getting information (general)
Evaluating DITA and DITA Open Toolkit
- The DITA authoring/production framework
- Use cases
- Use case template
Installing and upgrading DITA Open Toolkit
- Installation
  - Upgrade considerations
  - Installation considerations
- Installing the DITA authoring tools
- DITA Tookit distributions
- Installing the Java SDK
  - Installing the JDK on Windows
  - Installing the JDK on Linux
- Installing the DITA Tookit full package distribution
  - Evaluating the DITA Open Toolkit (fullpackage version)
- Installing the DITA Tookit small package distribution
  - Installing the required tools for the small package
    - Installing small package on Windows
    - Installing small package on Linux
- Installing the optional tools
- Installing on Mac OS
  - Installing DITA Open Toolkit on Mac OS
- Directories and files in the ditaot directory
- Production notes (installing and upgrading)
Setting up your working environment
- Configuring your authoring tool to use the Toolkit catalog
- Configuring your authoring tool to use DTD or schema URLs
- Setting up your source and output file directories
- Production notes (setting up)
- For more information (setting up)
Processing (building) and publishing DITA documents
- Processing overview
- About Ant
- About Ant scripts
- Ant processing parameters
- About the garage sample
- Processing to XHTML targets
- Processing to HTML Help targets
- Processing to PDF2 targets
- Processing to DocBook targets
- Processing to Eclipse content targets
- Processing to Eclipse help targets
- Using a DITA template for Eclipse document plug-ins
- Processing to Eclipse help targets using Eclipse
- Processing to JavaHelp targets
- Processing to troff targets
- Processing to Word RTF targets
- Processing from the Java command line
- Production notes (processing)
- For more information (processing)
Troubleshooting the build process
- Capturing and using the log
- DITA Open Toolkit error messages overview
- Messages generated by the Toolkit
- Messages generated from other sources
- Troubleshooting CLASSPATH and environment variables setup
- About the debugging, reporting, and file generation tools
- Using the debugging and reporting tools
- Production notes (troubleshooting)
- For more information (troubleshooting)
Creating DITA topics
- About the grocery shopping sample
- About topics
- Creating topics
- About concepts
- Creating concepts
- About tasks
- Creating tasks
- About reference information
- Creating reference topics
- Processing (building) a single topic
- Production notes (topics)
- For more information (topics)
Creating DITA maps
- About maps
- Creating maps
- Processing (building) the grocery shopping sample
- Production notes (maps)
- For more information (maps)
Linking content
- About linking
- Linking using cross-references (xrefs)
- Linking using related links
- Linking using relationship tables
- Production notes (linking)
- For more information (linking)
DITA Open Toolkit plug-ins
- About DITA Open Toolkit plug-ins
- Installing plug-ins
Managing your content
- Backing up your source files
- Using a library or source control system
- Using a a content management system
- Production notes (managing content)
- For more information (managing content)
Reuse concepts and techniques
- About reuse
- Implementing information design reuse (specialization)
- Implementing processing reuse
- Production notes (reuse)
- For more information (reuse)
Expanding and customizing access to your information
- About indexing
- About metadata
- About conditional processing
- About RDF and DITA Open Toolkit
- Production notes (accessing)
- For more information (accessing)
Customizing your published output
- Using your own CSS (cascading style sheet)
- Tailoring XHTML output
- Adding a product logo to a PDF2 cover page
- Production notes (customizing)
- For more information (customizing)
Localizing (translating) your DITA content
- About localizing (translating)
- Production notes (localizing)
- For more information (localizing)
Distributing your published content
- About distributing content
- Distributing information about published DITA content as RSS
- Distributing information by publishing DITA content on a web server
- For more information (distributing)
Migrating legacy content to DITA
- Content migration overview
- Production notes (migrating content)
- For more information (migrating content)
Sample files
Frequently asked questions (FAQs)
- Do I need to know XML to use DITA?
- What is topic-based authoring?
- Why is "Darwin" in the name of the DITA architecture and DITA Open Toolkit?
- How does DITA differ from DocBook?
- Should I set my root element to <dita> or <concept> (or <task> or <reference>)?
- How can I use conditional processing effectively?
- What steps should I follow to architect and write a large DITA document?
DITA core vocabulary
- About the DITA core vocabulary
- Administrator or manager audience category
- Ant
- Ant script
- Audience
- Best practice
- Block element
- Body element (<body>)
- Build file
- Cascading stylesheet (CSS)
- Choice table
- Collection-type attribute
- Command element (<cmd>)
- Concept
- Concept analysis
- Concept information type
- Conditional processing (filtering and flagging content)
- Content
- Content inventory
- Content reference attribute
- Content reuse
- Content specialist audience category
- Context element (<context>)
- Controlled vocabulary
- Cross-reference element (<xref>)
- Darwin Information Typing Architecture (DITA)
- Definition list
- Distributing your published content
- DITA
- DITA Open Toolkit (OT)
- DITA Open Toolkit User Guide and Reference
- DocBook
- DOCTYPE declaration
- Document type definition (DTD)
- Domain element
- Eclipse content
- Eclipse help
- Editor
- Environment variable
- Example element (<example>)
- Family linking
- Figure element (<fig>)
- Filtering and flagging content
- FOP processor
- Format attribute
- Garage sample
- Grocery shopping sample
- Graphic designer
- Guideline
- Hover help
- HTML Help
- HTML Help compiler
- ID attribute
- Indexing content
- Information analysis
- Information architect
- Information developer
- Information element (<info>)
- Information type
- Inheritance
- Java Development Kit (JDK)
- JavaHelp
- JavaHelp processor
- Keyword element (<keyword>)
- Linking attribute
- Linking content
- Map
- Metadata
- Migrating legacy content to DITA
- Navigation title (<navtitle>)
- OASIS (Organization for the Advancement of Structured Information Standards)
- Ordered list
- OWL (Web Ontology Language)
- PDF (Portable Document Format)
- Phrase element
- Plug-in
- Post-requirement element (<postreq>)
- Prerequisite element (<prereq>)
- Print-document designer
- Processing (building)
- Processing attribute
- Processing reuse
- Project manager
- Prolog element (<prolog>)
- RDF (Resource Description Framework)
- Reference analysis
- Reference information type
- Related links element (<related-links>)
- Relationship table
- result element (<result>)
- Reuse concepts and techniques
- SAXON XSLT processor
- Schema
- Scope attribute
- Search title element (<searchtitle>)
- Short description
- Simple list
- Simple table element
- SourceForge website
- Specialization (information design reuse)
- Step element
- Structure element
- Stylesheet
- Staff manager
- Table element (<table>)
- Technology specialist audience category
- Task analysis
- Task information type
- Task Modeler
- Topic information type
- troff
- Typographic element
- Unordered list (<ul>)
- Website designer
- Word RTF (Rich Text Format)
- Writer
- Xalan XSLT processor
- XHTML
- XML declaration