You can use a template to develop documentation plug-in with DITA
in Eclipse PDE and use DITA OT 1.3 to build and pack the final plug-in. When
you want to develop a documentation plug-in with DITA in Eclipse, you cannot
use the previous releases of DITA OT in Eclipse to transform DITA to HTML.
Though previous releases of DITA OT support the feature to transform DITA
files to Eclipse documentation plug-in, they are not integrated with Eclipse.
With DITA OT 1.3 integrated with WPT, you can develop document plug-ins with
DITA in Eclipse PDE and build and pack the final plug-in by taking the following
- Create a new PDE project in Eclipse, and apply the DITA
template to the project by following the wizard.
- Set the source directory, the main ditamap
file, the output directory (default value is root directory of project), css
storage directory (used to contain common.css, commonltr.css, and commonrtl.css),
user customized .css file name, and conditional processing ditaval file in
the wizard. Use root as output directory is selected
as the default. You can also clear Use root as output
directory and specify another output directory.
- Create DITA files in the source directory and a ditamap to include
the topic files that you created.
- Optional: Import the DITA files into the src directory
of the DITA plug-in project you just created.
- Right-click a directory that you want to put the imported files
and select Import, and then File system.
- Select the directory under which you put the DITA files.
- Click Finish after you selected the DITA files under the specified
directory. The DITA files are then imported to your DITA project.
- Right click build.xml, select Run As, and then ANT Build.
Note: If you're using SUN JDK, please download and use the latest Xalan.
The Xalan shipped with SUN JDK has some issue that will cause the build failure. You can use the latest
Xalan by selecting ANT Build ... and include the all of Xalan's jar files in Classpath.
After the transformation, the output is in the output directory set
in build.xml. Refresh the project after the build is successful.
- Edit the plug-in description of the property file MANITEST.MF in
the plug-in editor after you run the ANT build successfully.
- Click MANITEST.MF to go to the Overview page.
- Edit Dependencies to include org.eclipse.help.
- Edit Extensions to add org.eclipse.help.toc; right click the
added prgeclipse.help.toc, and select New, and then toc.
- Edit the Build Configuration to include the out directory or
the directory you specified in Step 2.
- Save the changes you made to the property file MANITEST.MF.
- Export the output to a documentation plug-in.
can be customized to meet the requirement of headless build.
- Select Next.
; select Deployable plug-ins and fragments and click
- Select the plug-in you want to export and specify a directory
under which you want to put the plug-in package.
- Click Finish to export the plug-in package.