To create a WebHelp XSLT customization that is only available for a
certain DITA OT transformation, the extension plugin should declare a custom transtype. The
WebHelp XSLT stylesheets can be overridden from an ANT file provided by the DITA-OT
extension plugin. From the Ant target associated with the plugin, you will specify a
custom XSLT stylesheet that imports the original WebHelp stylesheet and add some
customization templates.
The following procedure explains how to create a DITA-OT extension
plugin that uses this extension method:
-
In the [DITA-OT
DIR]\plugins\ folder, create a folder for this plugin (for
example, com.oxygenxml.webhelp.classic.custom).
-
Create a plugin.xml file (in the folder
you created in step 1) that specifies a new DITA Open Toolkit
transtype
and the build file associated with
the plugin.
For
example:
<plugin id="com.oxygenxml.webhelp.classic.custom">
<feature extension="dita.conductor.target.relative" file="integrator.xml"/>
<transtype name="webhelp-classic-custom" extends="webhelp"
desc="WebHelp Classic Customization"/>
</plugin>
-
Create the integrator.xml file that will
import the actual plugin Ant build file.
For
example:
<project basedir="." name="Webhelp Classic Customization">
<import file="build.xml"/>
</project>
-
Create the build.xml file that overrides
the value of properties associated with the XSLT stylesheets used to produce
HTML files. The following Ant properties can be overridden to specify your
customization stylesheets:
args.wh.classic.topic.xsl
- Specify this property if you want to customize
the XSLT stylesheet used to produce an HTML file for each
topic.
args.wh.classic.create.main.files.xsl
- Specify this property if you want to customize
the XSLT stylesheet used to produce the main HTML files.
args.wh.classic.createTocXML.xsl
- Specify this property if you want to customize
the toc.xml file. The
toc.xml file contains information
extracted from DITA map and it is mainly used to create the
WebHelp TOC.
For example, to customize a WebHelp Classic
transformation type, the build file should look
like:
<project basedir="." name="Webhelp Classic Customization">
<target name="dita2webhelp-classic-custom">
<property
name="args.wh.classic.topic.xsl"
value="${dita.plugin.com.oxygenxml.webhelp.classic.custom.dir}
/xsl/dita2webhelpCustom.xsl"/>
<property
name="args.wh.classic.create.main.files.xsl"
value="${dita.plugin.com.oxygenxml.webhelp.classic.custom.dir}
/xsl/createMainFilesCustom.xsl"/>
<property
name="args.wh.classic.createTocXML.xsl"
value="${dita.plugin.com.oxygenxml.webhelp.classic.custom.dir}
/xsl/createTocXMLCustom.xsl"/>
<antcall target="dita2webhelp"/>
</target>
</project>
-
Create an xsl directory in
the plugin customization directory (that you created in step 1) to store the
customized XSLT stylesheets.
-
Now that the extension plugin is created, install it in the
DITA Open Toolkit.