Processing to Eclipse targets (overview)

Eclipse Help is one of the DITA Open Toolkit target outputs. When this output type is specified, the Toolkit produces a directory containing a set of files that can be installed as an Eclipse documentation plug-in. This allows the output to be displayed as Eclipse help or in an Eclipse Infocenter.

In contrast to Eclipse help output, which produces XHTML files to be directly displayed by a browser, Eclipse content output produces .dita files that are rendered into .html files on-the-fly by the Eclipse help processor.

Eclipse help output is a set of files in an output directory that can be installed in an Eclipse distribution as a plug-in. One of the files generated by the Toolkit output processing in the output directory is plugin.xml. This file is used by Eclipse to install the rest of the files in the output directory as an Eclipse help plug-in. The figure below shows a sample plugin.xml file generated by the Toolkit.

<?xml version="1.0" encoding="utf-8"?>
<plugin name="DITA Open Toolkit User Guide" id="ditaug_top" version="1.0" provider-name="DITA">
<extension point=""><toc file="DITAOTUG.xml" primary="true"/>
</extension><extension point="">
<index file="index.xml"/>

The name attribute contains the title Eclipse will display for the set of help files.

The id and version attributes of the plug-in element in this file are combined together to specify the directory where Eclipse expects to find the rest of the plug-in files. In this case that directory would be ditaug_top_1.0. The name attribute is generated from the title attribute of the DITA map file. The id attribute is generated from the id attribute of the DITA map file. For the above plugin.xml file, the DITA map file contained:

<bookmap title="DITA Open Toolkit User Guide" id="ditaug_top">
Note: A bookmap is a specialization of map.