Migrating to release 2.1
In DITA-OT 2.1, the insertVariable
template was deprecated for PDF transformations and
should be replaced with the getVariable
template. Various dita.out.map.*
targets have been deprecated in favor of updated dita.map.*
equivalents.
The customFileUtils code used to handle input and output in earlier versions of DITA-OT has been replaced with the Apache Commons IO utilities library.
Deprecated targets
The following build targets have been deprecated and will be removed in an upcoming release:
- The
help
target that includes a reference to the current DITA-OT version during the build process.
Pre-processing
The following Ant properties and generated list files have been deprecated:
- imagefile property and
image.list
file - htmlfile property and
html.list
file
The following pre-processing targets and extension points have been deprecated:
- The
copy-subsidiary
target used to copy subsidiary files - The
copy-subsidiary-check
target used to check for subsidiary files - The depend.preprocess.copy-subsidiary.pre extension point used to insert an Ant target
before the
copy-subsidiary
step in the pre-processing stage.
A newdita.parser extension point has been added to allow plug-ins to contribute a custom parser for DITA files. If a custom DITA parser is defined, the pre-processing routines will use it during the gen-list and debug-filter stages to output DITA XML.
The following template has been deprecated:
insertVariable
, usegetVariable
instead
Calls to that template will result in warnings in the build log.
To update your plug-in, make the following changes:
<xsl:call-template name="insertVariablegetVariable">
<xsl:with-param name="theVariableIDid" select="var-id"/>
<xsl:with-param name="theParametersparams">
params
</xsl:with-param>
</xsl:call-template>
HTML-based output formats
- KEYREF-FILE
- displaytext
- keys
- target
pull-in-title
common-processing-phrase-within-link
XHTML
The dita.out.map.xhtml.toc
target has been deprecated and should be replaced with the
updated dita.map.xhtml.toc
equivalent.
Keydef processing has been removed from the XHTML rendering code. Keys are now resolved in one pre-processing step, whereas in earlier versions of DITA-OT, the XHTML code returned to the keydef.xml file to look up targets for phrase elements and pull in text when needed.
This change affects non-linking elements that canโt take @href
attributes, such as
<ph>
, <keyword>
, <cite>
,
<dt>
, <term>
, and <indexterm>
(when
$INDEXSHOW
is active).
HTMLHelp
The dita.out.map.htmlhelp.*
targets have been deprecated and should be replaced with
the updated dita.map.htmlhelp.*
equivalents:
dita.out.map.htmlhelp.hhp
, usedita.map.htmlhelp.hhp
insteaddita.out.map.htmlhelp.hhc
, usedita.map.htmlhelp.hhc
insteaddita.out.map.htmlhelp.hhk
, usedita.map.htmlhelp.hhk
instead
JavaHelp
The dita.out.map.javahelp.*
targets have been deprecated and should be replaced with
the updated dita.map.javahelp.*
equivalents:
dita.out.map.javahelp.toc
, usedita.map.javahelp.toc
insteaddita.out.map.javahelp.map
, usedita.map.javahelp.map
insteaddita.out.map.javahelp.set
, usedita.map.javahelp.set
insteaddita.out.map.javahelp.index
, usedita.map.javahelp.index
instead
OpenDocument Text
Support for the args.odt.img.embed parameter has been removed from OpenDocument Text transformations. The previous default behavior was to embed images as Base64-encoded text, but editors do not use this as a default. Instead, office packages such as LibreOffice will convert embedded images into linked images on opening and saving an ODT file.