DITA Readme map
2 | OpenTopic | TOC
Contents
DITA-OT Introduction.........................................................................................................3
Evaluating the DITA Open Toolkit..........................................................................................................3
DITA Open Toolkit release notes............................................................................................................ 4
DITA complete release history.............................................................................................................. 12
DITA 1.2 Specification Support.............................................................................................................34
Using DITA transforms..........................................................................................................................35
Building DITA output with Ant.............................................................................................................36
Building DITA output with Java command line.................................................................................... 43
Problem determination and log analysis................................................................................................ 50
Troubleshooting..................................................................................................................................... 51
Known Limitations.................................................................................................................................52
DITA to Word output transform............................................................................................................ 53
Migrating HTML to DITA.....................................................................................................................53
Migrating HTML to DITA with Ant script................................................................................54
Migrating HTML to DITA with Java command........................................................................55
Development Reference......................................................................................................................... 57
Supporting two file extensions in one DITA map......................................................................57
Standard XML catalog resolver................................................................................................. 57
Topic merge................................................................................................................................57
Working with documentation plug-in........................................................................................ 59
OpenTopic | DITA Open Toolkit | 3
DITA Open Toolkit
The DITA Open Toolkit is an implementation of the OASIS DITA Technical Committee's specification for DITA
DTDs and Schemas. The Toolkit transforms DITA content (maps and topics) into deliverable formats, such as
XHTML, PDF, Eclipse Help, HTML Help, and JavaHelp.
This set of documentation contains some basic setup and overview information for the DITA Open Toolkit. The latest
information about the toolkit, including plans for upcoming or future releases, can be found at dita.xml.org: The DITA
Open Toolkit.
Evaluating the DITA Open Toolkit (Full Easy Install)
The most common scenario for first users of the DITA Open Toolkit is to evaluate how it functions. Previous versions
of the Toolkit required a number of preliminary installation steps for components necessary both to run the base
function and to show off additional output capabilities. For each release since DITA-OT 1.4.2, three versions of
the Toolkit are available: the minimal package (contains core function only), standard package (minimal plus docs
and demos), and a "full easy install package" that basically installs everything you need to enable quick and easy
evaluation of the Toolkit. This topic deals with installing and using the full easy install package for the first time.
Note: This topic explains how to use the Full Easy Install
on Windows; the three versions are also available on
all other supported platforms. For a description of all
packages available, see What packages are available for
the DITA Open Toolkit at dita.xml.org.
Unzip or extract the "full_easy_install" zip file to a convenient directory, such as your c: drive's root directory. The
package will create a directory such as C:\DITA-OT-1.5.1\ that contains not only the usual Toolkit materials but also
all the run-time components needed to run the Toolkit in a basic evaluation mode.
Browse over to this new directory and double-click on the "startcmd.bat" file in that directory. A new "command
shell" window will open up, with the environment variables already set to enable the Toolkit to run within that shell.
At the command prompt (usually c:\DITA-OT1.5.2\ for this version), type "ant samples.web -f build_demo.xml".
After a series of processing messages, there should be a new out\ directory in the DITA-OT1.5.2\ directory that
contains a folder with the resulting HTML output in it. Congratulations on creating your first example of DITA
output!
Now try the full set of transforms from a single command: "ant all -f build_demo.xml". This command will process
DITA samples in the toolkit into many of the supported output types for the Toolkit. After a much longer flurry of
messages, the out\ directory should have a number of folders in it, each with several deliverables produced by the
Toolkit demos. If you happen to have the Microsoft HTMLHelp Workshop or the JavaHelp toolset installed for
other work you have done with User Assistance, you might even get ready-to use CHM and JavaHelp output files.
By comparing the outputs with the various source materials in the distribution, you can get an idea about how the
processing works. That explanation is best found in the DITA Open Toolkit User Guide and at the DITA-OT Focus
Area at http://dita.xml.org .
Demo targets
Here are the individual demo targets that you can try while evaluating the DITA Open Toolkit. Note that most are
subcomponents of larger operations--you can use any of these individually. Earlier releases also contained demo
targets for building the DITA 1.1 Language Specification, but that was removed in DITA-OT 1.5.2 because it was
superseded by the DITA 1.2 specification.
all Build all output
clean Delete all output
clean.demo Remove the demo output
clean.demo.book Remove the book demo output
4 | OpenTopic | DITA Open Toolkit
clean.demo.elementref Remove the Element Reference demo output
clean.demo.enote Remove the eNote demo output
clean.demo.faq Remove the FAQ demo output
clean.doc Remove the documentation output
clean.doc.articles Delete the articles directory in doc.
clean.docbook Remove the docbook output
clean.samples Remove the sample output
clean.samples.eclipse Remove the sample Eclipse output
clean.samples.htmlhelp Remove the sample HTMLHelp output
clean.samples.javahelp Remove the sample JavaHelp output
clean.samples.pdf Remove the sample PDF output
clean.samples.web Remove the sample web output
demo Build the demos
demo.book Build the book demo
demo.elementref Build the element reference demo
demo.enote Build the eNote demo
demo.faq Build the FAQ demo
doc Build the documentation
doc.articles.chm Build the articles of dita as document.
doc.articles.pdf Build the articles of dita as document.
doc.articles.web Build the articles of dita as document.
docbook Transform the samples to DocBook
prompt Prompt to build anything
samples Build the sample output
samples.eclipse Build the samples for Eclipse
samples.htmlhelp Build the samples for HTMLHelp
samples.javahelp Build the samples for JavaHelp
samples.pdf Build the samples as PDF
samples.troff Build the samples as troff
samples.web Build the samples for the web
If you do not specify a target for build_demo.xml, the default target is prompt.
You can also try your hand at modifying some of the sample scripts in the ant directory. These represent the kind of
driver files that you would create for your own projects. You can easily adapt these to process your own test DITA
files, for example. Call the other ant samples after this example:
c:\DITA-OT1.5.2>ant -f samples/ant_sample/sample_xhtml.xml
(This is basically the same as running ant samples.web -f build_demo.xml, but intended for you to
modify.)
You will find the output for this exercise in the samples/ant_sample/ directory itself. You can add parameters
to the sample_xhtml.xml file to change where your outputs end up, and also to modify the build process in other
ways. See the documentation for Ant parameters to learn more about processing options.
DITA Open Toolkit release notes
This document contains the release notes for the 1.5 series of DITA Open Toolkit releases.
DITA Open Toolkit Release 1.5.2
• Release date: December 10, 2010
• Supports: DITA 1.0 through 1.2
• Download at: DITA-OT Latest Stable Build
• Which package is for me? See DITA-OT Packages.
Release 1.5.2 is a maintenance release based on the final version of the DITA 1.2 standard. In addition to tweaks
to match late changes in the standard, version 1.5.2 contains many enhancements, user patches, bug fixes, and
significant updates to the documentation.
Release 1.5.2 was developed using a series of test builds released to the community every three weeks. Each item in
the list below indicates which test build first contained the update. The eighth build was the final build, released as the
DITA-OT 1.5.2 final stable build.
OpenTopic | DITA Open Toolkit | 5
[General Enhancements]
1.
Include final version of DITA 1.2 schemas and DTDs
2.
Minor updates to DITA 1.2 support added in earlier releases, to ensure compliance with the final standard
3.
Overhaul of documentation to remove outdated material
4.
Reorganization of doc directory to highlight new and important info
[11 SourceForge Enhancements Added]
1.
2797337 Support for ODF output transform (Prototype added in version 1.5.1, updates in each 1.5.2 Milestone,
transform complete in Milestone 7)
2.
3021544 Preserve DITA elements in XHTML class by default (Milestone 1)
3.
3019853 Create new "textonly" output method for use by any transform (Milestone 1)
4.
3012392 PDF transformation should allow args.xsl style override (Milestone 1)
5.
2882123 Add Ant Quick Start Guide to DITA-OT (Updated in each Milestone after 3)
6.
3086936 Add extension points for TOC output (Eclipse TOC, HTML Help TOC and Project, HTML TOC)
(Milestone 6)
7.
3079610 Add current OT version to log (Milestone 6)
8.
1520909 HTML Help requires appropriate codepage (Milestone 6)
9.
3125994 Allow PDF index conf. to be overridden in Customization (Milestone 7)
10.
3125983 Create a basic glossary implementation for PDF (Milestone 7)
11.
3109395 Add parameter for Eclipse symbolic name (Milestone 8)
[SourceForge Patches Added]
1.
3058008 Refactor chunk module for cleaner code (Milestone 4)
2.
3067681 Add class to ordered child links (Milestone 5)
3.
3064412 Integrator fails to escape XML correctly (Milestone 5)
4.
3062765 Fix unit test file paths to be platform dependent (Milestone 5)
5.
2949860 PDF build.xml with args for JVM memory and architecture (Milestone 6)
6.
3077935 Plug-in ignore in Integrator (Milestone 6)
7.
3065050 Common logging interface (Milestone 6)
8.
3063318 ChunkModule refactoring (Milestone 6)
9.
3061100 Define AbstractPipelineInput's function (Milestone 6)
10.
3102905 Move supported image extensions to configuration file (Milestone 7)
11.
3097518 Show effective property values (Milestone 8)
12.
3101335 apiMap.mod missing from catalog (Milestone 8)
[SourceForge Bugs Fixed]
1.
2928582 commonTopicProcessing template prolog processing out of order (Milestone 1)
2.
2823221 version of Xalan-J inconsistent (Milestone 1)
3.
3023642 Invalid @colname generated in nested table (Milestone 1)
4.
3016739 Chunking mixes up <link> to topic in reltable (Milestone 1)
5.
3020314 Chunk output includes index terms in navtitles (Milestone 1)
6.
3020313 Chunk processor adds <topicref> before <topicmeta> (Milestone 1)
7.
3031513 Nested table processing in pdf2 (Milestone 2)
8.
3030317 Filtering doesn't work on @rev or @props attributes (Milestone 2)
9.
3028650 Replace xs:float with xs:double in Plus plugins (Milestone 2)
10.
3022847 PDF transform gives Java exceptions for spaces in dir name (Milestone 2)
11.
3032950 Scale is not correctly computed in XHTML transforms (Milestone 2)
12.
3033141 dita.xml.properties file not closed after generating (Milestone 2)
13.
3034445 "CURRENDIR" typo in plus-plugins ( Checked in to CVS during Milestone 3)
14.
3034489 Remove all occurrences of <xmlcatalog> from plus-plugins ( Checked in to CVS during Milestone 3)
15.
3035816 When creating .chm, .hhp-file is missing a line-break (Milestone 3)
评论0