DITA Open Toolkit User Guide

DITA Open Toolkit User Guide
Colophon
Introduction
- About DITA (Darwin Information Typing Architecture)
- About DITA Open Toolkit (DITA OT)
- About this document
Key concepts (DITAdemystified)
- Documentation lifecycle
- Processing and publishing
- Project components
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
- System requirements and supported applications
- Installation overview
- Installing your DITA authoring tool
- Installing the Java SDK (JDK)
  - Installing the JDK on Windows
  - Installing the JDK on Linux
- Installing the DITA Tookit full package distribution
- Installing the DITA Tookit small package distribution
  - Installing the small package on Windows
  - Installing the small package on Linux
- Installing on Mac OS
- Directories and files in the ditaot directory
- Installing the optional tools
- DITAblogs (installing and upgrading)
DITA Open Toolkit plug-ins
- About DITA Open Toolkit plug-ins
- Installing the plug-ins
  - Installing the Idiom FO plug-in
- DITAblogs (plug-ins)
- For more information (plug-ins)
Setting up your working environment
- Configuring your authoring tool to use the Toolkit catalog
- Configuring your authoring tool to use DTD or schema URLs
- Configuring the Eclipse XMLBuddy editor for DITA
- Setting up your source and output file directories
- DITAblogs (setting up)
- For more information (setting up)
Processing (building) and publishing DITA documents
- About Ant
- About Ant scripts
- Processing overview
- Ant processing parameters
- About the garage sample
- Processing to the key Toolkit output targets
- Processing to other Toolkit output targets
- DITAblogs (processing)
- For more information (processing)
Troubleshooting the build process
- Capturing and using the log
- Error messages generated during processing
- Troubleshooting CLASSPATH and environment variables setup
- Debugging, reporting, and file generation tools
  - About the tools
  - Using the tools
- DITAblogs (troubleshooting)
- For more information (troubleshooting)
Creating DITA topics
- About the grocery shopping sample
- About topic-based authoring (structured writing)
- About topics
- Creating topics
- About concepts
- Creating concepts
- About tasks
- Creating tasks
- About reference information
- Creating reference topics
- Processing (building) a single topic
- DITAblogs (topics)
- For more information (topics)
Creating DITA maps
- About maps
- Creating maps
- Processing (building) the grocery shopping sample
- Processing using multilevel maps
- DITAblogs (maps)
- For more information (maps)
Linking your content
- About linking
- Linking using cross-references (xrefs)
- Linking using related links
- Linking using relationship tables
- DITAblogs (linking)
- For more information (linking)
Expanding and customizing access to your information
- About indexing
- About metadata
- About RDF and DITA Open Toolkit
- DITAblogs (accessing)
- For more information (accessing)
Reusing your content
- About content reuse
- DITAblogs (content reuse)
- For more information (reuse)
Customizing your published output
- Conditional processing
- Using your own CSS (cascading style sheet)
- Overriding XSLT stylesheet processing
- Customizing XHTML output
- Adding a product logo to a PDF2 cover page
- DITAblogs (customizing)
- For more information (customizing)
Specializing your information design
- About specialization
- Implementing specialization
- For more information (specialization)
Localizing (translating) your DITA content
- About localizing (translating)
- Localizing in XHTML output targets
- Localizing in PDF2 output targets
- DITAblogs (localizing)
- For more information (localizing)
Managing your DITA source content
- Backing up your source files
- About library or source control systems
- About content mangement systems
- DITAblogs (managing content)
- For more information (managing content)
Distributing your published content
- About distributing published content
- Distributing published content using RSS
- Publishing content on a web server
- For more information (distributing)
Migrating legacy content to DITA
- About content migration
- DITAblogs (migrating content)
- For more information (migrating content)
Sample files
Frequently asked questions (FAQs)
- Do I need to know XML to use DITA?
- 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?
- How can I add a special character (for example, trademark) to a DITA file?
Release 1.3.1 and 1.3 information
Release history
DITA core vocabulary
- About the DITA core vocabulary
- Administrator or manager audience category
- Apache Ant
- Ant processing parameter
- Ant script
- Audience
- Authoring tool (DITA)
- Best practice
- Block element
- Body element (<body>)
- Build file
- CMS (Content Management System)
- CSS (Cascading StyleSheet)
- 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>)
- Definition list (<dl>)
- Distributing content
- DITA Open Toolkit distributions
- DITA (Darwin Information Typing Architecture)
- DITA Open Toolkit (OT)
- DITA Open Toolkit User Guide
- DocBook
- DOCTYPE declaration
- DTD (Document Type Definition)
- Domain element
- Eclipse
- Eclipse content
- Eclipse help
- Editor
- Environment variable
- Example element (<example>)
- Family linking
- Figure element (<fig>)
- Filtering 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
- Java Development Kit (JDK)
- JavaHelp
- JavaHelp processor
- Keyword element (<keyword>)
- Linking attribute
- Linking content
- DITA Toolkit processing log
- Map
- Metadata
- Navigation title (<navtitle>)
- OASIS (Organization for the Advancement of Structured Information Standards)
- Ordered list (<ol>)
- OWL (Web Ontology Language)
- PDF (Portable Document Format)
- Phrase element
- Plug-in
- Post-requirement element (<postreq>)
- Prerequisite element (<prereq>)
- Print-document designer
- Processing (building)
- Project manager
- Prolog element (<prolog>)
- RDF (Resource Description Framework)
- Reference analysis
- Reference information type
- Related links element (<related-links>)
- Relationship table
- Result element (<result>)
- RSS (Really Simple Syndication)
- SAXON XSLT processor
- Schema
- Scope attribute
- Search title element (<searchtitle>)
- Short description
- Simple list (<sl>)
- Simple table element (<simpletable>)
- SourceForge website
- Specialization (information design reuse)
- Step element (<step>)
- Structure element
- Structured writing
- Stylesheet
- Staff manager
- Table element (<table>)
- Technology specialist audience category
- Task analysis
- Task information type
- Task Modeler
- Topic information type
- Topic-based authoring (structured writing)
- troff
- Typographic element
- Unordered list (<ul>)
- Vendor audience category
- Website designer
- Word RTF (Rich Text Format)
- Writer
- Xalan XSLT processor
- XEP processor
- XHTML
- XML (eXtensible Markup Language)
- XML declaration
- XPath
- XSLT (eXtensible Stylesheet Language Transformations)