apb/code-srv-test
apb/code-srv-test
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity Actions

from code-server

Browse source
This commit is contained in:
Andy Bunce 2021-03-23 22:38:58 +00:00
parent eda5c02fe9
commit 5ef8bdba47
2652 changed files with 528235 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

31
dita-ot-3.6/docsrc/release-notes/changes.ditamap Normal file
View file

@ -0,0 +1,31 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">
<map>
<title>DITA-OT release history</title>
<topicref href="rel1.8.dita"/>
<topicref href="rel1.7.dita"/>
<topicref href="rel1.6.dita"/>
<topicref href="rel1.5.4.dita"/>
<topicref href="rel1.5.3.dita"/>
<topicref href="rel1.5.2.dita"/>
<topicref href="rel1.5.1.dita"/>
<topicref href="rel1.5.dita"/>
<topicref href="rel1.4.3.dita"/>
<topicref href="rel1.4.2.1.dita"/>
<topicref href="rel1.4.2.dita"/>
<topicref href="rel1.4.1.dita"/>
<topicref href="rel1.4.dita"/>
<topicref href="rel1.3.1.dita"/>
<topicref href="rel1.3.dita"/>
<topicref href="rel1.2.2.dita"/>
<topicref href="rel1.2.1.dita"/>
<topicref href="rel1.2.dita"/>
<topicref href="rel1.1.2.1.dita"/>
<topicref href="rel1.1.2.dita"/>
<topicref href="rel1.1.1.dita"/>
<topicref href="rel1.1.dita"/>
<topicref href="rel1.0.2.dita"/>
<topicref href="rel1.0.1.dita"/>
<topicref href="rel1.0.dita"/>
<topicref href="history.dita"/>
</map>

8
dita-ot-3.6/docsrc/release-notes/history.dita Normal file
View file

@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" id="history" ditaarch:DITAArchVersion="1.2"><title>DITA history on developerWorks (pre-Open Source)</title><refbody><section id="section_eer_afj_nc">
<p>Versions of the toolkit prior to Open Source are in the developerWorks XML Zone at this
address: <xref format="html" href="http://www-106.ibm.com/developerworks/xml/library/x-dita6/x-dita_downloads.html">DITA Downloads</xref> Change logs for those versions are within the Readme files in
each distribution.</p>
</section></refbody></reference>

366
dita-ot-3.6/docsrc/release-notes/index.dita Normal file
View file

@ -0,0 +1,366 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
<reference id="ID" rev="3.6">
<title>DITA Open Toolkit <keyword keyref="release"/> Release Notes</title>
<titlealts>
<navtitle>Release Notes</navtitle>
</titlealts>
<abstract>
<shortdesc>DITA Open Toolkit <keyword keyref="release"/> includes <ph conref="#v3.6/summary"/>.</shortdesc>
<p conkeyref="conref-task/semver-info"/>
<note type="tip"><ph conkeyref="conref-task/download-ot"/></note>
</abstract>
<reference id="requirements">
<title>Requirements</title>
<refbody>
<section>
<draft-comment author="Roger">Add info on new minimum Java version or any other requirements that have changed
since previous release.</draft-comment>
<p conkeyref="reusable-components/java-clients"/>
</section>
</refbody>
</reference>
<reference id="v3.6">
<title>DITA-OT <keyword keyref="release"/>
<!-- <ph outputclass="small text-muted">released MMM DD, 2020</ph> -->
</title>
<prolog>
<metadata>
<keywords>
<indexterm/>
</keywords>
</metadata>
</prolog>
<refbody>
<section>
<p>DITA Open Toolkit Release <keyword keyref="release"/> includes <ph id="summary">performance enhancements such
as processing in parallel and in memory, support for PDF changebars with <tm
trademark="Apache"
tmtype="tm"
>Apache</tm> FOP, and an updated preview of features for the latest draft of the upcoming DITA 2.0
standard, including the <xmlelement>audio</xmlelement> and <xmlelement>video</xmlelement> elements, and the
new emphasis domain</ph>.</p>
</section>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.6+is%3Aclosed+label%3Afeature+sort%3Acreated-asc -->
<section conkeyref="migrating-to-3.6/parallel-processing">
<title/>
<p/>
</section>
<section conkeyref="migrating-to-3.6/in-memory-processing">
<title/>
<p/>
</section>
<section>
<title>Additional performance improvements</title>
<p>DITA-OT 3.6 includes a series of related changes designed to improve the performance of DITA
transformations.</p>
<ul>
<li id="3616">
<p>A new <parmname>--repeat</parmname> option can be passed to the <cmdname>dita</cmdname> command to run
the process a certain number of times. This option can be used by plug-in developers to measure
performance. (Timings for the first transformation are often dominated by Java warm-up time.)
<xref
href="https://github.com/dita-ot/dita-ot/issues/3616"
format="html"
scope="external"
>#3616</xref></p>
<p>To run a conversion five times, for example, use <parmname>--repeat</parmname>=<option>5</option>. The
duration of each execution will appear in the console when the final transformation is complete.
<codeblock outputclass="syntax-bash multi-platform">$ <cmdname>dita</cmdname> <parmname
>--input</parmname>=<filepath>docsrc/samples/sequence.ditamap</filepath> <parmname
>--format</parmname>=<option>html5</option> <parmname>--repeat</parmname>=<option>5</option>
1 11281ms
2 4132ms
3 3690ms
4 4337ms
5 3634ms</codeblock>
</p>
</li>
<li id="3569">The DITA-OT Java code uses a new caching <codeph>DitaClass.getInstance(cls)</codeph> factory
method rather than generating <codeph>DitaClass</codeph> instances directly. This allows previously created
instances to be re-used, which reduces the number of instances that need to be created.
<xref href="https://github.com/dita-ot/dita-ot/issues/3569" format="html" scope="external">#3569</xref>
</li>
<li id="3570">The Java code for several preprocessing modules has been refactored to use concurrent sets or
queues. This helps to speed up certain operations during preprocessing, allowing builds to complete faster.
<xref href="https://github.com/dita-ot/dita-ot/issues/3570" format="html" scope="external">#3570</xref>
</li>
<li id="3583">The Java code now uses a <codeph>BufferedWriter</codeph> to serialize <codeph>Job</codeph>
objects, which significantly improves UTF-8 encoding performance when writing the
<filepath>.job.xml</filepath> file.
<xref href="https://github.com/dita-ot/dita-ot/issues/3583" format="html" scope="external">#3583</xref>
</li>
</ul>
</section>
<section conkeyref="migrating-to-3.6/fop-changebars">
<title/>
<p/>
</section>
<section id="dita-2-0-preview">
<title>Updated DITA 2.0 preview</title>
<p>In addition to the
<xref keyref="dita-v2-0-support"/> provided in DITA-OT 3.5, this release includes updated processing support
for the latest DRAFT versions of the DITA 2.0 DTD and RELAX NG grammar files from OASIS (as of October 2020).
<xref href="https://github.com/dita-ot/dita-ot/issues/3586" format="html" scope="external">#3586</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3601" format="html" scope="external">#3601</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3617" format="html" scope="external">#3617</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3652" format="html" scope="external">#3652</xref>
</p>
<ul conkeyref="dita-v2-0-support/added-in-3.6">
<li/>
</ul>
<p conkeyref="dita-v2-0-support/grammar-files"/>
<note conkeyref="dita-v2-0-support/more-to-come"/>
</section>
<section id="enhancements">
<title>Enhancements and changes</title>
<indexterm/>
<p>DITA Open Toolkit Release <keyword keyref="release"/> includes the following enhancements and changes to
existing features:</p>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.6+is%3Aclosed+label%3Aenhancement+sort%3Acreated-asc -->
<ul>
<li id="3448">The <xmlatt>rotate</xmlatt> attribute on table <xmlelement>entry</xmlelement> elements is now
respected when generating HTML5 output. The rotation is implemented by setting the CSS
<codeph>writing-mode</codeph> property to <codeph>vertical-rl</codeph> to rotate the cell content. This
property is rendered correctly in Mozilla Firefox, but unevenly supported by other browsers. The
<codeph>rotate</codeph> class is passed to HTML5 output, so custom plug-ins can implement alternative
presentation rules in CSS if necessary.
<xref href="https://github.com/dita-ot/dita-ot/issues/3448" format="html" scope="external">#3448</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3541" format="html" scope="external">#3541</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3651" format="html" scope="external">#3651</xref>
</li>
<li id="3495">User-facing text for the <cmdname>dita</cmdname> command line interface has been extracted to a
strings file to facilitate editing. The <filepath>cli_en_US.properties</filepath> is provided in the
<filepath>resources</filepath> folder as a basis for customization and localization.
<xref href="https://github.com/dita-ot/dita-ot/issues/3495" format="html" scope="external">#3495</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3523" format="html" scope="external">#3523</xref>
</li>
<li id="3506">The new <codeph>Store</codeph> implementation that supports in-memory processing includes an
immutable document reader method that can be used to request a document that doesn't need to change during
processing. This approach facilitates caching and helps to speed up processing.
<xref href="https://github.com/dita-ot/dita-ot/issues/3506" format="html" scope="external">#3506</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3548" format="html" scope="external">#3548</xref>
</li>
<li id="3535">In earlier versions, variations in reference capitalization could cause unexpected results when
building output on case-sensitive file systems. DITA-OT now warns when file references use incorrect case.
(For example, if maps reference <filepath>Topic.dita</filepath>, but the filename on disk is actually
<filepath>topic.dita</filepath>.) In strict processing mode, this is considered a fatal error; in lax
processing mode, the file reference is rewritten to use the same case as the file system.
<xref href="https://github.com/dita-ot/dita-ot/issues/3535" format="html" scope="external">#3535</xref>
</li>
<li id="3556">The <parmname>--filter</parmname> option can now be passed to the <cmdname>dita</cmdname>
multiple times in a single command-line invocation to apply conditions from several DITAVAL files at once.
<xref href="https://github.com/dita-ot/dita-ot/issues/3556" format="html" scope="external">#3556</xref>
</li>
<li id="3558">The bundled <tm trademark="Apache" tmtype="tm">Apache</tm> Formatting Objects Processor (FOP)
has been upgraded to version 2.5, which includes security updates to various embedded libraries.
<xref href="https://github.com/dita-ot/dita-ot/issues/3558" format="html" scope="external">#3558</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3630" format="html" scope="external">#3630</xref>
</li>
<li id="3562">The deprecated <codeph>msgprefix</codeph> XSL variable (“DOTX”) has been removed. This variable
was originally deprecated in DITA-OT 2.3, but still defined in several stylesheets. Importing the common XSL
module <filepath>output-message.xsl</filepath> no longer requires this variable to be defined.
<xref href="https://github.com/dita-ot/dita-ot/issues/3562" format="html" scope="external">#3562</xref>
</li>
<li id="3564">The <apiname>S9api</apiname> message listener from the Saxon API is now used to forward log
messages to the <codeph>DITAOTLogger</codeph>. This allows message levels and error codes to be passed from
XSLT to Java code for improved debugging.
<xref href="https://github.com/dita-ot/dita-ot/issues/3564" format="html" scope="external">#3564</xref>
</li>
<!--
<li id="3569">Cache DitaClass instances
<xref href="https://github.com/dita-ot/dita-ot/issues/3569" format="html" scope="external">#3569</xref>
</li>
<li id="3570">Use concurrent sets or queues
<xref href="https://github.com/dita-ot/dita-ot/issues/3570" format="html" scope="external">#3570</xref>
</li>
<li id="3583">Use BufferedWriter to output Job for 200 fold performance improvement
<xref href="https://github.com/dita-ot/dita-ot/issues/3583" format="html" scope="external">#3583</xref>
</li>
-->
<li id="3594">HTML5 output now includes additional metadata to indicate that the content was produced using
DITA Open Toolkit.
<xref href="https://github.com/dita-ot/dita-ot/issues/3594" format="html" scope="external">#3594</xref>
<codeblock outputclass="language-html">&lt;meta name="generator" content="DITA-OT"/&gt;</codeblock>
</li>
<li id="3595">Up to version 3.5, DITA-OT included the
<xref keyref="dublin-core"/> in both XHTML and HTML5 output. For DITA-OT 3.6, this capability was extracted
to a separate plugin, and Dublin Core metadata is no longer generated in the default HTML5 output.
<xref href="https://github.com/dita-ot/dita-ot/issues/3595" format="html" scope="external">#3595</xref>
<p>If necessary, the
<xref keyref="plugin-dublin-core"/> plug-in can be installed from the plug-in registry at
<xref keyref="site-plugin-registry"/> to add Dublin Core metadata to HTML5. To install the plug-in, run
the following command:</p>
<codeblock outputclass="syntax-bash"><cmdname>dita install</cmdname> org.dita.html5.dublin-core</codeblock>
</li>
<li id="3599">In XHTML output, previous versions failed to distinguish <i>Notice</i> note types from regular
notes, prefixing both with <b>Note</b>. Support has been backported from HTML5 to XHTML to prefix notices
with <b>Notice</b> as expected.
<xref href="https://github.com/dita-ot/dita-ot/issues/3599" format="html" scope="external">#3599</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3600" format="html" scope="external">#3600</xref>
</li>
<li id="3602">Unused code for flagging and key processing has been removed along with related files that have
been deprecated since version 2.1, including the base <filepath>flag.xsl</filepath> stylesheet, the
generated <filepath>keydef.xml</filepath> file, and <filepath>schemekeydef.xml</filepath>.
<xref href="https://github.com/dita-ot/dita-ot/issues/3602" format="html" scope="external">#3602</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3603" format="html" scope="external">#3603</xref>
</li>
<!--
<li id="3617">Share latest from oasis-tcs/dita and oasis-tcs/dita-techcomm
<xref href="https://github.com/dita-ot/dita-ot/issues/3617" format="html" scope="external">#3617</xref>
</li>
-->
<li id="3632">
<p>Remaining inline style attributes were removed from HTML5 code, which prevented custom plug-ins from
overriding the presentation of the corresponding elements, including:
<ul>
<li><line-through><xmlelement>line-through</xmlelement></line-through> and
<overline><xmlelement>overline</xmlelement></overline> elements</li>
<li>syntax diagrams</li>
<li>long quote citations</li>
<li>Boolean states</li>
</ul></p>
<p>These changes move the default presentation rules to CSS to allow users to override these styles in
custom stylesheets. The output is visually equivalent to the results generated by previous toolkit
versions.
<xref href="https://github.com/dita-ot/dita-ot/issues/3632" format="html" scope="external">#3632</xref>
</p>
<note type="important">In publishing environments that do not use the default common CSS files, these styles
may need to be implemented in custom stylesheets.</note>
</li>
</ul>
</section>
<section id="bugs">
<title>Bugs</title>
<indexterm/>
<p>DITA Open Toolkit Release <keyword keyref="release"/> provides fixes for the following bugs:</p>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.6+is%3Aclosed+label%3Abug+sort%3Acreated-asc -->
<ul>
<!-- These issues only affected development builds, not any previously released version -->
<!--
<li id="3589">Build fails unless temp directory is specified
<xref href="https://github.com/dita-ot/dita-ot/issues/3589" format="html" scope="external">#3589</xref>
</li>
<li id="3593">Fix build init order to initialise project after temp dir
<xref href="https://github.com/dita-ot/dita-ot/issues/3593" format="html" scope="external">#3593</xref>
</li>
<li id="3609">Fix setting html5.map.url property
<xref href="https://github.com/dita-ot/dita-ot/issues/3609" format="html" scope="external">#3609</xref>
</li>
-->
<li id="2414">
<p>Folder names in development build archives previously included the “<codeph>+</codeph>” plus sign, which
caused errors when running from the unpacked directory. The snapshot folder name syntax has been updated
to use the “<codeph>@</codeph>” at sign instead, which allows builds to run directly from the extracted
folder.
<xref href="https://github.com/dita-ot/dita-ot/issues/2414" format="html" scope="external">#2414</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3623" format="html" scope="external">#3623</xref>
</p>
</li>
<li id="3608">
<p>The license text for the beta DITA 2.0 grammar file plug-in was missing in DITA-OT 3.5 and is now
included in the distribution package.
<xref href="https://github.com/dita-ot/dita-ot/issues/3608" format="html" scope="external">#3608</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3649" format="html" scope="external">#3649</xref>
</p>
</li>
<li>The Java code has been refactored to anticipate cases where resources are missing or incorrectly defined.
<ul>
<li id="3624">The <codeph>File.toURI()</codeph> method has been updated to ensure that the generated URI
for a directory will always end in a trailing slash. This prevents unexpected errors in cases when the
<codeph>File</codeph> input points to a path that doesn’t exist.
<xref href="https://github.com/dita-ot/dita-ot/issues/3621" format="html" scope="external">#3621</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3624" format="html" scope="external">#3624</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3626" format="html" scope="external">#3626</xref>
</li>
<li id="3625">The <codeph>JobSourceSet</codeph> has been fixed to handle cases where the
<codeph>src</codeph> input is <codeph>null</codeph>.
<xref href="https://github.com/dita-ot/dita-ot/issues/3625" format="html" scope="external">#3625</xref>
</li>
</ul>
</li>
<li id="3627">In DITA-OT 3.5.4, the HTMLHelp stylesheet <filepath>map2hhcImpl.xsl</filepath> included an
invalid code remnant left over from previous edits. The unnecessary line has been removed.
<xref href="https://github.com/dita-ot/dita-ot/issues/3627" format="html" scope="external">#3627</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3634" format="html" scope="external">#3634</xref>
</li>
<!--
<li id="3636">Fix repeat count in install and uninstall subcommands
<xref href="https://github.com/dita-ot/dita-ot/issues/3636" format="html" scope="external">#3636</xref>
</li>
-->
</ul>
</section>
<section id="contrib">
<title>Contributors</title>
<p>DITA Open Toolkit Release <keyword keyref="release"/> includes
<xref keyref="contributions"/> by the following people:</p>
<!-- https://github.com/tj/git-extras/blob/master/Commands.md#git-summary – `git summary 3.5.4..` -->
<draft-comment author="Roger">NOTE: This lists contributions to the core toolkit, not docs.</draft-comment>
<ol>
<li>Jarno Elovirta</li>
<li>Roger Sheen</li>
<li>Robert D Anderson</li>
<li>Radu Coravu</li>
<li>David Bertalan</li>
</ol>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/3.5...3.6" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
<section id="docs">
<title>Documentation updates</title>
<p>The documentation for DITA Open Toolkit Release <keyword keyref="release"/> provides corrections and
improvements to existing topics, along with new information in the following topics:</p>
<ul>
<li>
<xref keyref="store-api"/></li>
<li>
<xref keyref="dita-v2-0-support"/></li>
<li>
<xref keyref="migrating-to-3.6"/></li>
<li>
<xref keyref="reducing-processing-time"/></li>
<li>
<xref keyref="parameters-base"/></li>
<li>
<xref keyref="build-using-dita-command"/></li>
<li>
<xref keyref="dita-command-arguments"/></li>
</ul>
<p>For additional information on documentation issues resolved in DITA Open Toolkit Release <keyword
keyref="release"
/>, see the
<xref
href="https://github.com/dita-ot/docs/issues?q=milestone%3A3.6+is%3Aclosed"
format="html"
scope="external"
><keyword keyref="release"/> milestone</xref> in the documentation repository.</p>
<p>DITA Open Toolkit Release <keyword keyref="release"/> includes
<xref keyref="docs-contributions"/> by the following people:</p>
<draft-comment author="Roger">NOTE: This lists contributions to docs, not to the core toolkit.</draft-comment>
<ol>
<li>Roger Sheen</li>
<li>Jarno Elovirta</li>
<li>Lief Erickson</li>
<li>Heston Hoffman</li>
</ol>
<p>For the complete list of documentation changes since the previous release, see the
<xref href="https://github.com/dita-ot/docs/compare/3.5...3.6" format="html" scope="external">
changelog</xref>.</p>
</section>
</refbody>
</reference>
</reference>

9
dita-ot-3.6/docsrc/release-notes/rel1.0.1.dita Normal file
View file

@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" id="rel1.0.1" ditaarch:DITAArchVersion="1.2"><title>DITA OT release 1.0.1</title><shortdesc>Release 1.0.1 is a maintenance release to fix defects and adds some minor
enhancements in release 1.0.</shortdesc><refbody><section>
<title>Changes</title>
<ol><li>Committer: maplink.xsl doesn't generate related links for second level referred
topic </li><li>Committer: avoid infinite loop of conref</li><li>SF Bug 1160964: Can't point above the directory which contains the map file</li><li>SF Bug 1163523: Broken XPath expression in mappull.xsl</li><li>SF Bug 1168974: useless DRAFT param in FO transformation</li><li>SF Bug 1173162: generate null internal link destination in fo transformation</li><li>SF Bug 1173164: Not correctly use document() in dita2fo-links.xsl</li><li>SF Bug 1173663: All base directories are DITA-OT 1.0</li><li>SF Patch 1163561: XLST match patterns test for element names</li><li>SF Patch 1165068: FO hyperlinks and FOP-generated PDF bookmarks</li><li>SF Patch 1174012: Modification to sequence.ditamap</li></ol>
</section></refbody></reference>

8
dita-ot-3.6/docsrc/release-notes/rel1.0.2.dita Normal file
View file

@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" id="rel1.0.2" ditaarch:DITAArchVersion="1.2"><title>DITA OT release 1.0.2</title><shortdesc>Release 1.0.2 is a maintenance release to fix defects and adds some minor
enhancements in release 1.0.1.</shortdesc><refbody><section>
<title>Changes</title>
<ol><li>SF Bug 1181950: format attribute should be set to 'dita' for dita topic</li><li>SF RFE 1183487: Document the usage of footer property</li><li>SF RFE 1198847: command line interface support</li><li>SF RFE 1198850: architecture document update</li><li>SF RFE 1200410: need explanation for dita.list</li><li>SF RFE 1201175: XML catalog support</li><li>SF Patch 1176909: Add template for getting image URI</li></ol>
</section></refbody></reference>

18
dita-ot-3.6/docsrc/release-notes/rel1.0.dita Normal file
View file

@ -0,0 +1,18 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" id="rel1.0" ditaarch:DITAArchVersion="1.2"><title>DITA OT release 1.0</title><shortdesc>The initial release of the Open Sourced DITA Toolkit introduces major architectural
changes from the previous, developerWorks version of the Toolkit.</shortdesc><refbody><section>
<title>New features</title>
<ol><li>A new, Java-based processing architecture that supports single-threaded execution
throughout.</li><li>Ant-based orchestration of the processing environment, from preprocessing to
transformation to any required post-processing.</li><li>A pre-processor core that supports conditional processing and conref resolution.</li><li>Map-driven processing that generates links for transformed topics.</li><li>A new DITA to HTML transform that replaces the previous topic2html_Impl.xsl core
transform. This new core is based on requirements for high-volume usage within IBM for
the past several years.</li></ol>
<p>Ant-driven processing means that you can
integrate the DITA processing tools into a seamless pipeline within
supportive environments such as Eclipse.</p> <p>The DTDs and
Schemas in this version are based on those in the previous dita132
package with bug fixes. The DITA OS Toolkit will later support the
OASIS 1.0 specification in its public review form.</p>
</section></refbody></reference>

11
dita-ot-3.6/docsrc/release-notes/rel1.1.1.dita Normal file
View file

@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" id="rel1.1.1" ditaarch:DITAArchVersion="1.2"><title>DITA OT release 1.1.1</title><shortdesc>Release 1.1.1 is a maintenance release to fix defects and make patches based on
release 1.1.</shortdesc><refbody><section id="section_hjo_rej_nc">
<p>For patch 1284023, we are changing the name of the jar lib file from dost1.0.jar back to
dost.jar because we believe we need to keep the jar file name consistent through various
releases.</p>
</section><section id="section_tjo_rej_nc">
<b>Changes</b>
<ol><li>SF Bug 1196409: HTMLHelp output does not reference CSS</li><li>SF Bug 1272687: extra "../" link generated by topicgroup</li><li>SF Bug 1273751: revision flag using unavailable pictures </li><li>SF Bug 1273816: Index generation doesn't cope with multilevel well </li><li>SF Bug 1281900: Unnecessary comment and href typo</li><li>SF Bug 1283600: unecessary space in document cause invalid parameter of Ant </li><li>SF Bug 1283644: multipul document($FILTERFILE,/) doesn't work (XALAN) </li><li>SF Patch 1251609: pretargets xsl directory needs to use ${dita.script.dir} </li><li>SF Patch 1252441: Files in temp directory not deleted before build</li><li>SF Patch 1253785: Inline images in dita2fo-elems</li><li>SF Patch 1284023: change the name of jar file and remove the version name </li></ol></section></refbody></reference>

24
dita-ot-3.6/docsrc/release-notes/rel1.1.2.1.dita Normal file
View file

@ -0,0 +1,24 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" id="rel1.1.2.1" ditaarch:DITAArchVersion="1.2"><title>DITA OT release 1.1.2.1</title><shortdesc>Release 1.1.2.1 is a full build to provide an urgent fix to fix the following
critical problem which users found in release 1.1.2.</shortdesc><refbody><section id="section_vbz_mej_nc">
<p>
<ul><li>SF Bug 1345600 The build process failed when run "Ant all" in release
1.1.2</li></ul>
</p>
<p>For this fix, we have restored all the source DITA files in 'doc' and
directories in the binary packages.</p>
<p>Note that the original parameter "args.eclipse.toc" in "Ant tasks and
script" was separated to "args.eclipsehelp.toc" for DITA-to-Eclipse help
transformation, and "args.eclipsecontent.toc" for DITA-to-dynamic Eclipse
content transformation.</p>
<p>Another issue is that we found there is a mismatch in the document and the toolkit
behavior when you are trying to use the following command
<codeblock xml:space="preserve">ant -f conductor.xml -propertyfile ${dita.temp.dir}/property.temp.</codeblock>
Now we have updated the documentation. Please refer to the topic 'Building DITA
output with Java command line' on our website for more details.</p>
<p>These updates do not affect standard operation of the toolkit. The main goal of this
minor release to enable new users of the toolkit to run the installation verification
tests without failure.</p>
</section></refbody></reference>

23
dita-ot-3.6/docsrc/release-notes/rel1.1.2.dita Normal file
View file

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" id="rel1.1.2" ditaarch:DITAArchVersion="1.2"><title>DITA OT release 1.1.2</title><shortdesc>Release 1.1.2 is a maintenance release to fix defects and make patches based on
release 1.1.1.</shortdesc><refbody><section id="section_itw_oej_nc">
<p>But there are certain limitations and unfixed bugs in this release, such as, <ul><li>Bug 1343963 Blank index.html generated for ditamap contains only reltabe</li><li>Bug 1344486 java.io.EOFException thrown out when reading ditaval file</li></ul> Please check the current 'open' bugs on the SourceForge bugs tracker. </p>
</section><section id="section_qjq_pej_nc">
<title>Changes</title>
<ol><li>SF Bug 1297355: Multilevel HTML Help popup shows filenames</li><li>SF Bug 1297657: Update for Supported Parameters page</li><li>SF Bug 1304859: Toolkit disallows repetition of topic ID within map</li><li>SF Bug 1306361: Fatal error in published ditamap example</li><li>SF Bug 1306363: common.css not compiled with htmlhelp</li><li>SF Bug 1311788: DTD references not resolved</li><li>SF Bug 1314081: Fix catalog entries in catalag-ant.xml for OASIS DTDs</li><li>SF Bug 1323435: wrong system id for html output used in validation</li><li>SF Bug 1323486: HTML Help subterm indexes not sorted</li><li>SF Bug 1325290: JavaHelp output does not work for Russian</li><li>SF Bug 1325277: File missing from the map causes abend</li><li>SF Patch 1253783: dita2fo-links relative hrefs</li><li>SF Patch 1324387: In xslfo, groupchoice var prints extra | delimiter</li><li>SF RFE 1324990: Installation Guide</li></ol>
</section><section id="section_scb_qej_nc">
<title>Parameter Changes</title>
<p>
<ol><li>The original parameter "args.eclipse.toc" in "Ant tasks and
script" was separated to "args.eclipsehelp.toc" for dita2eclipsehelp
transformation, and "args.eclipsecontent.toc" for dita2eclipsecontent
transformation.</li><li>Several parameters were added to the java command line interface, including
"/javahelptoc","/javahelpmap","/eclipsehelptoc","/eclipsecontenttoc","/xhtmltoc".</li></ol>
</p>
</section><section id="section_vwh_qej_nc">
<title>Other Changes</title>
<p> Change to the "doc" directory, except "doc\langref" directory: <ol><li>The source dita files and the generated HTML, CHM, and PDF files were separated into
separate downloads.</li><li>The source package contains the source dita files.</li><li>The binary package contains the generated HTML, CHM, and PDF files.</li></ol></p>
</section></refbody></reference>

77
dita-ot-3.6/docsrc/release-notes/rel1.1.dita Normal file
View file

@ -0,0 +1,77 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" id="rel1.1" ditaarch:DITAArchVersion="1.2"><title>DITA OT release 1.1</title><shortdesc>Release 1.1 is a major release to add new functions, fulfill new requirements, make
some function enhancements and fix bugs over release 1.0.2.</shortdesc><refbody><section id="section_rnc_tej_nc">
<ol><li>
<b>Adaptation to the new OASIS DITA standard</b>
<p>Release 1.1 implements the new OASIS DITA 1.0 standard for DITA DTDs and Schemas.</p>
<p>DTDs of the previous release locate in the directory <b>dtd/dita132</b> and schemas
of the previous release locate in the directory <b>schema/dita132</b>. </p>
</li><li>
<b>Transformation to troff</b>
<p>Release 1.1 supports new troff output. Troff output looks like Linux man page
output.</p>
</li><li>
<b>XML catalog support</b>
<p>An XML catalog, which can consist of several catalog entry files, is a logical
structure that describes mapping information between public IDs and URLs of DTD files.
A catalog entry file is an XML file that includes a group of catalog entries. If you
want to know more about XML catalog, please refer<xref href="../xmlcatalog.xml">XML
Catalog</xref>.</p>
<p>A catalog entry can be used to locate a unified resource identifier (URI) reference
for a certain resource such as a DTD file. An external entity's public identifier
is used for mapping to the URI reference. The URI of any system identifier can be
ignored.</p>
</li><li>
<b>Topicref referring to a nested topic</b>
<p>The href attribute of the topicref is extended to quote a nested topic in a dita
file.</p>
<p>For example, in previous releases, href attribute is set like: href =
"xxx.dita"; in release 1.1, href attribute can be set like: href =
"xxx.dita#abc.dita".</p>
</li><li>
<b>Globalization support</b>
<p>Release 1.1 supports over 20 popular languages within the content of dita files. And
it also provides translation function for DITA keywords to over 20 languages.
Currently this globalization support fully applies to Eclipse Help and XHTML
transformations, and partially applies to other transformations.</p>
</li><li>
<b>Accessibility support</b>
<p>Accessibility support is now partially applies to PDF and XHTML transformations.</p>
</li><li>
<b>Eclipse Content Provider Support</b>
<p>Please refer to <xref href="../eclipseconprov.xml">Eclipse Content Provider</xref> for
detail information.</p>
</li><li>
<b>Index information in output</b>
<p>The output of HTML Help and Java Help transformations contain index information
now.</p>
</li><li>
<b>Mapref function</b>
<p>Mapref refers to a special usage of the <tt>&lt;topicref&gt;</tt> element as a
reference to another ditamap file. This allows you to manage the overall ditamap file
more easily. A large ditamap file can thus be broken down into several ditamap files,
making it easier for the user to manage the overall logical structure. On the other
hand, this mechanism also increases the reusability of those ditamap files. If you
want to know more about mapref, please refer <xref href="../mapref.xml">Mapref</xref>.</p>
</li><li>
<b>TOC generation for Eclipse Help transformation</b>
<p>TOC generation now supported in transformation to Eclipse Help. Eclipse.</p>
</li><li>
<b>Helpset generation for Java Help transformation</b>
<p>Helpset generation now supported in transformation to Java Help.</p>
</li><li>
<b>New parameters supported in Java commands</b>
<p>In Java commands: /indexshow, /outext, /copycss, /xsl, /tempdir.</p>
</li><li>
<b>New parameters supported in Ant scripts</b>
<p>In Ant scripts: args.indexshow, args.outext, args.copycss, args.xsl,
dita.temp.dir</p>
</li></ol>
</section><section id="section_goc_tej_nc">
<p>
<b>Other Changes</b>
<ol><li>SF bug 1220569: Add XML Schema processing to DITA-OT</li><li>SF bug 1220644: Prompted ant--image does not link for single topic to PDF</li><li>SF bug 1229058: Add schema validation loading file for processing</li><li>SF RFE 1176855: Ant must be run from toolkit directory</li><li>SF RFE 1183482: Copy pre-existing html to output dir</li><li>SF RFE 1183490: Provide argument to specify the location of temp dir</li><li>SF RFE 1201242: override capability</li></ol>
</p>
</section></refbody></reference>

11
dita-ot-3.6/docsrc/release-notes/rel1.2.1.dita Normal file
View file

@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" id="rel1.2.1" ditaarch:DITAArchVersion="1.2"><title>DITA OT release 1.2.1</title><shortdesc>Release 1.2.1 is a maintenance release to fix defects and make patches based on
release 1.2.</shortdesc><refbody><section id="section_wxg_hej_nc">
<title>Improvements</title>
<ol><li>Corrupt table generated in WORD RTF is fixed</li><li>Pictures are merged into the WORD RTF instead of creating links to them</li><li>lq element is supported in WORD RTF</li><li>Generated text can be translated to different languages in WORD RTF</li><li>In WORD RTF, if no &lt;choptionhd&gt; given, head will be generated in table</li></ol>
</section><section id="section_axn_hej_nc">
<title>SourceForge Changes</title>
<ol><li>SF Bug 1460451 Spaces preserving methods are different among tags.</li><li>SF Bug 1460449 Nested list can not be well supported.</li><li>SF Bug 1460445 h2d stylesheet cannot handle HTML files within namespace.</li><li>SF Bug 1431229 hardcoded path in MessageUtils.java</li><li>SF Bug 1408477 &lt;desc&gt; element is not handled inside xref for XHTML</li><li>SF Bug 1398867 ampersands in hrefs (on xref and link) cause build to fail</li><li>SF Bug 1326439 filtered-out indexterms leak into index through dita.list </li><li>SF Bug 1408487 Short description is not retrieved for &lt;xref&gt; element</li><li>SF Bug 1407454 XHTML processing for &lt;alt&gt; is incomplete </li><li>SF Bug 1405221 Some table frames ignored in dita-&gt;xhtml </li><li>SF Bug 1414398 Cannot set provider for Eclipse help transformation </li><li>SF RFE 1448712 add support for /plugins directory in plug-in architecture</li></ol>
</section></refbody></reference>

12
dita-ot-3.6/docsrc/release-notes/rel1.2.2.dita Normal file
View file

@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" id="rel1.2.2" ditaarch:DITAArchVersion="1.2"><title>DITA OT release 1.2.2</title><shortdesc>Release
1.2.2 is a maintenance release to fix defects and make patches based
on release 1.2.1.</shortdesc><refbody><section id="section_yma_eej_nc">
<title>Improvements</title>
<ol><li>Chinese support in WORD RTF</li><li>Improve plug-in architecture in plug-in dependency handling</li></ol>
</section><section id="section_olj_fej_nc">
<title>SourceForge Changes</title>
<ol><li>SF Bug 1461642 Relative paths in toolkit.</li><li>SF Bug 1463756 TROFF output is not usable</li><li>SF Bug 1459527 Properties elements should generate default headings</li><li>SF Bug 1457552 FO gen-toc does not work right for ditamaps and bookmaps</li><li>SF Bug 1430983 Specialized indexterm does not generate entries in index</li><li>SF Bug 1363055 Shortdesc disappears when optional body is removed</li><li>SF Bug 1368403 The dita2docbook transformation lacks support for args.xsl</li><li>SF Bug 1405184 Note template for XHTML should be easier to override</li><li>SF Bug 1407646 Map titles are not used in print outputs</li><li>SF Bug 1409960 No page numbers in PDF toc</li><li>SF Bug 1459790 Related Links omitted when map references file#topicid</li><li>SF Bug 1428015 Topicmerge.xsl should leave indentation alone</li><li>SF Bug 1429400 FO output should allow more external links</li><li>SF Bug 1405169 Space inside XHTML note title affects CSS presentation</li><li>SF Bug 1402377 Updated translations for Icelandic</li><li>SF Bug 1366845 XRefs do not generate page numbers</li><li>SF Patch 1326450 Make ${basedir} mine</li><li>SF Patch 1328264 FOP task userconfig file</li><li>SF Patch 1385636 Tweaks to docbook/topic2db.xsl</li><li>SF Patch 1435584 Recognize more image extensions</li><li>SF Patch 1444900 Add template for getting input file URI</li><li>SF Patch 1460419 Add a new parameter /cssroot:{args.cssroot}</li><li>SF Patch 1460441 map2hhp [FILES] include</li><li>SF RFE 1400140 Add a new parameter /cssroot:{args.cssroot}</li></ol>
</section></refbody></reference>

56
dita-ot-3.6/docsrc/release-notes/rel1.2.dita Normal file
View file

@ -0,0 +1,56 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" id="rel1.2" ditaarch:DITAArchVersion="1.2"><title>DITA OT release 1.2</title><shortdesc>DITA open toolkit Release 1.2 is a major release to add new functions, fulfill new
requirements, make some function enhancements and fix bugs over release 1.1.2.1.</shortdesc><refbody><section id="section_jyg_jej_nc">
<title>Important Change</title>
<p>DITA-OT 1.2 offers new error handling and logging system. If you invoke your
transformation by using java command line where new error handling and logging system is
mandatory, you need to set the <varname>CLASSPATH</varname> Environment Variable for
<codeph>dost.jar</codeph>. If you invoke your transformation by using an ant script, you
need to do one more step after the setting above. That is adding a parameter in your
command to invoke an ant script. For example, use <userinput>ant -f ant\sample_xhtml.xml
-logger org.dita.dost.log.DITAOTBuildLogger</userinput> instead of <userinput>ant -f
ant\sample_xhtml.xml</userinput> to start a transformation defined in ant script file
ant\sample_xhtml.xml. </p>
</section><section id="section_tix_lej_nc">
<title>New Functions</title>
<ol><li>
<b>New plugin archiecture</b>
<p>DITA Open Toolkit 1.2 provides a new function to help users to download, install and
use plug-ins and help developers create new plug-ins for DITA Open Toolkit.</p>
</li><li>
<b>Transformation to wordrtf</b>
<p>DITA Open Toolkit 1.2 provides DITA to Word transforming function to transform DITA
source files to output in <tm tmclass="special" tmowner="Microsoft Corporation" tmtype="reg" trademark="Microsoft">Microsoft</tm> Word RTF file.</p>
</li><li>
<b>HTML to DITA migration tool</b>
<p>DITA Open Toolkit 1.2 provides a HTML to DITA migration tool, which migrates HTML
files to DITA files. This migration tool originally comes from the developerWorks
publication of Robert D. Anderson's how-to articles with the original h2d
code.</p>
</li><li>
<b>Problem determination and log analysis</b>
<p>In DITA Open Toolkit 1.2, a new logging method is supported to log messages both on
the screen and into the log file. The messages on the screen present user with the
status information, warning, error, and fatal error messages. The messages in the log
file present user with more detailed information about the transformation process. By
analyzing these messages, user can know what cause the problem and how to solve
it.</p>
</li><li>
<b>Open DITA User Guide for conditional processing</b>
<p>In DITA Open Toolkit 1.2, a new user guide which can help users to use conditional
processing is added to toolkit document.</p>
</li><li>
<b>Include the OASIS version langref</b>
<p>In DITA Open Toolkit 1.2, a new OASIS version of language reference for DITA standard
is added to toolkit document.</p>
</li><li>
<b>Document adapt to OASIS DITA 1.0.1 DTDs</b>
<p>DITA DTD files are updated to 1.0.1 version in DITA Open Toolkit 1.2.</p>
</li></ol>
</section><section id="section_cjx_lej_nc">
<title>Other Changes</title>
<ol><li>SF Bug 1304545 Some folders were copied to DITA-OT's root directory</li><li>SF Bug 1328689 Stylesheet links in HTML emitted with local filesystem paths</li><li>SF Bug 1333481 Mapref function does not work for maps in another directory</li><li>SF Bug 1343963 Blank index.html generated for ditamap contains only reltabe</li><li>SF Bug 1344486 java.io.EOFException thrown out when reading ditaval file</li><li>SF Bug 1347669 Path Spec. in nested DITA maps</li><li>SF Bug 1357139 filtering behavior doesn't conform to spec</li><li>SF Bug 1358619 The property.temp file gets cleaned out by default</li><li>SF Bug 1366843 XRefs do not generate proper links in FO/PDF</li><li>SF Bug 1367636 dita2fo-elems.xsl has strange line breaks</li><li>SF RFE 1296133 Enable related-links in PDF output</li><li>SF RFE 1326377 Add a /dbg or /debug flag for diagnostic info</li><li>SF RFE 1331727 Toolkit need to run on JDK 1.5.x(only support to run under Sun JDK 1.5
with saxon in normal case)</li><li>SF RFE 1357054 Be more friendly towards relative directories</li><li>SF RFE 1357906 Provide a default output directory</li><li>SF RFE 1368073 Enable plugins for DITA open toolkit</li><li>SF RFE 1379518 Clearer error messages and improved exception handling</li><li>SF RFE 1379523 DITA to Rich Text Format (.rtf) file</li><li>SF RFE 1382482 plugin architecture of DITA-OT</li></ol>
</section></refbody></reference>

9
dita-ot-3.6/docsrc/release-notes/rel1.3.1.dita Normal file
View file

@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" id="rel1.3.1" ditaarch:DITAArchVersion="1.2"><title>DITA OT release 1.3.1</title><shortdesc>Release 1.3.1 is a maintenance release to fix defects and make patches based on
release 1.3.</shortdesc><refbody><section id="section_sre_zdj_nc">
<title>15 SF Bugs Fixed</title>
<ol><li>SF Bug 1385642 docbook/topic2db.xsl - shortdesc</li><li>SF Bug 1528638 wordrtf does not correctly number steps</li><li>SF Bug 1562518 Flag is confusing when a list is mixed with text</li><li>SF Bug 1563665 Should use CSS to honor rowsep and colsep in table entries</li><li>SF Bug 1567117 Xref to footnote is not resolved correctly </li><li>SF Bug 1569671 &lt;reltable&gt; in nested map creates bogus TOC entries</li><li>SF Bug 1573996 Plugins do not work in plugins directory</li><li>SF Bug 1574011 Spaces in a file name prevent XHTML output</li><li>SF Bug 1584186 Bookmap 1.1: &lt;title&gt; element duplicated in mappull</li><li>SF Bug 1588039 Conref domain checking is sub-par</li><li>SF Bug 1588624 OT v1.3 map2hhc.xsl error</li><li>SF Bug 1597444 Java topicmerge breaks when text contains less-than</li><li>SF Bug 1597473 Nothing references common.css</li><li>SF Bug 1598109 Java topicmerge does not rewrite image/@href</li><li>SF Bug 1598230 jhindexer of JavaHelp breaks Search Index for DITAOT content</li></ol>
</section></refbody><related-links><linklist><desc>SourceForge bugs, patches, and RFEs listed above can be found in SourceForge Bugs,
Patches, and RFE tracker pages</desc><link href="http://sourceforge.net/tracker/?group_id=132728&amp;atid=725074" scope="external"><linktext>Bugs tracker</linktext></link><link href="http://sourceforge.net/tracker/?group_id=132728&amp;atid=725076" scope="external"><linktext>Patches tracker</linktext></link><link href="http://sourceforge.net/tracker/?group_id=132728&amp;atid=725077" scope="external"><linktext>RFE tracker</linktext></link></linklist></related-links></reference>

86
dita-ot-3.6/docsrc/release-notes/rel1.3.dita Normal file
View file

@ -0,0 +1,86 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" id="rel1.3" ditaarch:DITAArchVersion="1.2"><title>DITA OT release 1.3</title><refbody><section id="section_qhs_zdj_nc">
<title>OASIS DITA 1.1 support</title>
<p>Things to know about OASIS DITA 1.1 support in this release:</p>
<ol><li>DITA-OT 1.3 provides preliminary processing support for the upcoming OASIS DITA 1.1
specification (see <xref format="html" href="http://wiki.oasis-open.org/dita/Roadmap_for_DITA_development" scope="external">http://wiki.oasis-open.org/dita/Roadmap_for_DITA_development</xref>). Because the
proposed OASIS DITA 1.1 DTDs and Schemas are fully backwards compatible with the latest
DITA 1.0.1 DTDs and Schemas, the 1.3 Toolkit provides the proposed 1.1 materials as the
default DTDs for processing. The XML Catalog resolution maps any references for DITA 1.0
doctypes to the 1.1 DTDs, for example. All processing ordinarily dependent on the 1.0
definition continues to work as usual, and any documents that make use of the newer
1.1-based elements or attributes will be supported with specific new processing function
(such as base support for the new &lt;data&gt; element). <i>Documents created with the
proposed OASIS DITA 1.1 DTDs are the only ones ever likely to have features that
invoke the specific new 1.1-based processing support</i>.<note type="important">Because this support is based on a yet-to-be-approved version of the proposed OASIS
DITA 1.1 specification, if you choose to investigate any1.1-based function, be aware
that the 1.1 implementation in this version of the Toolkit is preliminary and very
much forward-looking. Upon final approval of the DITA 1.1 standard, Toolkit developers
will, of course, review our implementation to make certain that it conforms to the
defined level of reference implementation.</note></li><li>Related to the DITA 1.1 preliminary implementation, the much-discussed bookmap updates
for DITA 1.1 will be provided as override capabilities for the FO plugin (Idiom's
donation). Note that:<ul><li>The FO demo transform code at the 1.2.2 level is still included in the DITA 1.3
package, but is now deprecated.</li><li>To get the FO updates for 1.3, grab the FO plug-in at its next update, which
should be shortly after the 1.3 core Toolkit code is released. </li><li>The updated FO plug-in will be usable with FOP as well as with XEP. </li></ul></li></ol>
</section><section id="section_mdb_aej_nc">
<title>Changes</title>
<p>The DITA Open Toolkit team understands the need for stability in essential APIs in the
Toolit. This verson of the toolkit provides some strategic updates that correct some
long-overdue faults in the original implementation. Necessarily, there are some changes to
note: </p>
<ol><li><u>Change to build.xml: </u>To make the DITA processing environment more like other
Ant-driven build environments, the original build.xml has been renamed as
build_demo.xml. The current build.xml in this release is now the normal ANT script
entrance for starting a transformation. If you have created Ant tasks that tried to work
around the former build.xml architecture, those might need to be revised to take
advantage of the separated function.</li><li><u>Change to command line invocations: </u>The "Ant refactoring" exercise
for this release has changed some previously documented Ant calls for running demos.
This change enables better use of the Ant modules for power users who need to integrate
the Toolkit into programming build environments such as Eclipse, but the change affects
some documentation. This is a permanent change that should remain stable from now on.
Wherever you see an older instruction like "c:\dita-ot&gt;ant all", you now
need to indicate the component that contains the demos, so you would type
"c:\dita-ot&gt;ant all -f build_demo.xml". </li><li><u>Separation of demo targets from formal component targets: </u>Another effect of the
Ant refactoring is that the internal programming targets will now be displayed when you
type "ant -p". To see both those programmings targets and the demos that are
part of this component, type "c:\dita-ot&gt;ant -p -f build_demo.xml". To run
just one of the demos that you see in the resulting list, dita.faq for example, type
"c:\dita-ot&gt;ant dita.faq -f build_demo.xml". </li><li><u>Classpath update to enable catalog resolver: </u>This release now includes the
Apache catalog resolver for improved lookup of DTDs by any of the Toolkit components.
The fullpackage version of the Toolkit sets up these variables for each session. For the
regular (smaller) version of the Toolkit, you need to include lib and
lib\resource\resolver.jar into your classpath. For example if your CLASSPATH is like:
<pre xml:space="preserve">c:\dita-ot\lib\dost.jar</pre><p>you need to change it to:
</p><pre xml:space="preserve">c:\dita-ot\lib;c:\dita-ot\lib\dost.jar;c:\dita-ot\lib\resolver.jar</pre><p>At
any time, the full version can be used like a normal installation as long as you
update the system variables either in the evironment settings or in a batch file that
sets up the shell environment. </p></li><li><u>License bundling: </u>To reduce the duplication of builds on Sourceforge in which
the only difference was the license provided in each, both the Apache and CPL licenses
are included in root directory of the Toolkit. Use the one that applies to your
situation.</li><li><u>Two install options: </u>Two download versions are now offered. The smaller one is
for updating existing installations or for reuse in embedded applications that already
provide the other processing components--business as usual. A new package with
"fullpackage" in the name now incorporates the essential processing modules to
create a processing environment for new users and evaluators that requires nothing more
than to unzip the file into an appropriate directory and then click on a
"start" batch file. A new document in its root directory (an output of
doc/EvaluateOT.dita, <q>Evaluating the DITA Open Toolkit (fullpackage version)</q>)
informs new users how to install and use the Toolkit for the first time.</li><li><u>Other enhancements: </u>The public design discussions that fed into the final
selection and architectures for this release are documented at the DITA Focus Area in a
topic called <q>DITA OT 1.3 Issues tracking</q> (<xref format="html" href="http://dita.xml.org/node/1282" scope="external">http://dita.xml.org/node/1282</xref>).</li></ol>
</section><section id="section_rci_aej_nc">
<title>7 Improvements</title>
<ol><li>Preliminary support for OASIS DITA 1.1 </li><li>Support ICU in index sorting </li><li>Integrate with Eclipse </li><li>Refactor Ant script for easy override </li><li>Topicmerge reimplementation in JAVA </li><li>Enable XML Catalog Resolver </li><li>Full package distribution (was GUI/usability)</li></ol>
</section><section id="section_pyo_aej_nc">
<title>21 SourceForge Bugs Fixed</title>
<ol><li>SF Bug 1582506 Docbook cannot handle &lt;author&gt; </li><li>SF Bug 1548189 Sections should not jump to &lt;h4&gt; for Accessibility reasons </li><li>SF Bug 1548180 Spaces dropped from index terms </li><li>SF Bug 1548154 XHTML index links should go to the topic </li><li>SF Bug 1545038 CommandLineInvoker is unfriendly towards spaces </li><li>SF Bug 1541055 topicref @id incorrectly uses NMTOKEN type </li><li>SF Bug 1530443 dost.jar relies on the incorrect behavior of Xerces </li><li>SF Bug 1473029 Syntax code makes overrides difficult </li><li>SF Bug 1470101 Metadata in topics is left out of XHTML headers </li><li>SF Bug 1470077 Choicetable headers create attribute inside attribute </li><li>SF Bug 1470057 Step template creates attributes after creating tags </li><li>SF Bug 1465947 &lt;topichead&gt; without children the whole branch to disappear </li><li>SF Bug 1465941 Keywords defined in map are ignored if &lt;topicref&gt; contains t </li><li>SF Bug 1465866 Problems in catalog-dita.txt </li><li>SF Bug 1460447 &lt;morerows&gt; not well supported in pdf tranformation. </li><li>SF Bug 1457187 'copy-to' doesn't actually copy files </li><li>SF Bug 1454835 OT renders files referenced via conref only </li><li>SF Bug 1427808 Should be easier to modify link attributes in XHTML </li><li>SF Bug 1422182 @colname renaming needs to apply to @namest and @nameend </li><li>SF Bug 1417820 fo and docbook outputs can\'t handle deep topic dirs </li><li>SF Bug 1368997 PDF Vertical list of author redundancy </li></ol>
</section><section id="section_eqv_aej_nc">
<title>1 SourceForge Patch Added</title>
<ol><li>SF Patch 1503296 Refactor of HTMLHelp inifiles creation</li></ol>
</section><section id="section_zbd_bej_nc">
<title>1 SourceForge RFE Added</title>
<ol><li>SF RFE 1160960 Enh: Toolkit should work with both both *.dita and *.xml</li></ol>
</section></refbody><related-links><linklist><desc>SourceForge bugs, patches, and RFEs listed above can be found in SourceForge Bugs,
Patches, and RFE tracker pages</desc><link href="http://sourceforge.net/tracker/?group_id=132728&amp;atid=725074" scope="external"><linktext>Bugs tracker</linktext></link><link href="http://sourceforge.net/tracker/?group_id=132728&amp;atid=725076" scope="external"><linktext>Patches tracker</linktext></link><link href="http://sourceforge.net/tracker/?group_id=132728&amp;atid=725077" scope="external"><linktext>RFE tracker</linktext></link></linklist></related-links></reference>

15
dita-ot-3.6/docsrc/release-notes/rel1.4.1.dita Normal file
View file

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" id="rel1.4.1" ditaarch:DITAArchVersion="1.2"><title>DITA OT release 1.4.1</title><shortdesc>Release 1.4.1 is a maintenance release to fix defects and make patches based on
release 1.4.</shortdesc><refbody><section id="section_gau_vdj_nc">
<title>23 SF Bugs Fixed</title>
<ol><li>1833801 Infinite loop in MapMetaReader</li><li>1833796 move-meta-entries creates invalid XML</li><li>1827055 Dita 1.4 move metadata method failing</li><li>1819663 XHTML processing add &amp;nbsp; in output files.</li><li>1815155 Using xref moves output directory</li><li>1807808 Java TopicMerge calling XSLT transformer with URL not file</li><li>1806728 Merge doesn't normalize filenames</li><li>1806130 chunk module wraps long lines</li><li>1806081 &lt;dita&gt; without class attribute triggers warning</li><li>1803190 XHTML: processing &lt;xref&gt; to &lt;a title=""&gt;</li><li>1803183 XHTML: &lt;b&gt; and &lt;xref&gt; within &lt;pre&gt;</li><li>1796207 topicmeta in ditamap causes build failure</li><li>1782109 Title input to Help Compiler invalid for taskbook example</li><li>1779066 [DOTX031E] Errors</li><li>1770571 Chunk "to-content" on map not implemented</li><li>1732678 Map without DOCTYPE declaration produces odd error</li><li>1675195 No Error Location for Titleless Topic</li><li>1639672 The Toolkit does not properly support valid xml:lang values.</li><li>1639344 Xref : topicpull : the spectitle not used as linktext</li><li>1628937 Rename supportingboth.ditaand.xmlinaditamap.dita</li><li>1584187 Bookmap 1.1: &lt;title&gt; element breaks topicmerge</li><li>1563093 Difficult to find location of error</li><li>1505172 foimgext Considered Harmful</li></ol>
</section><section id="section_cnb_wdj_nc">
<title>5 SF Patches Added</title>
<ol><li>1741302 Prevent indexterm crash with two-letter language codes</li><li>1630214 HTML Help HHP generator: Language tag</li><li>1498936 Failure when moving links with embedded mathml</li><li>1481586 CSS for ditamap-to-HTML TOC</li><li>1457541 xref to elements fails within topics in PDF</li></ol>
</section><section id="section_fal_wdj_nc">
<title>5 SF RFE Added</title>
<ol><li>1764910 Allow greater control over the output directory</li><li>1764905 Allow option to build only topics listed in the map</li><li>1725280 Improve error reporting in general</li><li>1686939 Make dita.list into an XML file</li><li>1676947 Integration points for passing params to XSL</li></ol>
</section></refbody><related-links><linklist><desc>SourceForge bugs, patches, and RFEs listed above can be found in SourceForge Bugs,
Patches, and RFE tracker pages</desc><link href="http://sourceforge.net/tracker/?group_id=132728&amp;atid=725074" scope="external"><linktext>Bugs tracker</linktext></link><link href="http://sourceforge.net/tracker/?group_id=132728&amp;atid=725076" scope="external"><linktext>Patches tracker</linktext></link><link href="http://sourceforge.net/tracker/?group_id=132728&amp;atid=725077" scope="external"><linktext>RFE tracker</linktext></link></linklist></related-links></reference>

10
dita-ot-3.6/docsrc/release-notes/rel1.4.2.1.dita Normal file
View file

@ -0,0 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" id="rel1.4.2.1" ditaarch:DITAArchVersion="1.2"><title>DITA OT release 1.4.2.1</title><shortdesc>Release 1.4.2.1 is a full build to provide an urgent fix to fix the following
critical problem which users found in release 1.4.2.</shortdesc><refbody><section id="section_rmh_udj_nc">
<title>SF Bugs Fixed</title>
<ol><li>SF Bug 1956231 OSGI Manifest for eclipsehelp transtype contains spaces.</li></ol>
<p>For this fix, we have updated xsl/map2pluginImpl.xsl to prevent generating extra spaces
at the head of every line in OSGI manifest file of eclipse help output.</p>
</section></refbody></reference>

22
dita-ot-3.6/docsrc/release-notes/rel1.4.2.dita Normal file
View file

@ -0,0 +1,22 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" id="rel1.4.2" ditaarch:DITAArchVersion="1.2"><title>DITA OT release 1.4.2</title><shortdesc>Release 1.4.2 is a maintenance release to fix defects and make patches based on
release 1.4.1.</shortdesc><refbody><section id="section_rgn_udj_nc">
<p>Release 1.4.2 comes in three versions:</p>
<ol><li>Minimal package contains only the core processing code.</li><li>Standard package contains the core processing code, plus demos, documentation, and
samples.</li><li>Full "easy install" package contains the standard package plus external libraries
useful for many toolkit processes (such as Xalan and ANT), plus a batch file to setup a
local environment.</li></ol>
</section><section id="section_zmw_udj_nc">
<title>39 SF Bugs Fixed</title>
<ol><li>1945824 Index-see works for "ru-ru" but not for "ru"</li><li>1944245 Null pointer error with complex filename</li><li>1923519 Conrefs in nested, conreffed topics don't work</li><li>1911285 files.txt is not up-to-date</li><li>1906954 Constants.ANT_INVOKER_EXT_PARAM_OUTPUTDIR resulted in null ...</li><li>1903830 Error when collection-type=sequence in map</li><li>1903626 Topicref to Glossentry With Topicmeta Throws Null Pointer</li><li>1900907 Documentation of generateouter command-line param is incorrect</li><li>1900427 TIFF file format not a supported type</li><li>1898810 Problem running ant with DITA-OT in path with Latin char</li><li>1897358 Compiling CHM's in sequence results in errant index entries</li><li>1894561 wordrtf not correctly handling p inside li</li><li>1893234 Java TopicMerge removes processing instruction</li><li>1868423 Null pointer exception when a PI is at the end of the file</li><li>1857405 chunk processing fails when no section element</li><li>1855047 startup.sh fails under OS X</li><li>1849346 FO file generated from DITA MAP not valid</li><li>1843652 Image referenced in map is not found, topicmerge breaks</li><li>1843583 Extra bullet in TOC for topicref with no href or navtitle</li><li>1839765 index-sort-as not used, content appears in index</li><li>1908306 Index entry for external resource is ignored</li><li>1908293 HTML Help index contains extra anchor</li><li>1900916 Pointer to CSS is Incorrect in index.html</li><li>1898451 HTML titles should be space-normalized for CHM consumption</li><li>1898228 Table desc not being processed</li><li>1897551 maplink is unawareof chunk to-content</li><li>1893461 map file href handling</li><li>1889918 Index link goes with wrong entry</li><li>1883907 IndexTermReader class doesn't handle specialized titles</li><li>1873401 XHTML: colsep in last column when @frame=none</li><li>1872434 _merge.xml missing metadata</li><li>1868047 htmlhelp path in demo ant script is fixed</li><li>1864247 PIs missing from ditamaps in temp dir</li><li>1857282 path to css output is not correct</li><li>1848355 gen-list wants class on &lt;foreign&gt; descendants</li><li>1843693 Bad XREF syntax gives confusing message about unique_193</li><li>1841175 Need to clean up doc/ directory (remove invalid items)</li><li>1832800 Empty end-range indexterm causes eclipse error</li><li>1606387 Shortdesc &amp; Abstract formatting is incorrect for XHTML</li></ol>
</section><section id="section_btc_vdj_nc">
<title>3 SF Patches Added</title>
<ol><li>1930220 Simplify flag templates</li><li>1876118 Add plug-in support for string resource-files</li><li>1818318 Path to HTML Help compiler on x64 Windows</li></ol>
</section><section id="section_kjj_vdj_nc">
<title>6 SF Enhancements Added</title>
<ol><li>1855523 Pass dost.class.path to XSLT tasks</li><li>1827322 Let plugins add their own template files</li><li>1825843 Let plugins add dependencies to Ant targets</li><li>1824466 Subclass ImportAction</li><li>1782256 Let plugins not have to choose to go in "demo" or "plugins"</li><li>1859421 Add plug-in support for string resource-files</li></ol>
</section></refbody><related-links><linklist><desc>SourceForge bugs, patches, and RFEs listed above can be found in SourceForge Bugs,
Patches, and RFE tracker pages</desc><link href="http://sourceforge.net/tracker/?group_id=132728&amp;atid=725074" scope="external"><linktext>Bugs tracker</linktext></link><link href="http://sourceforge.net/tracker/?group_id=132728&amp;atid=725076" scope="external"><linktext>Patches tracker</linktext></link><link href="http://sourceforge.net/tracker/?group_id=132728&amp;atid=725077" scope="external"><linktext>RFE tracker</linktext></link></linklist></related-links></reference>

27
dita-ot-3.6/docsrc/release-notes/rel1.4.3.dita Normal file
View file

@ -0,0 +1,27 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" id="rel1.4.3" ditaarch:DITAArchVersion="1.2"><title>DITA OT release 1.4.3</title><shortdesc>Release 1.4.3 is a maintenance release and is intended to be the last released based
fully on DITA 1.1.</shortdesc><refbody><section id="section_mdo_sdj_nc">
<p>It contains a significant amount of preview function for the upcoming DITA 1.2 standard,
but the DITA 1.2 document types must be specifically referenced in order to use this
capability. </p>
</section><section id="section_qeu_mhj_nc">
<title>Major Updates</title>
<ol><li>The PDF codebase switched from the older deprecated code to the plugin previously
known as PDF2. Running a build with the transform type PDF or PDF2 will now run the new
code. To continue using the older code, set your transform type to "legacypdf".</li><li>The PDF plugin now runs with FOP, as well as with the latest version of Saxon.</li><li>The Full Easy Install package now ships with Saxon 9B instead of with Xalan, and code
in the DITA-OT package has been updated to work with Saxon 9B.</li><li>The Full Easy Install package updates the versions of many open source libraries
(including Ant and FOP)</li><li>RFE 1982567 Allow spaces in DITA file names</li><li>Preview function for the majority of the upcoming OASIS DITA 1.2 standard, including
everything from milestone builds one through twelve of DITA-OT 1.5 </li></ol>
</section><section id="section_vaz_sdj_nc">
<title>10 SF Enhancements Added</title>
<ol><li>1982567 Allow spaces in DITA file names</li><li>2631145 dita2htmlImpl.xsl should not define doctype</li><li>2562718 Rename the ant directory to avoid naming collisions with ant</li><li>2314086 Let maplink generate &lt;linklist&gt; elements</li><li>2258659 Extend integrator to allow addition of messages.</li><li>2117337 Customize Integrator to integrate custom directories</li><li>2074933 Make index output for new transtypes more extensible</li><li>1995667 Add plugin extension points to preprocess pipeline</li><li>1972537 Let users specify reloadstylesheet on xslt tasks</li><li>1803199 Allow ability to include class ancestry in XHTML class attribute</li></ol>
</section><section id="section_cbi_tdj_nc">
<title>4 SourceForge Patches Added</title>
<ol><li>1996733 Structure Ant &lt;pipeline&gt; better</li><li>1796007 Refactor of related links HTML for specialized processing</li><li>1947566 pdf2: allow XEP to be installed elsewhere</li><li>2477370 Refactor of conrefImpl.xsl</li></ol>
</section><section id="section_ytu_tdj_nc">
<title>31 SF Bugs Fixed</title>
<ol><li>2008294 End flag does not work in ditaval</li><li>2078563 Keyref not working for external links</li><li>2027170 maprefImpl.xsl removes part of class attr from topichead</li><li>2027058 Topichead element stops map processing in ChunkMapReader</li><li>2001268 DITA-OT documentation wants JDK 1.4</li><li>2008317 Chunking one topic from a large file hogs memory</li><li>2219479 &lt;prodinfo&gt; subelement associations are lost in HTML output</li><li>2340727 No link in TOC to topics in ditabase</li><li>2317627 Chunking map to create one file should use map file name</li><li>2143078 Relcolwidth not respected in choicetable</li><li>1995223 bookmap: bookmeta-&gt;bookrights information is not generated</li><li>1990167 reltable doesn't generate external links correctly</li><li>1953553 FO 1.4.2 plugin: Inconsistent display of "on page" in xref</li><li>1951879 Link generation is disabled for bookmaps</li><li>1997171 topic body suppressed in chapter topics</li><li>2417980 Toolkit should support both versions of Serbian lang code</li><li>1947817 Extra topics appear in PDF output when using reltables</li><li>2004588 Image alt text needs space normalized</li><li>1954463 Conditional processing multiple PDFs in the same JVM</li><li>2061301 Useless import of xslt4j stops dost.jar being built</li><li>2317659 Chunking "by-topic" does not work</li><li>1955211 Footnotes-by-reference rendered naively</li><li>2010062 Spaces dropped in indexterm that has keyword</li><li>2607496 USEINDEX=no breaks HTML Help HHP</li><li>2570118 &lt;xref&gt; without href drops content</li><li>2414891 Map contains wrong reference after chunking</li><li>2010092 example or section title can be orphaned in PDF2</li><li>1999117 Ubuntu 8.04 | startcmd.sh doesn't work</li><li>2020317 Many duplicated id in xxx_MERGED.xml in PDF2 output.</li><li>2614006 Conref processing ignores -dita-use-conref-target</li><li>1727863 &lt;groupchoice&gt; has an extra "|" character</li></ol>
</section></refbody><related-links><linklist><desc>SourceForge bugs, patches, and RFEs listed above can be found in SourceForge Bugs,
Patches, and RFE tracker pages</desc><link href="http://sourceforge.net/tracker/?group_id=132728&amp;atid=725074" scope="external"><linktext>Bugs tracker</linktext></link><link href="http://sourceforge.net/tracker/?group_id=132728&amp;atid=725076" scope="external"><linktext>Patches tracker</linktext></link><link href="http://sourceforge.net/tracker/?group_id=132728&amp;atid=725077" scope="external"><linktext>RFE tracker</linktext></link></linklist></related-links></reference>

43
dita-ot-3.6/docsrc/release-notes/rel1.4.dita Normal file
View file

@ -0,0 +1,43 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" id="rel1.4" ditaarch:DITAArchVersion="1.2"><title>DITA OT release 1.4</title><abstract><shortdesc>Release 1.4 is a major release to add new functions, fulfill new
requirements, make some function enhancements and fix bugs over release 1.3.1.</shortdesc>
Available since August 1, 2007</abstract><refbody><section id="section_ruu_wdj_nc">
<p> The DITA-OT Release 1.4 contains full support for the OASIS DITA 1.1 standard. This
completes the preliminary support added in the 1.3 and 1.3.1 versions of the toolkit. New
and improved items for 1.1 are listed under [Improvements] below. Support for the new
bookmap standard is available in the latest version of the FO plug-in, which uses the
"pdf2" transform type; it will be released together with or soon after the release of
DITA-OT 1.4. The deprecated "pdf" transform type has not been updated for the new bookmap.
Together with DITA 1.1 support, the toolkit development team has improved error reporting
so that build failures are more accurately reported at the end of the build. Error
handling will continue to improve in future releases. Release 1.4 comes in two versions.
The full version contains several external packages that are useful or critical to running
the toolkit, such as Xalan and the XML Catalog resolver. The smaller package contains only
core toolkit code. NOTE ABOUT DEPRECATED CODE: changes for the new DITAVAL standard
required a change to code in dita2htmlImpl.xsl. The "flagit" named template is deprecated
and will not work with the new ditaval format. Overrides to this step should be updated to
use "start-flagit" and "end-flagit". The flagit template will continue to work with the
old ditaval but will generate a warning for each call. </p>
</section><section id="section_xuu_wdj_nc">
<title>Changes</title>
<ol><li>
<p>Release 1.4 improves the processing of DITA documents using XML Schemas. One was able
to process these type of documents in Release 1.3.1 but it meant that the schema
location had to have the ablsolute location of the schema in order for the Toolkit
properly.</p>
<p>DITA 1.1 introduces the use of URNs to normatively identify the schemas used for
validation. The URNs have the following desing pattern
"urn:oasis:names:tc:dita:xsd:&lt;schemaDocument&gt;:1.1". You should use these in as
the value for the attribute xsi:noNamespaceSchemaLocation.</p>
</li></ol>
</section><section id="section_tra_ydj_nc">
<title>13 Improvements</title>
<ol><li>Support &lt;title&gt; in map </li><li>Ignore Index-base in default processing</li><li>Retrieve the link text from abstract element.</li><li>Format shortdesc in abstract appropriately</li><li>Add standard code to allow overrides to easily process generalized version of unknown
and foreign element </li><li>Support @dir on every element</li><li>Refactor mapref resolution</li><li>Support generalization and re-specialization of unknown/foreign elements</li><li>Replace Move Index module with new Move Metadata module</li><li>New DITAVAL standard support</li><li>New chunk attribute support</li><li>Support XML Schema validated instance document processing using XML Catalogs</li></ol>
</section><section id="section_vuo_ydj_nc">
<title>17 SF Bugs Fixed</title>
<ol><li>1700561 Null Pointer Exception on Missing domain= Attribute</li><li>1733264 pretty.xsl is broken</li><li>1619074 table in step screws up following steps for HTML generation</li><li>1728700 GenMapAndTopicList keeps filtering when called a second time</li><li>1732562 DitaWriter.java can duplicate @xtrf and @xtrc</li><li>1733108 Update Bookmap sample files to DITA 1.1</li><li>1706263 Conrefing from a map to topic is not working properly</li><li>1677620 Non-DITA file is treated as DITA in pre-process</li><li>1717471 Links show up more than once</li><li>1712543 gen-list-without-flagging : NullPointerException</li><li>1652892 Invalid hdr/ftr arg value causes build failure</li><li>1647950 PIs in DITA source are dropped in the processing pipeline</li><li>1644559 Force Toolkit to use private catalog to allow schemas to work properly</li><li>1642138 Move javamerge target out of build_template.xml</li><li>1643155 Map TOC is HTML even for transtype="xhtml"</li><li>1637564 topicpull breaks specializations of xref</li><li>1676968 Plugins adding to classpath break when basedir != dita.dir</li></ol>
</section></refbody><related-links><linklist><desc>SourceForge bugs, patches, and RFEs listed above can be found in SourceForge Bugs,
Patches, and RFE tracker pages</desc><link href="http://sourceforge.net/tracker/?group_id=132728&amp;atid=725074" scope="external"><linktext>Bugs tracker</linktext></link><link href="http://sourceforge.net/tracker/?group_id=132728&amp;atid=725076" scope="external"><linktext>Patches tracker</linktext></link><link href="http://sourceforge.net/tracker/?group_id=132728&amp;atid=725077" scope="external"><linktext>RFE tracker</linktext></link></linklist></related-links></reference>

43
dita-ot-3.6/docsrc/release-notes/rel1.5.1.dita Normal file
View file

@ -0,0 +1,43 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" id="rel1.5.1" ditaarch:DITAArchVersion="1.2"><title>DITA OT Release 1.5.1</title><shortdesc>Release 1.5.1 is a maintenance release based on Committee Draft 01 of the DITA 1.2
standard.</shortdesc><refbody><section id="section_uuo_odj_nc">
<ul><li><b>Release date</b>: June 18, 2010</li><li><b>Supports</b>: DITA 1.0 through 1.2 (Committee Draft 02 level)</li><li><b>Download at</b>: <xref format="html" href="http://sourceforge.net/projects/dita-ot/files/DITA-OT%20Stable%20Release/" scope="external">DITA-OT Latest Stable Build</xref></li><li><b>Which package is for me?</b> See <xref format="html" href="http://dita.xml.org/freelinking/DITA-OT%2520Packages" scope="external">DITA-OT
Packages</xref>. </li></ul>
<p>This is the same version of the standard used for the DITA 1.2 Public Review. Release
1.5.1 contains many fixes and minor enhancements. It also includes a preview of a new
output transform to the Open Document Format; this transform will be completed in a later
release.</p>
<p>Release 1.5.1 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. There were seven total test builds.</p>
</section><section id="section_bsu_odj_nc">
<title>General Enhancements</title>
<ol><li>Update to latest copy of DITA 1.2 Draft DTDs and Schemas (last update in Milestone
5)</li></ol>
</section><section id="section_vib_pdj_nc">
<title>14 SourceForge Enhancements Added</title>
<ol><li>2797337 Support for ODF output transform (first prototype available in Milestone 2,
further updates in each milestone)</li><li>2703335 Reduce duplicated code in XHTML &lt;note&gt; processing (Milestone 3)</li><li>2976463 Provide finer grained control of links in PDF (include reltable and in-topic
links, without parent/child links) (Milestone 4)</li><li>2971536 New Java options for existing Ant parameters (Milestone 4)</li><li>2979084 Obey the "args.draft" parameter (Milestone 5)</li><li>2990783 allow caller-provided IndexTermCollection (Milestone 6 contains the core code
updates; M7 contains the full enhancement)</li><li>3001750 Shortdesc from map should override link description in PDF (Milestone 7)</li><li>3004305 Notes with type="warning" need styling / localization in XHTML (Milestone
7)</li><li>3004859 "eclipsecontent" transform should drop debug info (Milestone 7)</li><li>2892706 Don't delete the FO file (new option to preserve topic.fo) (Milestone 7)</li><li>2928584 Add general model for end-of-topic processing in PDF (Milestone 7)</li><li>3006675 Support new DITA 1.2 &lt;stepsection&gt; element in PDF (Milestone 7)</li><li>3006847 Add generated task headers to PDF (using the option that works for XHTML in
DITA-OT 1.5) (Milestone 7)</li><li>2987769 Add support for Eclipse Help index redirects (Milestone 7)</li></ol>
</section><section id="section_dqj_pdj_nc">
<title>2 SourceForge Patches Added</title>
<ol><li>2914475 Use Xerces Grammar Pool to Improve Performance (Milestone 1)</li><li>2991688 Refine package build Ant (Milestone 6)</li></ol>
</section><section id="section_wsw_pdj_nc">
<title>46 SourceForge Bugs Fixed</title>
<ol><li>2916469 @locktitle not respected by preprocessor (Milestone 1)</li><li>2917809 need empty lib/saxon directory for minimum and standard pkg. (Milestone
1)</li><li>2925636 Build fails when excluded section contains a table (Milestone 1)</li><li>2926417 Absolute file: URLs are not resolved. (Milestone 1)</li><li>2930109 Move meta module pushes content into peer topic. (Milestone 1)</li><li>1852808 args.css requires dummy file. (Milestone 1)</li><li>2952956 Imagemap processing drops outputclass from image (Milestone 3)</li><li>2953706 Minor improvements to "garage" samples (Milestone 3)</li><li>2961909 /onlytopicinmap does not respect conref (Milestone 3)</li><li>2957456 conkeyref breaks when topic is in subdir (Milestone 3)</li><li>2962813 stepsection throws off numbering in links to steps (Milestone 3)</li><li>2959588 Template Processor Doesn't handle XSLT atts that require ' (Milestone 3)</li><li>2914574 plus-htmlhelp-alias-map: using same extension point twice (Milestone 3)</li><li>2957938 coderef not working everytime (Milestone 3)</li><li>2962781 html documentation out of date (Milestone 3)</li><li>2952956 refactored XSL code in ut-d.xsl (Milestone 3)</li><li>2954819 NullPointer while processing simple BookMap (Milestone 3)</li><li>2954154 Updated default version from 1.0 to 1.0.0 (Milestone 3)</li><li>2970471 XSLFO test for @compact wrong (Milestone 4 for PDF, Milestone 5 for
LegacyPDF)</li><li>2972043 Setting onlytopicinmap causes a blank imagelist (Milestone 4)</li><li>2974667 Integrator adds spaces into XML Catalog entries (Milestone 4)</li><li>2986492 Duplicate parameter in XHTML code (Milestone 5)</li><li>2982485 Cannot read a document that was written during the same transform (Milestone
5)</li><li>2981216 &lt;tm&gt; @tmclass requires IBM-specific values (Milestone 5)</li><li>2979361 Java stack traces in OT log (Milestone 5)</li><li>2979328 Output parameters info at INFO level (Milestone 5)</li><li>2978858 keyref processing doesn't respect basedir (Milestone 5)</li><li>2990162 Conref to elements in same DITA file throw parsing errors (Milestone 6)</li><li>3000677 msgph and systemoutput should use &lt;samp&gt; instead of &lt;tt&gt; (Milestone
7)</li><li>3004220 &lt;tm&gt; elements dropped when keyref text resolved (Milestone 7)</li><li>2987322 Navtitle attribute of glossarylist breaks PDF (Milestone 7)</li><li>2916474 Inappropriate match on mapgroup/topichead in PDF code (Milestone 7)</li><li>2916408 Topichead with &lt;navtitle&gt; not processed same as @navtitle in PDF (Milestone
7)</li><li>3006443 CSS for prereq links indents prereq element (Milestone 7)</li><li>2607892 (Plus Plug-in) plus-allhtml-encoding: map x-windows-950 to Big5 (Milestone
7)</li><li>2385466 Handle @font-family="inherit" (Milestone 7)</li><li>2928540 Shortdesc should align with body in PDF (use topic__shortdesc) (Milestone
7)</li><li>1839827 PDF does not properly process &lt;xref&gt; to &lt;li&gt; elements (Milestone 7)</li><li>2521819 PDF topic title widowed due to fo:marker placed in separate block (Milestone
7)</li><li>1385654 docbook/topic2db.xsl - better linking support (Milestone 7)</li><li>3004550 Conkeyref does not work if key referenced is not in same folder (Milestone
7)</li><li>3004060 keyref/id not producing link in PDF output (Milestone 7)</li><li>3001705 conkeyref doesn't work across ditamaps (Milestone 7)</li><li>3000604 Legacy PDF: empty @column-number causes errors (Milestone 7)</li><li>3013079 Keyref handling does not respect scope="external" (Final build)</li><li>3005748 XHTML: Topics w/ @print set to "printonly" are included (Final build)</li></ol>
</section></refbody><related-links><linklist><desc>SourceForge bugs, patches, and RFEs listed above can be found in SourceForge Bugs,
Patches, and RFE tracker pages</desc><link href="http://sourceforge.net/tracker/?group_id=132728&amp;atid=725074" scope="external"><linktext>Bugs tracker</linktext></link><link href="http://sourceforge.net/tracker/?group_id=132728&amp;atid=725076" scope="external"><linktext>Patches tracker</linktext></link><link href="http://sourceforge.net/tracker/?group_id=132728&amp;atid=725077" scope="external"><linktext>RFE tracker</linktext></link></linklist></related-links></reference>

34
dita-ot-3.6/docsrc/release-notes/rel1.5.2.dita Normal file
View file

@ -0,0 +1,34 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" id="rel1.5.2" ditaarch:DITAArchVersion="1.2"><title>DITA Open Toolkit Release 1.5.2</title><shortdesc>Release 1.5.2 is a maintenance release based on the final version of the DITA 1.2
standard.</shortdesc><prolog><metadata><prodinfo><prodname>DITA Open Toolkit</prodname><vrmlist><vrm version="1.5.2" release=""/></vrmlist></prodinfo></metadata></prolog><refbody><section id="section_hcs_ldj_nc">
<ul><li><b>Release date</b>: December 10, 2010</li><li><b>Supports</b>: DITA 1.0 through 1.2</li><li><b>Download at</b>: <xref format="html" href="http://sourceforge.net/projects/dita-ot/files/DITA-OT%20Stable%20Release/" scope="external">DITA-OT Latest Stable Build</xref></li><li><b>Which package is for me?</b> See <xref format="html" href="http://dita.xml.org/freelinking/DITA-OT%2520Packages" scope="external">DITA-OT
Packages</xref>. </li></ul>
<p>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.</p>
<p>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.</p>
</section><section id="section_cnm_mdj_nc">
<title>General Enhancements</title>
<ol><li>Include final version of DITA 1.2 schemas and DTDs</li><li>Minor updates to DITA 1.2 support added in earlier releases, to ensure compliance with
the final standard</li><li>Overhaul of documentation to remove outdated material</li><li>Reorganization of doc directory to highlight new and important info</li></ol>
</section><section id="section_juu_mdj_nc">
<title>11 SourceForge Enhancements Added</title>
<?Pub Caret 4?>
<ol><li>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)</li><li>3021544 Preserve DITA elements in XHTML class by default (Milestone 1) </li><li>3019853 Create new "textonly" output method for use by any transform (Milestone 1) </li><li>3012392 PDF transformation should allow args.xsl style override (Milestone 1) </li><li>2882123 Add Ant Quick Start Guide to DITA-OT (Updated in each Milestone after 3)</li><li>3086936 Add extension points for TOC output (Eclipse TOC, HTML Help TOC and Project,
HTML TOC) (Milestone 6) </li><li>3079610 Add current OT version to log (Milestone 6) </li><li>1520909 HTML Help requires appropriate codepage (Milestone 6) </li><li>3125994 Allow PDF index conf. to be overridden in Customization (Milestone 7)</li><li>3125983 Create a basic glossary implementation for PDF (Milestone 7)</li><li>3109395 Add parameter for Eclipse symbolic name (Milestone 8)</li></ol>
</section><section id="section_fge_ndj_nc">
<title>SourceForge Patches Added</title>
<ol><li>3058008 Refactor chunk module for cleaner code (Milestone 4) </li><li>3067681 Add class to ordered child links (Milestone 5) </li><li>3064412 Integrator fails to escape XML correctly (Milestone 5) </li><li>3062765 Fix unit test file paths to be platform dependent (Milestone 5) </li><li>2949860 PDF build.xml with args for JVM memory and architecture (Milestone 6) </li><li>3077935 Plug-in ignore in Integrator (Milestone 6) </li><li>3065050 Common logging interface (Milestone 6) </li><li>3063318 ChunkModule refactoring (Milestone 6) </li><li>3061100 Define AbstractPipelineInput's function (Milestone 6) </li><li>3102905 Move supported image extensions to configuration file (Milestone 7) </li><li>3097518 Show effective property values (Milestone 8) </li><li>3101335 apiMap.mod missing from catalog (Milestone 8)</li></ol>
</section><section id="section_ycy_ndj_nc">
<title>SourceForge Bugs Fixed</title>
<ol><li>2928582 commonTopicProcessing template prolog processing out of order (Milestone 1) </li><li>2823221 version of Xalan-J inconsistent (Milestone 1) </li><li>3023642 Invalid @colname generated in nested table (Milestone 1) </li><li>3016739 Chunking mixes up &lt;link&gt; to topic in reltable (Milestone 1) </li><li>3020314 Chunk output includes index terms in navtitles (Milestone 1) </li><li>3020313 Chunk processor adds &lt;topicref&gt; before &lt;topicmeta&gt; (Milestone 1) </li><li>3031513 Nested table processing in pdf2 (Milestone 2) </li><li>3030317 Filtering doesn't work on @rev or @props attributes (Milestone 2) </li><li>3028650 Replace xs:float with xs:double in Plus plugins (Milestone 2)</li><li>3022847 PDF transform gives Java exceptions for spaces in dir name (Milestone 2) </li><li>3032950 Scale is not correctly computed in XHTML transforms (Milestone 2) </li><li>3033141 dita.xml.properties file not closed after generating (Milestone 2)</li><li>3034445 "CURRENDIR" typo in plus-plugins ( Checked in to CVS during Milestone 3) </li><li>3034489 Remove all occurrences of &lt;xmlcatalog&gt; from plus-plugins ( Checked in to
CVS during Milestone 3) </li><li>3035816 When creating .chm, .hhp-file is missing a line-break (Milestone 3) </li><li>3036222 RTF transform not editable with Word 2007 (Milestone 3) </li><li>3036985 Infinite recursivity in replaceString template (Milestone 3) </li><li>3038941 Link with &amp;amp; breaks in abstract (Milestone 3) </li><li>3039017 Comments in PDF plugin files are confusing (Milestone 3) </li><li>3058124 Toolkit Allows Unescaped URLs, doesn't handle escaped ones (Milestone 4) </li><li>3056939 Conref of keyref-based xref results in xref with no href (Milestone 4) </li><li>3052913 Multiple levels of keyref in map not resolved (Milestone 4) </li><li>3052904 Keydef with no href causes hard failure (Milestone 4) </li><li>3052156 Object with data that starts with slash breaks image copying (Milestone 4) </li><li>3044861 Inappropriate warning for resource-only topic to graphic (Milestone 4) </li><li>3042978 @copy-to and @chunk on topichead gives file not found (Milestone 4) </li><li>3016994 The included-domains entity cannot be used in document (Milestone 4) </li><li>2994593 Transformation breaks when DITA Topics contain entity refs (Milestone 4) </li><li>3028894 no support for title in plugin.xml file (Milestone 4) </li><li>3065853 Indent from &lt;title&gt; gets displayed in TOC (PDF) (Milestone 5) </li><li>3065486 CURRENTFILE not aware of DITAEXT (Milestone 5) </li><li>3065422 Wrong filename and filedir parameters for eclipse xsl (Milestone 5) </li><li>3063533 Adjacent words get glued together using DITA to RTF (Milestone 5) </li><li>3062912 Messages extension damages custom message formatting (Milestone 5) </li><li>3059256 Peer links break with missing format or wrong extension (Milestone 5) </li><li>2972393 Need to parameterize maxmemory and VM args for forked JVMs (Milestone 6) </li><li>3060269 Problem displaying French content TOC in CHM output (Milestone 6) </li><li>3038412 zh-CN file for PDF puts English strings in output (partial fix) (Milestone 6) </li><li>3079676 &lt;navtitle&gt; contents included in PDF output (Updated so that &lt;navtitle&gt;
in a topic will only appear when the draft parameter is set to 'yes') (Milestone 6) </li><li>3004895 XHTML output for &lt;draft-comment&gt; should use class attribute (Milestone 6) </li><li>2794487 No Easy Way to Override/Extend HTML TOC Navtitle Generation (Milestone 6) </li><li>3088314 Need to clarify many error messages (Milestone 6) </li><li>3095233 Shortdesc metadata missing when using abstract (Milestone 6) </li><li>3081597 conkeyref accepts values in conref style (Milestone 6) </li><li>3081459 fragment generation without plugin fails (Milestone 6) </li><li>3073262 missing terminating quote in bundle version (Milestone 6) </li><li>2832863 &lt;group&gt; elements in catalogs don't work for all editors (Milestone 6) </li><li>3038933 Troff output drops prereq links (Milestone 7)</li><li>3098975 Disable Output Escaping Should Not Be Used (Milestone 7)</li><li>3102827 Allow a way to specify recognized image extensions (Milestone 7)</li><li>3102219 Unexpected character code in Japanese string definition (Milestone 7)</li><li>3101964 Unnecessary XML declaration in HHP and HHC (Milestone 7)</li><li>3095233 Shortdesc metadata missing when using abstract (Milestone 7)</li><li>3097409 PDF should skip empty columns in property tables (Milestone 7)</li><li>3090803 PDF fails when chunk specified and topic appears twice (Milestone 7)</li><li>3102845 Japanese character-set definition (Milestone 7)</li><li>3103488 Update Saxon command line args for IDIOM PDF build.xml (Milestone 7)</li><li>3026627 side-col-width variable has no effect (Milestone 7)</li><li>3126007 TOC entries not properly indented in PDF (Milestone 7)</li><li>3109616 Update PDF plug-in to check for latest Antenna House dirs (Milestone 8)</li><li>3056040 problematic Bundle-Version test in eclipseMap (Milestone 8)</li><li>3029074 Index file not generated by default for Eclipse Help (Milestone 8)</li><li>3086552 XMLReader.parse does not correctly receive the XML system ID (Milestone
8)</li><li>3110418 Duplicate @colname generated for entry (Milestone 8)</li><li>3114353 Java sun.* packages should not be used (Milestone 8)</li></ol>
</section></refbody><related-links><linklist><desc>SourceForge bugs, patches, and RFEs listed above can be found in SourceForge Bugs,
Patches, and RFE tracker pages</desc><link href="http://sourceforge.net/tracker/?group_id=132728&amp;atid=725074" scope="external"><linktext>Bugs tracker</linktext></link><link href="http://sourceforge.net/tracker/?group_id=132728&amp;atid=725076" scope="external"><linktext>Patches tracker</linktext></link><link href="http://sourceforge.net/tracker/?group_id=132728&amp;atid=725077" scope="external"><linktext>RFE tracker</linktext></link></linklist></related-links></reference>

76
dita-ot-3.6/docsrc/release-notes/rel1.5.3.dita Normal file
View file

@ -0,0 +1,76 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" id="rel1.5.3" ditaarch:DITAArchVersion="1.2"><title>DITA Open Toolkit Release 1.5.3</title><shortdesc>Release 1.5.3 is a maintenance release based on the final version of the DITA 1.2
standard.</shortdesc><refbody><section>
<p>Version 1.5.3 contains many enhancements, user patches, bug fixes, and significant
updates to the documentation.</p>
<p>Release 1.5.3 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 public build was the final build, released as the
DITA-OT 1.5.3 final stable build.</p>
</section><section>
<title>General Enhancements and Changes</title>
<dl><dlentry id="topic_mxs_vps_qc"><dt>Base plug-ins</dt><dd><p>In earlier releases of OT, configuration parameters were hardcoded into Ant files and
Java code. Starting from version 1.5.3 OT has externalized base configurations into base
plug-ins in plugins folder. Base plug-in identifiers and folder names start with
<codeph>org.dita</codeph>: </p>
<ul><li>org.dita.base</li><li>org.dita.docbook</li><li>org.dita.eclipsecontent</li><li>org.dita.eclipsehelp</li><li>org.dita.htmlhelp</li><li>org.dita.javahelp</li><li>org.dita.odt</li><li>org.dita.pdf</li><li>org.dita.troff</li><li>org.dita.wordrtf</li><li>org.dita.xhtml</li></ul>
<p>For backwards compatibility, only configuration files were moved to plug-in folders,
the actual code and resource files were left in original locations.</p>
<p>Installations of OT may remove base plug-ins in order to remove funtionality, but the
<codeph>org.dita.base</codeph> plug-in must be retained as it contains
configuration for base functionality such as catalog files and preprocessing.</p></dd></dlentry><dlentry id="topic_uxs_vps_qc"><dt>Plug-ing configuration changes</dt><dd>
<p>The plug-in configuration file <filepath>plugin.xml</filepath> has support for new
syntax, where the old</p>
<codeblock xml:space="preserve">&lt;feature extension="foo" value="bar.xml" type="file"/&gt;</codeblock>
<p>can be written as</p>
<codeblock xml:space="preserve">&lt;feature extension="foo" file="bar.xml"/&gt;</codeblock>
<p>The new <codeph>file</codeph> attribute only supports a single file, not a comma
separated list like the value attribute.</p><p>In previous releases multiple feature elements with the same
extension ID were not supported. In release 1.5.3 multiple definitions are combined,
thus</p>
<codeblock xml:space="preserve">&lt;feature extension="foo" value="bar,baz"/&gt;</codeblock>
<p>can also be written as </p>
<codeblock xml:space="preserve">&lt;feature extension="foo" value="bar"/&gt;
&lt;feature extension="foo" value="baz"/&gt;</codeblock>
<p>Plug-in extension points can be added with</p>
<codeblock xml:space="preserve">&lt;extension-point id="<i>extension-id</i>" name="<i>human readable name</i>"/&gt;</codeblock>
<p>Plug-ins <b>should</b> declare all extension points they support. In version 1.5.3
undeclared extension points are supported, but a warning is thrown when running
integration in verbose mode. Support for undeclared extension points <b>may</b> be
removed in future releases.</p>
</dd></dlentry><dlentry id="topic_cys_vps_qc"><dt>PDF2 changes</dt><dd>
<p>Support for the format attribute in PDF2 variable files has been remove as
redundant. The same functionality as </p>
<codeblock xml:space="preserve">&lt;variable id="foo" format="bar"&gt;baz&lt;/variable&gt; </codeblock>
<p>can be implemented with e.g. </p>
<codeblock xml:space="preserve">&lt;variable id="foo.bar"&gt;baz&lt;/variable&gt; </codeblock>
<p>PDF2 no longer logs a warning about PDF2 plug-in replacing the legacy PDF
transformation type.</p>
<p>Support for flagging has been added.</p>
<p>Version of FOP that comes with Full Easy Install has been updated from 0.95 to
1.0.</p>
</dd></dlentry><dlentry id="topic_oys_vps_qc"><dt>Filtering configuration</dt><dd><p>List of transtypes which are considered to be print types has been moved to
<filepath>integrator.properties</filepath> with the property name
<codeph>print_transtypes</codeph>. In previous releases this list was hardcoded
into Java code. Configuring print transtypes is currently not possible in plug-in
configuration files.</p></dd></dlentry><dlentry><dt>Java API changes</dt><dd>
<p>Multiple Java classes have been changed from public non-final into package-private
final. This enables clearer distinction between public and internal API, and forbits
subclassing classes which have not been designed and documented for
extensibility.</p>
</dd></dlentry></dl>
</section><section>
<title>SourceForge Enhancements Added</title>
<ol id="ol_ghy_svh_pc"><li>3177971 Improve plugin configuration file (Milestone 2) </li><li>3178275 Add xsl:import extension point to PDF2 topic merge XSL (Milestone 3)</li><li>3182113 Add common attribute processing to PDF2 plugin (Milestone 3)</li><li>3185914 Improve integration loggin (Milestone 3)</li><li>3189073 Plugin location should be available as Ant property (Milestone 3)</li><li>3126848 Repository cleanup (Milestone 3)</li><li>3204188 Support for defining extension point (Milestone 4)</li><li>3213163 Clean PDF2 build and integration scripts (Milestone 4)</li><li>3227387 Need extension to pass user param to dita.map.xhtml.toc targ (Milestone 4) </li><li>3231695 Use an XML serializer object for writing XML (Milestone 4) </li><li>3256796 Remove lecagy PDF code from xsl (Milestone 4)</li><li>3283638 Remove format attribute support from PDF2 vars (Milestone 5)</li><li>3285716 Clean up PDF2 build files (Milestone 5)</li><li>3286085 Add output and temp dir params to PDF2 (Milestone 5)</li><li>3293738 Use extensible pipeline task implementation (Milestone 6)</li><li>3271552 ${args.xsl.pdf} as an absolut path not supported (Milestone 6)</li><li>3033000 update to Apache FOP 1.0 release (Milestone 6) </li><li>3213324 Separate FOP/XEP/AXF stylesheets in PDF2 (Milestone 6) </li><li>3302779 Dependency extension points for PDF2 formatting (Milestone 7) </li><li>3304945 Allow setting local overrides with properties file (Milestone 7) </li><li>3190356 Pluginize DITA-OT base configuration files (Milestone 8)</li><li>3167087 Reduce static variable usage in Java code (Milestone 8)</li><li>3158929 Java clean-up (Milestone 8)</li><li>3194917 Change Java API to be more final and non-public (Milestone 8)</li><li>3197328 Refactor writers for cleaner XML serialization (Milestone 8) </li><li>3199755 Improve log integration (Milestone 8) </li><li>3296040 Refactor PDF2 build files (Milestone 8)</li><li>3306146 PDF2 stylesheet refactoring (Milestone 8)</li><li>3304447 Add support for selecting output format in PDF2 (Milestone 8)</li><li>3310476 Add plug-in ID and version syntax check (Milestone 8)</li><li>3309275 Warning reported by Apache FOP on any topic (Milestone 8)</li><li>3305843 Support list of tables/figures in PDF2 (Milestone 8)</li></ol>
</section><section>
<title>SourceForge Patches Added</title>
<ol id="ol_iky_svh_pc"><li>3123507 String concat in map2plugin (Milestone 1)</li><li>3110513 HTML XSLT uses complex casts (Milestone 1)</li><li>3097677 Add property to reload XHTML stylesheets (Milestone 1) </li><li>3106659 Added topicgroup elements to tocjs (Milestone 1)</li><li>3109051 RestoreEntity duplicates functionality (Milestone 1)</li><li>3107755 Configure templates with integrator properties (Milestone 1)</li><li>3142967 IndexTermReader leaves tab characters in terms (Milestone 1)</li><li>3140543 Add missing Commons Codec JAR into compile classpath for buildPackage.xml
(Milestone 1)</li><li>3087664 Clean plugin configuration parser (Milestone 1)</li><li>3145258 Plug-in integrator code clean-up (Milestone 2)</li><li>3147226 Use common directory layout for Junit (Milestone 2) </li><li>3062765 Fix unit test file paths to be platform dependent (Milestone 2)</li><li>3164523 Refactor platform Java code (Milestone 2)</li><li>3160801 Improve unit test coverage (Milestone 8)</li><li>3189026 Avoid strings where other types are more appropriate (Milestone 8)</li></ol>
</section><section>
<title>SourceForge Bugs Fixed</title>
<ol id="ol_zly_svh_pc"><li>3114411 keyref links don't work for HTML Help (Milestone 1)</li><li>3126578 Chunking Issues in DITA 1.5.1 (Milestone 1)</li><li>3109616 More Antenna House Path Problems (Milestone 1)</li><li>3155375 Incorrect way to specify recognized image extensions(Milestone 2)</li><li>3157890 Navtitle Construction Does not Preserve Markup (Milestone 2)</li><li>3155848 xml decl in ditaval file not closed properly (Milestone 2)</li><li>3162808 Chunking remaps in-file &lt;xref&gt; to invalid value (Milestone 2)</li><li>3164866 Upper letter estensions (Milestone 2)</li><li>3165307 Add boilerplate to Java files (Milestone 2)</li><li>2793836 CHM Index terms come out with extra spaces (Milestone 2)</li><li>3165762 Initializer XMLReader without modifying system variables (Milestone 2)</li><li>3175328 Imagemap alt text gets extra text (Milestone 2)</li><li>3085106 FO: topicmerge drops id on map/topicref without href. (Milestone 2)</li><li>3147328 Error in commons.xsl: getTopicrefShortdesc (Milestone 2)</li><li>3130724 Error in tables.xsl: fix-relcolwidth (Milestone 2)</li><li>3174906 Normalize Map and Bookmap titles for JavaHelp output (Milestone 3)</li><li>3178361 Conkeyref push fails when equivalent conref push succeeds (Milestone 3)</li><li>3180681 PDF2: Inconsistent template import / include. (Milestone 3)</li><li>3191701 Conref Push to Same File Fails (Milestone 3)</li><li>3191704 Push Replace Results in Pushed element Being removed (Milestone 3)</li><li>3189883 MapLinksReader should not be namespace aware (Milestone 3)</li><li>3164587 Warnings issued by Saxon 9.3.0.4 when publishing to PDF (Milestone 3)</li><li>3159001 Clean unit tests (Milestone 4) </li><li>3199985 @chunk : xrefs and links break (Milestone 4)</li><li>3206158 Inconsistent message DOTJ038W (Milestone 4)</li><li>3206373 Better handling of referenced SVG images (Milestone 4)</li><li>3279539 Out of memory error from move-meta module (Milestone 5)</li><li>3281108 Fallback to $locale when xml:lang value is wrong format (Milestone 5)</li><li>3286679 ODT output transform deletes too many files (Milestone 6)</li><li>3287609 Chunking rewrites image based on map directory (Milestone 6)</li><li>3288639 Conref code improperly generalizes map domain elements (Milestone 6)</li><li>3294295 PDF2 indexing and I18N fails with missing languages (Milestone 6)</li><li>3294864 tocjs-demo: tocjs.ditamap is referencing a missing file (Milestone 6)</li><li>3297930 PDF2: axf specific templates can't be overridden. (Milestone 7) </li><li>2001271 DITA-OT documentation wants Ant 1.6.5 (Milestone 8) </li><li>3136773 Incorrect version reported in log file (Milestone 8) </li><li>3260746 Topichead not processed the same as title-only topic (Milestone 8) </li><li>3315029 Garbled character problem in Japanese HTMLHelp (Milestone 8) </li><li>3308775 Keyref map in grandparent folder fails (Milestone 8) </li></ol>
</section></refbody></reference>

203
dita-ot-3.6/docsrc/release-notes/rel1.5.4.dita Normal file
View file

@ -0,0 +1,203 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" id="rel1.5.4" ditaarch:DITAArchVersion="1.2"><title>DITA Open Toolkit Release 1.5.4</title><reference id="general-enhancements-and-changes" ditaarch:DITAArchVersion="1.2"><title>General Enhancements and Changes</title><refbody><section id="section_vc5_gld_g2">
<title>Configuration file for defaults</title>
<p>In previous versions, <filepath>lib/configuration.properties</filepath> was generated
by integration process. Integration has been changed to generate
<filepath>lib/org.dita.dost.platform/plugin.properties</filepath> and the role of the
old <filepath>lib/configuration.properties</filepath> has been changed to contain
defaults and configuration options, such as default language.</p>
</section><section>
<title>Plug-in extension point for file extension configuration</title>
<p>New plug-in extension points have been added allow configuring DITA-OT behaviour based
on file extensions.</p>
<simpletable id="simpletable_xym_ryi_uc"><sthead><stentry>Extension point</stentry><stentry>Description</stentry><stentry>Default values</stentry></sthead><strow><stentry><codeph>dita.topic.extension</codeph></stentry><stentry>DITA topic</stentry><stentry><filepath>.dita</filepath>, <filepath>.xml</filepath></stentry></strow><strow><stentry><codeph>dita.map.extensions</codeph></stentry><stentry>DITA map</stentry><stentry><filepath>.ditamap</filepath></stentry></strow><strow><stentry><codeph>dita.html.extensions</codeph></stentry><stentry>HTML file</stentry><stentry><filepath>.html</filepath>, <filepath>.htm</filepath></stentry></strow><strow><stentry><codeph>dita.resource.extensions</codeph></stentry><stentry>Resource file</stentry><stentry><filepath>.pdf</filepath>, <filepath>.swf</filepath></stentry></strow></simpletable><p>Both HTML and resource file extensions are used to determine if a
file in source is copied to output.</p>
<p>New plug-in extension point has been added to allow declaring transtypes as print types.</p>
<simpletable><sthead><stentry>Extension point</stentry><stentry>Description</stentry></sthead><strow><stentry><codeph>dita.transtype.print</codeph></stentry><stentry>Declare transtype as a print type.</stentry></strow></simpletable>
</section><section>
<title>Strict integration mode</title>
<p>Two modes have been added to integration process: lax and strict. In strict mode the
processing will fail if any errors are encountered. In lax mode an error message may be
thrown for an error and the integration process will try to run to the end, even if
there are errors that were unrecoverable. The default mode is lax.</p>
<note>In lax mode, even if the process runs to the end and reports a successful result,
DITA-OT may not be able to function correctly because of e.g. corrupted plug-in files or
unprocessed template files.</note>
</section><section id="section_dcd_yhr_wc">
<title>Code reference charset support</title>
<p>Encoding of the code reference target file can be set using the <codeph>format</codeph>
attribute, for example </p>
<codeblock xml:space="preserve">&lt;coderef href="unicode.txt" format="txt; charset=UTF-8"/&gt; </codeblock>
</section><section>
<title>Plugin URI scheme</title>
<p>Support for <keyword>plugin</keyword> URI scheme has been added to XSLT stylesheets.
Plug-ins can refer to files in other plug-ins without hard coding relative paths, for
example </p>
<codeblock xml:space="preserve">&lt;xsl:import href="plugin:org.dita.pdf2:xsl/fo/topic2fo_1.0.xsl"/&gt;</codeblock>
</section><section id="section_mdj_zcw_td">
<title>PDF</title>
<p>Support for mirrored page layout has been added. The default is the unmirrored
layout.</p>
<p>The <codeph>args.bookmap-order</codeph> property has been added to control how front
and back matter are processed in bookmaps. The default is to reorder the frontmatter
content as in previous releases.</p>
<p>A new extension point has been added to add mappings to the PDF configuration catalog
file.</p>
<simpletable><sthead><stentry>Extension point</stentry><stentry>Description</stentry></sthead><strow><stentry><codeph>org.dita.pdf2.catalog.relative</codeph></stentry><stentry>Configuration catalog includes.</stentry></strow></simpletable>
<p>Support for the following languages has been added:</p>
<ul><li>Finnish</li><li>Hebrew</li><li>Romanian</li><li>Russian</li><li>Swedish</li></ul>
<p>PDF processing no longer copies images or generates XSL FO to output directory.
Instead, the temporary directory is used for all temporary files and source images are
read directly from source directory. The legacy processing model can be enabled by setting
<codeph>org.dita.pdf2.use-out-temp</codeph> to <codeph>true</codeph> in configuration
properties; support for the legacy processing model may be removed in future releases.</p>
<p>Support for FrameMaker index syntax has been disabled by default. To enable FrameMaker
index syntax, set <codeph>org.dita.pdf2.index.frame-markup</codeph> to <codeph>true</codeph> in
configuration properties.</p>
<p>A configuration option has been added to disable I18N font processing and use
stylesheet defined fonts. To disable I18N font processing, set
<codeph>org.dita.pdf2.i18n.enabled</codeph> to <codeph>false</codeph> in configuration
properties</p>
</section><section id="section_cnx_gmd_g2">
<title>XHTML</title>
<p>Support for the following languages has been added:</p>
<ul><li>Indonesian</li><li>Kazakh</li><li>Malay</li></ul>
</section></refbody></reference><reference id="reference_yvj_ttj_bd" ditaarch:DITAArchVersion="1.2"><title>Migration from previous releases</title><refbody><section>
<p>To allow access to configuration files, the <filepath>lib</filepath> directory needs to
be added to Java classpath.</p>
<p>The <codeph>print_transtypes</codeph> property in <filepath>integrator.properties</filepath> has been deprecated in favor of <codeph>dita.transtype.print</codeph> plug-in extension point.</p>
<p>The <codeph>dita.plugin.org.dita.*.dir</codeph> properties have been changed to point
to DITA-OT base directory.</p>
</section><section><title>PDF</title><p>Support for mirrored page layout was added and the following
XSLT configuration variables have been
deprecated:</p><ul id="ul_hkv_oyj_bd"><li><codeph>page-margin-left</codeph></li><li><codeph>page-margin-right</codeph></li></ul>
<p>The following variables should be used instead to control page margins:</p>
<ul id="ul_yda_wyj_bd"><li><codeph>page-margin-outside</codeph></li><li><codeph>page-margin-inside</codeph></li></ul>
<p>XSLT Parameters <codeph>customizationDir</codeph> and
<codeph>fileProfilePrefix</codeph> have been removed in favor of
<codeph>customizationDir.url</codeph> parameter.</p>
<p>A new shell stylesheet has been added for FOP and other shell stylesheets have also
been revised. Plug-ins which have their own shell stylesheets for PDF processing should
make sure all required stylesheets are imported.</p>
<p>Font family definitions in stylesheets have been changed from Sans, Serif, and
Monospaced to sans-serif, serif, and monospace, respectively. The I18N font processing
still uses the old logical names and aliases are used to map the new names to old ones. </p></section></refbody></reference>
<reference id="reference_r2v_pdv_j2">
<title>SourceForge trackers</title>
<refbody>
<section>
<title>Feature requests</title>
<ul>
<li>3333697 Add strict mode processing (Milestone 1)</li>
<li>3336630 Add resource file extension configuration (Milestone 1)</li>
<li>3323776 Base HTML stylesheets (Milestone 1)</li>
<li>3355860 Enable defining code ref target encoding (Milestone 1)</li>
<li>3393969 Make default TocJS output more usable (Milestone 3)</li>
<li>3394708 cfg/catalog.xml should be an extension point (Milestone 4)</li>
<li>3411030 Add args.fo.userconfig to PDF2 (Milestone 5)</li>
<li>3411961 Change margin-* to space-* property (Milestone 5)</li>
<li>3412144 Add FOP specific shell to PDF2 (Milestone 5)</li>
<li>3413215 Add schemas for PDF2 configuration files (Milestone 5)</li>
<li>3414416 Support bookmap order in PDF2 front and back matter (Milestone 5)</li>
<li>3413933 Fix inconsistencies in PDF2 page headers (Milestone 5)</li>
<li>3418877 Mechanism to refer to other plug-ins in XSLT (Milestone 5)</li>
<li>3411476 Add extension point for print type declaration (Milestone 6)</li>
<li>3392891 Copy the graphic files to the temporary folder (Milestone 6)</li>
<li>3429290 Remove unused Apache Commons Logging JAR (Milestone 6)</li>
<li>3434640 Add XHTML NLS support for Indonesian, Malay, Kazakh (Milestone 6) </li>
<li>3435528 Add base configuration file (Milestone 7)</li>
<li>3432219 Refector dita.list read and write (Milestone 7)</li>
<li>3401849 PDF2: runtime switch for localization post-processing (Milestone 7)</li>
<li>3438361 Add "tocjs" transform to demo script (Milestone 7)</li>
<li>3341648 Clean HTML and XHTML stylesheets (Milestone 8)</li>
<li>3343562 Java clean-up (Milestone 8)</li>
<li>3346094 Improve test coverage (Milestone 8)</li>
<li>3372147 Improve logging (Milestone 8)</li>
<li>3373416 Refactor PDF attribute sets (Milestone 8)</li>
<li>3376114 Improve PDF page layout configuration (Milestone 8)</li>
<li>3415269 Support for more languages in the PDF transform (Milestone 8)</li>
<li>3412211 Refactor PDF index stylesheet for XSL 1.1 support (Milestone 8)</li>
<li>3425838 General PDF2 improvements (Milestone 8)</li>
<li>3428152 General I18N improvements (Milestone 8)</li>
<li>3429390 General XHTML improvements (Milestone 8)</li>
<li>3438790 Clean up build_demo script (Milestone 8)</li>
<li>3440826 Dutch patch for feature request 3415269 (Milestone 8)</li>
<li>1785391 Make Java code thread-safe (in progress)</li>
</ul>
</section>
<section>
<title>Patches</title>
<ul>
<li>2963037 PDF changes to fix index rendering of colon (bug 2879196) (Milestone 7)</li>
</ul>
</section>
<section>
<title>Bugs</title>
<ul>
<li>2714699 FO plug-in doesn't support specialized index elements (Milestone 1)</li>
<li>2848636 Duplicate key definitions should produce info messages (Milestone 1)</li>
<li>3353955 Frontmatter child order is not retained in PDF2 (Milestone 1)</li>
<li>3354301 XRef with conreffed phrases not properly generate HTML link (Milestone 1)</li>
<li>3281074 Bad attribute being applied to fo:bookmark-title element (Milestone 2)</li>
<li>3344142 Conref Push order of validation (Milestone 2)</li>
<li>3358377 Cryptic error message when DITA Map has "bookmap" extension (Milestone 3)</li>
<li>3384673 ODF transtype no longer embeds images in output (OT 1.5.3) (Milestone 3)</li>
<li>3394000 TocJS needs cleanup for several minor bugs (Milestone 3)</li>
<li>3392718 TOCJS sample should not require ant target (Milestone 3)</li>
<li>3389277 DocBook transform redundantly nests Related Links (Milestone 3)</li>
<li>3105339 '&lt;' and '>' characters in a title cause tocjs trouble (Milestone 3)</li>
<li>3104497 tocjs JavaScripts don't work in Japanese environment (Milestone 3)</li>
<li>3394130 Remove outdated developer documentation (Milestone 3)</li>
<li>3397165 chunk on topichead not honored (Milestone 4)</li>
<li>3397501 Custom reltable column headers are reversed (Milestone 4)</li>
<li>3397495 Relcolspec with &lt;title> does not generate link group headers (Milestone 4)</li>
<li>3399030 &lt;ph> Elements not flagged with alt-text in HTML output (Milestone 4)</li>
<li>3396884 NPE in EclipseIndexWriter.java&lt;Merges,setLogger for AbstractIndexWriters (Milestone 4)</li>
<li>3398004 -d64 flag to JVM not allowed for Windows JVMs (Milestone 4)</li>
<li>3401323 Fix PDF nested variable handling (Milestone 4)</li>
<li>3401721 Processing broken for &lt;topicsetref> elements (Milestone 4)</li>
<li>3404049 Setting of clean_temp is backwards (Milestone 4)</li>
<li>3386590 Product name repeated hundreds of times in PDF (Milestone 4)</li>
<li>3405417 Shortdesc output twice when using abstract (Milestone 4)</li>
<li>3402165 wrong image output dir if using generate.copy.outer=2 (Milestone 4)</li>
<li>2837095 Positions of index and TOC in bookmaps are ignored (Milestone 5)</li>
<li>3414826 DITA OT not handling image path with chunking turned on (Milestone 5)</li>
<li>3411767 Not so meaningful messages given by ImgUtils (Milestone 5)</li>
<li>3405851 Incorrect entry@colname in merged XML with row and colspan (Milestone 5)</li>
<li>3406357 Custom profiling issue (Milestone 5)</li>
<li>3413203 Remove references to OpenTopic in PDF2 (Milestone 5)</li>
<li>3414270 @props specialization not used in map (Milestone 5)</li>
<li>3383618 Attribute 'link-back' cannot occur at element 'fo:index-key (Milestone 5)</li>
<li>3418953 Scale computation for XHTML uncorrectly looks up images (Milestone 6)</li>
<li>3413229 onlytopic.in.map &amp; symlink (Milestone 6)</li>
<li>3423537 Additional line breaks in &lt;menucascade> should be ignored (Milestone 6)</li>
<li>3423672 Problems with refs to images outside the DITA Map directory (Milestone 6)</li>
<li>2879663 indexterm/keyword causees NullPointerException (Milestone 7)</li>
<li>2879196 Colon character in &lt;indexterm> causes nesting in output (Milestone 7)</li>
<li>3179018 Indexterm with only nested subelement results in NPE (Milestone 7)</li>
<li>3432267 Task example title processing incorrect for PDF (Milestone 7)</li>
<li>3430302 Unitless images sizes in throw errors (Milestone 7)</li>
<li>3429845 No variables for Warning (Milestone 7)</li>
<li>3428871 topicmerge gives incomplete topicref when reference or topic (Milestone 7)</li>
<li>3132976 Duplicate index text in index page (Milestone 7)</li>
<li>2795649 Java topicmerge ignores xml:lang (Milestone 7)</li>
<li>3431798 Relative CSS paths incorrectly computed for @copy-of (Milestone 7)</li>
<li>3438421 Remove transtype default (Milestone 7)</li>
<li>2866342 Nested see also is ignored (Milestone 8)</li>
<li>1844429 PDF2: Non-DITA link broken unless marked external (Milestone 8)</li>
<li>3270616 "lcTime" not displayed in PDF output (Milestone 8)</li>
<li>3388668 Data in figure captions not suppressed in xrefs (Milestone 8)</li>
<li>3429824 topicmerge gives wrong topicref with nested topics (Milestone 8)</li>
<li>3414332 PDF2 variable string translations missing (Milestone 8)</li>
<li>3323806 Improve Java logging and exception handling (Milestone 8)</li>
<li>3426920 Image files not copied or referenced correctly for eclipse (Milestone 8)</li>
<li>3445159 entry/@colname has been removed! (Milestone 8)</li>
<li>3447732 Bug in handling of longdescref (Milestone 8)</li>
<li>3452510 Ant parameter customization.dir not documented anywhere (Milestone 8)</li>
<li>3451621 Revisions on &lt;plentry&gt; use wrong image for nested &lt;pd&gt; (Milestone 8)</li>
</ul>
</section>
</refbody>
</reference></reference>

26
dita-ot-3.6/docsrc/release-notes/rel1.5.dita Normal file
View file

File diff suppressed because one or more lines are too long

383
dita-ot-3.6/docsrc/release-notes/rel1.6.dita Normal file
View file

@ -0,0 +1,383 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="rel1.5.4" xml:lang="en">
<title>DITA Open Toolkit Release 1.6</title>
<reference id="releasehighlights" xml:lang="en-US">
<title>Release highlights</title>
<refbody>
<section><dl><dlentry><dt>Performance improvements</dt><dd>DITA-OT 1.6 contains
several updates that combine for significant performance improvements
for large documents. For example, building the DITA 1.2 Language Specification
to XHTML takes just over 1/3 of the time as with the previous release
(tests show an improvement of 288%).</dd></dlentry>
<dlentry><dt>Error message overhaul</dt><dd>In the recent DITA-OT
usage survey, we asked for specific problems encountered when running
the DITA-OT. The most frequent response was difficulty understanding
and responding to error messages. The latest release addresses this
in two ways:<ol>
<li>Every message has been reviewed, and nearly every message has
been revised for clarification.</li>
<li>Messages are now documented in the DITA-OT User Guide. The new
documentation contains additional details about nearly every message,
including potential remedies and links to helpful information.</li>
</ol></dd></dlentry>
<dlentry><dt>Code cleanup</dt><dd>Of particular interest to developers,
much of the deprecated code in the toolkit (some of it unused for
5+ years) has been removed. As a result, much of the code is cleaner,
faster, and easier to customize. For example, the cleanup of PDF code
allowed us to remove the alternate *_1.0.xsl stylesheets.</dd></dlentry></dl></section>
</refbody>
</reference>
<reference id="general-enhancements-and-changes">
<title>General Enhancements and Changes</title>
<refbody>
<section id="section_h5q_3nt_q2">
<p>New arguments have been added:</p>
<ul>
<li><codeph>args.rellinks</codeph> controls which related links will be output.</li>
<li><codeph>args.filter</codeph> defines the filter file to be used.</li>
</ul>
<p>New configuration options have been added:</p>
<ul id="ul_vzj_f5m_zf">
<li><codeph>generate-debug-attributes</codeph> controls debug attribute generation and can
be used to reduce memory consumption.</li>
<li><codeph>processing-mode</codeph> controls error recovery behavior.</li>
</ul>
<p>Support for the old DITAVAL format (used before OASIS
added DITAVAL to the standard in 2007) has been removed.</p>
<p>Source distribution package has been removed in favor or Git and GitHub source
downloads.</p>
<p>The <filepath>demo</filepath> folder has been deprecated and the following plug-ins have
been moved to <filepath>plugins</filepath> folder:</p>
<simpletable id="simpletable_gst_mcz_gg">
<sthead>
<stentry>old path</stentry>
<stentry>new path</stentry>
</sthead>
<strow>
<stentry><filepath>demo/dita11</filepath></stentry>
<stentry><filepath>plugins/org.dita.specialization.dita11</filepath></stentry>
</strow>
<strow>
<stentry><filepath>demo/dita132</filepath></stentry>
<stentry><filepath>plugins/org.dita.specialization.dita132</filepath></stentry>
</strow>
<strow>
<stentry><filepath>demo/eclipsemap</filepath></stentry>
<stentry><filepath>plugins/org.dita.specialization.eclipsemap</filepath></stentry>
</strow>
<strow>
<stentry><filepath>demo/fo</filepath></stentry>
<stentry><filepath>plugins/org.dita.pdf2</filepath></stentry>
</strow>
<strow>
<stentry><filepath>demo/tocjs</filepath></stentry>
<stentry><filepath>plugins/com.sophos.tocjs</filepath></stentry>
</strow>
<!-- These plugins are pulled from ext-plugins during build -->
<strow>
<stentry><filepath>demo/h2d</filepath></stentry>
<stentry><filepath>plugins/h2d</filepath></stentry>
</strow>
<strow>
<stentry><filepath>demo/legacypdf</filepath></stentry>
<stentry><filepath>plugins/legacypdf</filepath></stentry>
</strow>
</simpletable>
<p>The following plug-ins in the demo folder have been moved to a <xref href="https://github.com/dita-ot/ext-plugins" scope="external" format="html">separate plug-ins
Git repository</xref>:</p>
<ul>
<li><filepath>FrameMaker_adapter</filepath></li>
<li><filepath>apiref</filepath></li>
<li><filepath>authorinfo</filepath></li>
<li><filepath>book</filepath></li>
<li><filepath>elementref</filepath></li>
<li><filepath>enote</filepath></li>
<li><filepath>faq</filepath></li>
<!-- The commented out plugins are still shipped with DITA-OT -->
<!--li><filepath>h2d</filepath></li-->
<li><filepath>java</filepath></li>
<li><filepath>javaapiref</filepath></li>
<!--li><filepath>legacypdf</filepath></li-->
<li><filepath>music</filepath></li>
<li><filepath>thesaurus</filepath></li>
<li><filepath>tutorial</filepath></li>
<li><filepath>video</filepath></li>
</ul>
</section>
<section id="section_cr5_5fh_mg">
<p>The following bundled libraries have been updated:</p>
<ul>
<li>Ant <keyword keyref="tool.ant.version"/></li>
<li>ICU4J <keyword keyref="tool.icu4j.version"/></li>
<li>Apache Xerces <keyword keyref="tool.xerces.version"/></li>
</ul>
</section>
<section><title>PDF2</title><p>The following deprecated items are no longer supported in the PDF transform:</p><ul>
<li>Support for the beta version of DITA, available from IBM before the OASIS standard was created in 2005.</li>
<li>Support for the "bkinfo" demo plug-in, used to support book metadata before OASIS created the BookMap format in 2007.</li>
<li>Support for <filepath>layout-masters.xml</filepath> configuration.</li>
</ul>
<p>The following extension-points have been added:</p>
<ul id="ul_lhx_1jk_rf">
<li><codeph>dita.conductor.pdf2.param</codeph> to add XSLT parameters to XSL FO
transformation.</li>
</ul>
</section>
</refbody>
</reference>
<reference id="reference_yvj_ttj_bd">
<title>Migration from previous releases</title>
<refbody>
<section>
<p>The deprecated property <codeph>dita.input.valfile</codeph> should be replaced with the
new argument property <codeph>args.filter</codeph>.</p>
<p>Target <codeph>dita-preprocess</codeph> has been removed and dependencies should be
replaced with a target sequence <codeph>build-init, preprocess</codeph>.</p>
<p>Support for argument <codeph>args.message.file</codeph> has been removed as message
configuration has become static configuration.</p>
<p>Processing instruction <codeph>workdir</codeph> has been deprecated in favor of
processing instruction <codeph>workdir-uri</codeph>. The only difference between the two processing instructions is that <codeph>workdir-uri</codeph> contains
a URI instead of a system path.</p>
</section>
<section id="section_gvw_5xn_2g">
<title>Preprocessing</title>
<p>The following deprecated templates and modes have been removed in topic pull
stylesheets:</p>
<ul>
<li>inherit</li>
<li>get-stuff</li>
<li>verify-type-attribute</li>
<li>classval</li>
<li>getshortdesc</li>
<li>getlinktext</li>
<li>blocktext</li>
<li>figtext</li>
<li>tabletext</li>
<li>litext</li>
<li>fntext</li>
<li>dlentrytext</li>
<li>firstclass</li>
<li>invalid-list-item</li>
<li>xref</li>
</ul>
</section>
<section>
<title>XHTML</title>
<p>The following named templates have been deprecated:</p>
<ul id="ul_rrg_2wd_3g">
<li>make-index-ref</li>
</ul>
<p>The following deprecated templates have been removed:</p>
<ul id="ul_ywp_gsc_ff">
<li>revblock-deprecated</li>
<li>revstyle-deprecated</li>
<li>start-revision-flag-deprecated</li>
<li>end-revision-flag-deprecated</li>
<li>concept-links</li>
<li>task-links</li>
<li>reference-links</li>
<li>relinfo-links</li>
<li>sort-links-by-role</li>
<li>create-links</li>
<li>add-linking-attributes</li>
<li>add-link-target-attribute</li>
<li>add-user-link-attributes</li>
</ul>
<p>The removed templates have been replaced by other templates in earlier releases and
plug-ins should be changed to use the new templates.</p>
</section>
<section>
<title>ODT</title>
<p>The following deprecated templates have been removed:</p>
<ul id="ul_ywp_gsc_ff2">
<li>revblock-deprecated</li>
<li>revstyle-deprecated</li>
<li>start-revision-flag-deprecated</li>
<li>end-revision-flag-deprecated</li>
</ul>
<p>The removed templates have been replaced by other templates in earlier releases and
plug-ins should be changed to use the new templates.</p>
</section>
<section id="section_tqw_bnt_q2"><title>PDF2</title><p>Custom PDF2 shell stylesheets need to
be revised to not include separate IBM and OASIS DITA stylesheets. The
<filepath><varname>*</varname>_1.0.xsl</filepath> stylesheets have been removed and
their imports must be removed from shell stylesheets.</p><p>The following template modes
have been deprecated:</p><ul id="ul_hxz_ks2_gf">
<li>toc-prefix-text</li>
<li>toc-topic-text</li>
</ul><p>The following named templates have been removed:</p>
<ul>
<li>processTopic</li>
<li>createMiniToc</li>
<li>processTopicTitle</li>
<li>createTopicAttrsName</li>
<li>processConcept</li>
<li>processReference</li>
<li>getTitle</li>
<li>placeNoteContent</li>
<li>placeImage</li>
<li>processUnknowType</li>
<li>insertReferenceTitle</li>
<li>buildRelationships</li>
<li>processTask</li>
</ul>
<p>Main
FO generation now relies on merging process to rewrite duplicate IDs. The default merging
has done this already in previous releses, but now also custom merging needs to fulfill
the duplicate ID rewrite requirement.</p>
<p>Support for <filepath>layout-masters.xml</filepath> configuration has been removed,
plug-ins should use <codeph>createDefaultLayoutMasters</codeph> template instead.</p></section>
</refbody>
</reference>
<reference id="rel1.6">
<title>Issues</title>
<shortdesc>The following items are included in DITA Open Toolkit Release
1.6. Issue numbers correspond to the tracking number in the <ph><xref keyref="dita-ot-issues">GitHub issues tracker</xref></ph>.</shortdesc>
<refbody>
<section>
<title>Feature requests</title>
<ul>
<li>#1057 Deprecate logException and add logError(String, Throwable) (milestone 1)</li>
<li>#1059 PDF2 should fully support core default language (milestone 1)</li>
<li>#1058 Add switch to ignore links in XHTML (milestone 1)</li>
<li>#1158 Refactor log messages and tasks (milestone 1)</li>
<li>#1060 Reduce topic merge memory consumption (milestone 1)</li>
<li>#1062 Remove IBM DITA and BookMap demo support from PDF2 (milestone 1)</li>
<li>#1063 Move OT version number to configuration (milestone 2)</li>
<li>#1061 Remove obsolete dita-preprocess target (milestone 2)</li>
<li>#1065 Add index file to PDF2 variables (milestone 3)</li>
<li>#1067 Move Ant scripts to plug-in folders (milestone 3)</li>
<li>#1066 Run XSLT with Ant task in PDF2 (milestone 3)</li>
<li>#762 bookmap.dtd and map.dtd are out of sync with OASIS (milestone 3)</li>
<li>#1068 Add XSLT param extension point to PDF2 (milestone 4)</li>
<li>#948 For PDF output, xml:lang does not work at the element level (milestone 4)</li>
<li>#1064 Support localization of quotation marks in quote (milestone 4)</li>
<li>#1070 Remove support for args.message.file (milestone 4)</li>
<li>#1071 Add automatic font detection to PDF2 (milestone 4)</li>
<li>#1182 Need extension for determining topic level (milestone 4)</li>
<li>#1236 &lt;span&gt; tags added around step when DRAFT on (milestone 4)</li>
<li>#1262 css support for codeph in HTML output (milestone 4)</li>
<li>#1198 Generate PDF metadata from bookmeta (milestone 5)</li>
<li>#1273 Remove source distribution builds (milestone 5)</li>
<li>#1203 ditaval flag action screws strow rendering (milestone 5)</li>
<li>#1104 DitaWriter workdir PI not a URL (milestone 5)</li>
<li>#1252 Document error messages in user guide (milestone 5)</li>
<li>#1278 Separate core and extra plug-ins (milestone 5)</li>
<li>#1249 Add Files from Distribution Packages to Git Repo (milestone 5)</li>
<li>#1283 xref with desc and no href not handled in XHTML (milestone 5)</li>
<li>#1137 Consistent coding conventions for Java code (final release)</li>
<li>#1153 Remove deprecated Ant files (final release)</li>
<li>#1300 Add a hook to set @summary on table in XHTML (final release)</li>
<li>#1302 Add a way for cross-references to pick up generated text for sections (final
release)</li>
<li>#1266 Honor the map top level processing instruction (final release)</li>
<li>#1156 Refactor preprocessing to use SAX filters (final release)</li>
<li>#1159 Remove Content object (final release)</li>
<li>#1155 Use Job to read/write job configuration files (final release)</li>
<li>#1160 Improve filtering (final release)</li>
<li>#1124 Make Java code thread-safe (final release)</li>
<li>#1157 Clean Ant scripts (final release)</li>
<li>#1149 Consistent Ant property names (final release)</li>
<li>#1161 Remove deprecated code (final release)</li>
<li>#1162 Improve title numbering in PDF2 (final release)</li>
<li>#1163 Clean PDF2 ID processing (final release)</li>
<li>#1165 Improve PDF2 table customization (final release)</li>
<li>#1166 Improve pipeline module processing (final release)</li>
<li>#1164 Avoid strings where other types are more appropriate (final release)</li>
<li>#1168 Add ability to disable debug attribute generation (final release)</li>
<li>#1249 Add Files from Distribution Packages to Git Repo (final release)</li>
<li>#1243 Support for some kind of die_on_error property (final release)</li>
<li>#1257 Simplify common XHTML code for flag/revision (final release)</li>
</ul>
</section>
<section>
<title>Patches</title>
<ul>
<li>#849 Map references with root fragment are not processed (milestone 1)</li>
<li>#743 Key-based mapref results in preprocessing error (milestone 1)</li>
</ul>
</section>
<section>
<title>Bugs</title>
<ul>
<li>#732 Temp dir with non-ASCII character crashes (milestone 1)</li>
<li>#729 v 1.5.4 fails to create PDF with external topic ref (milestone 1)</li>
<li>#747 [1.5.4]Glosslist no longer visible in Bookmarks (PDF output) (milestone 1)</li>
<li>#733 Incorrect image reference does not checked (milestone 1)</li>
<li>#725 Deprecated property breaks Plus plugins (milestone 1)</li>
<li>#740 Info message about inline flagging not displayed (milestone 1)</li>
<li>#738 NullPointerException when absolute path to image (milestone 1)</li>
<li>#739 PDF2 image references broken with uplevels (milestone 1)</li>
<li>#734 1.5.4 looks for lib dir at current dir instead a ${dita.dir} (milestone 1)</li>
<li>#735 Apache FOP: TOCs with uneven right margin (milestone 1)</li>
<li>#744 Possible collision in File Extension detection mechanism (milestone 1)</li>
<li>#743 Key-based mapref results in preprocessing error (milestone 1)</li>
<li>#753 Choicetable headings not localized in PDF (milestone 2)</li>
<li>#754 Check all places where output streams are used in dost.jar (milestone 2)</li>
<li>#755 Property noCoderef not declared (milestone 2)</li>
<li>#745 HTML handling of *div does not generate @outputclass (milestone 2)</li>
<li>#750 Stylesheet imported multiple times in the hierarchy (milestone 2)</li>
<li>#752 Warning when using @copy-to in reltable (milestone 2)</li>
<li>#722 Revisions on &lt;plentry> use wrong image for nested &lt;pd> (milestone 2)</li>
<li>#721 Bug in handling of longdescref (milestone 2)</li>
<li>#709 Image files not copied or referenced correctly for eclipse (milestone 2)</li>
<li>#758 Keydefs in non-base folder fails (milestone 3) </li>
<li>#757 Deprecated metadata PICS-Label in XHTML output (milestone 3)</li>
<li>#719 Glossentry makes FO file invalid in PDF output (milestone 3)</li>
<li>#677 Warning given by Saxon EE when processing flag-rules.xsl (milestone 3)</li>
<li>#759 PDF2: preface titles does not pull indexterms. (milestone 3)</li>
<li>#760 startcmd.bat adds dost.jar twice to the CLASSPATH (milestone 3)</li>
<li>#765 XSL for Warning uses wrong attribute set (milestone 4)</li>
<li>#764 steps-unordered doesn't generate heading (milestone 4)</li>
<li>#763 choicetable/@product value output in fo:table (milestone 4)</li>
<li>#1229 Typos in domains_(un)classed.css (in progress)</li>
<li>#1284 Fix broken references in catalog file for PDF publishing (milestone 5)</li>
<li>#1216 Customizing PDF layout-masters in 1.5.3 (milestone 5)</li>
<li>#1177 Extension Point @behavior Not Documented (milestone 5)</li>
<li>#1207 Table colwidth attribute always treated as proportional (milestone 5)</li>
<li>#1101 zh-CN file for PDF puts English strings in output (final release)</li>
<li>#1289 Improve error messages (final release)</li>
<li>#1295 Various errors when using term with keyref in XHTML (final release)</li>
<li>#1294 Use dita.ext instead of dita.extname (final release)</li>
<li>#1297 Mappull doesn't recognize &lt;navtitle> when checking for navtitle for non-DITA
resources (final release)</li>
<li>#1191 Text only mode outputs desc content in links (final release)</li>
<li>#1303 Add Java properties file DTD to catalog (final release)</li>
<li>#1308 XHTML flag support missing for linklist, linkinfo, linklist/desc (final
release)</li>
<li>#1307 M5 reports "illegal character" for xref that uses space in directory name (final
release)</li>
<li>#1152 UNC paths are not supported in input argument (final release)</li>
<li>#1072 URLs not decoded by dost.jar (final release)</li>
<li>#1306 Typo in XSLT mode results in extra fallthrough text for step (final
release)</li>
<li>#1321 Fix path2project separator clean-up (maintenance 1)</li>
<li>#1322 Xref to table cell does not properly navigate to it (maintenance 1)</li>
<li>#1323 @relcolwidth attribute not taken into account when transforming &lt;choicetable>
to PDF using Apache FOP (maintenance 1)</li>
<li>#1325 Variable "Index See Also String" missing from Hebrew (maintenance 1)</li>
<li>#1329 PDF2 indexing fails for ranges (maintenance 1)</li>
<li>#1330 Spaces in Filenames in 1.6 (maintenance 1)</li>
<li>#1335 Link to see/see also in index is broken (maintenance 2)</li>
<li>#1340 The "DitaWriter" class does not properly resolve entities when catalogs are referenced with &lt;nextCatalog> in the catalog-dita.xml (maintenance 2)</li>
<li>#1343 Topics with spaces in file name appear twice (maintenance 2)</li>
<li>#1346 Cannot determine the title of a xreffed topic (maintenance 2)</li>
<li>#1348 Topics copied using "copy-to" become not wellformed (DITA OT 1.6.1) (maintenance 2)</li>
<li>#1351 'Unexpected Text' root-processing_axf.xsl bug (maintenance 2)</li>
<li>#1353 dita2htmlImpl.xsl/add-br-for-empty-cmd ... content match (maintenance 2)</li>
<li>#1354 xml comment not being stripped correctly in preprocessing (maintenance 2)</li>
<li>#1357 NPE when image is incorrectly referenced when publishing to HTML (maintenance 2)</li>
<li>#1358 Cannot cross reference definition list items (dlentry, dt, dd) in PDF (maintenance 2)</li>
<li>#1365 pdf duplicate see-also entries in Index (maintenance 3)</li>
<li>#1369 prodinfo seems to lead to "(file) does not exist", where file has spaces in name (maintenance 3)</li>
<li>#1370 Links to files with spaces in name broken (maintenance 3)</li>
<li>#1371 build_demo uses deprecated Ant property (maintenance 3)</li>
<li>#1377 htmlhelp ampersand (&amp;amp;) entity in indexterm does not convert (maintenance 3)</li>
<li>#1378 dita.out.map.htmlhelp.hhk: target doesn't allow topic with empty indexterm (maintenance 3)</li>
<li>#1382 Merging uses system path separator when rewriting URIs (maintenance 3)</li>
</ul>
</section>
</refbody>
</reference>
</reference>

251
dita-ot-3.6/docsrc/release-notes/rel1.7.dita Normal file
View file

@ -0,0 +1,251 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
"reference.dtd">
<reference id="rel1.7" xml:lang="en">
<title>DITA Open Toolkit Release 1.7</title>
<!--reference id="releasehighlights" xml:lang="en-US">
<title>Release highlights</title>
<refbody>
<section/>
</refbody>
</reference-->
<reference id="general-enhancements-and-changes" xml:lang="en-US">
<title>General Enhancements and Changes</title>
<refbody>
<section> <p>The minimum Java version has changed from 5.0
to 6.</p><p>Added support for abbreviated-form processing in PDF.</p><p>X/HTML
processing code has been streamlined to make it faster and easier
to read.</p><p>Ant proprocessing dependencies have been cleaned up
to make tasks easier to use independently.</p><p>Numerous internal
improvements not directly visible to most end users; see feature and
patch list for details.</p> </section>
<section> <title>Preprocessing</title> <p>By default,
DITA-OT no longer normalizes file extensions to <codeph>.xml</codeph>.
Temporary files will retain the original file extensions,
unless <parmname>dita.ext</parmname> parameter is used to force file
extension normalization to a given value.</p> <p>Key name
validation has been added. If an invalid key name is found, <msgnum>DOTJ055E</msgnum> error
is thrown.</p> </section>
</refbody>
</reference>
<reference id="reference_yvj_ttj_bd">
<title>Migration from previous releases</title>
<refbody>
<section> <p>A new job status file <filepath>.job.xml</filepath> has
been introduced and replaces <filepath>dita.list</filepath> and
<filepath>dita.xml.properties</filepath> as the normative
source for job status. If you have custom processing which modifies
the job properties, you should change your code to modify <filepath>.job.xml</filepath> instead.</p>
<p>Support for the following deprecated properties have been
removed:</p> <ul>
<li><codeph>dita.input</codeph></li>
<li><codeph>dita.input.dirname</codeph></li>
<li><codeph>dita.extname</codeph></li>
</ul> <p>Stylesheets for the following transtypes have moved
to plug-in specific folders:</p> <ul>
<li>docbook</li>
<li>eclipsecontent</li>
<li>troff</li>
<li>wordrtf</li>
</ul> <p>If custom plug-ins have hard coded paths to these
stylesheets, update references to use either <codeph>plugin</codeph>
URIs in <codeph>xsl:import</codeph> instructions or use <codeph>dita.plugin.*</codeph> Ant
properties.</p> <p>The integration process has been changed
to use strict mode by default. For old plug-ins which are not valid,
<keyword>lax</keyword> processing mode can still be used.</p>
<p>Plug-ins that use the <codeph>MessageUtils</codeph> Java
class must use <codeph>getInstance</codeph> method to access
the <codeph>MessageUtils</codeph> instance, as <codeph>getMessage</codeph> methods
have been changed to instance methods.</p> </section>
<section> <title>Preprocessing</title> <p>The preprocessing
Ant dependency chain has been cleaned up. Tasks no longer depend on
the previous task in the default chain, but rather the whole
preprocess dependency chain is defined by the <codeph>preprocess</codeph> task.</p>
</section>
<section> <title>HTML</title> <p>Core TOC generation
has been moved to a separate XSLT stylesheet <filepath>xsl/map2htmtoc/map2htmlImpl.xsl</filepath>
and the new templates use the mode <codeph>toc</codeph>.
Plug-ins which override HTML TOC processing should change
the map processing templates to <codeph>toc</codeph> mode.</p>
</section>
<section> <title>HTML and extended transform types</title>
<p>Flagging logic has been pulled out of the core X/HTML code
and moved to a preprocess step. This significantly simplifies
and optimizes the X/HTML code, while making flagging logic available
to any other transform type. The new preprocess step implements
all flagging logic; for each active flag, it adds a DITA-OT specific
hint into the intermediate topics (implemented as a specialization
of the DITA &lt;foreign&gt; element). As part of this change, all
flagging related templates in the XHTML code (such as start-flagit
and gen-style) are deprecated.</p> <p>If you override the
X/HTML transforms, you may need to update your overrides to use the
new flagging logic. In most cases this just means deleting
calls to the deprecated templates; in some cases, the calls can be
replaced with 2 lines to process flags in new places. You
should compare your override to the updated XHTML code and update
as needed. See "XHTML migration for flagging updates in
DITA-OT 1.7" in the <xref href="../../reference/preprocessing.dita"></xref> section
for details.</p> <p>Plug-ins that provide support for new
transforms need to ensure that they properly support the DITA &lt;foreign&gt;
element, which should be ignored by default; if so, this
change will have no immediate impact. Support for flagging
new transform types may be more easily added based on this update,
because there is no need to re-implement flagging logic,
but this is not required. See "Flagging in the toolkit" in the <xref
href="../../reference/preprocessing.dita"></xref> section for details
on how to add flagging support.</p> </section>
<section> <title>PDF</title> <p>The following deprecated
XSLT variables have been removed:</p> <ul>
<li><codeph>page-margin-left</codeph></li>
<li><codeph>page-margin-right</codeph></li>
</ul> <p>XSLT stylesheets have been split to separate specialization
topic code and new <codeph>xsl:import</codeph> instructions have been
added to <filepath>topic2fo.xsl</filepath>. Plug-ins which
define their own shell stylesheet should be revised to import all
the required stylesheet modules.</p> <p>PDF processing
used to replace topic <codeph>shortdesc</codeph> with map <codeph>shortdesc</codeph>,
but this behaviour was incorrect and was removed to comply
with the DITA specification.</p> <p>The following variable
strings have been added:</p> <ul>
<li><codeph>#note-separator</codeph></li>
</ul> </section>
</refbody>
</reference>
<reference id="rel1.7.issues">
<title>Issues</title>
<shortdesc>The following items are included in DITA Open Toolkit Release
1.7. Issue numbers correspond to the tracking number in the <ph><xref keyref="dita-ot-issues">GitHub issues tracker</xref></ph>.</shortdesc>
<refbody>
<section> <title>Feature requests</title> <ul>
<li>#1144 Produce HTML5 output (milestone 1)</li>
<li>#1319 Remove deprecated code (milestone 1)</li>
<li>#1339 PDF, flagged image : change use-attribute-sets="image" (milestone
1)</li>
<li>#1141 XHTML: ability to include TOC in every topic (milestone
2)</li>
<li>#1331 Possibility to customize &lt;stepresult> in HTML output
(milestone 2)</li>
<li>#1366 pdf index entries have too many keep-with-previous (milestone
2)</li>
<li>#1379 Use format attribute to identity DITA topics (milestone
2)</li>
<li>#1384 Validate key names (milestone 2)</li>
<li>#1388 Remove temporary file file-extension normalization (milestone
2)</li>
<li>#1288 Use strict integration by default (milestone 3)</li>
<li>#1327 Change minimum Java version to 6 (milestone 3)</li>
<li>#1391 Add new job status file format (milestone 3)</li>
<li>#1398 Allow defining source input base directory (milestone 3)</li>
<li>#1403 Refactor XEP index processing to extend base index processing
(milestone 4)</li>
<li>#1405 Provide catalog URL rewrite for common XSL files (milestone
4)</li>
<li>#1313 Separate flagging logic from XHTML code (milestone 4)</li>
<li>#1312 Refactor preprocessing to use SAX filters (release candidate)</li>
<li>#1317 General XHTML improvements (release candidate)</li>
<li>#1324 Avoid strings where other types are more appropriate (release
candidate)</li>
<li>#1338 Add named error messages (release candidate)</li>
<li>#1345 Add source location to error messages (release candidate)</li>
<li>#1389 Move stylesheets and resource files to plug-in folder (release
candidate)</li>
</ul> </section>
<section> <title>Patches</title> <ul>
<li>#1350 Move table specializations into separate stylesheets (milestone
1)</li>
<li>#1359 Fix text overflow issue in PDF ToC entries with long titles.
(milestone 1)</li>
<li>#1352 Wrap itemgroup task elements into &lt;div> elements #1331
(milestone 2)</li>
<li>#1400 Updates on the build instructions plus a fix in one of the
dost classes that made the build fail (milestone 4)</li>
<li>#1401 Disable XSD Grammar caching (milestone 4)</li>
</ul> </section>
<section> <title>Bugs</title> <ul>
<li>#1316 Conref error message missing the @conref value (milestone
1)</li>
<li>#1321 Fix path2project separator clean-up (milestone 1)</li>
<li>#1322 Xref to table cell does not properly navigate to it (milestone
1)</li>
<li>#1323 @relcolwidth attribute not taken into account when transforming &lt;choicetable>
to PDF using Apache FOP (milestone 1)</li>
<li>#1325 Variable "Index See Also String" missing from Hebrew (milestone
1)</li>
<li>#1329 PDF2 indexing fails for ranges (milestone 1)</li>
<li>#1330 Spaces in Filenames in 1.6 (milestone 1)</li>
<li>#1332 output-deprecated-msg deleted; still referenced (milestone
1)</li>
<li>#1335 Link to see/see also in index is broken (milestone 1)</li>
<li>#1340 The "DitaWriter" class does not properly resolve entities
when catalogs are referenced with &lt;nextCatalog> in
the catalog-dita.xml (milestone 1)</li>
<li>#1343 Topics with spaces in file name appear twice (milestone
1)</li>
<li>#1346 Cannot determine the title of a xreffed topic (milestone
1)</li>
<li>#1348 Topics copied using "copy-to" become not wellformed (DITA
OT 1.6.1) (milestone 1)</li>
<li>#1349 "Ambiguous rule match" in PDF processing XSLT when &lt;choicetable>
is used in topic (milestone 1)</li>
<li>#1351 'Unexpected Text' root-processing_axf.xsl bug (milestone
1)</li>
<li>#1353 dita2htmlImpl.xsl/add-br-for-empty-cmd ... content match
(milestone 1)</li>
<li>#1354 xml comment not being stripped correctly in preprocessing
(milestone 1)</li>
<li>#1357 NPE when image is incorrectly referenced when publishing
to HTML (milestone 1)</li>
<li>#1358 Cannot cross reference definition list items (dlentry, dt,
dd) in PDF (milestone 1)</li>
<li>#1365 pdf duplicate see-also entries in Index (milestone 2)</li>
<li>#1369 prodinfo seems to lead to "(file) does not exist", where
file has spaces in name (milestone 2)</li>
<li>#1370 Links to files with spaces in name broken (milestone 2)</li>
<li>#1371 build_demo uses deprecated Ant property (milestone 2)</li>
<li>#1377 htmlhelp ampersand (&amp;amp;) entity in indexterm does
not convert (milestone 2)</li>
<li>#1378 dita.out.map.htmlhelp.hhk: target doesn't allow topic with
empty indexterm (milestone 2)</li>
<li>#1382 Merging uses system path separator when rewriting URIs (milestone
2)</li>
<li>#1393 shortdesc in map overrides topic shortdesc (milestone 5)</li>
<li>#1398 Genlist processes file multiple times (milestone 3)</li>
<li>#1402 Foreign and Unknown elements not ignored in PDF (milestone
4)</li>
<li>#1404 buildsample file in TocJS plug-in hard codes old demo path
(milestone 4)</li>
<li>#1237 abbreviated-form is not rendered as link to glossentry (milestone
4)</li>
<li>#1193 abbreviated-form not handled at all in PDF output (release
candidate)</li>
<li>#1409 Stylesheet imported multiple times in the hierarchy (reloaded)
(release candidate)</li>
<li>#1413 Mapref resolution cascades role (release candidate)</li>
<li>#1416 German translation update (release candidate)</li>
<li>#1197 Handling of @href on a &lt;glossarylist> (final release)</li>
<li>#1362 href attribute in appendices element breaks PDF conversion
(final release)</li>
<li>#1411 Files with ".orig" extension missing from distribution (final
release)</li>
<li>#1418 PDF2 transtype breaks when bookmap has parts (final release)</li>
<li>#1425 XHTML flagging included before imports (maintenance 1)</li>
<li>#1428 Topic level calculated incorrectly for appendices (maintenance 1)</li>
<li>#1427 Fix text overflow issue in lot/lof entries with long titles (maintenance 1)</li>
<li>#1430 PDF transformation: Problems with index in OT 1.7 (maintenance 1)</li>
<li>#1432 startcmd.sh broken in 1.7 (maintenance 1)</li>
<li>#1433 Profiling filter included multiple times (maintenance 1)</li>
<li>#1437 Fatal UTF-8 error in .job.xml (maintenance 2)</li>
<li>#1456 XHTML Build failed when referencing subject scheme in different file path (maintenance 3)</li>
<li>#1423 Formatting glitch in PDF index (maintenance 4)</li>
<li>#1468 Reference to remote image does not appear in PDF (maintenance 4)</li>
<li>#1469 @outputclass and @class values not passed from &lt;chhead> to &lt;tr> in XHTML output (maintenance 4)</li>
<li>#1472 PDF output: whitespace not preserved in msgblock element (maintenance 4)</li>
<li>#1475 Error received in console does not point correctly to location of published DITA Map (maintenance 4)</li>
<li>#1477 Tables: using percentage in colwidth values [PDF2 plugin] (maintenance 4)</li>
<li>#1484 Enable default revision markers using active xml:lang value (maintenance 5)</li>
<li>#1489 External keys are lost if using onlytopic.in.map (maintenance 5)</li>
<li>#1491 TopicMerge generates invalid xref/@href if it contains Ideographic character (maintenance 5)</li>
</ul> </section>
</refbody>
</reference>
</reference>

181
dita-ot-3.6/docsrc/release-notes/rel1.8.dita Normal file
View file

@ -0,0 +1,181 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
"reference.dtd">
<reference id="rel1.8" xml:lang="en">
<title>DITA Open Toolkit Release 1.8</title>
<!--reference id="releasehighlights" xml:lang="en-US">
<title>Release highlights</title>
<refbody>
<section/>
</refbody>
</reference-->
<reference id="general-enhancements-and-changes" xml:lang="en-US">
<title>General Enhancements and Changes</title>
<refbody>
<section>
<title>Preprocessing</title>
<p>Additional validation has been added to check e.g. element ID uniqueness, and <codeph>xml:lang</codeph> and URI syntax.</p>
</section>
<section>
<title>PDF</title>
<p>Bundled FOP has been updated from 1.0 to 1.1.</p>
</section>
</refbody>
</reference>
<reference id="reference_yvj_ttj_bd">
<title>Migration from previous releases</title>
<refbody>
<section>
<p>Stylesheets for the following transtypes have moved
to plug-in specific folders:</p>
<ul>
<li>eclipsehelp</li>
<li>htmlhelp</li>
<li>javahelp</li>
<li>odt</li>
<li>xhtml</li>
</ul>
</section>
<section>
<title>Preprocessing</title>
<p>The following deprecated Ant properties have been removed:</p>
<ul id="ul_rp5_hjs_53">
<li><codeph>dita.script.dir</codeph>, use <codeph>${dita.plugin.<varname>id</varname>.dir}</codeph>
instead</li>
<li><codeph>dita.resource.dir</codeph>, use <codeph>${dita.plugin.org.dita.base.dir}/resource</codeph> instead</li>
<li><codeph>dita.empty</codeph></li>
<li><codeph>args.message.file</codeph></li>
</ul>
</section>
<section>
<title>XHTML</title>
<p>XSLT Java extension <codeph>ImgUtils</codeph> has been removed from stylesheets and been replaced with preprocessing module <codeph>ImageMetadataModule</codeph>.
The old <codeph>ImgUtils</codeph> Java classes are still included in the build.</p>
</section>
<section>
<title>PDF</title>
<p>The following deprecated XSLT stylesheets have been removed:</p>
<ul id="ul_vmw_v3s_53">
<li><filepath>artwork-preprocessor.xsl</filepath></li>
<li><filepath>otdita2fo_frontend.xsl</filepath></li>
</ul>
<p>The following deprecated XSLT templates have been removed:</p>
<ul id="ul_bwz_r3s_53">
<li><codeph>insertVariable.old</codeph></li>
</ul>
<p>The following deprecated XSLT modes have been removed:</p>
<ul>
<li><codeph>layout-masters-processing</codeph></li>
<li><codeph>toc-prefix-text</codeph>, use <codeph>tocPrefix</codeph> mode instead</li>
<li><codeph>toc-topic-text</codeph>, use <codeph>tocText</codeph> mode instead</li>
</ul>
<p>Link generation has been simplified by removing deprecated arguments in favour of <codeph>args.rellinks</codeph>.
The following deprecated Ant properties have been removed:</p>
<ul>
<li><codeph>args.fo.include.rellinks</codeph></li>
</ul>
<p>The following XSLT parameters have been removed:</p>
<ul>
<li><codeph>antArgsIncludeRelatedLinks</codeph></li>
<li><codeph>disableRelatedLinks</codeph></li>
</ul>
<p>A call to a named template <codeph>pullPrologIndexTerms.end-range</codeph> has been added to <codeph>processTopic*</codeph> templates to handle topic wide index ranges.</p>
</section>
<section>
<title>Legacy PDF</title>
<p>The following deprecated XSLT stylesheets have been removed:</p>
<ul>
<li><filepath>dita2fo-shell_template.xsl</filepath></li>
<li><filepath>topic2fo-shell.xsl</filepath></li>
</ul>
</section>
<section>
<title>ODT</title>
<p>Link generation has been simplified by removing deprecated arguments in favour of <codeph>args.rellinks</codeph>.
The following deprecated Ant properties have been removed:</p>
<ul>
<li><codeph>args.odt.include.rellinks</codeph></li>
</ul>
<p>The following XSLT parameters have been added:</p>
<ul>
<li><codeph>include.rellinks</codeph></li>
</ul>
<p>The following XSLT parameters have been removed:</p>
<ul>
<li><codeph>disableRelatedLinks</codeph></li>
</ul>
</section>
</refbody>
</reference>
<reference id="rel1.8.issues">
<title>Issues</title>
<shortdesc>The following items are included in DITA Open Toolkit Release 1.8. Issue numbers
correspond to the tracking number in the <ph><xref keyref="dita-ot-issues" scope="external"
>GitHub issues tracker</xref></ph>.</shortdesc>
<refbody>
<section>
<title>Feature requests</title>
<ul>
<li>#1406 Bundle FOP 1.1 (milestone 1)</li>
<li>#1447 Move stylesheets and resource files to plug-in folder (milestone 1)</li>
<li>#1449 Add support for Slovenian (milestone 1)</li>
<li>#1453 Add image metadata filter (milestone 1)</li>
<li>#1435 Add validation filter to debug-filter step</li>
<li>#1455 Remove deprecated features</li>
<li>#1460 "Get String" template should use parameter instead of variable</li>
<li>#1461 Move file list generation to Ant</li>
<li>#1465 New doc topic listing non-standard tweaks to preprocessed files</li>
<li>#1480 Correcting values for the @relcolwidth attribute</li>
<li>#1492 Line range extension to coderef processing</li>
<li>#1494 Move integrator configuration to lib/configuration.properties</li>
<li>#1495 Remove ancient doc directories</li>
</ul>
</section>
<section>
<title>Bugs</title>
<ul>
<li>#1425 XHTML flagging included before imports (milestone 1)</li>
<li>#1428 Topic level calculated incorrectly for appendices (milestone 1)</li>
<li>#1427 Fix text overflow issue in lot/lof entries with long titles (milestone 1)</li>
<li>#1430 PDF transformation: Problems with index in OT 1.7 (milestone 1)</li>
<li>#1432 startcmd.sh broken in 1.7 (milestone 1)</li>
<li>#1433 Profiling filter included multiple times (milestone 1)</li>
<li>#1437 Fatal UTF-8 error in .job.xml (milestone 1)</li>
<li>#1456 XHTML Build failed when referencing subject scheme in different file path (milestone 1)</li>
<li>#1080 Index page range issues (milestone 2)</li>
<li>#1423 Formatting glitch in PDF index (milestone 2)</li>
<li>#1468 Reference to remote image does not appear in PDF (milestone 2)</li>
<li>#1469 @outputclass and @class values not passed from &lt;chhead> to &lt;tr> in XHTML output (milestone 2)</li>
<li>#1472 PDF output: whitespace not preserved in msgblock element (milestone 2)</li>
<li>#1475 Error received in console does not point correctly to location of published DITA Map (milestone 2)</li>
<li>#1477 Tables: using percentage in colwidth values [PDF2 plugin] (milestone 2)</li>
<li>#1464 Flagging a simpletable row throws off @keycol counting bug (milestone 2)</li>
<li>#1459 Link not created in the XHTML output for a xref/@keyref element</li>
<li>#1473 Troff output not working in latest build bug troff</li>
<li>#1498 White space will break tocjs</li>
<li>#1519 Latest code in develop branch fails to build PDF</li>
<li>#1528 PDF fails when topic referenced with and without topic ID (maintenance 1)</li>
<li>#1529 NPE when topichead has @copy-to and @chunk="to-content" (maintenance 1)</li>
<li>#1535 Specialized class cannot be handled during XML parsing (maintenance 1)</li>
<li>#1537 Whitespace issue when @conref is preceded by a linefeed in map &lt;title> (maintenance 1)</li>
<li>#1538 Incorrect handling of topics outside of map path (maintenance 1)</li>
<li>#1531 CSS link generated with backslash on Windows (maintenance 2)</li>
<li>#1532 Keyref link generated with backslash and %5C on Windows (maintenance 2)</li>
<li>#1540 Add missing @class attribute to &lt;navref> in chunking phase (maintenance 2)</li>
<li>#1547 startPageNumbering missing from some page sequence (maintenance 2)</li>
<li>#1073 Some elements are not handled correctly in troff transform (maintenance 3)</li>
<li>#1175 pdf2 plugin: PDF transform produces invalid FO doc with DITAVAL (flag on simpletable) (maintenance 3)</li>
<li>#1234 pdf2 plugin: Note image path broken for "other" note type (maintenance 3)</li>
<li>#1373 Cells of a Properties table misaligned in PDF output if Value column is missing (maintenance 3)</li>
<li>#1563 path2project generated PI is invalid in copy-to file (maintenance 3)</li>
<li>#1570 pdf2 plugin: 'Body first header' variable does not support 'prodname' parameter (maintenance 3)</li>
<li>#1571 pdf2 plugin: top level topic titles styled as normal text (maintenance 3)</li>
<li>#1581 pdf2 plugin: Change bars from DITAVAL crash FOP (maintenance 3)</li>
<li>#1584 Add basic table support to troff #1073 (maintenance 3)</li>
<li>#1585 Properties table cell misalligned if no value column #1373 (maintenance 3)</li>
<li>#1603 XSD schema for Machinery Task does not allow attributes in prelreqs element (maintenance 3)</li>
</ul>
</section>
</refbody>
</reference>
</reference>

591
dita-ot-3.6/docsrc/release-notes/rel2.0.dita Normal file
View file

@ -0,0 +1,591 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
<reference id="rel2.0" xml:lang="en">
<title>DITA Open Toolkit 2.0 Release Notes</title>
<reference id="releasehighlights">
<title>Release Highlights</title>
<refbody>
<section>
<p>DITA Open Toolkit Release 2.0 includes the following significant enhancements: <ul>
<li>New <cmdname>dita</cmdname> command line tool provides a simple command interface</li>
<li>XSLT stylesheets have been converted to XSLT 2.0</li>
<li>Processing order of keys and conrefs has been changed to optimize processing speed for many
documents</li>
<li>Initial preview support for many features from the upcoming DITA 1.3 standard</li>
<li>Major refactoring to remove unused, out of date, or deprecated code in Java and XSLT </li>
<li>Faster PDF output generation</li>
</ul>
</p>
<p>For details on these and all other enhancements, see the sections below.</p>
</section>
</refbody>
</reference>
<!--
<reference id="general-enhancements-and-changes">
<title>General Enhancements and Changes</title>
<refbody>
<section>
<draft-comment author="jelovirt">
<p>TODO:</p>
<ul>
<li>New command line tool</li>
<li>XSLT stylesheets have been converted to XSLT 2.0</li>
<li>Processing order of keys and conrefs has been changed</li>
<li>Initial preview support for DITA 1.3</li>
</ul>
</draft-comment>
</section>
</refbody>
</reference>
<reference id="migration">
<title>Migration From Previous Releases</title>
<refbody>
<section>
<draft-comment author="jelovirt">TODO</draft-comment>
</section>
</refbody>
</reference>
-->
<reference id="requirements">
<title>Requirements</title>
<refbody>
<section>
<draft-comment author="infotexture">Add info on new minimum Java version or any other requirements that have
changed since previous release.</draft-comment>
<p>DITA Open Toolkit Release 2.0 requires the Java Runtime Environment (JRE) or Java Development Kit (JDK),
version 7 or later.</p>
</section>
</refbody>
</reference>
<reference id="rel2.0.issues">
<title>Resolved Issues</title>
<shortdesc>The following items are included in DITA Open Toolkit Release 2.0. Issue numbers correspond to the
tracking number in the <ph><xref keyref="dita-ot-issues">GitHub issues
tracker</xref></ph>.</shortdesc>
<refbody>
<section>
<title>Initial Preview Support for DITA 1.3</title>
<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1649" format="html" scope="external">#1649</xref>
Support DITA 1.3 link syntax (milestone 2)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1636" format="html" scope="external">#1636</xref>
Support DITA 1.3 cascade attribute (milestone 2)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1635" format="html" scope="external">#1635</xref>
Implement DITA 1.3 profiling (milestone 2)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1651" format="html" scope="external">#1651</xref> Add
new DITA 1.3 highlighting elements (milestone 4)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1652" format="html" scope="external">#1652</xref> Add
DITA 1.3 markup and xml domain support (milestone 4)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1654" format="html" scope="external">#1654</xref> Add
DITA 1.3 div element (milestone 4)</li>
</ul>
</section>
<section>
<title>Feature Requests</title>
<ul>
<li>
<p>The filtering logic has been extended to catch cases which could cause PDF rendering to fail when
"exclude" actions in ditaval filtering result in empty elements. <ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1192" format="html" scope="external"
>#1192</xref> Empty &lt;ul>&lt;/ul> kills FOP (milestone 1)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1610" format="html" scope="external"
>#1610</xref> Filtered content leads to total fail of PDF rendering duplicate (milestone 1)</li>
</ul></p></li>
<li>
<p>The format of figure and table references in PDF output can now be defined using the same parameters that
govern HTML output.</p>
<p>The <parmname>args.figurelink.style</parmname> and <parmname>args.tablelink.style</parmname> Ant
parameters are now also considered when generating PDF output. The <option>NUMBER</option> and
<option>TITLE</option> options previously available for HTML-based output formats can now also be
applied to PDF output. By default PDF uses the new value <option>NUMTITLE</option> to include both the
number and title of the referenced figure or table as in previous toolkit versions. The
<option>NUMTITLE</option> value is not supported for other transform types. <ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1267" format="html" scope="external"
>#1267</xref> PDF support for figurelink/tablelink.style (milestone 1)</li>
</ul></p></li>
<li>
<p>The XSLT processing has been updated to use the XHTML output method for XHTML 1.0 and assign the
mandatory xhtml namespace to the the generated HTML root element:
<codeblock>&lt;html&#xA0;xmlns="http://www.w3.org/1999/xhtml"&gt;</codeblock></p>
<p>This ensures the XSL processor formats elements in the output with XHTML syntax (self-closing elements
include an additional space for browser compatibility). <ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1347" format="html" scope="external"
>#1347</xref> Issue with "xsl/dita2xhtml.xsl"? (milestone 1)</li>
</ul></p></li>
<li>
<draft-comment author="infotexture">TODO: Add extended description to Release Highlights</draft-comment>
<p>A new <cmdname>dita</cmdname> command line tool wraps Ant processing into a single command. The CLI sets
all required environment variables and allows you to run DITA-OT without setting up anything beforehand.
Instead of calling <cmdname>java</cmdname> or <cmdname>ant</cmdname>, you can now run
<codeblock><cmdname>dita</cmdname> -f <varname>format</varname> -i <varname>input</varname> <varname>[options]</varname></codeblock>
The command line tool is a wrapper around the Ant interface; it takes the simplified parameters as input,
converts them to Ant parameters, and then runs an Ant build. The command-line tool supports a subset of
the parameters that are available to the Ant builds. For example, use the <option>-f</option> option
instead of <option>-Dtranstype</option> to set the output format, and use <option>-i</option> insted of
<option>-Dargs.input</option> to set the input file.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1506" format="html" scope="external"
>#1506</xref> New command line tool (milestone 1)</li>
</ul></p></li>
<li>
<draft-comment author="infotexture">TODO: Add to Release Highlights / Migration sections</draft-comment>
<p>The XSLT stylesheets for preprocessing and transformation types have been converted to version 2.0 and
EXSLT extensions like node-set have been removed. If you have customized versions of these stylesheets in
your own plugins, you may need to adjust them for compatibility with XSLT 2.0.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1507" format="html" scope="external"
>#1507</xref> Convert XSLT to version 2.0 (milestone 1)</li>
</ul></p></li>
<li>
<p>Apache Ivy is now used to resolve project dependencies. A new <filepath>ivy.xml</filepath> file lists the
resources necessary to build the project. Ivy uses this list to resolve and download the necessary
resources from an artifact repository, so the corresponding libraries were removed from the Git
repository. (They are still included in the <filepath>/lib/</filepath> folder of the appropriate client
distribution packages.)<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1511" format="html" scope="external"
>#1511</xref> Use Ivy for dependency management (milestone 1)</li>
</ul></p></li>
<li>
<p>A new <option>html5</option> transformation type is now available to produce output compatible with the
<xref href="http://www.w3.org/TR/2014/REC-html5-20141028/" format="html" scope="external">HTML5</xref>
recommendation recently published by the W3C. This uses the <filepath>dita2html5</filepath> shell to
extend the existing <option>xhtml</option> transform for HTML5-compatible output. The resulting HTML files
use the <tt>!DOCTYPE html</tt> document type declaration instead of the XHTML 1.0 Transitional output
generated by the <option>xhtml</option> transformation. To support legacy browsers that don't recognize
the preferred short doctype, the SYSTEM keyword is included in the declaration with the
"about:legacy-compat" value. <ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1522" format="html" scope="external"
>#1522</xref> Add HTML5 transtype (milestone 1)</li>
</ul></p></li>
<li>
<p>The Ant scripts and stylesheets in the HTML and XHTML transformation types have been refactored to reduce
code duplication. <ph id="custom-files">If you have customized versions of these files in your own
plugins, you may need to adjust them for compatibility with DITA-OT 2.0</ph>.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1523" format="html" scope="external"
>#1523</xref> Reduce HTML/XHTML code duplication (milestone 1)</li>
</ul></p></li>
<li>
<p>The custom print filtering code has been replaced with a generated DITAVAL filter file that is applied to
all print-oriented transformation types. The <codeph>dita.transtype.print</codeph> plug-in extension point
introduced in DITA-OT 1.5.4 is used to declare a transtype as a print type. When output is generated via
plugins that include this property, the following DITAVAL filter is applied:<codeblock>&lt;val>
&lt;prop att="print" val="yes" action="include"/>
&lt;prop att="print" val="printonly" action="include"/>
&lt;prop att="print" val="no" action="exclude"/>
&lt;prop att="print" action="include"/>
&lt;/val></codeblock><ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1524" format="html" scope="external"
>#1524</xref> Use DITAVAL for print filtering (milestone 1)</li>
</ul></p></li>
<li>
<p>The <codeph>coderef</codeph> element now supports fragment identifiers as specified in <xref
keyref="rfc5147"/> along with the custom line-range fragment function previously added in DITA-OT
1.8.</p>
<p>You can use fragment identifiers to refer to specific parts of a file by line position or range. For
example, the following <codeph>coderef</codeph> includes a range of lines from an external file in a
<codeph>codeblock</codeph>.</p>
<p><codeblock>&lt;coderef href="Parser.scala#line=4,10" format="scala"/></codeblock>
<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1548" format="html" scope="external"
>#1548</xref> Support RFC 5147 in coderef (milestone 1)</li>
</ul></p></li>
<li>
<p>The list of chunked topics is now included in the full list of DITA topics, rather than generating a
separate list for topics that were created as a result of chunking. All chunk-generated content is now
treated as if it was part of the original input set. <ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1561" format="html" scope="external"
>#1561</xref> Combine chunkedtopic lists into fullditatopic list (milestone 1)</li>
</ul></p></li>
<li>
<p>An Index is now created when generating PDF output via Apache Formatting Objects Processor (FOP).<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1569" format="html" scope="external"
>#1569</xref> Index capability with FOP (milestone 1)</li>
</ul></p></li>
<li>
<p>Single-topic PDFs now include only the topic content, rather than generating a cover page and table of
contents as in previous versions of DITA-OT.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1601" format="html" scope="external"
>#1601</xref> Change output for rendering a single topic to PDF (milestone 1)</li>
</ul></p></li>
<li>
<p>Plugins can now be installed and removed via the new <cmdname>dita</cmdname> command line tool.</p>
<p><codeblock>$ dita -install &lt;plugin-zip-path>
$ dita -uninstall &lt;plugin-id></codeblock></p>
<p>Plugins provided as ZIP or JAR files are extracted to the <filepath>plugins</filepath> folder on
installation. A new plugin folder is created based on the plugin ID in the <filepath>plugin.xml</filepath>
file. If the <filepath>plugin.xml</filepath> is located in a subfolder inside the archive, that subfolder
is treated as the plugin folder. After the plugin is extracted, the integration process is run. The
uninstall operation removes the subfolder with the specified ID from the <filepath>plugins</filepath>
folder and runs the integration process to update the list of registered plugins. <ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1602" format="html" scope="external"
>#1602</xref> Add plug-in installation operation to integration (milestone 1)</li>
</ul></p></li>
<li>
<p>HTML output now wraps scalable vector graphics (SVG) images in an <codeph>img</codeph> element like all
other image types, rather than in an <codeph>embed</codeph> element. This ensures that SVG images in
cross-references are correctly rendered as hyperlinks in HTML-based output formats.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1608" format="html" scope="external"
>#1608</xref> img should be used instead of embed in XHTML output for all image types (milestone
1)</li>
</ul></p></li>
<li>
<p>The bundled distribution of Apache Ant has been updated from version 1.8.4 to 1.9.2. For details on the
changes in recent Ant versions, see <xref href="https://ant.apache.org/antnews.html" format="html"
scope="external">Ant Project News</xref>.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1612" format="html" scope="external"
>#1612</xref> Update Ant to 1.9.2 (milestone 1)</li>
</ul></p></li>
<li>
<p>PDF builds no longer require Apache FOP to be present in the <filepath>fop/lib</filepath> folder of the
PDF plugin. Previous versions of DITA-OT expected to find Apache FOP in the default location and issued an
error if the path was not present (even if FOP was available in an alternate location).<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1614" format="html" scope="external"
>#1614</xref> ant build should not bail out when fop directory has no lib folder (milestone 1)</li>
</ul></p></li>
<li>
<p>The deprecated legacy PDF transformation is no longer included in the default distribution packages.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1616" format="html" scope="external"
>#1616</xref> Remove legacy PDF from default distributions (milestone 1)</li>
</ul></p></li>
<li>
<p>The deprecated <filepath>integrator.properties</filepath> file has been removed. The integration-related
properties <option>plugindirs</option> and <option>plugin.ignores</option> are now specified along with
other configuration properties in the <filepath>lib/configuration.properties</filepath> file.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1509" format="html" scope="external"
>#1509</xref> Remove deprecated code (in progress)</li>
</ul></p></li>
<li>
<p>Additional HTML entities have been added to the <filepath>entities.properties</filepath> file that is
used in the HTMLHelp transformation to provide support for Greek characters and other commonly used
special characters in Windows help files (CHM).<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1644" format="html" scope="external"
>#1644</xref> Add more HTML entities to file entities.properties in dost.jar (milestone 2)</li>
</ul></p></li>
<li>
<p>The @location attributes in integration-generated Ant properties now use the forward slash character (/)
as directory separator to ensure that generated pathnames are compatible with both UNIX and Windows.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1643" format="html" scope="external"
>#1643</xref> Integrator task constructs property constructs with platform-dependent path separators
(milestone 2)</li>
</ul></p></li>
<li>
<p>The order of preprocessing stages has been optimized to move keyref processing before conref processing.
This provides significant performance gains for source that uses multiple key references within reusable content.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1631" format="html" scope="external"
>#1631</xref> Process keyrefs before conref (milestone 2)</li>
</ul></p></li>
<li>
<p>Removed support for the rarely used <parmname>generate.copy.outer</parmname>=<option>2</option> option
that generated output for content located outside the DITA map directory. If output must be generated for
content that is not located in or beneath the directory containing the DITA map file, option
<option>3</option> should be used instead to shift the output directory so that it contains all output
for the publication. <ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1673" format="html" scope="external"
>#1673</xref> Remove support for generate.copy.outer=2 (milestone 3)</li>
</ul></p></li>
<li>
<p>New templates and variables have been added to make it easier to include a back cover in PDF output. A
new <codeph>generate-back-cover</codeph> option is now provided in the
<filepath>basic-settings.xsl</filepath> file in the <filepath>cfg/fo/attrs/</filepath> folder of the PDF
plugin. This option is disabled by default. An empty XSL template named
<codeph>createBackCoverContents</codeph> has been added to <filepath>xsl/fo/front-matter.xsl</filepath>.
Custom PDF plugins can enable back cover generation and adjust the template to include images or text on
the last page of PDF files.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1671" format="html" scope="external"
>#1671</xref> Add support for generating back cover on PDF (milestone 3)</li>
</ul></p></li>
<li>
<p>The redundant code that supported legacy FrameMaker syntax for <codeph>indexterm</codeph> elements has
been removed. The same functionality is available with a preprocessing step.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1667" format="html" scope="external"
>#1667</xref> Remove FrameMaker index syntax support (milestone 3)</li>
</ul></p></li>
<li>
<p>When generating PDF output for bookmaps, the <codeph>notices</codeph> element in
<codeph>frontmatter</codeph> now uses the preface static contents template to ensure that page numbering
is consistent with the numbering scheme used for other <codeph>frontmatter</codeph> content.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1186" format="html" scope="external"
>#1186</xref> PDF2: update processTopicNotices staticcontents (milestone 4)</li>
</ul></p></li>
<li>
<p>Localization strings for all transformation types can now be configured in one place by specifying the
<parmname>variable.file.url</parmname> parameter.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1188" format="html" scope="external"
>#1188</xref> Localization should be independent of transtype. (milestone 4)</li>
</ul></p></li>
<li>
<p>An error message has been added to alert users if the root ditamap contains a <codeph>topicref</codeph>
element that refers to a submap without setting the format attribute to <option>ditamap</option>. In
<option>lax</option> processing mode, the debug filter will add the missing attribute for links to maps,
but it will not fix any existing incorrect format values.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1310" format="html" scope="external"
>#1310</xref> Improve error message during topicmerge step in case format attribute is incorrect
(milestone 4)</li>
</ul></p></li>
<li>
<p>The DTDs and XML Schemas included with the toolkit have been bundled as plugins to facilitate maintenance
and customization.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1508" format="html" scope="external"
>#1508</xref> Move DTDs and XML Schemas to plug-ins (milestone 4)</li>
</ul></p></li>
<li>
<p>PDF output is now generated faster as a result of performance optimizations in the XSLT stylesheets of
the PDF2 plugin.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1672" format="html" scope="external"
>#1672</xref> Performance optimizations for the PDF2 plugin (milestone 4)</li>
</ul></p></li>
<li>
<p>The default map processing for HTML now generates a cover page with a table of contents in an HTML5
<codeph>nav</codeph> element rather than generating a separate ToC file for use in a frameset.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1674" format="html" scope="external"
>#1674</xref> Change HTML default TOC to cover with TOC (milestone 4)</li>
</ul></p></li>
<li>
<p>Figure descriptions in HTML output now appear in the same paragraph as the figure title.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1695" format="html" scope="external"
>#1695</xref> In XHTML output the figure title and figure description should be in the same
paragraph (milestone 4)</li>
</ul></p></li>
<li>
<p>The interdependent maplink and move-links preprocessing steps have been merged into a single step.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1714" format="html" scope="external"
>#1714</xref> Merge maplink and move-links preprocessing steps (milestone 4)</li>
</ul></p></li>
<li>
<p>Topic references inside <codeph>glossarylist</codeph> elements are now supported in PDF output. They are
treated like regular nested topics.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1719" format="html" scope="external"
>#1719</xref> Restore glossarylist check introduced in #1659 (milestone 4)</li>
</ul></p></li>
<li>
<p>If the lines of program listing are too long to fit into one line, they can now be marked with the
&#x25BA; character (<codeph>&amp;#x25BA;</codeph>) to indicate that code continues on the next line. Lines
will be automatically wrapped at this character.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1735" format="html" scope="external"
>#1735</xref> Support marking wrapped lines in codeblock (milestone 4)</li>
</ul></p></li>
<li>
<p>Profiling attributes set on DITA content are now mapped to their equivalent HTML5 <codeph>data-</codeph>
attributes. This allows you to use Javascript or CSS rules to show/hide parts of the output based on user roles.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1739" format="html" scope="external"
>#1739</xref> Map profiling attributes set on DITA elements to equivalent HTML5 "data-" attributes
(milestone 4)</li>
</ul></p></li>
<li>
<p>A new <parmname>root-chunk-override</parmname> parameter has been added to support overrides to the root
map chunk value.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1742" format="html" scope="external"
>#1742</xref> Add override for map chunk (milestone 4)</li>
</ul></p></li>
<li>
<p>The Java code has been refactored to use URI and File objects instead of Strings to permit automatic
validation of values.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1544" format="html" scope="external"
>#1544</xref> Use URI and File instead of String (in progress)</li>
</ul></p></li>
</ul>
</section>
<section>
<title>Bugs</title>
<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1095" format="html" scope="external">#1095</xref>
Empty tags result in invalid HTML (milestone 1)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1239" format="html" scope="external">#1239</xref>
Essentially needs XercesImpl (milestone 1)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1247" format="html" scope="external">#1247</xref>
Enable specifying MathML file as image/@href (milestone 1)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1272" format="html" scope="external">#1272</xref>
chapter numbering confused when chapters and parts in bookmap (milestone 1)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1407" format="html" scope="external">#1407</xref>
"Ambiguous rule match" in PDF processing XSLT when &lt;imagemap> is used in topic (milestone 1)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1421" format="html" scope="external">#1421</xref>
Warnings when converting to PDF with XEP (milestone 1)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1462" format="html" scope="external">#1462</xref>
Support for &lt;table> rowheader in PDF output (milestone 1)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1486" format="html" scope="external">#1486</xref> PDF
transform does not apply @rowsep correctly (milestone 1)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1607" format="html" scope="external">#1607</xref>
Keyref not processed for pushed conrefs (milestone 1)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1620" format="html" scope="external">#1620</xref> ODT
plugin fails due to missing getMax() (milestone 2)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1619" format="html" scope="external">#1619</xref> Add
validation for attribute generalization (milestone 2)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1103" format="html" scope="external">#1103</xref>
DITA-OT doesn't rewrite lq/@href (milestone 2)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1668" format="html" scope="external">#1668</xref> Fix
table cell @id and @headers attributes #1596 (milestone 3)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1634" format="html" scope="external">#1634</xref> XML
Catalog which has a DOCTYPE declaration is not properly parsed by Integrator task (milestone 3)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1596" format="html" scope="external">#1596</xref> xref
to table cell of DITA simple table does not result in correct target in &lt;a> element (XHTML output)
(milestone 3)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1539" format="html" scope="external">#1539</xref>
TopicMerge generates multiple topic entries in the merged middle file. (milestone 3)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1231" format="html" scope="external">#1231</xref>
&lt;screen> and &lt;codebock> do not support all frame attributes (milestone 3)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1086" format="html" scope="external">#1086</xref>
metadata in ancestor map not inherited by topics in childmap (milestone 3)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1183" format="html" scope="external">#1183</xref>
PDF2: image/@placement='break' breaks keeps. (milestone 4)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1209" format="html" scope="external">#1209</xref>
border-after-width.conditionality mismatches border-bottom (milestone 4)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1344" format="html" scope="external">#1344</xref>
&lt;related-links> element breaks child links (milestone 4)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1488" format="html" scope="external">#1488</xref> Doc
gives wrong value for onlytopic.in.map, or code uses wrong value (milestone 4)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1678" format="html" scope="external">#1678</xref>
Potential memory leaks in DITA OT 1.8 (probably also 1.7) (milestone 4)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1679" format="html" scope="external">#1679</xref>
DITA-OT 2.0 M 3: maprefImpl.xsl: XPTY0004: A sequence of more than one item is not allowed as the first
argument of contains() (milestone 4)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1682" format="html" scope="external">#1682</xref>
DITA-OT 2.0 M 3: nested topicref elements cause false warnings on wrong topic type (DOTX019W) (milestone
4)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1684" format="html" scope="external">#1684</xref>
Internal links in conreffed topic are not properly re-written (milestone 4)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1693" format="html" scope="external">#1693</xref>
Preserve @class and @outputclass values for DITA Map topicrefs in XHTML output (milestone 4)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1700" format="html" scope="external">#1700</xref>
VERSION_PATTERN typo (milestone 4)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1701" format="html" scope="external">#1701</xref>
Frame attribute not supported for fig element (milestone 4)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1711" format="html" scope="external">#1711</xref> The
"path2project-uri" is not output in chunked topics [DITA OT 1.8] (milestone 4)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1712" format="html" scope="external">#1712</xref> PDF2
pipeline throws MalformedURLException (milestone 4)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1727" format="html" scope="external">#1727</xref> Obey
@scalefit attribute on an image (milestone 4)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1728" format="html" scope="external">#1728</xref>
Conref push into codeblock causes angle brackets in output (milestone 4)</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1732" format="html" scope="external">#1732</xref>
xrefs to &lt;preface> topics fail in PDF2 output in 1.8.4 (milestone 4)</li>
</ul>
</section>
<section>
<title>Maintenance Release 2.0.1</title>
<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1744" format="html" scope="external">#1744</xref>
copy-to attribute not processed correctly (error DOTX008E) in XHTML transtype on a topicref included in a
child map</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1790" format="html" scope="external">#1790</xref> FO:
Xref processing does not handle case of key with no remote resource or link text</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1806" format="html" scope="external">#1806</xref> IDs
are not preserved on &lt;bodydiv&gt; element</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1808" format="html" scope="external">#1808</xref>
DITA-OT 2.0: PDF bookmarks (TOC, index) not in language indicated in source files</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1810" format="html" scope="external">#1810</xref>
DITA-OT 2.0: typo in PDF-plugin, xsl/fo/toc.xsl ("boookmap")</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1811" format="html" scope="external">#1811</xref>
Filtering doesn't support @deliveryTarget</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1813" format="html" scope="external">#1813</xref>
Mappull step fails with nested concept</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1814" format="html" scope="external">#1814</xref> Task
with links and nested task fails in XHTML</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1815" format="html" scope="external">#1815</xref>
Convert String to double Error message when we try to generate pdf</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1826" format="html" scope="external">#1826</xref> OT
2.0: Map with subject scheme and non-below map fails</li>
</ul>
</section>
</refbody>
</reference>
<!--
<reference id="limitations">
<title>Limitations</title>
<refbody>
<section>
<draft-comment author="infotexture">Add info on any significant open issues, caveats or known limitations in DITA markup support.</draft-comment>
</section>
</refbody>
</reference>
-->
</reference>

387
dita-ot-3.6/docsrc/release-notes/rel2.1.dita Normal file
View file

@ -0,0 +1,387 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
<reference id="rel2.1" xml:lang="en">
<title>DITA Open Toolkit 2.1.2 Release Notes</title>
<shortdesc>DITA Open Toolkit 2.1.2 is a maintenance release that includes fixes for reported
issues.</shortdesc>
<!--
<reference id="releasehighlights">
<title>Release Highlights</title>
<refbody>
<section>
<p>DITA Open Toolkit Release 2.1 includes the following significant enhancements: <ul>
<li></li>
</ul>
</p>
<p>For details on these and all other enhancements, see the sections below.</p>
</section>
</refbody>
</reference>
-->
<!--
<reference id="migration">
<title>Migration From Previous Releases</title>
<refbody>
<section>
<draft-comment author="jelovirt">TODO</draft-comment>
</section>
</refbody>
</reference>
-->
<reference id="requirements">
<title>Requirements</title>
<refbody>
<section>
<draft-comment author="infotexture">Add info on new minimum Java version or any other requirements that have
changed since previous release.</draft-comment>
<p>DITA Open Toolkit Release 2.1 requires the Java Runtime Environment (JRE) or Java
Development Kit (JDK), version <keyword keyref="tool.java.version"/> or later.</p>
</section>
</refbody>
</reference>
<reference id="rel2.1.issues">
<title>Resolved issues</title>
<shortdesc>The following items are included in DITA Open Toolkit Release 2.1. Issue numbers
correspond to the tracking number in the <ph><xref keyref="dita-ot-issues">GitHub issues
tracker</xref></ph>.</shortdesc>
<refbody>
<!--
<section>
<title>Extended Preview Support for DITA 1.3</title>
<ul>
<li></li>
</ul>
</section>
-->
<section>
<title>Maintenance Release 2.1.2</title>
<p>DITA Open Toolkit Release 2.1.2 includes the following bug fixes:</p>
<ul>
<li>
<p>Index terms starting with “Ñ” are no longer dropped from Spanish PDF indexes. They are now handled with
the correct Spanish sort order and placed in a group between “N” and “O”, under the “Ñ” heading. <ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/2068" format="html" scope="external"
>#2068</xref> Add support for n-tilde in Spanish index </li>
</ul>
</p>
</li>
<li>
<p>References to external code samples are now resolved properly when <codeph>@coderef</codeph> attributes
target non-XML resources and the output directory is shifted by setting the
<parmname>generate.copy.outer</parmname> parameter to <option>3</option>. <ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/2044" format="html" scope="external"
>#2044</xref> Non-XML coderef fails on outer context </li>
</ul>
</p>
</li>
<li>
<p>Warnings for deprecated templates are now displayed with the correct message prefix:
<codeph>DOTX</codeph>. <ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/2043" format="html" scope="external"
>#2043</xref> Warning for deprecated templates fails </li>
</ul>
</p>
</li>
</ul>
</section>
<section>
<title>Maintenance Release 2.1.1</title>
<p>DITA Open Toolkit Release 2.1.1 includes the following bug fixes:</p>
<ul>
<li>
<p>Whitespace in <codeph>&lt;image></codeph> elements is now ignored in PDF output to prevent errors when
rendering XSL:FO. <ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1985" format="html" scope="external"
>#1985</xref> XEP&#xA0;error: Element 'fo:external-graphic' must be empty</li>
</ul>
</p>
</li>
<li>
<p>Any proportional table column widths expressed in the CALS table model as "*" are now normalized to the
equivalent "1*" value to prevent errors while generating XHTML output. <ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1978" format="html" scope="external"
>#1978</xref> colwidth="*" causes Fatal Error! Cannot convert string "" to a double </li>
</ul>
</p>
</li>
<li>
<p>In DITA Open Toolkit 2.0.1, the line ending characters in shell files were inadvertently changed to
Windows (CRLF) line endings. The correct UNIX (LF) line endings have now been restored.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1954" format="html" scope="external"
>#1954</xref> bin/ant throws errors when executed in Ubuntu shell </li>
</ul>
</p>
</li>
</ul>
</section>
<section>
<title>Feature requests and changes</title>
<p>DITA Open Toolkit Release 2.1 includes the following new features and changes:</p>
<ul>
<li>
<p>In PDF output, inline <codeph>&lt;codeph></codeph> elements in topic titles now inherit the font size
from the surrounding title text. <ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1874" format="html" scope="external">1874</xref>
Codephrase used in topic title has very small font </li>
</ul>
</p>
</li>
<li>
<p>Image metadata processing has been refactored to improve the processing speed by determining width and
height without reading the entire image into memory. <ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1883" format="html" scope="external">1883</xref>
Faster implementation for ImgUtils.getWidth/getHeight </li>
</ul>
</p>
</li>
<li>
<p> Obsolete CHM configuration files have been removed from the PDF2 plugin. <ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1897" format="html" scope="external">1897</xref>
DITA OT 2.1.dev chm properties folder in org.dita.pdf2 </li>
</ul>
</p>
</li>
<li>
<p>The code for the <option>troff</option> transformation has been refactored into two separate steps to
enable re-use in other plain-text—based transformation types. The first step generates an abstract syntax
tree with div/span syntax, and the second takes that intermediate format and creates troff output. Two new
extension points are available to override the processing performed in each step: <dl>
<dlentry>
<dt><codeph>dita.xsl.troff-ast</codeph></dt>
<dd>Overrides the intermediate block-and-phrase format generated as input to troff processing.</dd>
</dlentry>
<dlentry>
<dt><codeph>dita.xsl.troff</codeph></dt>
<dd>Overrides the XSL that converts block-and-phrase intermediate markup into troff. </dd>
</dlentry>
</dl>
<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1910" format="html" scope="external">1910</xref>
Refactor troff code to be usable for other text-like transform types </li>
</ul>
</p>
</li>
</ul>
<p>Milestone 1 included the following new features and changes:</p>
<ul>
<li>
<p>The <codeph>chapterBody</codeph> XSL template mode has been refactored to create additional HTML5 groups
in the generated HTML <codeph>&lt;body></codeph> element. </p>
<p>DITA topics are now mapped to the HTML5 <codeph>&lt;article></codeph> element, DITA
<codeph>&lt;section></codeph> to <codeph>&lt;section></codeph>, and DITA <codeph>&lt;fig></codeph> to
<codeph>&lt;figure></codeph>. </p>
<p>HTML5 <codeph>@aria-labelledby</codeph> accessibility attributes are also generated to associate each
article with its heading. This helps to improve the accessibility and interoperability of HTML output by
providing structural information to assistive technologies such as screen readers. <ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1179" format="html" scope="external">1179</xref>
Added HTML generation extension for body content</li>
</ul>
</p>
</li>
<li>
<p>Additional file formats referenced from <codeph>&lt;image></codeph> elements are now copied to output.
Any references that are not DITA, DITA map, or image, are now treated as resources and also copied, so you
no longer need extra <codeph>&lt;copy></codeph> operations in your project build scripts to include such
assets in output. <ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1687" format="html" scope="external">1687</xref>
More recognized default resource extensions in the plugins base</li>
</ul>
</p>
</li>
<li>
<p>DITA-OT now fails with a fatal error (DOTA013F) if a specified .ditaval filter file is not available.
This ensures that unexpected output is not generated if the filter file is missing or invalid. <ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1703" format="html" scope="external">1703</xref>
Link to missing DITAVAL file should show a relevant error code in the console</li>
</ul>
</p>
</li>
<li>
<p>The <parmname>generate-debug-attributes</parmname> and <parmname>processing-mode</parmname> configuration
options have been moved to runtime properties, so you can now pass these parameters at build time to
specify whether the <codeph>@xtrf</codeph> and <codeph>@xtrc</codeph> debugging attributes should be
generated, and how the DITA-OT handles errors and error recovery. For more information, see <xref
href="../parameters/parameters-base.dita#base">common parameters</xref>.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1799" format="html" scope="external">1799</xref>
Move configuration options to runtime properties</li>
</ul></p>
</li>
<li>
<p>The deprecated Java command line tool has been removed in favor of the <cmdname>dita</cmdname> command
introduced in DITA-OT 2.0. </p>
<p>If you previously generated output via a Java command sequence such as
<codeblock><cmdname>java</cmdname> -jar lib/dost.jar /i:<varname>input-file</varname> /transtype:<varname>transformation-type</varname> /<varname>parameter-name</varname>:<varname>value</varname></codeblock>
you should now use the following syntax instead: <codeblock><cmdname>dita</cmdname> -f <varname>transformation-type</varname> -i <varname>input-file</varname> -o <varname>output-dir</varname></codeblock>
<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1800" format="html" scope="external">1800</xref>
Remove old Java command line tool </li>
</ul>
</p>
</li>
<li>
<p>The custom <codeph>FileUtils</codeph> code used to handle input and output in earlier versions of DITA-OT
has been replaced with the <xref href="http://commons.apache.org/proper/commons-io/" format="html"
scope="external">Apache Commons IO</xref> utilities library.<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1803" format="html" scope="external">1803</xref>
Use Commons IO</li>
</ul>
</p>
</li>
<li>
<p>Support for the <parmname>args.odt.img.embed</parmname> parameter has been removed from OpenDocument
format transformations.</p>
<p>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. <ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1832" format="html" scope="external">1832</xref>
Remove support for args.odt.img.embed</li>
</ul>
</p>
</li>
<li>
<p>Keydef processing has been removed from the XHTML rendering code </p>
<p>Keys are now resolved in one preprocessing step, whereas in earlier versions of DITA-OT, the XHTML code
returned to the <filepath>keydef.xml</filepath> file to look up targets for phrase elements and pull in
text when needed. This change affects non-linking elements that can't take <codeph>@href</codeph>
attributes, such as <codeph>&lt;ph></codeph>, <codeph>&lt;keyword></codeph>, <codeph>&lt;cite></codeph>,
<codeph>&lt;dt></codeph>, <codeph>&lt;term></codeph>, and <codeph>&lt;indexterm></codeph> (when
<codeph>$INDEXSHOW</codeph> is active). <ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1837" format="html" scope="external">1837</xref>
Remove keydef processing from XHTML rendering code </li>
</ul>
</p>
</li>
<li>
<p>A new <codeph>dita.parser</codeph> extension point has been added to allow plug-ins to contribute a
custom parser for DITA files. </p>
<p>If a custom DITA parser is defined, the preprocessing routines will use it during the gen-list and
debug-filter stages to output DITA XML. <ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1847" format="html" scope="external">1847</xref>
Extension-point for custom DITA parsers </li>
</ul>
</p>
</li>
</ul>
</section>
<section>
<title>Bugs</title>
<p>DITA Open Toolkit Release 2.1 provides fixes for the following bugs:</p>
<ul>
<li><xref href="https://github.com/dita-ot/dita-ot/issues/1513" format="html" scope="external">1513</xref>
Suspected memory leak in OT bug preprocess</li>
<li><xref href="https://github.com/dita-ot/dita-ot/issues/1694" format="html" scope="external">1694</xref>
Cannot convert string to double</li>
<li><xref href="https://github.com/dita-ot/dita-ot/issues/1854" format="html" scope="external">1854</xref>
integrator.xml should also load the necessary "commons-io.jar" </li>
<li><xref href="https://github.com/dita-ot/dita-ot/issues/1870" format="html" scope="external">1870</xref>
PDF2 output plugin fails rendering tables </li>
<li><xref href="https://github.com/dita-ot/dita-ot/issues/1872" format="html" scope="external">1872</xref>
Link to index term repeats itself </li>
<li><xref href="https://github.com/dita-ot/dita-ot/issues/1877" format="html" scope="external">1877</xref>
Searchtitle Incorrectly Used for HTML Title </li>
<li><xref href="https://github.com/dita-ot/dita-ot/issues/1888" format="html" scope="external">1888</xref>
build.xml help target documentation is incorrect ant interface </li>
<li><xref href="https://github.com/dita-ot/dita-ot/issues/1889" format="html" scope="external">1889</xref>
@class missing from choicetable XHTML output </li>
<li><xref href="https://github.com/dita-ot/dita-ot/issues/1890" format="html" scope="external">1890</xref>
properties table XHTML output </li>
<li><xref href="https://github.com/dita-ot/dita-ot/issues/1894" format="html" scope="external">1894</xref> Fix
unitless length-to-pixels </li>
<li><xref href="https://github.com/dita-ot/dita-ot/issues/1921" format="html" scope="external">1921</xref>
Error reported during flagging </li>
<li><xref href="https://github.com/dita-ot/dita-ot/issues/1922" format="html" scope="external">1922</xref>
Index continued markers don't work if both primary and its secondary entries continue </li>
<li><xref href="https://github.com/dita-ot/dita-ot/issues/1927" format="html" scope="external">1927</xref> In
the key() function, the node supplied in the third argument (or the context node if absent) must be in a
tree whose root is a document node </li>
<li><xref href="https://github.com/dita-ot/dita-ot/issues/1932" format="html" scope="external">1932</xref>
when running ./dita, console shows "No such file or directory" when directory contains spaces</li>
</ul>
<p>Milestone 1 provided fixes for the following bugs:</p>
<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1415" format="html" scope="external">1415</xref>
Filtering doesn't support default for rev flagging</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1840" format="html" scope="external">1840</xref>
Keyref processing doesn't use only first keyword or term</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1849" format="html" scope="external">1849</xref> Some
XSLT XPaths do not properly use the @class attribute to select elems</li>
</ul>
</section>
<section>
<title>Maintenance Release 2.0.1</title>
<note>DITA Open Toolkit Release 2.1 also included the following bug fixes that were
released earlier this year with maintenance version 2.0.1.</note>
<ul>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1744" format="html" scope="external">#1744</xref>
copy-to attribute not processed correctly (error DOTX008E) in XHTML transtype on a topicref included in a
child map</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1790" format="html" scope="external">#1790</xref> FO:
Xref processing does not handle case of key with no remote resource or link text</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1806" format="html" scope="external">#1806</xref> IDs
are not preserved on &lt;bodydiv&gt; element</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1808" format="html" scope="external">#1808</xref>
DITA-OT 2.0: PDF bookmarks (TOC, index) not in language indicated in source files</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1810" format="html" scope="external">#1810</xref>
DITA-OT 2.0: typo in PDF-plugin, xsl/fo/toc.xsl ("boookmap")</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1811" format="html" scope="external">#1811</xref>
Filtering doesn't support @deliveryTarget</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1813" format="html" scope="external">#1813</xref>
Mappull step fails with nested concept</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1814" format="html" scope="external">#1814</xref> Task
with links and nested task fails in XHTML</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1815" format="html" scope="external">#1815</xref>
Convert String to double Error message when we try to generate pdf</li>
<li>
<xref href="https://github.com/dita-ot/dita-ot/issues/1826" format="html" scope="external">#1826</xref> OT
2.0: Map with subject scheme and non-below map fails</li>
</ul>
</section>
</refbody>
</reference>
<!--
<reference id="limitations">
<title>Limitations</title>
<refbody>
<section>
<draft-comment author="infotexture">Add info on any significant open issues, caveats or known limitations in DITA markup support.</draft-comment>
</section>
</refbody>
</reference>
-->
</reference>

761
dita-ot-3.6/docsrc/release-notes/rel2.2.dita Normal file
View file

@ -0,0 +1,761 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
<reference id="ID" rev="2.2">
<title>DITA Open Toolkit 2.2.5 Release Notes</title>
<abstract>
<shortdesc>DITA Open Toolkit 2.2.5 is a maintenance release that fixes issues
reported in DITA-OT 2.2, which includes new features and enhancements and additional
support for the OASIS DITA 1.3 specification.</shortdesc>
<p>Issue numbers correspond to the tracking number in the <ph>
<xref keyref="dita-ot-issues">GitHub issues tracker</xref></ph>.</p>
</abstract>
<reference id="v225">
<title>Maintenance Release 2.2.5</title>
<refbody>
<section>
<p>DITA Open Toolkit Release 2.2.5 includes the following bug fixes.</p>
<ul>
<li id="1190">In earlier toolkit versions, the Word RTF transformation produced invalid RTF output when source
files contained tables with absolute column widths. Processing has been modified to treat all widths as
proportional, including units given in inches, centimeters, millimeters, or points. Absolute units are not
respected, but the toolkit now generates valid RTF output rather than crashing.
<xref href="https://github.com/dita-ot/dita-ot/issues/1190" scope="external" format="html">#1190</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2333" scope="external" format="html">#2333</xref>
</li>
<li id="1549">References to empty ditamap files threw the <msgnum>DOTX031E</msgnum> error message during the
mapref processing stage. The toolkit no longer checks for subelements in the map and will now continue
processing as long as a root node is available.
<xref href="https://github.com/dita-ot/dita-ot/issues/1549" scope="external" format="html">#1549</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2336" scope="external" format="html">#2336</xref>
</li>
<li id="1709">Several error messages generated during index processing for PDF output have been clarified to
better explain the cause of the error and provide more helpful information on how to resolve the issue.
<xref href="https://github.com/dita-ot/dita-ot/issues/1709" scope="external" format="html">#1709</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2327" scope="external" format="html">#2327</xref>
</li>
<li id="1764">Links to <xmlelement>dlentry</xmlelement> elements were broken in PDFs generated via Apache FOP,
as FOP does not support the <xmlatt>id</xmlatt> attribute on table rows. To work around this issue, DITA-OT
now moves the ID from the <xmlelement>dlentry</xmlelement> to an <xmlelement>fo:inline</xmlelement> element
in the first term when rendering PDF output via FOP.
<xref href="https://github.com/dita-ot/dita-ot/issues/1764" scope="external" format="html">#1764</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2198" scope="external" format="html">#2198</xref>
</li>
<li id="1876">The DITA-OT 2.0 HTML5 transformation declared several XSL extension points that were not fully
implemented:
<ul>
<li><codeph>dita.xsl.html5</codeph></li>
<li><codeph>dita.xsl.html5.toc</codeph></li>
<li><codeph>dita.xsl.html5.cover</codeph></li>
</ul> Three new templates now provide the necessary <xmlelement>dita:extension</xmlelement> elements to add
custom XSLT processing to the HTML5 transformation.
<xref href="https://github.com/dita-ot/dita-ot/issues/1876" scope="external" format="html">#1876</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2313" scope="external" format="html">#2313</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2342" scope="external" format="html">#2342</xref>
</li>
<li id="2266">The OASIS catalogs for DITA 1.3 pointed to a series of non-existent resources. The catalog files
have been updated to remove spurious file references and errata have been submitted to OASIS for inclusion
in the original source catalogs.
<xref href="https://github.com/dita-ot/dita-ot/issues/2266" scope="external" format="html">#2266</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2320" scope="external" format="html">#2320</xref>
</li>
<li id="2307">Performance of previous toolkit versions suffered substantially if a single warehouse topic was
used to store a large number of blocks for reference instead of multiple smaller warehouse topics with the
same total number of blocks. An expensive XPath expression in the content reference processing phase was
replaced with an optimized expression that dramatically reduces publication time in cases with thousands of
following siblings.
<xref href="https://github.com/dita-ot/dita-ot/issues/2307" scope="external" format="html">#2307</xref>,
<!--<xref href="https://github.com/dita-ot/dita-ot/issues/2308" scope="external" format="html">#2308</xref>, -->
<xref href="https://github.com/dita-ot/dita-ot/issues/2309" scope="external" format="html">#2309</xref>
</li>
<li id="2311">In JavaHelp output, the copy-css task was called too early, before the
<parmname>user.csspath</parmname> parameter was evaluated, so CSS files were copied to a folder named
<codeph>${user.csspath}</codeph> rather than to the intended location. JavaHelp processing has been
corrected to avoid the duplicate dependency on the copy-css task and ensure that CSS files are handled
correctly.
<xref href="https://github.com/dita-ot/dita-ot/issues/2311" scope="external" format="html">#2311</xref>
</li>
<li id="2312">Two unimplemented parameter extension points were removed from the HTML5 plug-in:
<ul>
<li><codeph>dita.conductor.html5.param</codeph></li>
<li><codeph>dita.conductor.html5.toc.param</codeph></li>
</ul> Implementers who want to add parameters to the HTML5 transformation can instead require the base HTML
plug-in as well as the HTML5 plug-in and extend the base HTML plug-in's parameter extension points
<xref href="https://github.com/dita-ot/dita-ot/issues/2312" scope="external" format="html">#2312</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2314" scope="external" format="html">#2314</xref>
</li>
<li id="2315">Content reference range processing has been modified to use before <codeph>&lt;&lt;</codeph> and
after <codeph>&gt;&gt;</codeph> expressions rather than following-sibling and check that the conref end
target actually exists.
<xref href="https://github.com/dita-ot/dita-ot/issues/2315" scope="external" format="html">#2315</xref>
</li>
<li id="2321">When a <xmlelement>topicsetref</xmlelement> element is used to refer to a
<xmlelement>topicset</xmlelement>, previous toolkit versions threw <msgnum>DOTX019W</msgnum> errors,
suggesting that every reference in the original <xmlelement>topicset</xmlelement> also specified
<xmlatt>type</xmlatt><codeph>="topicset"</codeph>. Map reference processing has been modified to drop the
<xmlatt>type</xmlatt> attribute as part of the resolution. This prevents such unintended side effects by
ensuring that the type no longer cascades further down the resolved branch.
<xref href="https://github.com/dita-ot/dita-ot/issues/2321" scope="external" format="html">#2321</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2338" scope="external" format="html">#2338</xref>
</li>
<li id="2329">Support for flagging in HTML output has been imported (rather than included) and moved before
the extension point to allow custom plug-ins to override flagging behavior.
<!--<xref href="https://github.com/dita-ot/dita-ot/issues/2325" scope="external" format="html">#2325</xref>, -->
<!--<xref href="https://github.com/dita-ot/dita-ot/issues/2328" scope="external" format="html">#2328</xref>, -->
<xref href="https://github.com/dita-ot/dita-ot/issues/2329" scope="external" format="html">#2329</xref>
</li>
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/2.2.4...2.2.5" scope="external" format="html">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v224">
<title>Maintenance Release 2.2.4</title>
<refbody>
<section>
<p>DITA Open Toolkit Release 2.2.4 included the following bug fixes.</p>
<ul>
<li id="2283">The <xmlelement>title</xmlelement> is now used as link text when links are specified using a
<xmlelement>title</xmlelement> element (or specialized variant) as link target. This approach allows the
toolkit to be more lenient when authors link to a <xmlelement>glossterm</xmlelement> rather than to the
parent <xmlelement>glossentry</xmlelement> element, or to figure or table titles instead of the
<xmlelement>fig</xmlelement> or <xmlelement>table</xmlelement> element structure
<xref href="http://docs.oasis-open.org/dita/dita/v1.3/os/part1-base/langRef/base/xref.html#xref"
format="html" scope="external">recommended</xref> by the
<xref keyref="dita-ot-spec"/>.
<xref href="https://github.com/dita-ot/dita-ot/issues/2283" scope="external" format="html">#2283</xref>
</li>
<li id="2278">The default value for the <parmname>args.copycss</parmname> parameter has been explicitly set to
<option>no</option>. Previous toolkit versions never initialized a default value, and only copied the
custom .css file if the parameter was set to <option>yes</option>.
<xref href="https://github.com/dita-ot/dita-ot/issues/2278" scope="external" format="html">#2278</xref>
</li>
<li id="2274">Hyperlink reference processing has been modified to guard against error conditions caused by
Windows-style path separators in <xmlatt>href</xmlatt> attribute values. Any backslashes are converted to
forward slash (“/”) characters to ensure that the attribute values are valid URI references according to
<xref keyref="rfc3986"/>.
<xref href="https://github.com/dita-ot/dita-ot/issues/2274" scope="external" format="html">#2274</xref>
</li>
<li id="2270">A typo was fixed in the common string logic for the PDF plug-in to retrieve the proper localized
string for the task “Results” label that appears when <parmname>args.gen.task.lbl</parmname> is set to
<option>YES</option>.
<xref href="https://github.com/dita-ot/dita-ot/issues/2270" scope="external" format="html">#2270</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2216" scope="external" format="html">#2216</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2203" scope="external" format="html">#2203</xref>
</li>
<li id="2264">DITA-OT 2.2 introduced a regression in which topics referenced via keys in submaps were not
included in the table of contents. The keyref resolution mechanism has been corrected to ensure that key
references in submaps are correctly resolved.
<xref href="https://github.com/dita-ot/dita-ot/issues/2264" scope="external" format="html">#2264</xref>
</li>
<li id="1293">A new <msgnum>DOTJ068E</msgnum> error message was added to report cases when a conref "mark"
action is used to mark a target element without a corresponding content reference target (for example, when
the order of the "mark" element and the pushed element is reversed).
<xref href="https://github.com/dita-ot/dita-ot/issues/1293" scope="external" format="html">#1293</xref>
</li>
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/2.2.3...2.2.4" scope="external" format="html">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v223">
<title>Maintenance Release 2.2.3</title>
<refbody>
<section>
<p>DITA Open Toolkit Release 2.2.3 included the following bug fixes.</p>
<ul>
<li id="2246">Specifying the source of a long quote with a <xmlatt>keyref</xmlatt> attribute on a
<xmlelement>longquoteref</xmlelement> element caused a Null Pointer Exception. The keyref parser has been
modified to ensure that key references on long quote references are correctly resolved.
<xref href="https://github.com/dita-ot/dita-ot/issues/2246" scope="external" format="html">#2246</xref>
</li>
<li id="2240">The keyscope cascading mechanisms for branch filtering have been modified to comply with the
<xref keyref="dita-ot-spec"/>. In cases where no <xmlatt>keyscope</xmlatt> attribute is specified on a
filtered branch, the prefix and/or suffix values specified in <xmlelement>dvrKeyscopePrefix</xmlelement> /
<xmlelement>dvrKeyscopeSuffix</xmlelement> are now used as the effective key scope names. Key scope
prefixes and suffixes are no longer propagated to descendant key scopes, but only applied to the branch
parent.
<xref href="https://github.com/dita-ot/dita-ot/issues/2240" scope="external" format="html">#2240</xref>
</li>
<li id="2236">PDF: In DITA-OT 2.2.2, if a <xmlelement>link</xmlelement> element contained both
<xmlelement>linktext</xmlelement> and a description in the <xmlelement>desc</xmlelement> element, the
hyperlink was rendered with the contents of the <xmlelement>desc</xmlelement> element appended to the
contents of the <xmlelement>linktext</xmlelement> element. Link processing has been modified to ensure that
<xmlelement>link</xmlelement> elements with descriptions are rendered correctly.
<xref href="https://github.com/dita-ot/dita-ot/issues/2236" scope="external" format="html">#2236</xref>
</li>
<li id="2214">PDF: Index term processing has been revised to ensure that indexes in PDF output generated with
Apache FOP correctly include page ranges when <xmlatt>start</xmlatt> and <xmlatt>end</xmlatt> attributes are
defined on <xmlelement>indexterm</xmlelement> elements and the terms of the index range appear on different
pages. A single page reference is generated in cases where both occurrences of the index term appear on the
same page.
<xref href="https://github.com/dita-ot/dita-ot/issues/2214" scope="external" format="html">#2214</xref>
</li>
<li id="2211">ODT: The OpenDocument Text transformation has been revised to support SVG images for which image
dimensions are not specified via <xmlatt>height</xmlatt> and <xmlatt>width</xmlatt> attributes.
<xref href="https://github.com/dita-ot/dita-ot/issues/2211" scope="external" format="html">#2211</xref>
</li>
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/2.2.2...2.2.3" scope="external" format="html">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v222">
<title>Maintenance Release 2.2.2</title>
<refbody>
<section>
<p>DITA Open Toolkit Release 2.2.2 included the following bug fixes.</p>
<ul>
<li id="2023">PDF: In earlier DITA-OT 2.x releases, short description content was not rendered when publishing
from a bookmap with the <parmname>args.chapter.layout</parmname> parameter set to <option>BASIC</option>.
Short descriptions are now rendered properly.
<xref href="https://github.com/dita-ot/dita-ot/issues/2023" scope="external" format="html">#2023</xref>
</li>
<li id="2172"><i>Windows:</i> The name of the JAR file for Apache Ant has been corrected to fix the
<codeph>ANT_HOME is set incorrectly or ant could not be located</codeph> error that appeared when running
the bundled Ant version on Windows in DITA-OT 2.2.
<xref href="https://github.com/dita-ot/dita-ot/issues/2172" scope="external" format="html">#2172</xref>
</li>
<li id="2180">The order in which plug-ins are integrated has been revised to guarantee that the base DITA-OT
plug-ins always come first. This ensures that base target code cannot be overridden.
<xref href="https://github.com/dita-ot/dita-ot/issues/2180" scope="external" format="html">#2180</xref>
</li>
<!--
<li id="2181">Two unimplemented extension point declarations were removed from the html5 plug-in pending
implementation in a future DITA-OT version (
<xref href="https://github.com/dita-ot/dita-ot/issues/2181" scope="external" format="html">#2181</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2184" scope="external" format="html">#2184</xref>):
<ul>
<li><codeph>dita.conductor.html5.param</codeph></li>
<li><codeph>dita.conductor.html5.toc.param</codeph></li>
</ul>
</li>
-->
<li id="2192">Content references with relative paths were not properly resolved to the target document in some
cases. The conref base URI resolution mechanism was fixed to ensure that relative references are now
resolved correctly.
<xref href="https://github.com/dita-ot/dita-ot/issues/2192" scope="external" format="html">#2192</xref>
</li>
<li>The documentation has been updated with links to the final
<xref keyref="dita-ot-spec"/>.</li>
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/2.2.1...2.2.2" scope="external" format="html">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v221">
<title>Maintenance Release 2.2.1</title>
<refbody>
<section>
<p>DITA Open Toolkit Release 2.2.1 included the following bug fixes.</p>
<ul>
<li id="2170">PDF: Several templates in the <filepath>pr-domain.xsl</filepath> file used
<codeph>value-of</codeph> rather than <codeph>apply-templates</codeph> to output the element contents.
This prevented flagging from working as intended in PDF output. This has been corrected to ensure that
elements in the programming domain are properly flagged.
<xref href="https://github.com/dita-ot/dita-ot/issues/2170" scope="external" format="html">#2170</xref>
</li>
<li id="2163">The name of the JAR file for the Apache Commons library that provides reusable Java components
has been corrected in the integrator Ant script to fix the <codeph>NoClassDefFoundError</codeph> error that
appeared when the integrator ran in DITA-OT 2.2.
<xref href="https://github.com/dita-ot/dita-ot/issues/2163" scope="external" format="html">#2163</xref>
</li>
<li id="2154">PDF title metadata is now generated correctly for DITA maps that set the
<xmlatt>xml:lang</xmlatt> attribute. In certain cases, previous versions of DITA-OT displayed the
<codeph>XMP structure: 1</codeph> label in the Document Properties dialog instead of the map title.
<xref href="https://github.com/dita-ot/dita-ot/issues/2154" scope="external" format="html">#2154</xref>
</li>
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/2.2...2.2.1" scope="external" format="html">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="requirements">
<title>Requirements</title>
<refbody>
<section>
<draft-comment author="infotexture">Add info on new minimum Java version or any other requirements that have
changed since previous release.</draft-comment>
<p>DITA Open Toolkit Release 2.2 requires the Java Runtime Environment (JRE) version
<keyword keyref="tool.java.version"/> or later.</p>
</section>
</refbody>
</reference>
<reference id="highlights">
<title>Release Highlights</title>
<refbody>
<section>
<title>DITA 1.3 support</title>
<p><ph conref="../reference/DITA_v1-3-support.dita#dita-13-spec-support/shortdesc-ph"/></p>
<p conref="../reference/DITA_v1-3-support.dita#dita-13-spec-support/p"/>
<p>DITA Open Toolkit Release 2.2 extends DITA 1.3 support with the following
enhancements: <note id="2094" conref="../reference/DITA_v1-3-support.dita#dita-13-spec-support/2094"/>
<ul>
<li id="1969">Initial implementation of DITA 1.3 branch filtering
<xref href="https://github.com/dita-ot/dita-ot/pull/1969" scope="external" format="html">#1969</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/1637" scope="external" format="html">#1637</xref>
</li>
<li id="1979" conref="../reference/DITA_v1-3-support.dita#dita-13-spec-support/1979"/>
<li id="1783" conref="../reference/DITA_v1-3-support.dita#dita-13-spec-support/1783"/>
<li id="1968" conref="../reference/DITA_v1-3-support.dita#dita-13-spec-support/1968"/>
</ul>
</p>
<!--<p>For details on these and all other enhancements, see the sections below.</p>-->
</section>
<section>
<title>New HTML5 output</title>
<ul>
<li id="2099">The <option>HTML5</option> transformation has been moved to a separate plug-in to facilitate
customization of modern HTML5-based output. The default CSS has been refactored in
<xref keyref="sass-lang"/> as a foundation for further extensions with CSS frameworks, custom plug-ins and
future toolkit versions. (The original XHTML plug-in remains available to support existing legacy HTML-based
output formats such as TocJS, HTML Help and JavaHelp.)
<xref href="https://github.com/dita-ot/dita-ot/pull/2099" scope="external" format="html">#2099</xref>
</li>
<li id="2103">The <option>HTML5</option> transformation has been extended with a new
<parmname>nav-toc</parmname> parameter that can be used to generate a table of contents in the HTML5
<xmlelement>nav</xmlelement> element of each page. The navigation can then be rendered in a sidebar or
menu via CSS. This parameter is disabled by default (<option>none</option>), but can be enabled by setting
the value to <option>partial</option> (which includes the current topic in the ToC along with its parents,
siblings and children), or <option>full</option> (which generates a ToC for the entire map).
<xref href="https://github.com/dita-ot/dita-ot/pull/2103" scope="external" format="html">#2103</xref>
</li>
</ul>
</section>
<section>
<title>PDF supports new languages</title>
<p>The <option>PDF</option> transformation has been extended to support additional languages with localized
strings files and index collation.
<xref href="https://github.com/dita-ot/dita-ot/pull/2085" scope="external" format="html">#2085</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2089" scope="external" format="html">#2089</xref>
<ul>
<li>Arabic</li>
<li>Catalan</li>
<li>Croatian</li>
<li>Czech</li>
<li>Danish</li>
<li>Hungarian</li>
<li>Icelandic</li>
<li>Latvian</li>
<li>Norwegian</li>
<li>Polish</li>
<li>Portuguese</li>
<li>Portuguese (Brazil)</li>
<li>Slovak</li>
<li>Turkish</li>
</ul>
</p>
</section>
</refbody>
<related-links>
<link keyref="dita-ot-spec"/>
<link href="../reference/DITA_v1-3-support.dita"/>
</related-links>
</reference>
<reference id="issues">
<title>Resolved issues</title>
<shortdesc>In addition to the highlights mentioned above, DITA Open Toolkit Release 2.2
includes the following changes.</shortdesc>
<refbody>
<section id="features">
<title>Features</title>
<p>DITA Open Toolkit Release 2.2 includes the following new features:</p>
<ul>
<!--<li id="2094">Add DITA 1.3 schemas
<xref href="https://github.com/dita-ot/dita-ot/issues/2094" scope="external" format="html">#2094</xref>
</li>-->
<li id="2072">The <parmname>args.artlbl</parmname> parameter previously provided in HTML-based transformations
to show the source file name along with referenced images has been added to the PDF transformation. For
inline images, the label appears immediately after the image; for standalone images, it appears on a line
following the image.
<xref href="https://github.com/dita-ot/dita-ot/pull/2072" scope="external" format="html">#2072</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2062" scope="external" format="html">#2062</xref>
</li>
<li id="2071">In PDF output, any index entries that begin with special characters are now moved to a dedicated
section of the index. (Previous toolkit versions issued a warning and dropped any unexpected index terms.)
<xref href="https://github.com/dita-ot/dita-ot/pull/2073" scope="external" format="html">#2073</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2071" scope="external" format="html">#2071</xref>
</li>
<li id="2018">The plug-in configuration file <filepath>resources/plugins.xml</filepath> generated by the
integration process now adds the <xmlatt>xml:base</xmlatt> attribute to each plug-in configuration element
so that file paths in the plug-in configuration can be resolved relative to the plug-in folder. This makes
it easier to share a DITA-OT distribution with others via a version control system or bundle it with an
application without re-running the integration process in each installation location.
<xref href="https://github.com/dita-ot/dita-ot/issues/2018" scope="external" format="html">#2018</xref>
</li>
<!--<li id="2004">Support multiple scope names in a single keyscope attribute
<xref href="https://github.com/dita-ot/dita-ot/issues/2004" scope="external" format="html">#2004</xref>
</li>-->
<li id="1995">The <codeph>move-meta-entries</codeph> and <codeph>mappull</codeph> steps have been merged. The
<codeph>mappull</codeph> step has been moved into <codeph>move-meta-entries</codeph> and an empty target
for mappull is retained for backwards compatibility.
<xref href="https://github.com/dita-ot/dita-ot/issues/1995" scope="external" format="html">#1995</xref>
</li>
<li id="1984">The generation of page masters and page sequence masters in the PDF plug-in has been modularized
to make it easier to extend or override the default set of masters.
<xref href="https://github.com/dita-ot/dita-ot/issues/1984" scope="external" format="html">#1984</xref>
</li>
<!--<li id="1979">Initial support for DITA 1.3 key scopes
<xref href="https://github.com/dita-ot/dita-ot/pull/1979" scope="external" format="html">#1979</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/1648" scope="external" format="html">#1648</xref>
</li>-->
<li id="1976">The PDF plug-in has been extended with two new extension points for
<codeph>flagging-preprocess</codeph> and <codeph>i18n-postprocess</codeph> to alllow plug-ins to customize
these steps of the flagging process.
<xref href="https://github.com/dita-ot/dita-ot/pull/1976" scope="external" format="html">#1976</xref>
</li>
<!--<li id="1969">Initial implementation of DITA 1.3 branch filtering
<xref href="https://github.com/dita-ot/dita-ot/pull/1969" scope="external" format="html">#1969</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/1637" scope="external" format="html">#1637</xref>
</li>-->
<li id="1962">The key definition reading process has been moved from the <codeph>gen-list</codeph>
preprocessing module to the <codeph>keyref</codeph> module to further modularize the code and support
additional DITA 1.3 use cases for keys, such as a map that includes a map that then includes another map
with a key definition.
<xref href="https://github.com/dita-ot/dita-ot/pull/1962" scope="external" format="html">#1962</xref>
</li>
<li id="1961">The mapref processing stage has been moved to the beginning of the preprocessing pipeline to
simplify keyref processing and support DITA 1.3 branch filtering by allowing all processing to be performed
on a single map.
<xref href="https://github.com/dita-ot/dita-ot/pull/1961" scope="external" format="html">#1961</xref>
</li>
<li id="1957">The <cmdname>dita</cmdname>
<option>-install</option> option can now be used to integrate multiple plug-ins at once. If no
<varname>file</varname> or <varname>url</varname> argument is provided, the integration process reloads
plug-ins from the <filepath>plugins</filepath> directory, so you can unzip multiple plug-ins to the
<filepath>plugins</filepath> directory and run <cmdname>dita</cmdname>
<option>-install</option> to integrate them all at once.
<xref href="https://github.com/dita-ot/dita-ot/issues/1957" scope="external" format="html">#1957</xref>
</li>
<li id="1955">The PDF transformation has been extended with XML catalog support for RenderX XEP. The main
DITA-OT catalog file is now used to ensure that doctypes such as SVG graphics pass validation when
generating PDF output using XEP.
<xref href="https://github.com/dita-ot/dita-ot/pull/1955" scope="external" format="html">#1955</xref>
</li>
<li id="1953">The Java code has been refactored to use URI-based processing (rather than File objects or
Strings) wherever possible to permit automatic validation of values and support the use of external URIs.
This allows non-file resources to be processed with commands such as <cmdname>dita</cmdname>
<option>-i http://example.com/test.ditamap -f html5</option>.
<xref href="https://github.com/dita-ot/dita-ot/issues/1544" format="html" scope="external">#1544</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/1953" scope="external" format="html">#1953</xref>
</li>
<li id="1905">Plug-in folders are now sorted before the integration process runs to ensure predictable results
and consistent order each time plug-ins are reloaded.
<xref href="https://github.com/dita-ot/dita-ot/issues/1905" scope="external" format="html">#1905</xref>
</li>
<li id="1866">The metadata format in the <filepath>plugin.xml</filepath> file for the
<filepath>org.dita.xhtml</filepath> plug-in has been refactored with abstract transtypes that group common
parameters used in multiple transformation types. This approach allows common parameters to be defined in
one place and re-used for multiple output formats as necessary.
<xref href="https://github.com/dita-ot/dita-ot/issues/1866" scope="external" format="html">#1866</xref>
</li>
<li id="1836">The <cmdname>dita</cmdname> command options have been extended to add <option>-t</option> as a
synonym for the <option>-temp</option> option used to specify the location of the temporary directory.
<xref href="https://github.com/dita-ot/dita-ot/issues/1836" scope="external" format="html">#1836</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2039" scope="external" format="html">#2039</xref>
</li>
<li id="1835">The validation of the table group <xmlatt>cols</xmlatt> attribute has been relaxed to support
use cases in which tables containing auto-generated <xmlatt>cols</xmlatt> values are reused via content
references.
<xref href="https://github.com/dita-ot/dita-ot/issues/1835" scope="external" format="html">#1835</xref>
</li>
<li id="1757">The format of the <filepath>plugin.xml</filepath> file has been extended to allow plug-ins to
specify the list of public parameters added for each transformation type and announce extensions to a list
of arguments defined in another transtype.
<xref href="https://github.com/dita-ot/dita-ot/issues/1757" scope="external" format="html">#1757</xref>
</li>
</ul>
</section>
<section id="enhancements">
<title>Enhancements</title>
<p>DITA Open Toolkit Release 2.2 includes the following enhancements and changes to
existing features:</p>
<ul>
<li id="2118">PDF: Table body rows now use the <option>keep-together.within-page</option> attribute to prevent
page breaks within rows.
<xref href="https://github.com/dita-ot/dita-ot/issues/2118" scope="external" format="html">#2118</xref>
</li>
<li id="2117">PDF: List item numbers are now aligned with the baseline to prevent issues when list items
include icons or other inline elements that affect line spacing.
<xref href="https://github.com/dita-ot/dita-ot/issues/2117" scope="external" format="html">#2117</xref>
</li>
<li id="2116">PDF: Step section bodies within task topics now honor the <codeph>$side-col-width</codeph> value
from <filepath>basic-settings.xsl</filepath>, which defines a uniform indent relative to the page margin and
aligns with other body text. (Earlier toolkit versions used a hard-coded 9-mm <option>start-indent</option>
setting.)
<xref href="https://github.com/dita-ot/dita-ot/issues/2116" scope="external" format="html">#2116</xref>
</li>
<li id="2098">PDF: The index generation process has been rewritten using XSL keys for better performance. The
optimizations yield significantly faster PDF builds when using Apache FOP.
<xref href="https://github.com/dita-ot/dita-ot/issues/2098" scope="external" format="html">#2098</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2086" scope="external" format="html">#2086</xref>
</li>
<li id="2097">HTML5 and XHTML table border processing has been optimized to match the expected output based on
the table width, column separation, row separation and frame settings in the source files, permit easier
integration of CSS frameworks, and output valid documents.
<xref href="https://github.com/dita-ot/dita-ot/issues/2097" scope="external" format="html">#2097</xref>
</li>
<!--<li id="2096">Extra warnings reported when project using key scopes and branch filtering is published
<xref href="https://github.com/dita-ot/dita-ot/issues/2096" scope="external" format="html">#2096</xref>
</li>-->
<!--<li id="2089">Add additional languages to PDF2
<xref href="https://github.com/dita-ot/dita-ot/pull/2089" scope="external" format="html">#2089</xref>
</li>-->
<li id="2088">The task headings (About this task, Procedure, etc.) and flags for Optional and Required steps
in the <option>PDF</option> transformation have been synchronized with those available in the common string
files, <option>XHTML</option> and <option>ODT</option> transformations. Source files that make use of these
options should now yield more more consistent results when generating output in multiple formats.
<xref href="https://github.com/dita-ot/dita-ot/issues/2088" scope="external" format="html">#2088</xref>
</li>
<!--<li id="2085">Add support for many new languages to PDF2
<xref href="https://github.com/dita-ot/dita-ot/pull/2085" scope="external" format="html">#2085</xref>
</li>-->
<li id="2080">PDF: The index groups for Numerics and Special Characters have been aligned for greater
consistency across languages.
<xref href="https://github.com/dita-ot/dita-ot/pull/2080" scope="external" format="html">#2080</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2074" scope="external" format="html">#2074</xref>
</li>
<li id="2076">PDF: The “pointing finger” image <filepath>hand.gif</filepath> is no longer used to highlight
<xmlelement>note</xmlelement> elements, as it may be considered offensive in some cultures. The image file
is still available for backwards compatibility with any customization that references it, and the "Note
Image Path" variables are still present to permit the use of custom image files, but they are now empty by
default. Text-only note labels appear instead, and the default indentation is reduced by the width of the
empty note image column.
<xref href="https://github.com/dita-ot/dita-ot/pull/2076" scope="external" format="html">#2076</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/1577" scope="external" format="html">#1577</xref>
<note>The <filepath>warning.gif</filepath> file is still used for Attention, Caution, Danger and Warning
admonitions.</note>
</li>
<!-- Already included in 2.1.2 RN -->
<!--<li>Add support for n-tilde in Spanish index
<xref href="https://github.com/dita-ot/dita-ot/pull/2068" scope="external" format="html">#2068</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2069" scope="external" format="html">#2069</xref>
</li>-->
<li id="2066">The <parmname>outer.control</parmname> parameter description was corrected to clarify how the
DITA-OT handles content files that are not located in or below the directory containing the master DITA map.
<xref href="https://github.com/dita-ot/dita-ot/pull/1707" scope="external" format="html">#1707</xref>
<xref href="https://github.com/dita-ot/dita-ot/pull/2066" scope="external" format="html">#2066</xref>
</li>
<li id="2058">Formatter-specific code for XSL-FO rendering engines has been removed from the PDF plug-in and
split into separate plug-ins for Apache FOP, Antenna House Formatter and RenderX XEP.
<xref href="https://github.com/dita-ot/dita-ot/pull/2058" scope="external" format="html">#2058</xref>
</li>
<!--<li id="2055">Extend <codeph>transtype</codeph> parameter description
<xref href="https://github.com/dita-ot/dita-ot/pull/2055" scope="external" format="html">#2055</xref>
</li>
<li id="2054">Sync order of arguments in command descriptions
<xref href="https://github.com/dita-ot/dita-ot/pull/2054" scope="external" format="html">#2054</xref>
</li>-->
<li id="2053">The classpath order is now retained when generating the <filepath>env.sh</filepath> and
<filepath>env.bat</filepath> environment files to ensure predictable results when a plug-in that uses Java
libraries presupposes a certain classpath order.
<xref href="https://github.com/dita-ot/dita-ot/pull/2053" scope="external" format="html">#2053</xref>
</li>
<li id="2049">The PDF2 flagging step that converted <filepath>stage1.xml</filepath> to
<filepath>stage1a.xml</filepath> in the PDF process has been refactored to take advantage of the flagging
information added during the common preprocessing stage.
<xref href="https://github.com/dita-ot/dita-ot/pull/2049" scope="external" format="html">#2049</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2047" scope="external" format="html">#2047</xref>
</li>
<li id="2046">The <filepath>dita.bat</filepath> Windows batch file for the <cmdname>dita</cmdname> command now
sets the <varname>DITA_HOME</varname> variable to point to the correct location of the DITA-OT.
<xref href="https://github.com/dita-ot/dita-ot/pull/2046" scope="external" format="html">#2046</xref>
</li>
<li id="2041">PDF: A new <parmname>axf.opt</parmname> parameter has been added to specify the user
configuration file for Antenna House Formatter.
<xref href="https://github.com/dita-ot/dita-ot/pull/2041" scope="external" format="html">#2041</xref>
</li>
<li id="1986">Processing mode coverage has been improved to treat error messages as fatal errors, so the
DITA-OT will now stop processing if any source files are missing when the
<parmname>processing-mode</parmname> parameter is set to <option>strict</option>.
<xref href="https://github.com/dita-ot/dita-ot/issues/1986" scope="external" format="html">#1986</xref>
</li>
<li id="1970">Table columns for which no width is defined in a <xmlelement>colspec</xmlelement> element are no
longer set to <codeph>1*</codeph> per the CALS Table Model. Instead, empty <xmlatt>colwidth</xmlatt>
attributes are generated to allow formatter-specific auto-layout. The FO processor can then set the width of
the columns based on the column content.
<xref href="https://github.com/dita-ot/dita-ot/issues/1970" scope="external" format="html">#1970</xref>
</li>
<!--<li id="1544">Use URI and File instead of String
<xref href="https://github.com/dita-ot/dita-ot/issues/1544" scope="external" format="html">#1544</xref>
</li>-->
</ul>
</section>
<section id="bugs">
<title>Bugs</title>
<p>DITA Open Toolkit Release 2.2 provides fixes for the following bugs:</p>
<ul>
<li id="2128">Inconsistency in naming of flow name, region definition
<xref href="https://github.com/dita-ot/dita-ot/issues/2128" scope="external" format="html">#2128</xref>
</li>
<!--<li id="2125">Missing `.tar.gz` distribution package
<xref href="https://github.com/dita-ot/dita-ot/issues/2125" scope="external" format="html">#2125</xref>
</li>-->
<li id="2119">Third relcolspec title on a reltable no longer taken into account for publishing
<xref href="https://github.com/dita-ot/dita-ot/issues/2119" scope="external" format="html">#2119</xref>
</li>
<li id="2109">Topic in temp folder is not wellformed
<xref href="https://github.com/dita-ot/dita-ot/issues/2109" scope="external" format="html">#2109</xref>
</li>
<li id="2108">gradle build fails with ‘Could not load FFI Provider ..’ on Windows
<xref href="https://github.com/dita-ot/dita-ot/issues/2108" scope="external" format="html">#2108</xref>
</li>
<li id="2105">Behavior of the force-unique flag
<xref href="https://github.com/dita-ot/dita-ot/issues/2105" scope="external" format="html">#2105</xref>
</li>
<li id="2101">Site builds fail after <codeph>html5</codeph> changes
<xref href="https://github.com/dita-ot/dita-ot/issues/2101" scope="external" format="html">#2101</xref>
</li>
<li id="2095">Generated HTML table is invalid according to HTML5 specs
<xref href="https://github.com/dita-ot/dita-ot/issues/2095" scope="external" format="html">#2095</xref>
</li>
<li id="2093">Fix table and figure list to include number, title
<xref href="https://github.com/dita-ot/dita-ot/pull/2093" scope="external" format="html">#2093</xref>
</li>
<li id="2091">Remove obsolete info from codepage list
<xref href="https://github.com/dita-ot/dita-ot/pull/2091" scope="external" format="html">#2091</xref>
</li>
<li id="2090">Add axf.jar into log-processor taskdef classpath
<xref href="https://github.com/dita-ot/dita-ot/pull/2090" scope="external" format="html">#2090</xref>
</li>
<li id="2081">Add PFD2 index groups for a-breve, a-circ in Romanian
<xref href="https://github.com/dita-ot/dita-ot/pull/2081" scope="external" format="html">#2081</xref>
</li>
<li id="2078">Ambiguous message for example with two titles
<xref href="https://github.com/dita-ot/dita-ot/pull/2078" scope="external" format="html">#2078</xref>
</li>
<!-- #2068 already included in 2.1.2 RN -->
<li id="2061">Table not localized in French translation org.dita.pdf2 - fr.xml
<xref href="https://github.com/dita-ot/dita-ot/pull/2061" scope="external" format="html">#2061</xref>
</li>
<li id="2060">French translation of Table of contents is incorrect
<xref href="https://github.com/dita-ot/dita-ot/pull/2060" scope="external" format="html">#2060</xref>
</li>
<li id="2059">Fix ODT title generation
<xref href="https://github.com/dita-ot/dita-ot/pull/2059" scope="external" format="html">#2059</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2034" scope="external" format="html">#2034</xref>
</li>
<li id="2051">Catch null FileInfo object being referenced in move-meta.
<xref href="https://github.com/dita-ot/dita-ot/pull/2051" scope="external" format="html">#2051</xref>
</li>
<li id="2050">Flagging preprocess grabs too much with check for defaults
<xref href="https://github.com/dita-ot/dita-ot/pull/2050" scope="external" format="html">#2050</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2048" scope="external" format="html">#2048</xref>
</li>
<!--<li id="2027">when transfer .ditamap file to odt format output,the title of the odt file is not correct <xref
href="https://github.com/dita-ot/dita-ot/issues/2034" scope="external" format="html">#2034</xref>
</li>-->
<li id="2027">Error message not properly formatted
<xref href="https://github.com/dita-ot/dita-ot/issues/2027" scope="external" format="html">#2027</xref>
</li>
<li id="2012">Can no longer publish to XHTML image with data protocol
<xref href="https://github.com/dita-ot/dita-ot/issues/2012" scope="external" format="html">#2012</xref>
</li>
<li id="2009">Ensuring @chunk inside topicgroups functions as expected.
<xref href="https://github.com/dita-ot/dita-ot/pull/2009" scope="external" format="html">#2009</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/1991" scope="external" format="html">#1991</xref>
</li>
<li id="2006">Copy-to usage with URI support does not properly work
<xref href="https://github.com/dita-ot/dita-ot/issues/2006" scope="external" format="html">#2006</xref>
</li>
<li id="2003">Cannot publish remote HTTP DITA Map to XHTML
<xref href="https://github.com/dita-ot/dita-ot/issues/2003" scope="external" format="html">#2003</xref>
</li>
<li id="1992">Branch filtering does not seem to work with entire DITA Maps
<xref href="https://github.com/dita-ot/dita-ot/issues/1992" scope="external" format="html">#1992</xref>
</li>
<!-- <li id="1991">Problem with chunking (DITA OT 2.x). <xref href="https://github.com/dita-ot/dita-ot/issues/1991"
scope="external" format="html">#1991</xref>
</li>-->
<li id="1989">Add proper mappings for topicrefs with copy-to attributes in JavaHelp
<xref href="https://github.com/dita-ot/dita-ot/pull/1989" scope="external" format="html">#1989</xref>
</li>
<li id="1974">Use the fragment part of KeyDef @href attribute when building @conref
<xref href="https://github.com/dita-ot/dita-ot/pull/1974" scope="external" format="html">#1974</xref>
</li>
<!--<li id="1968">Move same topic fragment processing before conref
<xref href="https://github.com/dita-ot/dita-ot/pull/1968" scope="external" format="html">#1968</xref>
</li>-->
<li id="1967">Remove unwanted $PATH2PROJ remnant from $entry-file definition (glossary entry file resolution
fails from term and abbreviated-form DOTX058W)
<xref href="https://github.com/dita-ot/dita-ot/pull/1967" scope="external" format="html">#1967</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/1966" scope="external" format="html">#1966</xref>
</li>
<li id="1823">DITA-OT 2.0 - Build Error (Windows) - Illegal character - keyref target
<xref href="https://github.com/dita-ot/dita-ot/issues/1823" scope="external" format="html">#1823</xref>
</li>
<li id="1816">abbreviated-form and term keyref links are not resolved when chunk="to-content"
<xref href="https://github.com/dita-ot/dita-ot/issues/1816" scope="external" format="html">#1816</xref>
</li>
<li id="1605">Two levels of map ref causes good key ref to fail
<xref href="https://github.com/dita-ot/dita-ot/issues/1605" scope="external" format="html">#1605</xref>
</li>
</ul>
</section>
<section id="contrib">
<title>Contributors</title>
<p>DITA Open Toolkit Release 2.2 includes
<xref keyref="contributions"/> by the following people:</p>
<!-- https://github.com/tj/git-extras/blob/master/Commands.md#git-summary – `git summary 2.1..` -->
<ol>
<li>Jarno Elovirta</li>
<li>Robert D. Anderson</li>
<li>Roger Sheen</li>
<li>Eero Helenius</li>
<li>Radu Coravu</li>
<li>Tom Glastonbury</li>
<li>Kendall Shaw</li>
<li>Eliot Kimber</li>
<li>Chris Nitchie</li>
<li>Stefan Eike</li>
</ol>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/2.1...2.2" scope="external" format="html">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<!--
<reference id="limitations">
<title>Limitations</title>
<refbody>
<section>
<draft-comment author="infotexture">Add info on any significant open issues, caveats or known limitations in
DITA markup support.</draft-comment>
</section>
</refbody>
</reference>
-->
<!--
<reference id="migration">
<title>Migration From Previous Releases</title>
<refbody>
<section>
<draft-comment author="jelovirt">TODO</draft-comment>
</section>
</refbody>
</reference>
-->
</reference>

655
dita-ot-3.6/docsrc/release-notes/rel2.3.dita Normal file
View file

@ -0,0 +1,655 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
<reference id="ID" rev="2.3">
<title>DITA Open Toolkit 2.3.3 Release Notes</title>
<abstract>
<shortdesc>DITA Open Toolkit 2.3.3 is a maintenance release that fixes issues reported in DITA-OT 2.3, which
includes <ph conref="#highlights/summary"/>.</shortdesc>
<p>Issue numbers correspond to the tracking number in the <ph>
<xref keyref="dita-ot-issues">GitHub issues tracker</xref></ph>.</p>
</abstract>
<reference id="v233">
<title>Maintenance Release 2.3.3</title>
<refbody>
<section>
<p>DITA Open Toolkit Release 2.3.3 includes the following bug fixes.</p>
<ul>
<li id="2440">Lax processing now tolerates hyperlink references with leading or trailing whitespace in the
<xmlatt>href</xmlatt> attribute value, such as:
<codeblock>&lt;xref href=" http://www.example.com" format="html"&gt;</codeblock> Earlier versions of DITA-OT
would convert the space to its URL-encoded equivalent <codeph>%20</codeph> and fail with an error. The URI
validation routines have been modified to issue a warning and continue processing in lax mode, but still
fail in strict mode.
<xref href="https://github.com/dita-ot/dita-ot/issues/2440" scope="external" format="html">#2440</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2488" scope="external" format="html">#2488</xref>
</li>
<li id="2017">In certain cases, earlier versions of DITA-OT resolved relative paths to related links from the
temporary directory rather than from the input DITA map file. Processing has been modified to ensure that
links are generated correctly regardless of the target file location.
<xref href="https://github.com/dita-ot/dita-ot/issues/2017" scope="external" format="html">#2017</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2444" scope="external" format="html">#2444</xref>
</li>
<li id="2458">Several errors in the DITA 1.3 <filepath>subjectScheme</filepath> catalog file were corrected to
ensure that the module files and entities for the DITA Map Subject Classification Domain are properly
resolved. Corresponding errata have been submitted to OASIS to ensure the fixes are applied to the official
catalogs.
<xref href="https://github.com/dita-ot/dita-ot/issues/2458" scope="external" format="html">#2458</xref>
</li>
<li id="2464">Related link processing has been adjusted to handle cases that generate empty related links
groups.
<xref href="https://github.com/dita-ot/dita-ot/issues/2464" scope="external" format="html">#2464</xref>
</li>
<li id="2470">The <codeph>mappull</codeph> preprocessing step that pulls content from referenced topics into
maps has been updated to use the XML catalog to resolve external entity references to their locally cached
equivalents.
<xref href="https://github.com/dita-ot/dita-ot/issues/2470" scope="external" format="html">#2470</xref>
</li>
<li id="2474">In PDF output generated by earlier versions of DITA-OT, roman numerals were used to number pages
in the Notices section, assuming notices are most commonly located in the front matter, which uses roman
numbering by default. The toolkit now checks whether the <xmlelement>notices</xmlelement> element is inside
<xmlelement>backmatter</xmlelement>, and uses arabic numbering as appropriate.
<xref href="https://github.com/dita-ot/dita-ot/issues/2474" scope="external" format="html">#2474</xref>
</li>
<li id="2477">When processing topics with unsupported languages, DITA-OT erroneously claimed it couldn't find
the language <codeph>en_us</codeph> rather than mentioning the unsupported language. The
<msgnum>DOTX001W</msgnum> message now includes the original, most complete value of the ancestor language
to assist in troubleshooting.
<xref href="https://github.com/dita-ot/dita-ot/pull/2477" scope="external" format="html">#2477</xref>
</li>
<li id="2482">In DITA-OT 2.3.2, reference targets for link-like elements such as
<xmlelement>abbreviated-form</xmlelement> in short descriptions were incorrectly calculated in some cases.
Processing has been updated to ensure that links are correctly resolved by adjusting references as necessary
to match the path to the target document.
<xref href="https://github.com/dita-ot/dita-ot/issues/2482" scope="external" format="html">#2482</xref>
</li>
<li id="2486">The copy-to processing routine failed to update image paths, resulting in invalid references in
topics copied to locations other than the original or peer directories. Processing has been updated to
ensure that image references are adjusted as necessary to reflect the location of the referencing document.
<xref href="https://github.com/dita-ot/dita-ot/issues/2486" scope="external" format="html">#2486</xref>
</li>
<li id="2487">PDF: Definitions for several missing localization variables have been added to the Finnish,
Romanian, Russian, and Swedish strings files.
<xref href="https://github.com/dita-ot/dita-ot/pull/2487" scope="external" format="html">#2487</xref>
</li>
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/2.3.2...2.3.3" scope="external" format="html">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v232">
<title>Maintenance Release 2.3.2</title>
<refbody>
<section>
<p>DITA Open Toolkit Release 2.3.2 included the following bug fixes.</p>
<ul>
<li id="1599">In earlier versions of DITA-OT, relative paths to cross-references from short descriptions were
sometimes interpreted incorrectly if the source and target topics were located in different directories. New
XSL functions now ensure that these references are correctly resolved.
<xref href="https://github.com/dita-ot/dita-ot/issues/1599" scope="external" format="html">#1599</xref>
</li>
<li id="2413">In DITA-OT 2.3, the HTML5 transtype failed on topics with tables when the
<parmname>args.xhtml.classattr</parmname> parameter was set to <option>no</option>. Processing has been
updated to handle these cases and correctly exclude the DITA class ancestry information when publishing
HTML5 output.
<xref href="https://github.com/dita-ot/dita-ot/issues/2413" scope="external" format="html">#2413</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2424" scope="external" format="html">#2424</xref>
</li>
<li id="2439">In DITA-OT 2.3, the PDF2 build target dependency list contained redundant entries. The
integration process has been corrected to remove the duplicates.
<xref href="https://github.com/dita-ot/dita-ot/issues/2439" scope="external" format="html">#2439</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2451" scope="external" format="html">#2451</xref>
</li>
<li id="2441">The script that checks for Antenna House installations has been updated to include installation
paths with spaces as used by recent versions of Antenna House for Windows –
<filepath>C:\Program&#xA0;Files\Antenna&#xA0;House</filepath> and the (x86) equivalent.
<xref href="https://github.com/dita-ot/dita-ot/issues/2441" scope="external" format="html">#2441</xref>
</li>
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/2.3.1...2.3.2" scope="external" format="html">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v231">
<title>Maintenance Release 2.3.1</title>
<refbody>
<section>
<p>DITA Open Toolkit Release 2.3.1 included the following bug fixes.</p>
<ul>
<li id="2395">The distribution package for the 2.3 release included several unnecessary subfolders and
appended the Git commit ID to the version number in the <filepath>lib/configuration.properties</filepath>
file. The extra directories have been removed and the <codeph>otversion</codeph> in the properties file has
been corrected.
<xref href="https://github.com/dita-ot/dita-ot/issues/2395" scope="external" format="html">#2395</xref>
</li>
<li id="2398">In DITA-OT 2.3, temporary file folders specified via the <parmname>dita.temp.dir</parmname>
parameter were interpreted as relative to the folder where the Java process started. This regression has
been fixed to ensure that temporary folders are once again interpreted as relative to the base directory of
the Ant process as in previous toolkit versions.
<xref href="https://github.com/dita-ot/dita-ot/issues/2398" scope="external" format="html">#2398</xref>
</li>
<li id="2400">On Windows, the <cmdname>dita</cmdname> command would not run correctly if the name of a folder
in the path to the DITA-OT 2.3 installation directory included spaces. The <filepath>dita.bat</filepath>
script has been modified to support installation paths with spaces.
<xref href="https://github.com/dita-ot/dita-ot/issues/2400" scope="external" format="html">#2400</xref>
</li>
<li id="2401">The DITA 1.3 DTD, Schema, and RNG files have been updated to the final "OASIS Standard" copy;
this change updates the OASIS link and date in many header files, but does not affect how the grammar files
work. In addition, the catalog has been updated to restore two entries that will eventually be shipped in
the DITA 1.3 Errata from OASIS.
<xref href="https://github.com/dita-ot/dita-ot/issues/2401" scope="external" format="html">#2401</xref>
</li>
<li id="2408">Fixed an issue where some front-matter sections, such as <xmlelement>draftintro</xmlelement> and
<xmlelement>bookabstract</xmlelement>, caused page numbering to switch back and forth between Roman
numerals and body-style Arabic numerals.
<xref href="https://github.com/dita-ot/dita-ot/issues/2408" scope="external" format="html">#2408</xref>
</li>
<!--
<li id="2413">HTML5 transtype fails on topics with tables when args.xhtml.classattr=no
<xref href="https://github.com/dita-ot/dita-ot/issues/2413" scope="external" format="html">#2413</xref>
</li>
-->
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/2.3...2.3.1" scope="external" format="html">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="requirements">
<title>Requirements</title>
<refbody>
<section>
<draft-comment author="Roger">Add info on new minimum Java version or any other requirements that have changed
since previous release.</draft-comment>
<p>DITA Open Toolkit Release 2.3 requires the Java Runtime Environment (JRE) version <keyword
keyref="tool.java.version"/> or later.</p>
</section>
</refbody>
</reference>
<reference id="highlights">
<title>Release Highlights</title>
<shortdesc>DITA-OT 2.3 includes <ph id="summary">enhanced HTML5 output, new language support and additional
internationalization improvements</ph>.</shortdesc>
<refbody>
<section>
<title>Single .zip distribution package</title>
<p id="2269">DITA Open Toolkit now ships as a single distribution package in a <filepath>.zip</filepath>
archive, as modern versions of Linux and OS X no longer have the file permission issues that originally
required the additional <filepath>.tar.gz</filepath> distribution package.
<xref href="https://github.com/dita-ot/dita-ot/issues/2269" scope="external" format="html">#2269</xref>
</p>
</section>
<section>
<title>Enhanced HTML5 output</title>
<p id="2239">The <option>HTML5</option> table processing has been refactored to use valid HTML5 markup, HTML5
best practices, and better CSS properties for styling.
<xref href="https://en.bem.info/methodology/" format="html" scope="external">BEM</xref>-style CSS classes are
now generated with the name of the containing element, the name of the attribute, and the value of the
attribute.
<xref href="https://github.com/dita-ot/dita-ot/issues/2239" scope="external" format="html">#2239</xref>
</p>
<p id="2195-2196">Common CSS files are now generated using separate modules for each DITA domain, implemented as
<xref keyref="sass-lang"/> partials to better support extensions with CSS frameworks, custom plug-ins and
future toolkit versions.
<xref href="https://github.com/dita-ot/dita-ot/pull/2195" scope="external" format="html">#2195</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2196" scope="external" format="html">#2196</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2218" scope="external" format="html">#2218</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2369" scope="external" format="html">#2369</xref>
</p>
</section>
<section>
<title>New language support</title>
<p id="2137">The <option>PDF</option> transformation has been extended to support additional languages with
localized strings files and index collation.
<xref href="https://github.com/dita-ot/dita-ot/issues/2137" scope="external" format="html">#2137</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2344" scope="external" format="html">#2344</xref>
<ul>
<li>Belarusian</li>
<li>Bulgarian</li>
<li>Chinese (traditional), with limited support for index sorting</li>
<li>Estonian</li>
<li>Greek</li>
<li>Hindi</li>
<li>Indonesian</li>
<li>Kazakh</li>
<li>Korean</li>
<li>Lithuanian</li>
<li>Macedonian</li>
<li>Malay</li>
<li>Serbian (Cyrillic script)</li>
<li>Serbian (Latin script)</li>
<li>Thai</li>
<li>Ukrainian</li>
<li>Urdu</li>
</ul>
</p>
<p><option>PDF</option>, <option>HTML</option>, and <option>XHTML</option> transformation types have been
updated to support Bosnian, Montenegrin, and Vietnamese, including localized string files and (for
<option>PDF</option>) index collation.
<xref href="https://github.com/dita-ot/dita-ot/issues/2150" scope="external" format="html">#2150</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2360" scope="external" format="html">#2360</xref>
</p>
</section>
<section>
<title>Internationalization improvements</title>
<p>Along with the new languages supported by the <option>PDF</option> and <option>HTML</option> transformations,
DITA Open Toolkit Release 2.3 provides additional internationalization improvements, including:
<ul>
<li id="2267">When testing for bi-directional content, more languages are now recognized as right-to-left.
No additional support is added (for example, generated strings for new languages will appear using the
DITA-OT default language), but otherwise content will use the proper direction by default. Arabic, Urdu,
and Hebrew are already recognized by default; this change recognizes an additional 14 languages.
<xref href="https://github.com/dita-ot/dita-ot/issues/1710" scope="external" format="html">#1710</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2267" scope="external" format="html">#2267</xref>
</li>
<li id="2279">PDF: Additional fallback fonts have been specified in the
<filepath>font-mappings.xml</filepath> file to provide better out-of-the-box support for Asian
characters.
<xref href="https://github.com/dita-ot/dita-ot/issues/2279" scope="external" format="html">#2279</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2280" scope="external" format="html">#2280</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2296" scope="external" format="html">#2296</xref>
</li>
<li id="2302">HTML: Earlier releases of DITA-OT 2.x generated a <xmlatt>style</xmlatt> attribute with
<codeph>text-align:left</codeph> on table cells, regardless of whether the <xmlatt>align</xmlatt>
attribute was set in the source. This caused problems with right-to-left languages. The default entry
alignment has been removed, so the values of the <xmlatt>xml:lang</xmlatt> and <xmlatt>dir</xmlatt>
attributes on the root of the topic will be respected. (This allows the browser to infer the value for the
<codeph>text-align</codeph> property from the parent elements/styles.)
<xref href="https://github.com/dita-ot/dita-ot/issues/2302" scope="external" format="html">#2302</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2368" scope="external" format="html">#2368</xref>
</li>
<li id="2343">PDF: The Dutch variable file now includes translations for Glossary, List of tables, and List
of figures. In addition, German, Italian, French, and Spanish have been updated to define missing
variables, including one that previously resulted in a build error ("Table of Contents Notices").
<xref href="https://github.com/dita-ot/dita-ot/issues/2131" scope="external" format="html">#2131</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2343" scope="external" format="html">#2343</xref>
</li>
<li id="2357">The DITA-OT configuration value <codeph>default.language</codeph> is now used as the default
language in all output formats. The value ships as <codeph>en</codeph>, but can be changed in
<filepath>configuration.properties</filepath> or specified as a parameter to the build. For HTML output,
the default is now the closest specified language; if a document does not specify
<xmlatt>xml:lang</xmlatt>, <codeph>default.language</codeph> is used. For PDF output, the default is the
closest specified language; if a document does not specify <xmlatt>xml:lang</xmlatt>, the root map is
used; if the root map does not specify <xmlatt>xml:lang</xmlatt>, <codeph>default.language</codeph> is
used.
<xref href="https://github.com/dita-ot/dita-ot/issues/1476" scope="external" format="html">#1476</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2201" scope="external" format="html">#2201</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2356" scope="external" format="html">#2356</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2357" scope="external" format="html">#2357</xref>
</li>
</ul>
</p>
</section>
</refbody>
</reference>
<reference id="issues">
<title>Resolved issues</title>
<shortdesc>In addition to the highlights mentioned above, DITA Open Toolkit Release 2.3 includes the following
changes.</shortdesc>
<refbody>
<section id="features">
<title>Features</title>
<p>DITA Open Toolkit Release 2.3 includes the following new features:</p>
<ul>
<li id="1116">The <codeph>args.eclipsehelp.toc</codeph> parameter for Eclipse Help, which has not worked
properly for several releases after it was made obsolete in DITA-OT 1.3, has been removed.
<xref href="https://github.com/dita-ot/dita-ot/issues/1116" scope="external" format="html">#1116</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2354" scope="external" format="html">#2354</xref>
</li>
<li id="1777">DITA 1.3: Initial support has been added for the <xmlatt>orient</xmlatt> attribute on
<xmlelement>table</xmlelement> elements. These changes allow Antenna House Formatter to render tables in
landscape mode when the <xmlatt>orient</xmlatt> attribute is set to <option>land</option>. A future release
will provide extended support for multi-page landscape tables with additional rendering engines.
<xref href="https://github.com/dita-ot/dita-ot/issues/1777" scope="external" format="html">#1777</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2387" scope="external" format="html">#2387</xref>
</li>
<li id="2130">To permit automated building and testing on any platform, the HTMLHelp version of the
documentation is no longer included in the distribution package. An HTMLHelp version of the documentation
can still be built on Windows using the downloaded distribution package.
<xref href="https://github.com/dita-ot/dita-ot/issues/2130" scope="external" format="html">#2130</xref>
</li>
<li id="2144">SAX pipes can now be configured in Ant <xmlelement>pipeline</xmlelement> tasks. This allows new
tasks to take advantage of in-memory processing without the need to write out files to disk.
<xref href="https://github.com/dita-ot/dita-ot/issues/2144" scope="external" format="html">#2144</xref>
</li>
<li id="2155">The process for generating topic headers in the <option>PDF</option> transformation type has
been simplified to use a single template with <codeph>mode="insertTopicHeaderMarker"</codeph>. This reduces
the amount of work needed to format titles differently in the header and body.
<xref href="https://github.com/dita-ot/dita-ot/issues/2155" scope="external" format="html">#2155</xref>
</li>
<li id="2185">The <option>HTML5</option> transformation type supports two new extension points
<codeph>dita.conductor.html5.param</codeph> and <codeph>dita.conductor.html5.toc.param</codeph>, allowing
plugins to provide new parameters for HTML5 processing.
<xref href="https://github.com/dita-ot/dita-ot/issues/2185" scope="external" format="html">#2185</xref>
</li>
<li id="2210">Processing for <xmlatt>copy-to</xmlatt> has been moved out of the <codeph>gen-list</codeph>
preprocessing module and into a separate step. This improves processing for
<xmlelement>topicref</xmlelement> elements that use <xmlatt>copy-to</xmlatt> and <xmlatt>keyref</xmlatt>.
<xref href="https://github.com/dita-ot/dita-ot/issues/2210" scope="external" format="html">#2210</xref>
</li>
<li id="2230">The DITA-OT preprocessing step that reads images for information about height and width now
supports reading dimension metadata from SVG images.
<xref href="https://github.com/dita-ot/dita-ot/issues/2230" scope="external" format="html">#2230</xref>
</li>
<li id="2317">The <option>PDF</option> transformation type has been updated to support the
<xmlatt>expanse</xmlatt> value "page" for elements that use the attribute. In addition, the
<xmlelement>msgblock</xmlelement> element has been updated to support <xmlatt>frame</xmlatt> and
<xmlatt>scale</xmlatt>, which generally appear on the same elements that use <xmlatt>expanse</xmlatt>.
<xref href="https://github.com/dita-ot/dita-ot/issues/2317" scope="external" format="html">#2317</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2352" scope="external" format="html">#2352</xref>
</li>
<li id="2359">Cross-references to footnotes now generate hyperlinks in PDF output.
<xref href="https://github.com/dita-ot/dita-ot/issues/2359" scope="external" format="html">#2359</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2364" scope="external" format="html">#2364</xref>
</li>
</ul>
</section>
<section id="enhancements">
<title>Enhancements</title>
<p>DITA Open Toolkit Release 2.3 includes the following enhancements and changes to existing features:</p>
<ul>
<li id="1860">PDF: Information from the <filepath>README.txt</filepath> files in the
<filepath>org.dita.pdf2</filepath> plugin have been moved to the “PDF plug-in structure” topic in the DITA
Open Toolkit <cite>Developer Reference</cite>. Now that all useful information is available in the
documentation, the <filepath>README.txt</filepath> files have been removed.
<xref href="https://github.com/dita-ot/dita-ot/issues/1860" scope="external" format="html">#1860</xref>
</li>
<li id="1924">PDF: In earlier versions of DITA-OT, filtering out all rows from a
<xmlelement>simpletable</xmlelement> element resulted in invalid XSL-FO. When all rows are filtered out,
the XSL-FO file now contains an empty (but valid) table so that processing can continue.
<xref href="https://github.com/dita-ot/dita-ot/issues/1924" scope="external" format="html">#1924</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/1950" scope="external" format="html">#1950</xref>
</li>
<li id="2122">Guava libraries are now used to simplify access to collections in Java code (among other
things).
<xref href="https://github.com/dita-ot/dita-ot/issues/2122" scope="external" format="html">#2122</xref>
</li>
<li id="2133">HTML: The documentation for the <option>args.hdr</option> and <option>args.ftr</option> options
now clarifies that header and footer files must be specified using an absolute path. The options have always
required an absolute path, but the documentation for earlier releases did not include this requirement.
<xref href="https://github.com/dita-ot/dita-ot/issues/2133" scope="external" format="html">#2133</xref>
</li>
<li id="2140">The <cmdname>dita</cmdname> command will now run using Java headless mode by default. This
optimizes the use of system resources during a build and prevents the build process from stealing focus from
other applications.
<xref href="https://github.com/dita-ot/dita-ot/issues/2140" scope="external" format="html">#2140</xref>
</li>
<li id="2160">HTML: Static text for XHTML tables and figures (such as "Table 5") is now surrounded with a
<xmlelement>span</xmlelement> element, making it easier to style or hide the static text using CSS. In
addition, HTML5 output is updated to use semantic elements for figure and table captions.
<xref href="https://github.com/dita-ot/dita-ot/issues/2160" scope="external" format="html">#2160</xref>
</li>
<li id="2177">Two members of the <codeph>AbstractPipelineModuleImpl</codeph> class have been marked as
protected, to allow plugins to access them from derived classes.
<xref href="https://github.com/dita-ot/dita-ot/issues/2177" scope="external" format="html">#2177</xref>
</li>
<li id="2179">PDF: The I18N Java and XSLT processing code has been merged into single task. This is not
visible to most users of the PDF code, apart from a reduction in processing time. It also eliminates the
need for a <filepath>stage3.fo</filepath> file in the temporary directory; instead,
<filepath>topic.fo</filepath> is generated directly from <filepath>stage2.fo</filepath>.
<xref href="https://github.com/dita-ot/dita-ot/issues/2179" scope="external" format="html">#2179</xref>
</li>
<li id="2181">In a previous release, the HTML5 extension point <codeph>dita.conductor.html5.param</codeph> was
declared but not implemented. The improper declaration was removed and the extension was properly
implemented.
<xref href="https://github.com/dita-ot/dita-ot/issues/2181" scope="external" format="html">#2181</xref>
</li>
<li id="2191">HTML: In previous releases, short descriptions in <xmlelement>abstract</xmlelement> elements
were rendered as division elements (<xmlelement>div</xmlelement>), rather than paragraphs
(<xmlelement>p</xmlelement>). Processing has been revised to ensure that short descriptions are
consistently rendered as paragraphs, regardless of whether they appear in <xmlelement>abstract</xmlelement>
elements.
<xref href="https://github.com/dita-ot/dita-ot/issues/2191" scope="external" format="html">#2191</xref>
</li>
<li id="2207">The order of the <codeph>chunk</codeph> and <codeph>move-meta-entries</codeph> pre-processing
stages has been switched so that <codeph>chunk</codeph> comes first. This ensures that metadata is properly
pulled or pushed into the chunked version of DITA topics.
<xref href="https://github.com/dita-ot/dita-ot/issues/2207" scope="external" format="html">#2207</xref>
</li>
<li id="2217">HTML: The process for handling <xmlatt>othertype</xmlatt> on a <xmlelement>note</xmlelement>
element in HTML has been updated to use XSLT 2.0 best practices.
<xref href="https://github.com/dita-ot/dita-ot/issues/2217" scope="external" format="html">#2217</xref>
</li>
<li id="2229">PDF: Earlier versions used an <xmlelement>fo:inline</xmlelement> element as a link target within
topic titles, which can result in extra white space for certain common customizations. The process now
places an ID on <xmlelement>fo:wrapper</xmlelement>, which removes the extra element and extra white space.
<xref href="https://github.com/dita-ot/dita-ot/issues/2229" scope="external" format="html">#2229</xref>
</li>
<li id="2231">XSLT processing now uses a single parameter for message IDs rather than combining one parameter
for the error number with another parameter for severity. This simplifies message processing and allows a
greater range of message IDs in the future. In addition, the <msgnum>DOTX071W</msgnum> message will display
a warning for customizations that use the older, deprecated parameters.
<xref href="https://github.com/dita-ot/dita-ot/issues/2231" scope="external" format="html">#2231</xref>
</li>
<li id="2233">Common XSLT utility templates have been rewritten as functions. In addition, XSpec tests have
been created so that the functions are now covered by automated DITA-OT testing.
<xref href="https://github.com/dita-ot/dita-ot/issues/2233" scope="external" format="html">#2233</xref>
</li>
<li id="2241">The distribution integration and docs stages of the build process are now run in a forked JVM .
<xref href="https://github.com/dita-ot/dita-ot/issues/2241" scope="external" format="html">#2241</xref>
</li>
<li id="2249">PDF: A reference to the PDF2 catalog has been added to <filepath>catalog-dita.xml</filepath>. In
previous releases, running <filepath>topic2fo_shell.xsl</filepath> directly would fail because the XSLT
processor couldn't resolve paths that use the <codeph>cfg:</codeph> scheme.
<xref href="https://github.com/dita-ot/dita-ot/issues/2249" scope="external" format="html">#2249</xref>
</li>
<li id="2268">The distribution package is now built via a fully automated Continuous Integration process.
<xref href="https://github.com/dita-ot/dita-ot/issues/2268" scope="external" format="html">#2268</xref>
</li>
<li id="2276">HTML5: A new stable ID generation process has been implemented, instead of relying on the
<codeph>generate-id()</codeph> function. By removing reliance on a dynamic value, this change enables
automated testing of <xmlatt>id</xmlatt> and <xmlatt>headers</xmlatt> (generated for table accessibility).
This also speeds up regression testing when comparing HTML output with previous versions.
<xref href="https://github.com/dita-ot/dita-ot/issues/2276" scope="external" format="html">#2276</xref>
</li>
<li id="2277">A new ditaFileset function has been implemented to replace list files. This has no visible
impact for builds, but improves the processing model overall and allows the older way of working with
individual list files to be deprecated in a future release.
<xref href="https://github.com/dita-ot/dita-ot/issues/2277" scope="external" format="html">#2277</xref>
</li>
<li id="2288">The build script for HTMLHelp, <filepath>build_dita2htmlhelp.xml</filepath>, now uses an
environment variable to locate the HTMLHelp compiler. This allows the process to build a CHM file when the
HTML Help Workshop is not installed on the <filepath>C:</filepath> drive.
<xref href="https://github.com/dita-ot/dita-ot/issues/2288" scope="external" format="html">#2288</xref>
</li>
<!-- Unmerged PR, remove 2.3 milestone in GitHub issues tracker (See 2.2.5 #1876, #2313, #2342) -->
<li id="2305">HTML5: new extension points allow for customization of HTML5 output, HTML5 TOC processing, and
HTML5 cover processing. These extension points were declared (but not implemented) in DITA-OT 2.2; this was
addressed in 2.2.5 by removing the declarations. In DITA-OT 2.3, the declarations are restored and properly
implemented.
<xref href="https://github.com/dita-ot/dita-ot/issues/2305" scope="external" format="html">#2305</xref>
</li>
<li id="2341">The <filepath>startcmd</filepath> scripts are now generated by the DITA-OT integration process.
This ensures that the <codeph>CLASSPATH</codeph> setting in the scripts is updated with any new or required
Java libraries referenced by custom plug-ins.
<xref href="https://github.com/dita-ot/dita-ot/issues/2341" scope="external" format="html">#2341</xref>
<note type="important">Users who still run DITA-OT using a custom start script based on a copy of
<filepath>startcmd</filepath> may need to update their script after installing custom plug-ins. The
<codeph>CLASSPATH</codeph> declarations are stored in alphabetical order, so they should only change
when new plug-in libraries are added. To avoid these issues, run DITA-OT using the <cmdname>dita</cmdname>
command instead of the deprecated <filepath>startcmd</filepath> scripts.</note></li>
<li id="2350">PDF: Index group headings now appear in the PDF bookmarks. The new bookmarks will always appear
in collapsed form under the Index heading. For example, a large index that covers every heading in English
will now have bookmarks for "Special characters", "Numerics", and every letter from "A" to "Z". <!-- Supersedes unmerged PR 2149 -->
<xref href="https://github.com/dita-ot/dita-ot/issues/2350" scope="external" format="html">#2350</xref>
</li>
<li id="2382">PDF: The <codeph>antiquewhite</codeph> background color has been removed from table heads and
key column contents in <xmlelement>simpletable</xmlelement> and <xmlelement>properties</xmlelement> tables
to synchronize presentation with <xmlelement>choicetable</xmlelement> and provide a more uniform
customization baseline between PDF output and HTML-based formats.
<xref href="https://github.com/dita-ot/dita-ot/pull/2382" scope="external" format="html">#2382</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2386" scope="external" format="html">#2386</xref>
</li>
<li id="2383">Localization variables that are no longer used in PDF processing have been deprecated and will
be removed in an upcoming release.
<xref href="https://github.com/dita-ot/dita-ot/pull/2383" scope="external" format="html">#2383</xref>
</li>
</ul>
</section>
<section id="bugs">
<title>Bugs</title>
<p>DITA Open Toolkit Release 2.3 provides fixes for the following bugs:</p>
<ul>
<li id="1931">PDF: The message "No topicTitleNumber mode template" has been removed. This removes extraneous
messages that appeared when processing a bookmap with <xmlelement>notices</xmlelement> or
<xmlelement>bookabstract</xmlelement>, or which refers to a subject scheme map.
<xref href="https://github.com/dita-ot/dita-ot/issues/1931" scope="external" format="html">#1931</xref>
</li>
<li id="2065">HTML: trademark symbols previously only appeared for <xmlelement>tm</xmlelement> elements in
English and a select few languages. This was a legacy of processing carried over from beta processing before
DITA-OT 1.0; HTML trademark processing will now work the same regardless of document language.
<xref href="https://github.com/dita-ot/dita-ot/issues/2065" scope="external" format="html">#2065</xref>
</li>
<li id="2141">Processing for <xmlelement>coderef</xmlelement> elements could be broken when the
<xmlelement>coderef</xmlelement> was part of a larger section reused by conref. This is fixed by resolving
<xmlelement>coderef</xmlelement> during the <codeph>topic-fragment</codeph> step of preprocessing.
<xref href="https://github.com/dita-ot/dita-ot/issues/2141" scope="external" format="html">#2141</xref>
</li>
<li id="2161">The AXF document-info attribute <xmlatt>title</xmlatt> is deprecated; XSL-FO output for Antenna
House output should use the <xmlatt>document-title</xmlatt> attribute instead.
<xref href="https://github.com/dita-ot/dita-ot/issues/2161" scope="external" format="html">#2161</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2162" scope="external" format="html">#2162</xref>
</li>
<li id="2190">When using keys, referencing a file outside of the current directory causes processing to fail.
Previously, the target file URI was resolved against the root of the temp directory. This has been updated
to resolve the URI against the source file URI, which should always yield the correct result.
<xref href="https://github.com/dita-ot/dita-ot/issues/2190" scope="external" format="html">#2190</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2223" scope="external" format="html">#2223</xref>
</li>
<li id="2197">In previous releases, specializations of the <xmlelement>link</xmlelement> element did not work
as intended. The corresponding XSLT template mode <codeph>related-links:link</codeph> has been modified to
properly handle new elements that are based on the <xmlelement>link</xmlelement> element.
<xref href="https://github.com/dita-ot/dita-ot/issues/2197" scope="external" format="html">#2197</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2199" scope="external" format="html">#2199</xref>
</li>
<li id="2227">Circular key definitions, when an element used <xmlatt>keyref</xmlatt> to refer to a key on the
same element, resulted in a stack overflow in KeydefReader. This construct is now reported as an error with
message <msgnum>DOTJ069E</msgnum>.
<xref href="https://github.com/dita-ot/dita-ot/issues/2227" scope="external" format="html">#2227</xref>
</li>
<!-- Cherry-picked fixes released as workaround with 2.2.4 (see #2274). -->
<li id="2243">Publishing failed when using <xmlelement>term</xmlelement> with keyref and chunking, as the
chunking module created file references with backslashes. Processing has been updated to convert any
backslashes to slashes before using the <codeph>resolve-uri</codeph> function in XSLT. This ensures that the
attribute values are valid URI references according to
<xref keyref="rfc3986"/>.
<xref href="https://github.com/dita-ot/dita-ot/issues/2243" scope="external" format="html">#2243</xref>
</li>
<li id="2294">PDF: In the simplified Chinese variables file (zh-CN), additional translations have been
provided for some static strings that previously appeared in English.
<xref href="https://github.com/dita-ot/dita-ot/issues/2294" scope="external" format="html">#2294</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2353" scope="external" format="html">#2353</xref>
</li>
<li id="2304">Resource-only topic references were considered duplicates by key processing, resulting in
renamed output files in some cases. The resource-only instances are now ignored when determining whether to
rename output files.
<xref href="https://github.com/dita-ot/dita-ot/issues/2304" scope="external" format="html">#2304</xref>
</li>
<li id="2326">PDF code was cleaned up to remove a broken message that could not be triggered
<xref href="https://github.com/dita-ot/dita-ot/issues/2326" format="html" scope="external">#2326</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2351" scope="external" format="html">#2351</xref>
</li>
<li id="2339">In previous releases, specifying a <xmlatt>keyscope</xmlatt> attribute on the root
<xmlelement>map</xmlelement> element would cause builds to fail. Processing has been modified to handle
this situation correctly.
<xref href="https://github.com/dita-ot/dita-ot/issues/2339" scope="external" format="html">#2339</xref>
</li>
</ul>
</section>
<section id="contrib">
<title>Contributors</title>
<p>DITA Open Toolkit Release 2.3 includes
<xref keyref="contributions"/> by the following people:</p>
<!-- https://github.com/tj/git-extras/blob/master/Commands.md#git-summary – `git summary 2.2..` -->
<ol>
<li>Jarno Elovirta</li>
<li>Robert D. Anderson</li>
<li>Eero Helenius</li>
<li>Roger Sheen</li>
<li>Eliot Kimber</li>
<li>Radu Coravu</li>
<li>Shane Taylor</li>
<li>Stefan Eike</li>
<li>George Bina</li>
<li>Kristen James Eberlein</li>
</ol>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/2.2...2.3" scope="external" format="html">
changelog</xref> on GitHub.</p>
</section>
<section id="docs">
<title>Documentation updates</title>
<p>The documentation for DITA Open Toolkit Release 2.3 includes corrections and improvements to existing topics,
along with several notable enhancements, including:</p>
<ul>
<li>The DITA Open Toolkit <cite>User Guide</cite> includes new topics on additional methods of publishing via
the <cmdname>dita</cmdname> command:
<ul>
<li>
<xref keyref="using-dita-properties-file"/>
</li>
<li>
<xref keyref="migrating-ant-to-dita"/>
</li>
</ul>
</li>
<li>The DITA Open Toolkit <cite>Developer Reference</cite> includes several new sections dedicated to
customization:
<ul>
<li>
<xref keyref="pdf-customization"/> provides an overview of approaches commonly used to customize the
default PDF output and includes recommendations on best practices and additional resources.</li>
<li>
<xref keyref="migration"/> highlights customization-related changes in recent releases to assist plug-in
developers in updating overrides to work with the latest toolkit versions.</li>
</ul>
</li>
<li>
<p>
<xref href="https://travis-ci.org/" format="html" scope="external">Travis CI</xref> continuous integration
is used to automatically publish the latest development version of the documentation on the project
website at
<xref href="http://www.dita-ot.org/dev/" format="html" scope="external">dita-ot.org/dev</xref> whenever
changes are pushed to the <codeph>develop</codeph> branch of the
<xref href="https://github.com/dita-ot/docs" format="html" scope="external">dita-ot/docs</xref> repository
on GitHub.</p></li>
<li>
<p>In the latest
<xref href="http://www.dita-ot.org/dev/" format="html" scope="external">development version</xref> of the
documentation, page footers now include <uicontrol>Edit this page</uicontrol> links that open the DITA
source file for the topic in
<xref href="https://www.oxygenxml.com/webauthor/" format="html" scope="external">oXygen XML Web
Author</xref>.</p>
<p>The web-based authoring workflow prompts users to log in to GitHub and fork the
<xref href="https://github.com/dita-ot/docs" format="html" scope="external">dita-ot/docs</xref> repository
if necessary. Changes saved in the authoring environment are committed to a new branch, and a pull request
is created to submit changes for review by the DITA-OT documentation team.</p>
</li>
</ul>
<p>For additional information on documentation issues resolved in DITA Open Toolkit Release 2.3, see the
<xref href="https://github.com/dita-ot/docs/issues?q=milestone%3A2.3+is%3Aclosed" format="html"
scope="external">2.3 milestone</xref> in the documentation repository.</p>
<p>For the complete list of documentation changes since the previous release, see the
<xref href="https://github.com/dita-ot/docs/compare/2.2...2.3" scope="external" format="html">
changelog</xref>.</p>
</section>
</refbody>
</reference>
</reference>

594
dita-ot-3.6/docsrc/release-notes/rel2.4.dita Normal file
View file

@ -0,0 +1,594 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
<reference id="ID" rev="2.4">
<title>DITA Open Toolkit 2.4.6 Release Notes</title>
<abstract>
<shortdesc>DITA Open Toolkit 2.4.6 is a maintenance release that fixes issues reported in DITA-OT 2.4, which
includes <ph conref="#highlights/summary"/>.</shortdesc>
<p>Issue numbers correspond to the tracking number in the <ph>
<xref keyref="dita-ot-issues">GitHub issues tracker</xref></ph>.</p>
</abstract>
<reference id="v246">
<title>Maintenance Release 2.4.6</title>
<refbody>
<section>
<p>DITA Open Toolkit Release 2.4.6 includes the following bug fixes.</p>
<ul>
<li id="2212">
<p>Earlier versions of DITA-OT would fail with XSLT errors when processing invalid table markup.</p>
<p>The toolkit is now more lenient when handling column settings that do not match the table contents,
including:
<ul>
<li><xmlelement>table</xmlelement> elements that contain incorrect <xmlelement>colspec</xmlelement>
entries</li>
<li><xmlelement>tgroup</xmlelement> elements with incorrect <xmlatt>cols</xmlatt> attribute values</li>
<li><xmlelement>simpletable</xmlelement> elements with invalid <xmlatt>relcolwidth</xmlatt>
attributes</li>
<li><xmlelement>sthead</xmlelement> header rows with the wrong number of cells</li>
</ul></p>
<p>Processing will now continue in these cases, though output may not be generated entirely as expected.
<xref href="https://github.com/dita-ot/dita-ot/issues/2212" scope="external" format="html">#2212</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2651" scope="external" format="html">#2651</xref>
</p>
</li>
<li id="2549">DITA-OT 2.4 failed to process maps with multiple references to a single topic file that contains
key references. Processing has been revised to properly handle duplicate topics within key scopes.
<xref href="https://github.com/dita-ot/dita-ot/issues/2549" scope="external" format="html">#2549</xref>
</li>
<li id="2650">Several XSL stylesheets used incorrect <xmlatt>extension-element-prefixes</xmlatt> attributes,
which have been replaced with <xmlatt>exclude-result-prefixes</xmlatt> to ensure no unnecessary namespace
nodes are copied to the result tree.
<xref href="https://github.com/dita-ot/dita-ot/issues/2650" scope="external" format="html">#2650</xref>
</li>
<li>
<p>The documentation includes minor
<xref href="https://github.com/dita-ot/docs/compare/2.4.5...2.4.6" scope="external" format="html">
changes</xref> with
<xref href="https://github.com/dita-ot/docs/milestone/24?closed=1" scope="external" format="html"
>corrections and improvements</xref> to existing topics.</p>
</li>
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/2.4.5...2.4.6" scope="external" format="html">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v245">
<title>Maintenance Release 2.4.5</title>
<refbody>
<section>
<p>DITA Open Toolkit Release 2.4.5 includes the following bug fixes.</p>
<ul>
<li id="2559">DITA-OT 2.4 reported errors when filtering HTML5 output with a DITAVAL file and failed to
preserve attributes that were set to <option>passthrough</option> via the <xmlatt>action</xmlatt> attribute.
The order in which properties are initialized has been corrected and profiling conditions are now propagated
to corresponding <xmlatt>data-</xmlatt> attributes in HTML5 output to support filtering.
<xref href="https://github.com/dita-ot/dita-ot/issues/2559" scope="external" format="html">#2559</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2598" scope="external" format="html">#2598</xref>, <!--
<xref href="https://github.com/dita-ot/dita-ot/pull/2611" scope="external" format="html">#2611</xref>-->
<xref href="https://github.com/dita-ot/dita-ot/issues/2627" scope="external" format="html">#2627</xref>
</li>
<li id="2567">Remaining XHTML property references in the HTML5 transformation have been corrected to point to
their HTML5 equivalents.
<xref href="https://github.com/dita-ot/dita-ot/issues/2567" scope="external" format="html">#2567</xref>
</li>
<li id="2570">In DITA-OT 2.4, the HTML5 transformation failed to process topics with tables when the
<parmname>args.html5.classattr</parmname> parameter was set to <option>no</option>. Processing has been
updated to ensure that tables are handled correctly when the DITA class ancestry is not passed to output.
<xref href="https://github.com/dita-ot/dita-ot/issues/2570" scope="external" format="html">#2570</xref>
</li>
<li id="2622">The HTML5 transformation has been updated to preserve the <xmlatt>class</xmlatt> attribute on
ordered lists when <xmlelement>steps</xmlelement> contain a <xmlelement>stepsection</xmlelement> element.
<xref href="https://github.com/dita-ot/dita-ot/issues/2622" scope="external" format="html">#2622</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2631" scope="external" format="html">#2631</xref>
</li>
<li id="2623">Earlier versions of DITA-OT ignored any <xmlelement>navref</xmlelement> and
<xmlelement>anchor</xmlelement> elements that were declared as direct children of referenced submaps. The
map reference implementation has been updated to preserve these elements as-is when resolving nested maps.
<xref href="https://github.com/dita-ot/dita-ot/issues/2623" scope="external" format="html">#2623</xref>
</li>
<li id="2628">HTML5 processing has been corrected to respect the <parmname>args.outext</parmname> setting.
<xref href="https://github.com/dita-ot/dita-ot/issues/2628" scope="external" format="html">#2628</xref>
</li>
<li id="2629">The Finnish translations for attention and warning notes have been corrected to “Huomio” and
“Varoitus”, respectively.
<xref href="https://github.com/dita-ot/dita-ot/issues/2629" scope="external" format="html">#2629</xref>
</li>
<li id="2636">DITA-OT 2.4.4 introduced a regression that prevented table cells from spanning multiple columns.
Table processing has been corrected to produce the proper table structure.
<xref href="https://github.com/dita-ot/dita-ot/issues/2636" scope="external" format="html">#2636</xref>
</li>
<li>
<p>The documentation includes minor
<xref href="https://github.com/dita-ot/docs/compare/2.4.4...2.4.5" scope="external" format="html">
changes</xref> with
<xref href="https://github.com/dita-ot/docs/milestone/23?closed=1" scope="external" format="html"
>corrections and improvements</xref> to existing topics.</p>
</li>
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/2.4.4...2.4.5" scope="external" format="html">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v244">
<title>Maintenance Release 2.4.4</title>
<refbody>
<section>
<p>DITA Open Toolkit Release 2.4.4 includes the following bug fixes.</p>
<ul>
<li id="2564">DITA-OT 2.4 threw errors if non-XML DITA topics (such as Markdown files) were referenced in DITA
maps. The source format information is now retained to ensure these topics are processed correctly when the
<xref href="https://github.com/jelovirt/dita-ot-markdown" format="html" scope="external">DITA-OT Markdown
plug-in</xref> is installed.
<xref href="https://github.com/dita-ot/dita-ot/issues/2564" scope="external" format="html">#2564</xref>
</li>
<li id="2573">In HTML5 transformations, DITA-OT 2.4 threw XSLT warnings if a topic included copyright metadata
in the prolog. The redundant templates have been removed to ensure that copyright metadata is correctly
processed.
<xref href="https://github.com/dita-ot/dita-ot/issues/2573" scope="external" format="html">#2573</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2574" scope="external" format="html">#2574</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2610" scope="external" format="html">#2610</xref>
</li>
<li id="2577">In earlier versions of DITA-OT, the HTML5 transformation generated an empty
<xmlelement>nav</xmlelement> element for table-of-contents navigation when the
<parmname>nav-toc</parmname> parameter was set to <option>partial</option> and the <xmlatt>chunk</xmlatt>
attribute for a topic reference was set <option>to-content</option>. Processing has been updated to produce
valid navigation links with to-content chunks.
<xref href="https://github.com/dita-ot/dita-ot/issues/2577" scope="external" format="html">#2577</xref>
<xref href="https://github.com/dita-ot/dita-ot/pull/2578" scope="external" format="html">#2578</xref>
</li>
<li id="2584">If an index term was defined in a map, a redundant empty citation was created in the index when
generating PDF output with Apache FOP. Index processing has been revised to ensure that links to index terms
defined in maps work properly for FOP.
<xref href="https://github.com/dita-ot/dita-ot/issues/2584" scope="external" format="html">#2584</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2589" scope="external" format="html">#2589</xref>
</li>
<li id="2586">When reading the <filepath>local.properties</filepath> file, the Ant <codeph>basedir</codeph>
property is set to the root directory of the DITA-OT installation. This change ensures that the
<filepath>local.properties</filepath> file in the installation directory can be read consistently, even in
cases when custom build scripts override the <codeph>basedir</codeph> property beforehand.
<xref href="https://github.com/dita-ot/dita-ot/issues/2586" scope="external" format="html">#2586</xref>
</li>
<li id="2602">When generating PDF output, earlier versions of DITA-OT applied the
<xmlatt>keep-with-next.within-line</xmlatt> attribute to list item labels, which is not valid on
<xmlelement>fo:list-item-label</xmlelement> formatting objects. The list label attribute sets have been
revised to generate valid XSL:FO output.
<xref href="https://github.com/dita-ot/dita-ot/issues/2602" scope="external" format="html">#2602</xref>
</li>
<li id="2603">Parameter processing in variable resolution has been adjusted to ensure that nested
<xmlelement>param</xmlelement> elements are taken into account when parameters are passed as a document
node.
<xref href="https://github.com/dita-ot/dita-ot/issues/2603" scope="external" format="html">#2603</xref>
</li>
<li id="2605">The command-line help and documentation for the <cmdname>dita</cmdname> command mistakenly
included the equals sign in the descriptions of the <option>--install</option> and
<option>--uninstall</option> options. The correct syntax separates these options from their values with a
space instead. To install a single plug-in from a local ZIP file, for example, use
<cmdname>dita</cmdname> <parmname>--install</parmname> <varname>filename</varname>.
<xref href="https://github.com/dita-ot/dita-ot/issues/2605" scope="external" format="html">#2605</xref>
</li>
<li>
<p>The documentation includes minor
<xref href="https://github.com/dita-ot/docs/compare/2.4.3...2.4.4" scope="external" format="html">
changes</xref> with
<xref href="https://github.com/dita-ot/docs/milestone/22?closed=1" scope="external" format="html"
>corrections and improvements</xref> to existing topics.</p>
</li>
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/2.4.3...2.4.4" scope="external" format="html">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v243">
<title>Maintenance Release 2.4.3</title>
<refbody>
<section>
<p>DITA Open Toolkit Release 2.4.3 includes the following bug fixes.</p>
<ul>
<li id="1525">In PDF output generated with earlier versions of DITA-OT and RenderX XEP, the
<xmlelement>indexterm</xmlelement> hierarchy for multilevel entries in the PDF index was not properly
indented. Index term indentation has been corrected to properly reflect the entry hierarchy as authored in
DITA source files.
<xref href="https://github.com/dita-ot/dita-ot/issues/1525" scope="external" format="html">#1525</xref>
</li>
<li id="2038">In earlier versions of DITA-OT, specifying a relative path for the temporary directory on the
command line would cause PDF processing to fail. DITA-OT now checks whether the
<parmname>dita.temp.dir</parmname> property is set to an absolute path and responds with an error message
otherwise.
<xref href="https://github.com/dita-ot/dita-ot/issues/2038" scope="external" format="html">#2038</xref>
</li>
<li id="2522">In certain cases, DITA-OT 2.4 generated broken links in PDF output for related topics and
reported “unresolved internal destination” warnings in the console when processing topic references with the
<xmlatt>collection-type</xmlatt> attribute set to <option>family</option>. Link rewrite processing has
been corrected to ensure that links are generated properly.
<xref href="https://github.com/dita-ot/dita-ot/issues/2522" scope="external" format="html">#2522</xref>
</li>
<li id="2555">Default settings for several parameters have been removed from the
<filepath>configuration.properties</filepath> file.
<xref href="https://github.com/dita-ot/dita-ot/issues/2555" scope="external" format="html">#2555</xref>
<p>Values for these parameters can be passed as usual to the <cmdname>dita</cmdname> command or included in
build scripts:
<ul>
<li><parmname>default.language</parmname></li>
<li><parmname>generate-debug-attributes</parmname></li>
<li><parmname>processing-mode</parmname></li>
</ul></p>
</li>
<li id="2563">In previous versions of DITA-OT, the HTML5 transformation generated
<xmlelement>simpletable</xmlelement> output with column widths specified in <xmlelement>col</xmlelement>
elements as direct children of the <xmlelement>table</xmlelement> element. A
<xmlelement>colgroup</xmlelement> wrapper element has been added for compatibility with the HTML5
standard.
<xref href="https://github.com/dita-ot/dita-ot/issues/2563" scope="external" format="html">#2563</xref>
</li>
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/2.4.2...2.4.3" scope="external" format="html">
changelog</xref> on GitHub.</p>
</section>
<section>
<title>Documentation updates</title>
<p>The DITA-OT 2.4.3 documentation includes corrections and improvements to existing topics, along with new
content on
<xref keyref="configuration-properties"/>.</p>
</section>
</refbody>
</reference>
<reference id="v242">
<title>Maintenance Release 2.4.2</title>
<refbody>
<section>
<p>DITA Open Toolkit Release 2.4.2 includes the following bug fixes.</p>
<ul>
<li id="1885">DITA-OT 2.0 threw a null pointer exception when producing Eclipse Help output from a bookmap
with a <xmlelement>glossarylist</xmlelement> that referenced a composite <xmlelement>dita</xmlelement>
topic. Processing has been updated to properly handle root <xmlelement>dita</xmlelement> elements or any
other elements without <xmlatt>class</xmlatt> attributes.
<xref href="https://github.com/dita-ot/dita-ot/issues/1885" scope="external" format="html">#1885</xref>
</li>
<li id="2542">HTML5 output generated with DITA-OT 2.4.1 included spurious namespace attributes for
<xmlelement>taskbody</xmlelement> and <xmlelement>simpletable</xmlelement> elements. The extra result
prefixes (<xmlnsname>ditamsg</xmlnsname>, <xmlnsname>dita2html</xmlnsname> and
<xmlnsname>related-links</xmlnsname>) have been excluded to ensure they no longer appear in output files.
<xref href="https://github.com/dita-ot/dita-ot/issues/2542" scope="external" format="html">#2542</xref>
</li>
<li id="2547">Earlier versions of DITA-OT failed to ignore empty props specialization attributes during the
filtering process. Processing has been updated to treat any empty attributes specialized from
<xmlatt>props</xmlatt> like empty default profiling attributes such as
<xmlatt>audience</xmlatt><codeph>=""</codeph>, which are ignored.
<xref href="https://github.com/dita-ot/dita-ot/issues/2547" scope="external" format="html">#2547</xref>
</li>
<li id="2548">The <codeph>xml-apis-ext</codeph> library that FOP depends on to render SVG images was missing
in DITA-OT 2.4. The distribution package has been updated to provide support for SVG images in PDF output.
<xref href="https://github.com/dita-ot/dita-ot/issues/2548" scope="external" format="html">#2548</xref>
</li>
<li id="2551">If an input map contained topic references with duplicate <xmlatt>copy-to</xmlatt> attribute
values, earlier versions of DITA-OT failed to generate additional output topics. Processing now applies the
<parmname>force-unique</parmname> parameter to ensure that unique output files are created for each
instance of a resource when a map contains multiple references to a single topic.
<xref href="https://github.com/dita-ot/dita-ot/issues/2551" scope="external" format="html">#2551</xref>
</li>
<li id="2554">Support for the <parmname>args.breadcrumbs</parmname> parameter provided in earlier versions of
DITA-OT was never fully implemented and has been removed. HTML customizations that rely on the XSLT
<parmname>BREADCRUMBS</parmname> parameter will need to re-implement this functionality in custom plug-in
code.
<xref href="https://github.com/dita-ot/dita-ot/issues/2554" scope="external" format="html">#2554</xref>
</li>
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/2.4.1...2.4.2" scope="external" format="html">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v241">
<title>Maintenance Release 2.4.1</title>
<refbody>
<section>
<p>DITA Open Toolkit Release 2.4.1 includes the following bug fixes.</p>
<ul>
<li id="2520">In DITA-OT 2.3 and 2.4, setting the <parmname>force-unique</parmname> parameter to
<option>true</option> had no effect. Processing has been corrected to properly generate the copy-to
attributes that ensure unique file names for each instance of a resource when a map contains multiple
references to a single topic.
<xref href="https://github.com/dita-ot/dita-ot/issues/2520" scope="external" format="html">#2520</xref>
</li>
<li id="2524">HTML5: In DITA-OT 2.4, the text content of table cells was partially propagated to the CSS
<xmlatt>class</xmlatt> attribute. Table processing has been updated to remove the legacy XHTML CSS class
mode and ensure that <xmlatt>class</xmlatt> attribute values are generated correctly.
<xref href="https://github.com/dita-ot/dita-ot/issues/2524" scope="external" format="html">#2524</xref>
</li>
<li id="2526">Saxon 9.7.0.11 reported an error when producing output from DITA content: <msgph>The context
item for axis step ./@class is absent</msgph>. This was resolved by modifying the
<codeph>$localclass</codeph> variable in the <codeph>output-message</codeph> template to use the
<codeph>$ctx</codeph> context variable as a parent.
<xref href="https://github.com/dita-ot/dita-ot/issues/2526" scope="external" format="html">#2526</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2535" scope="external" format="html">#2535</xref>
</li>
<li id="2529">Earlier versions of DITA-OT did not correctly override the default <xmlatt>scope</xmlatt> and
<xmlatt>format</xmlatt> attribute values for topic references with values from the key definition. Keyref
processing has been updated to properly handle scope and format definition for non-local non-DITA targets.
<xref href="https://github.com/dita-ot/dita-ot/issues/2529" scope="external" format="html">#2529</xref>
</li>
<li id="2537">In earlier versions of DITA-OT, the <codeph>dita.xsl.html5.cover</codeph> extension point did
not respond to overrides declared in custom plug-ins. The extension point has now been moved to the template
file to ensure that it can be overridden as intended.
<xref href="https://github.com/dita-ot/dita-ot/issues/2537" scope="external" format="html">#2537</xref>
</li>
<li id="2539">In cases where a single topic is used in multiple key scopes (and copies of the topic are
created), earlier versions of DITA-OT used the same target for key references to both key scopes. Key
targets are now rewritten to point to the new resource to ensure that duplicate link targets in key scopes
are correctly resolved.
<xref href="https://github.com/dita-ot/dita-ot/issues/2539" scope="external" format="html">#2539</xref>
</li>
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/2.4...2.4.1" scope="external" format="html">
changelog</xref> on GitHub.</p>
</section>
<section>
<title>Documentation updates</title>
<p>The DITA-OT 2.4.1 documentation includes corrections and improvements to existing topics, along with new
content.</p>
<ul>
<li>
<xref keyref="html-customization"/> provides examples that illustrate various approaches for customizing
HTML-based output, including:
<ul>
<li>
<xref keyref="html-customization-navigation"/></li>
<li>
<xref keyref="html-customization-plugin-bundle-css"/></li>
</ul>
</li>
<li>
<xref keyref="languages"/> provides a common overview of languages supported for PDF and HTML-based output
formats.</li>
<li>
<xref keyref="third-party-software"/> lists bundled software components with version and license information
for each library.</li>
</ul>
</section>
</refbody>
</reference>
<reference id="requirements">
<title>Requirements</title>
<refbody>
<section>
<draft-comment author="Roger">Add info on new minimum Java version or any other requirements that have changed
since previous release.</draft-comment>
<p>DITA Open Toolkit Release 2.4 requires the Java Runtime Environment (JRE) version <keyword
keyref="tool.java.version"/> or later.</p>
</section>
</refbody>
</reference>
<reference id="highlights">
<title>Release Highlights</title>
<shortdesc>DITA-OT 2.4 includes <ph id="summary">Apache FOP <ph keyref="tool.fop.version"/>, a new long-form syntax
for <cmdname>dita</cmdname> command options, and additional code referencing extensions</ph>.</shortdesc>
<refbody>
<section id="1958">
<title>Apache FOP <ph keyref="tool.fop.version"/></title>
<p>DITA-OT 2.4 bundles the latest version of <tm trademark="Apache" tmtype="tm">Apache</tm> FOP (Formatting
Objects Processor).
<xref href="https://github.com/dita-ot/dita-ot/issues/1958" scope="external" format="html">#1958</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2399" scope="external" format="html">#2399</xref></p>
<p>FOP <ph keyref="tool.fop.version"/> builds on the OpenType CFF font support added in FOP 2.0, with additional
font support and enhancements for PDF accessibility, including PDF/UA (PDF/Universal Accessibility) and
PDF/A-3.</p>
<p>For details on recent changes in FOP, see the <cite>Release Notes</cite> for versions
<xref keyref="fop-20-rn">2.0</xref> and
<xref keyref="fop-20-rn">2.1</xref>.</p>
<note>
<p>To conserve memory, accessible PDF output is disabled by default in FOP 2.1. To generate accessible PDFs
from DITA-OT, set the <parmname>args.fo.userconfig</parmname> parameter and include the
<option>&lt;accessibility>true&lt;/accessibility></option> option in your custom FOP configuration
file.</p>
<p>For more information, see
<xref keyref="fop-accessibility"/>.</p>
</note>
</section>
<section id="2422">
<title>New long-form syntax for <cmdname>dita</cmdname> command options</title>
<p>All <cmdname>dita</cmdname> command options can now be specified with a GNU-style option keyword preceded by
two hyphens. For example:</p>
<p>
<codeblock><cmdname>dita</cmdname> <parmname>--input</parmname>=<filepath>userguide.ditamap</filepath> <parmname>--format</parmname>=<option>html5</option></codeblock>
</p>
<p>DITA-OT parameters can now be passed to the <cmdname>dita</cmdname> command with this same syntax:
<parmname>--parameter</parmname>=<varname>value</varname>.</p>
<p>When set with this method, properties are validated against the toolkit’s plug-in configuration. An error
message appears if a property is not recognized or if an enumerated property value is invalid.
<xref href="https://github.com/dita-ot/dita-ot/issues/2422" scope="external" format="html">#2422</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2492" scope="external" format="html">#2492</xref>
<note type="attention">Unix-style single-letter options (preceded by a single hyphen) are also available in
some cases for backwards compatibility. The X-Toolkit–style single-hyphen keyword variants supported by
previous releases (such as <parmname>-input</parmname>) have been deprecated and may be removed in an
upcoming release.</note></p>
</section>
<section id="2469">
<title>Extended code reference processing</title>
<p>DITA-OT 2.4 provides additional support for extracting a range of lines from code references based on the
content of the target file. Instead of specifying line numbers, you can now also select lines to include in
the code reference by specifying keywords (or “<term>tokens</term>”) that appear in the referenced file.
<xref href="https://github.com/dita-ot/dita-ot/pull/2469" scope="external" format="html">#2469</xref>
</p>
<div conref="../reference/extended-functionality.dita#code-reference/coderef-by-content"/>
<note conref="../reference/extended-functionality.dita#code-reference/coderef-by-content-tip"/>
<p>For more information, see
<xref href="../reference/extended-functionality.dita#code-reference"/>.</p>
</section>
<section id="2405">
<title>Standalone <option>HTML5</option> plug-in</title>
<div conref="../reference/migrating-to-2.4.dita#migrating-to-2.4/24-html5-split"/>
<p>
<xref href="https://github.com/dita-ot/dita-ot/pull/2405" scope="external" format="html">#2405</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2511" scope="external" format="html">#2511</xref>
</p>
</section>
<section id="1542" conref="../reference/migrating-to-2.4.dita#migrating-to-2.4/24-legacy-plugin-removal"/>
<section>
<p>
<xref href="https://github.com/dita-ot/dita-ot/issues/1542" scope="external" format="html">#1542</xref></p>
</section>
</refbody>
</reference>
<reference id="issues">
<title>Resolved issues</title>
<shortdesc>In addition to the highlights mentioned above, DITA Open Toolkit Release 2.4 includes the following
changes.</shortdesc>
<refbody>
<!--
<section id="features">
<title>Features</title>
<p>DITA Open Toolkit Release 2.4 includes the following new features:</p>
<ul>
<li/>
</ul>
</section>
-->
<section id="enhancements">
<title>Enhancements and changes</title>
<p>DITA Open Toolkit Release 2.4 includes the following enhancements and changes to existing features:</p>
<ul>
<li id="2026">Move to Java 8
<xref href="https://github.com/dita-ot/dita-ot/issues/2026" scope="external" format="html">#2026</xref>
</li>
<li id="1245">TM output
<xref href="https://github.com/dita-ot/dita-ot/issues/1245" scope="external" format="html">#1245</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2404" scope="external" format="html">#2404</xref>
</li>
<li id="2512">Bug in "dita-utilities.xsl" getVariable when called from string context
<xref href="https://github.com/dita-ot/dita-ot/issues/2512" scope="external" format="html">#2512</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2513" scope="external" format="html">#2513</xref>
</li>
<li id="2503">HTML5 generates duplicate class attributes
<xref href="https://github.com/dita-ot/dita-ot/issues/2503" scope="external" format="html">#2503</xref>
</li>
<li id="2502">Use Sass <codeph>// comment</codeph> syntax for partials copyrights
<xref href="https://github.com/dita-ot/dita-ot/issues/2502" scope="external" format="html">#2502</xref>
</li>
<li id="2499">Change HTML5 to use libsass instead of Compass
<xref href="https://github.com/dita-ot/dita-ot/issues/2499" scope="external" format="html">#2499</xref>
</li>
<li id="2471">Add sign-off requirement to contribution
<xref href="https://github.com/dita-ot/dita-ot/issues/2471" scope="external" format="html">#2471</xref>
</li>
<li id="2467">Add copyright based on Git history
<xref href="https://github.com/dita-ot/dita-ot/issues/2467" scope="external" format="html">#2467</xref>
</li>
<li id="2465">Run dita command with only properties file
<xref href="https://github.com/dita-ot/dita-ot/issues/2465" scope="external" format="html">#2465</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2468" scope="external" format="html">#2468</xref>
</li>
<li id="2462">Map temporary files to source/result files using job configuration
<xref href="https://github.com/dita-ot/dita-ot/issues/2462" scope="external" format="html">#2462</xref>
</li>
<li id="2453">Use job mapper when transforming topics to final output
<xref href="https://github.com/dita-ot/dita-ot/issues/2453" scope="external" format="html">#2453</xref>
</li>
<li id="2437">Move chunk target detection to chunk module
<xref href="https://github.com/dita-ot/dita-ot/issues/2437" scope="external" format="html">#2437</xref>
</li>
<!--
<li id="2419">Drop empty fo:inline elements
<xref href="https://github.com/dita-ot/dita-ot/issues/2419" scope="external" format="html">#2419</xref>
</li>
-->
<li id="2412">Replace named template with mode for easy override of static content
<xref href="https://github.com/dita-ot/dita-ot/issues/2412" scope="external" format="html">#2412</xref>
</li>
<li id="2151">Remove lax integration process
<xref href="https://github.com/dita-ot/dita-ot/issues/2151" scope="external" format="html">#2151</xref>
</li>
</ul>
</section>
<section id="bugs">
<title>Bugs</title>
<p>DITA Open Toolkit Release 2.4 provides fixes for the following bugs:</p>
<ul>
<li id="2394">Fix error when <xmlelement>linktext</xmlelement> contains <xmlelement>tm</xmlelement> #2303
<xref href="https://github.com/dita-ot/dita-ot/pull/2394" scope="external" format="html">#2394</xref>
</li>
<li id="2347">Build fails when <xmlelement>navtitle</xmlelement> in <xmlelement>relcell</xmlelement> has child
elements
<xref href="https://github.com/dita-ot/dita-ot/issues/2347" scope="external" format="html">#2347</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2390" scope="external" format="html">#2390</xref>
</li>
</ul>
</section>
<section id="contrib">
<title>Contributors</title>
<p>DITA Open Toolkit Release 2.4 includes
<xref keyref="contributions"/> by the following people:</p>
<!-- https://github.com/tj/git-extras/blob/master/Commands.md#git-summary – `git summary 2.3..` -->
<draft-comment author="Roger">NOTE: This lists contributions to the core toolkit, not docs.</draft-comment>
<ol>
<li>Jarno Elovirta</li>
<li>Robert D. Anderson</li>
<li>Eliot Kimber</li>
<li>Eero Helenius</li>
<li>Roger Sheen</li>
<li>Radu Coravu</li>
</ol>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/2.3...2.4" scope="external" format="html">
changelog</xref> on GitHub.</p>
</section>
<section id="docs">
<title>Documentation updates</title>
<p>The documentation for DITA Open Toolkit Release 2.4 includes corrections and improvements to existing topics,
along with new content.</p>
<ul>
<li>Like the generated
<xref keyref="dita-ot-params"/> and
<xref keyref="messages"/> topics, a new
<xref keyref="extension-points-by-plugin"/> section is now generated from the installed DITA-OT plug-ins to
provide an overview of the extension points supported by each plug-in.</li>
<li>A new
<xref keyref="features-in-docs"/> topic provides examples of how the project documentation uses various
recent DITA features.</li>
<li>A new topic provides information on
<xref keyref="migrating-to-2-4">Migrating to release 2.4</xref>.</li>
</ul>
<p>For additional information on documentation issues resolved in DITA Open Toolkit Release 2.4, see the
<xref href="https://github.com/dita-ot/docs/issues?q=milestone%3A2.4+is%3Aclosed" format="html"
scope="external">2.4 milestone</xref> in the documentation repository.</p>
<p>DITA Open Toolkit Release 2.4 includes
<xref keyref="docs-contributions"/> by the following people:</p>
<draft-comment author="Roger">NOTE: This lists contributions to docs, not to the core toolkit.</draft-comment>
<ol>
<li>Roger Sheen</li>
<li>Jarno Elovirta</li>
<li>Mark Giffin</li>
</ol>
<p>For the complete list of documentation changes since the previous release, see the
<xref href="https://github.com/dita-ot/docs/compare/2.3...2.4" scope="external" format="html">
changelog</xref>.</p>
</section>
</refbody>
</reference>
</reference>

619
dita-ot-3.6/docsrc/release-notes/rel2.5.dita Normal file
View file

@ -0,0 +1,619 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
<reference id="ID" rev="2.5">
<title>DITA Open Toolkit 2.5.4 Release Notes</title>
<abstract>
<shortdesc>DITA Open Toolkit 2.5.4 is a maintenance release that fixes issues
reported in DITA-OT 2.5, which includes <ph conref="#highlights/summary"/>.</shortdesc>
<note type="tip"><ph conref="../resources/conref-task.dita#ID/download-ot"/></note>
</abstract>
<reference id="v254">
<title>Maintenance Release 2.5.4</title>
<refbody>
<section>
<p>DITA Open Toolkit Release 2.5.4 includes the following bug fixes.</p>
<ul>
<li id="2226">In earlier releases, plugins that contributed variables (or strings) did not work when the
variables were contributed with mixed case (such as <codeph>pt-BR</codeph> instead of
<codeph>pt-pt</codeph>). This has been fixed, so that the case of <xmlatt>xml:lang</xmlatt> is ignored when
contributing variables.
<xref href="https://github.com/dita-ot/dita-ot/issues/2226" format="html" scope="external">#2226</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2790" format="html" scope="external">#2790</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2803" format="html" scope="external">#2803</xref>
</li>
<li id="2772">In DITA-OT 2.5, external cross references to DITA topics, such as <codeph>&lt;xref
href="http://example.com/onlineTopic.dita" scope="external"&gt;</codeph>, resulted in build failures due
to an improperly set XSLT variable. This setting has been corrected to ensure external references are
resolved as expected.
<xref href="https://github.com/dita-ot/dita-ot/issues/2772" format="html" scope="external">#2772</xref>
</li>
<li id="2795">External links in <xmlelement>related-links</xmlelement> collections were dropped from PDF
output in DITA-OT 2.4 and 2.5. These links now appear using the <xmlatt>href</xmlatt> attribute value as
link text, as in earlier releases.
<xref href="https://github.com/dita-ot/dita-ot/issues/2795" format="html" scope="external">#2795</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2802" format="html" scope="external">#2802</xref>
</li>
<li id="2800">In DITA-OT 2.5, cross references to targets within the same document, such as <codeph>&lt;xref
href="#topicid/sampleFigure"/&gt;</codeph>, caused build errors when the
<parmname>onlytopic.in.map</parmname> parameter was set to <option>true</option>. Processing has been
corrected to ensure these links are generated correctly.
<xref href="https://github.com/dita-ot/dita-ot/issues/2800" format="html" scope="external">#2800</xref>
</li>
<li id="2801">In DITA-OT 2.4 and 2.5, the <xmlelement>property</xmlelement> element in reference topics
resulted in an "Ambiguous rule match" message from Saxon when building HTML5. This message has been removed.
<xref href="https://github.com/dita-ot/dita-ot/pull/2801" format="html" scope="external">#2801</xref>
</li>
<li id="2805">In earlier releases, when <codeph>chunk="by-topic"</codeph> was specified on a
<xmlelement>topicref</xmlelement> element that did not specify the <xmlatt>href</xmlatt> attribute, the
build would end in a null pointer exception. This error has been removed and the build will continue.
<xref href="https://github.com/dita-ot/dita-ot/pull/2805" format="html" scope="external">#2805</xref>
</li>
<li id="2806">In earlier releases, when a map reference (such as <xmlelement>mapref</xmlelement>) referred to
a map in a subdirectory, and that referenced map included elements with <xmlatt>conref</xmlatt> attributes,
the step that resolved map references did not properly adjust paths in <xmlatt>conref</xmlatt>, resulting in
unresolvable content references. This has been fixed, and <xmlatt>conref</xmlatt> attributes in nested maps
in subdirectories now resolve properly.
<xref href="https://github.com/dita-ot/dita-ot/pull/2806" format="html" scope="external">#2806</xref>
</li>
<li>
<p>The documentation includes minor
<xref href="https://github.com/dita-ot/docs/compare/2.5.3...2.5.4" format="html" scope="external">
changes</xref> with
<xref href="https://github.com/dita-ot/docs/milestone/29?closed=1" format="html" scope="external"
>corrections and improvements</xref> to existing topics.</p>
</li>
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/2.5.3...2.5.4" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v253">
<title>Maintenance Release 2.5.3</title>
<refbody>
<section>
<p>DITA Open Toolkit Release 2.5.3 includes the following bug fixes.</p>
<ul>
<li id="2759">In DITA-OT 2.5, the <codeph>gen-list</codeph> pre-processing step listed resource-only
references with <xmlatt>scope</xmlatt>=<codeph>"peer"</codeph> as local files when the
<parmname>onlytopic.in.map</parmname> parameter was set to <option>true</option>. This caused later
processing steps to generate errors as they tried to read the peer files (even when they were not DITA).
Pre-processing has been updated to avoid reading these files, which also removes the build errors.
<xref href="https://github.com/dita-ot/dita-ot/issues/2759" format="html" scope="external">#2759</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2761" format="html" scope="external">#2761</xref>
</li>
<li id="2768">In previous versions of DITA-OT, the <codeph>copy-files</codeph> pre-processing step would stop
the build with an error if the destination directory for copied files did not (yet) exist. The copy process
has been adjusted to create the destination directory if necessary and allow the build to continue.
<xref href="https://github.com/dita-ot/dita-ot/issues/2768" format="html" scope="external">#2768</xref>
</li>
<li id="2769">DITA-OT 2.5 would crash when publishing maps that contained <xmlelement>ditavalref</xmlelement>
elements without valid hyperlink references in the <xmlatt>href</xmlatt> attribute. Pre-processing has been
updated to be more tolerant in these cases. The <codeph>branch-filter</codeph> step will now proceed as if
the <xmlelement>ditavalref</xmlelement> were not specified, which allows the build to finish.
<xref href="https://github.com/dita-ot/dita-ot/issues/2769" format="html" scope="external">#2769</xref>
</li>
<li>
<p>The documentation includes minor
<xref href="https://github.com/dita-ot/docs/compare/2.5.2...2.5.3" format="html" scope="external">
changes</xref> with
<xref href="https://github.com/dita-ot/docs/milestone/28?closed=1" format="html" scope="external"
>corrections and improvements</xref> to existing topics.</p>
</li>
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/2.5.2...2.5.3" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v252">
<title>Maintenance Release 2.5.2</title>
<refbody>
<section>
<p>DITA Open Toolkit Release 2.5.2 includes the following bug fixes.</p>
<ul>
<li id="2743">In DITA-OT 2.5.1, the mappull step could fail when a map referenced a DITA document where the
root element was filtered out. The filtered document is now processed correctly.
<xref href="https://github.com/dita-ot/dita-ot/pull/2743" format="html" scope="external">#2743</xref>
</li>
<li id="2749">In the original 2.5 release, setting a revision property to "flag" in the DITAVAL resulted in
build errors if the DITAVAL did not also specify a start and end image for that flag. The build errors no
longer appear.
<xref href="https://github.com/dita-ot/dita-ot/pull/2749" format="html" scope="external">#2749</xref>
</li>
<li>
<p>The documentation includes minor
<xref href="https://github.com/dita-ot/docs/compare/2.5.1...2.5.2" format="html" scope="external">
changes</xref> with
<xref href="https://github.com/dita-ot/docs/milestone/27?closed=1" format="html" scope="external"
>corrections and improvements</xref> to existing topics.</p>
</li>
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/2.5.1...2.5.2" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v251">
<title>Maintenance Release 2.5.1</title>
<refbody>
<section>
<p>DITA Open Toolkit Release 2.5.1 includes the following bug fixes.</p>
<ul>
<li id="2014">
<p>In DITA-OT 2.5 and earlier, key resolution did not comply with the DITA specification’s requirement to
use <xmlelement>linktext</xmlelement> from a key definition as valid replacement text for all uses of that
key.
<xref href="https://github.com/dita-ot/dita-ot/issues/1590" format="html" scope="external">#1590</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2014" format="html" scope="external">#2014</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2719" format="html" scope="external">#2719</xref></p>
<p>In addition, several less common cases are fixed:
<ul>
<li>Previously, a <xmlelement>keyword</xmlelement> anywhere within the key definition was used as the
first choice for link text, even if that keyword was located within <xmlelement>linktext</xmlelement>.
As defined by the DITA specification, the replacement keyword is taken only from within
<xmlelement>keywords</xmlelement>.</li>
<li>Previously, the <xmlatt>navtitle</xmlatt> attribute was used as fallback text in some cases, while
<xmlelement>navtitle</xmlelement> was ignored. The <xmlelement>navtitle</xmlelement> element is now
used before checking the deprecated <xmlatt>navtitle</xmlatt> value for all cases.</li>
<li>Previously, <xmlatt>navtitle</xmlatt> was used as link text even for local DITA topics where that
value was ignored in favor of a navigation title in the topic. Now <xmlatt>navtitle</xmlatt> and
<xmlelement>navtitle</xmlelement> are only used when locked or when the topic is not local
DITA.</li>
</ul>
</p>
</li>
<li id="2701">In some cases, invalid DITA content resulted in build crashes from PDF, XHTML, or HTML5
processing modules that expect required elements to be present. For example, this could happen when an
element such as <xmlelement>ol</xmlelement> (which requires at least one list item) used DITAVAL filtering
to exclude all items from the list. The code has been updated to more gracefully handle elements that are
missing required children.
<xref href="https://github.com/dita-ot/dita-ot/issues/2701" format="html" scope="external">#2701</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2712" format="html" scope="external">#2712</xref>
</li>
<li id="2705">One DITA 1.3 RNG module in the grammar files for the
<xref keyref="dita13-spec"/> contained a typo in a default attribute value. The typo will be corrected in
the next DITA 1.3 errata, and is now fixed in the DITA-OT copy.
<xref href="https://github.com/dita-ot/dita-ot/issues/2705" format="html" scope="external">#2705</xref>
</li>
<li id="2706">On Windows only, chunking a DITA document using the "by-topic" method would lose the root chunk
and result in processing errors. The chunking process has been updated to handle Windows file paths
correctly; the chunking process now produces the same results on all systems.
<xref href="https://github.com/dita-ot/dita-ot/issues/2706" format="html" scope="external">#2706</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2728" format="html" scope="external">#2728</xref>
</li>
<li id="2714">HTML5 output restores support for the <xmlatt>spectitle</xmlatt> attribute on
<xmlelement>simpletable</xmlelement> elements and for the <xmlatt>specentry</xmlatt> attribute on
<xmlelement>stentry</xmlelement> elements. Support for those attributes was missing after the HTML5 and
XHTML code bases split in release 2.4.
<xref href="https://github.com/dita-ot/dita-ot/pull/2714" format="html" scope="external">#2714</xref>
</li>
<li id="2716">In the original 2.5 release, a <xmlelement>topicref</xmlelement> that included a reference to a
local topic ID (such as <codeph>href="file.dita#root"</codeph>) could cause build failures when another
element in the document used the same ID. The reference is now handled properly.
<xref href="https://github.com/dita-ot/dita-ot/pull/2716" format="html" scope="external">#2716</xref>
</li>
<li>
<p>The documentation includes minor
<xref href="https://github.com/dita-ot/docs/compare/2.5...2.5.1" format="html" scope="external">
changes</xref> with
<xref href="https://github.com/dita-ot/docs/milestone/25?closed=1" format="html" scope="external"
>corrections and improvements</xref> to existing topics.</p>
</li>
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/2.5...2.5.1" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="requirements">
<title>Requirements</title>
<refbody>
<section>
<draft-comment author="Roger">Add info on new minimum Java version or any other requirements that have changed
since previous release.</draft-comment>
<p>DITA Open Toolkit Release 2.5 requires the Java Runtime Environment (JRE) version
<keyword keyref="tool.java.version"/> or later.</p>
</section>
</refbody>
</reference>
<reference id="highlights">
<title>Release Highlights</title>
<shortdesc>DITA-OT 2.5 includes <ph id="summary">a basic Java API, an experimental map-first
preprocessing option, better support for DITA composite documents, publishing with multiple DITAVAL files, and
more consistent styling for default PDF output</ph>.</shortdesc>
<refbody>
<section id="2604">
<title>Java Application Programming Interface</title>
<p>DITA-OT 2.5 includes a new
<xref keyref="java-api"/> to allow developers to embed DITA-OT more easily into other Java programs.
<xref href="https://github.com/dita-ot/dita-ot/issues/2604" format="html" scope="external">#2604</xref></p>
<note type="tip">See the <cite>DITA-OT Java API documentation</cite> in the <filepath>doc/api/</filepath> folder
of the DITA-OT distribution package for information on the packages, classes, interfaces and methods provided
by the Java API.</note>
</section>
<section id="2497">
<title>Map-first preprocessing</title>
<p><ph conref="../reference/map-first-preprocessing.dita#ID/map-first-preproc-desc"/></p>
<p conref="../reference/map-first-preprocessing.dita#ID/map-first-preproc-gain"/>
<note conref="../reference/map-first-preprocessing.dita#ID/map-first-preproc-note"/>
<p>See
<xref keyref="map-first-preproc"/>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2497" format="html" scope="external">#2497</xref></p>
</section>
<section id="1077">
<title>Improved PDF support for DITA composite documents</title>
<p>When publishing PDF output from a DITA composite document (a DITA document with a root
<xmlelement>dita</xmlelement> element), earlier versions of DITA-OT included only the first topic, and links
to topics within <xmlelement>dita</xmlelement> elements were broken. The PDF output now includes the full
content of the referenced document, and links to any element within the document are correct.
<xref href="https://github.com/dita-ot/dita-ot/issues/1077" format="html" scope="external">#1077</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/1904" format="html" scope="external">#1904</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2679" format="html" scope="external">#2679</xref></p>
<p id="2698">Attributes from the <xmlelement>dita</xmlelement> element are now preserved when merging topics. In
previous releases, attributes like <xmlatt>xml:lang</xmlatt> set on the <xmlelement>dita</xmlelement> element
were lost during the PDF "topic merge" process.
<xref href="https://github.com/dita-ot/dita-ot/issues/1298" format="html" scope="external">#1298</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2698" format="html" scope="external">#2698</xref></p>
</section>
<section id="2637">
<title>Publishing with multiple DITAVAL filter files</title>
<p>The <codeph>args.filter</codeph> parameter, which previously allowed you to specify a single DITAVAL file for
filtering or flagging, now accepts a list of URIs. The system path separator character is used to delimit
individual file paths in the list of values (semicolon ‘<codeph>;</codeph>’ on Windows, and colon
‘<codeph>:</codeph>’ on macOS and Linux). DITAVAL files are evaluated in the order specified, so conditions
specified in the first file take precedence over matching conditions specified in later files, just as
conditions at the start of a DITAVAL document take precedence over matching conditions later in the same
document.
<xref href="https://github.com/dita-ot/dita-ot/issues/2637" format="html" scope="external">#2637</xref></p>
<p>This feature allows you to manage your conditions independently or combine conditions from multiple sources.
For example, you can now manage your filter conditions (that might change rarely) separately from revisions,
or easily combine flagging conditions from different products when those products are published together.</p>
<p>You can then pass the filenames to the <cmdname>dita</cmdname> command as follows:</p>
<p>
<codeblock><cmdname>dita</cmdname> <parmname>--input</parmname>=<filepath>userguide.ditamap</filepath> <parmname>--format</parmname>=<option>pdf</option> <parmname>--filter</parmname>=<filepath>filters.ditaval:flags.ditaval</filepath></codeblock>
</p>
<p id="2681"> DITAVAL properties are now more flexible so that plug-ins can provide a common set of DITAVAL
conditions and override the <parmname>args.filter</parmname> parameter. Initialization code has been cleaned
up so that it does not set unnecessary properties.
<xref href="https://github.com/dita-ot/dita-ot/pull/2681" format="html" scope="external">#2681</xref></p>
</section>
<section id="2519" conref="../reference/migrating-to-2.5.dita#migrating-to-2.5/25-pdf-changes"/>
<section>
<p>A separate <codeph>org.dita.pdf2.legacy</codeph> plug-in can be used to restore the original settings. See
<xref keyref="migrating-to-2-5">Migrating to release 2.5</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2519" format="html" scope="external">#2519</xref>.</p>
</section>
</refbody>
</reference>
<reference id="issues">
<title>Resolved issues</title>
<shortdesc>In addition to the highlights mentioned above, DITA Open Toolkit Release 2.5
includes the following changes.</shortdesc>
<refbody>
<section id="features">
<title>Features</title>
<p>DITA Open Toolkit Release 2.5 includes the following new features:</p>
<ul>
<li id="1134">The PDF transformation now uses variables to control ordered list numbering and unordered list
bullets. This allows list styles to be more easily configured in overrides or by locale.
<xref href="https://github.com/dita-ot/dita-ot/issues/1134" format="html" scope="external">#1134</xref>
</li>
<li id="1230">In PDF output, monospaced elements now inherit the font size from their parent elements. In
earlier versions, the <codeph>base-font</codeph> attribute-set caused monospaced elements to reset font
sizes unnecessarily. Removing these extra calls to <codeph>base-font</codeph> allows monospace elements to
retain the current font size.
<xref href="https://github.com/dita-ot/dita-ot/issues/1230" format="html" scope="external">#1230</xref>
</li>
<li id="1431">A new property named <codeph>remove-broken-links</codeph> is available to automatically remove
any unresolved links. Setting the parameter to <codeph>true</codeph> will remove map-based links that do not
resolve, as well as links coded within <xmlelement>related-links</xmlelement>. The default value is
<codeph>false</codeph>.
<xref href="https://github.com/dita-ot/dita-ot/issues/1431" format="html" scope="external">#1431</xref>
</li>
<li id="1964">The <codeph>copy-html</codeph> step in the pre-processing stage has been updated to work like
<codeph>copy-image</codeph>, with a parameter for the destination directory. This allows more flexibility
for extended transformation types that use these targets.
<xref href="https://github.com/dita-ot/dita-ot/issues/1964" format="html" scope="external">#1964</xref>
</li>
<li id="2569">DITA-OT now processes DITA elements nested within <xmlelement>foreign</xmlelement> and
<xmlelement>unknown</xmlelement> elements. Previously these elements were ignored and treated as part of
the <xmlelement>foreign</xmlelement> or <xmlelement>unknown</xmlelement> content, so that (for example)
<xmlatt>conref</xmlatt> targets were not retrieved and links were not properly handled.
<xref href="https://github.com/dita-ot/dita-ot/issues/2569" format="html" scope="external">#2569</xref>
</li>
<li id="2670">A new internal parameter named <codeph>temp.output.dir.name</codeph> allows plugin developers to
direct output to a location within the existing temporary directory, which allows for additional
post-processing before files are placed in the output directory.
<xref href="https://github.com/dita-ot/dita-ot/pull/2670" format="html" scope="external">#2670</xref>
</li>
<li id="2684">Eclipse Help output can now be created as a JAR file. When the
<codeph>args.eclipsehelp.jar.name</codeph> property is specified for an Eclipse build, the generated
content will all be zipped in a JAR file with the name taken from that property.
<xref href="https://github.com/dita-ot/dita-ot/issues/2684" format="html" scope="external">#2684</xref>
</li>
<li id="2707">A new <codeph>path2rootmap</codeph> processing instruction is now added to topics in the
temporary directory that includes a relative path to the root map. This helps to preserve links when
generating output for content that is not located in or beneath the directory containing the DITA map file.
<xref href="https://github.com/dita-ot/dita-ot/pull/2707" format="html" scope="external">#2707</xref>
</li>
</ul>
</section>
<section id="enhancements">
<title>Enhancements and changes</title>
<p>DITA Open Toolkit Release 2.5 includes the following enhancements and changes to
existing features:</p>
<ul>
<li id="1238">DITA-OT now works with Saxon-HE (home edition) 9.4.0.3. Some XSLT modules in earlier versions
relied on Java extensions that are not available in Saxon-HE; those dependencies have all been removed.
<xref href="https://github.com/dita-ot/dita-ot/issues/1238" format="html" scope="external">#1238</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2668" format="html" scope="external">#2668</xref>
</li>
<li id="2293">Product name processing has been revised to better support overrides in PDF customizations. The
existing <codeph>text-only</codeph> mode is now used to enable customizations to support elements that add
text (such as trademark symbols).
<xref href="https://github.com/dita-ot/dita-ot/issues/2293" format="html" scope="external">#2293</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2693" format="html" scope="external">#2693</xref>
</li>
<li id="2419">Earlier versions of DITA-OT created empty and unnecessary <xmlelement>fo:inline</xmlelement>
elements for some elements when generating PDF output; those empty elements have been removed.
<xref href="https://github.com/dita-ot/dita-ot/pull/2419" format="html" scope="external">#2419</xref>
</li>
<li id="2446">An <xmlelement>abbr</xmlelement> abbreviation wrapper has been added to
<xmlelement>menucascade</xmlelement> output for improved HTML5 and XHTML accessibility. This allows screen
readers to detect and read the right angle bracket <codeph>></codeph> submenu separator that appears between
menu items as accessible text. In English, for example, this will be read as “and then”.
<xref href="https://github.com/dita-ot/dita-ot/issues/2446" format="html" scope="external">#2446</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2516" format="html" scope="external">#2516</xref>
</li>
<li id="2459">PDF output did not properly evaluate DITAVAL flagging conditions for
<xmlelement>step</xmlelement> and <xmlelement>choice</xmlelement> elements within tasks, or for root topic
elements. In addition, topics in sub-directories did not render image flags properly for any elements. These
issues are all resolved.
<xref href="https://github.com/dita-ot/dita-ot/issues/2459" format="html" scope="external">#2459</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2674" format="html" scope="external">#2674</xref>
</li>
<li id="2552">Error messages in <cmdname>dita</cmdname> command output now appear in red on terminals that
support
<xref href="https://en.wikipedia.org/wiki/ANSI_escape_code" format="html" scope="external">ANSI escape
codes</xref>, such as on Linux or macOS. The new property <codeph>cli.color</codeph> can be set to
<codeph>false</codeph> to disable the color. (Colored output is not supported on Windows consoles such as
<cmdname>cmd.exe</cmdname> or PowerShell).
<xref href="https://github.com/dita-ot/dita-ot/pull/2552" format="html" scope="external">#2552</xref>
</li>
<li id="2579">The <codeph>args.logdir</codeph> and <codeph>args.debug</codeph> properties have been
deprecated. To write the log to a file, use <cmdname>dita</cmdname>
<parmname>--logfile</parmname>=<varname>file</varname> or <cmdname>ant</cmdname>
<parmname>-l</parmname>
<varname>file</varname> to set the path to the log.
<xref href="https://github.com/dita-ot/dita-ot/issues/2579" format="html" scope="external">#2579</xref>
</li>
<li id="2594">Plug-in configuration has been extended to support configuration of parser features. For
example, you can now toggle XInclude processing or change error recovery options. <!-- FIXME: How? -->
<xref href="https://github.com/dita-ot/dita-ot/pull/2594" format="html" scope="external">#2594</xref>
</li>
<li id="2601">The file info filter configuration has been generalized to allow all modules to be configured
via Ant.
<xref href="https://github.com/dita-ot/dita-ot/issues/2601" format="html" scope="external">#2601</xref>
</li>
<li id="2657">In earlier versions, invalid IDs in a topic could break the build with a Null Pointer Exception
if the topic was used twice in a map. Processing for topics that appear more than once has been improved to
avoid this condition.
<xref href="https://github.com/dita-ot/dita-ot/issues/2657" format="html" scope="external">#2657</xref>
</li>
<li id="2664">DITA-OT now uses Saxon functionality to write XSLT messages to a logger instead of to standard
output. This provides a more consistent approach to logging messages across all modules.
<xref href="https://github.com/dita-ot/dita-ot/pull/2664" format="html" scope="external">#2664</xref>
</li>
<li id="2672">Earlier processing for branch filtering could place <xmlelement>ditavalref</xmlelement> elements
ahead of <xmlelement>topicmeta</xmlelement>, which would not be valid in a source map. Pre-processing has
been revised to ensure the map remains valid after the branch filtering process.
<xref href="https://github.com/dita-ot/dita-ot/pull/2672" format="html" scope="external">#2672</xref>
</li>
<li id="2677">The bundled Ant version has been updated to 1.10.1.
<xref href="https://github.com/dita-ot/dita-ot/issues/2677" format="html" scope="external">#2677</xref>
</li>
<li id="2703">A common set of string variables is now used for the localized quotation marks that are used to
wrap quotations in <xmlelement>q</xmlelement> elements; previous versions had one set of variables for PDF
and another for other transformation types.
<xref href="https://github.com/dita-ot/dita-ot/pull/2703" format="html" scope="external">#2703</xref>
</li>
</ul>
</section>
<section id="bugs">
<title>Bugs</title>
<p>DITA Open Toolkit Release 2.5 provides fixes for the following bugs:</p>
<ul>
<li id="1210">In previous releases, when a child map specified the <xmlatt>chunk</xmlatt> attribute on the
<xmlelement>map</xmlelement> element, the resulting generated map in the temp directory no longer had the
<xmlatt>chunk</xmlatt> attribute. The attribute is now preserved.
<xref href="https://github.com/dita-ot/dita-ot/issues/1210" format="html" scope="external">#1210</xref>
</li>
<li id="1734">In earlier releases, resource-only topics would generate HTML5 and XHTML topics when they were
used as the target of a content reference; topics referenced from resource-only topics also generated output
even when the parameter <parmname>onlytopic.in.map</parmname> was set to override this behavior. Processing
has been modified to ensure these extra files are no longer generated.
<xref href="https://github.com/dita-ot/dita-ot/issues/1734" format="html" scope="external">#1734</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2077" format="html" scope="external">#2077</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2694" format="html" scope="external">#2694</xref>
</li>
<li id="1848">In previous releases, root level containers in a bookmap were dropped from PDF if they did not
have a title or reference a topic. This occurred with <xmlelement>preface</xmlelement>,
<xmlelement>chapter</xmlelement>, <xmlelement>appendices</xmlelement>, <xmlelement>appendix</xmlelement>,
and any grouping element in the front or back matter. In addition, PDF builds would fail if a grouping
element without title or <xmlatt>href</xmlatt> was the only child of a map. These are all fixed by letting
processing fall through to topics within the group.
<xref href="https://github.com/dita-ot/dita-ot/issues/1848" format="html" scope="external">#1848</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2092" format="html" scope="external">#2092</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2614" format="html" scope="external">#2614</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2648" format="html" scope="external">#2648</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2683" format="html" scope="external">#2683</xref>
</li>
<li id="2443">Links directly to nested topics in HTML5 were broken; HTML5 output now generates the correct
links.
<xref href="https://github.com/dita-ot/dita-ot/issues/2443" format="html" scope="external">#2443</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2685" format="html" scope="external">#2685</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2686" format="html" scope="external">#2686</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2702" format="html" scope="external">#2702</xref>
</li>
<li id="2491">When a <xmlatt>copy-to</xmlatt> attribute is used to copy a topic to a new directory, earlier
versions generated CSS paths based on the original location. CSS paths are now generated based on the new
location.
<xref href="https://github.com/dita-ot/dita-ot/issues/2491" format="html" scope="external">#2491</xref>
</li>
<li id="2541">Using the same name in two different key scopes is now supported as defined in the
<xref keyref="dita13-spec"/>.
<xref href="https://github.com/dita-ot/dita-ot/issues/2541" format="html" scope="external">#2541</xref>
</li>
<li id="2550">In earlier releases, when maps referenced content outside of the map directory and
<parmname>generate.copy.outer</parmname>=<option>1</option> was used, HTML5 or XHTML output would copy
images to the wrong location outside of the output directory. The images are now copied to the proper
location.
<xref href="https://github.com/dita-ot/dita-ot/issues/2550" format="html" scope="external">#2550</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2682" format="html" scope="external">#2682</xref>
</li>
<li id="2646">The <msgnum>DOTX010E</msgnum> error included extra spacing around the <xmlatt>conref</xmlatt>
attribute value. The extra spaces have been removed.
<xref href="https://github.com/dita-ot/dita-ot/issues/2646" format="html" scope="external">#2646</xref>
</li>
<li id="2653">In earlier releases, key definitions for some images were marked as
<codeph>format="html"</codeph> in the <filepath>.job.xml</filepath> file, limiting their use with later
image processing. These now use <codeph>format="image"</codeph> as intended.
<xref href="https://github.com/dita-ot/dita-ot/issues/2653" format="html" scope="external">#2653</xref>
</li>
<li id="2659">In DITA-OT 2.4, when new topics were generated by the Branch Filtering process, the generated
topics were not added to the <filepath>.job.xml</filepath> configuration file. They are now added properly.
<xref href="https://github.com/dita-ot/dita-ot/issues/2659" format="html" scope="external">#2659</xref>
</li>
<li id="2665">When setting link text, some link targets caused <filepath>topicpullImpl.xsl</filepath> to
generate the following message <msgph>XPTY0004: A sequence of more than one item is not allowed as the first
argument of normalize-space()</msgph>. The XSLT data type has been corrected to prevent this.
<xref href="https://github.com/dita-ot/dita-ot/issues/2665" format="html" scope="external">#2665</xref>
</li>
<li id="2667">When key definitions reference files outside the map scope, key references to images could be
resolved with the wrong path. The key definitions are now processed correctly.
<xref href="https://github.com/dita-ot/dita-ot/issues/2568" format="html" scope="external">#2568</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2667" format="html" scope="external">#2667</xref>
</li>
<li id="2669">If maps contained <xmlelement>ditavalref</xmlelement> elements and key definitions pointing to
non-DITA files (such as images), earlier versions attempted to filter the non-DITA files and returned
errors. The branch filtering process has been corrected to apply only to DITA files.
<xref href="https://github.com/dita-ot/dita-ot/pull/2669" format="html" scope="external">#2669</xref>
</li>
<li id="2676">In previous releases, HTML5 builds failed when processing <xmlelement>table</xmlelement>
elements that contained multiple <xmlelement>tgroup</xmlelement> elements. This is resolved by retrieving
column definitions from the <xmlelement>tgroup</xmlelement> element.
<xref href="https://github.com/dita-ot/dita-ot/issues/2676" format="html" scope="external">#2676</xref>
</li>
<li id="2678">When chunking a document, earlier releases dropped the <xmlatt>xml:lang</xmlatt> attribute from
the root topic. The correct <xmlatt>xml:lang</xmlatt> attribute is now preserved on any chunked topics.
<xref href="https://github.com/dita-ot/dita-ot/issues/2022" format="html" scope="external">#2022</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2678" format="html" scope="external">#2678</xref>
</li>
<li id="2688">In HTML5 tables, some required table classes were missing when
<codeph>args.html5.classattr=no</codeph> was specified for the build.
<xref href="https://github.com/dita-ot/dita-ot/issues/2688" format="html" scope="external">#2688</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2689" format="html" scope="external">#2689</xref>
</li>
<li id="2690">When a DITA topic that is used in the map is referenced using <xmlelement>coderef</xmlelement>,
code references would embed the normalized file from the temporary directory. The original copy is now read
from the source URI so that the original source appears in the code block.
<xref href="https://github.com/dita-ot/dita-ot/issues/2690" format="html" scope="external">#2690</xref>
</li>
<li id="2691">In earlier releases, keys that referred to nested topics were not properly resolved. Key
references to nested topics are now correctly resolved as a reference to the nested topic.
<xref href="https://github.com/dita-ot/dita-ot/issues/2691" format="html" scope="external">#2691</xref>
</li>
<li id="2695">In PDF output from previous releases, the table of contents inserted a generated “<cite>Chapter
:</cite>” prefix in front of the navigation title for the <xmlelement>appendices</xmlelement> element.
This prefix has been removed.
<xref href="https://github.com/dita-ot/dita-ot/issues/2695" format="html" scope="external">#2695</xref>
</li>
</ul>
</section>
<section id="contrib">
<title>Contributors</title>
<p>DITA Open Toolkit Release 2.5 includes
<xref keyref="contributions"/> by the following people:</p>
<!-- https://github.com/tj/git-extras/blob/master/Commands.md#git-summary – `git summary 2.4..` -->
<draft-comment author="Roger">NOTE: This lists contributions to the core toolkit, not docs.</draft-comment>
<ol>
<li>Jarno Elovirta</li>
<li>Robert D. Anderson</li>
<li>Alexey Mironov</li>
<li>Roger Sheen</li>
<li>Shane Taylor</li>
<li>Bob Thomas</li>
<li>Vitaliy Danylyuk</li>
<li>Lionel Moizeau </li>
<li>Eliot Kimber</li>
<li>Holger Voormann</li>
</ol>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/2.4...2.5" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
<section id="docs">
<title>Documentation updates</title>
<p>The documentation for DITA Open Toolkit Release 2.5 provides corrections and
improvements to existing topics, along with new information:</p>
<ul>
<li>
<xref keyref="java-api">New Java API</xref>
</li>
<li>
<xref keyref="map-first-preproc"/></li>
<li>
<xref keyref="migrating-to-2-5">Migrating to release 2.5</xref>
</li>
</ul>
<p>For additional information on documentation issues resolved in DITA Open Toolkit Release <keyword
keyref="release"/>, see the
<xref href="https://github.com/dita-ot/docs/issues?q=milestone%3A2.5+is%3Aclosed" format="html"
scope="external">
2.5 milestone</xref> in the documentation repository.</p>
<p>DITA Open Toolkit Release 2.5 includes
<xref keyref="docs-contributions"/> by the following people:</p>
<draft-comment author="Roger">NOTE: This lists contributions to docs, not to the core toolkit.</draft-comment>
<ol>
<li>Roger Sheen</li>
<li>Robert D. Anderson</li>
<li>Jarno Elovirta</li>
<li>Shane Taylor</li>
<li>Ed Porter</li>
<li>Eero Helenius</li>
<li>Lionel Moizeau</li>
<li>George Bina</li>
<li>Rene Mjartan</li>
</ol>
<p>For the complete list of documentation changes since the previous release, see the
<xref href="https://github.com/dita-ot/docs/compare/2.4...2.5" format="html" scope="external">
changelog</xref>.</p>
</section>
</refbody>
</reference>
</reference>

694
dita-ot-3.6/docsrc/release-notes/rel3.0.dita Normal file
View file

@ -0,0 +1,694 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
<reference id="ID" rev="3.0">
<title>DITA Open Toolkit 3.0.4 Release Notes</title>
<titlealts>
<navtitle>Release Notes</navtitle>
</titlealts>
<abstract>
<shortdesc>DITA Open Toolkit 3.0.4 is a maintenance release that fixes issues
reported in DITA-OT 3.0, which <ph conref="#highlights/summary"/></shortdesc>
<p conkeyref="conref-task/semver-info"/>
<note type="tip"><ph conref="../resources/conref-task.dita#ID/download-ot"/></note>
</abstract>
<reference id="requirements">
<title>Requirements</title>
<refbody>
<section>
<draft-comment author="Roger">Add info on new minimum Java version or any other requirements that have changed
since previous release.</draft-comment>
<p>DITA Open Toolkit Release 3.0 requires the Java Runtime Environment (JRE) version
<keyword keyref="tool.java.version"/> or later.</p>
</section>
</refbody>
</reference>
<reference id="v304">
<title>DITA-OT 3.0.4
<ph outputclass="small">released May 10, 2018</ph></title>
<refbody>
<section>
<p>DITA Open Toolkit 3.0.4 is a maintenance release that includes the
following bug fixes.</p>
<ul>
<li id="2005">In previous releases, including a <codeph>&lt;!DOCTYPE></codeph> declaration in a DITAVAL
document resulted in a build failure. This is now fixed, and the referenced grammar file will be found using
the same catalog that is used to locate other grammar files.
<xref href="https://github.com/dita-ot/dita-ot/issues/2005" format="html" scope="external">#2005</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2922" format="html" scope="external">#2922</xref>
</li>
<!--
<li id="2821">HTML5 builds in DITA-OT 3.0 warned that the <filepath>map2html5Impl.xsl</filepath> stylesheet
was included or imported more than once. The redundant import has been removed to quiet the log message.
<xref href="https://github.com/dita-ot/dita-ot/issues/2821" format="html" scope="external">#2821</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2950" format="html" scope="external">#2950</xref>
</li>
-->
<li id="2835">DITA-OT 3.0 failed to recognize PDF customizations if the custom plug-in used the same file
names as the base PDF plug-in. The default catalog has been removed from the catalog configuration file to
ensure that only explicitly configured catalogs are used and customizations take precedence regardless of
the file names in the custom plug-in.
<xref href="https://github.com/dita-ot/dita-ot/issues/2835" format="html" scope="external">#2835</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2937" format="html" scope="external">#2937</xref>
</li>
<li id="2841">In DITA-OT 3.0, URI-based links may cause NullPointerExceptions when link targets do not exist
until after <xmlatt>copy-to</xmlatt> attributes are evaluated. The build failure has been removed, and this
type of link will now generate normal build errors as in previous releases.
<xref href="https://github.com/dita-ot/dita-ot/issues/2841" format="html" scope="external">#2841</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2936" format="html" scope="external">#2936</xref>
</li>
<li id="2842">In previous releases, if a key definition specified both <xmlatt>href</xmlatt> and
<xmlatt>copy-to</xmlatt> attributes, references to that key always resolved to the original
<xmlatt>href</xmlatt> rather than to the new copy specified with <xmlatt>copy-to</xmlatt>. Key references
to this type of definition will now resolve to the appropriate copy of the resource.
<xref href="https://github.com/dita-ot/dita-ot/issues/2842" format="html" scope="external">#2842</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2935" format="html" scope="external">#2935</xref>
</li>
<li id="2901">In DITA-OT 3.0.1, <xmlelement>coderef</xmlelement> elements that contained references to line
ranges in DITA map files were not reliably included in PDF output as the preprocessing routine may change
maps. All code references are now resolved from the original files to ensure that code blocks reflect the
intended source range.
<xref href="https://github.com/dita-ot/dita-ot/issues/2901" format="html" scope="external">#2901</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2916" format="html" scope="external">#2916</xref>
</li>
<li id="2910">In DITA-OT 3.0, PDF output files were created outside of the specified output directory when the
map referenced content outside of the map directory. This has been fixed to ensure that PDFs are always
placed in the specified output directory.
<xref href="https://github.com/dita-ot/dita-ot/issues/2910" format="html" scope="external">#2910</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2923" format="html" scope="external">#2923</xref>
</li>
<li id="2917">When generating HTML output with DITA-OT 3.0.2, images referenced indirectly via keys were not
copied to the output folder. Processing has been corrected to ensure that the list of images in the job
configuration includes those referenced via keys.
<xref href="https://github.com/dita-ot/dita-ot/issues/2917" format="html" scope="external">#2917</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2921" format="html" scope="external">#2921</xref>
</li>
<li id="2926">In earlier releases, <xmlatt>scale</xmlatt> attributes on the <xmlelement>fig</xmlelement>
element were ignored for PDF output. The <xmlatt>scale</xmlatt> attribute is now respected for PDF figures,
which may include text content (such as code blocks), inline images inside the text, or block images.
<xref href="https://github.com/dita-ot/dita-ot/pull/2926" format="html" scope="external">#2926</xref>
</li>
<li id="2927">In earlier releases, topic references to peer DITA content reported “missing navigation title”
errors even when the reference included <xmlelement>linktext</xmlelement>. As with all other peer, external,
and non-DITA references, the <xmlelement>linktext</xmlelement> for peer topics will now be used as a
fallback title when no navigation title is available.
<xref href="https://github.com/dita-ot/dita-ot/pull/2927" format="html" scope="external">#2927</xref>
</li>
<li id="2929">The Lightweight DITA plug-in has been updated to the latest version (2.0.3) to prevent errors
when processing Markdown input that contains typographic quotation marks with the <xmlatt>format</xmlatt>
attribute set to <codeph>markdown</codeph>
<xref href="https://github.com/dita-ot/dita-ot/issues/2929" format="html" scope="external">#2929</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2956" format="html" scope="external">#2956</xref>
</li>
<li id="2942">When generating PDF output for tables that specified row headers, DITA-OT failed to honor
vertical spans defined via the <xmlatt>morerows</xmlatt> attribute on an <xmlelement>entry</xmlelement>
(cell). Row headers are now properly applied when cells span additional rows.
<xref href="https://github.com/dita-ot/dita-ot/issues/2942" format="html" scope="external">#2942</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2946" format="html" scope="external">#2946</xref>
</li>
<li id="2945">When <xmlelement>fragref</xmlelement> elements were used to reference a syntax diagram fragment,
earlier versions of DITA-OT displayed an error. Processing has been updated to use the latest designs from
the topicpull module and fix the error.
<xref href="https://github.com/dita-ot/dita-ot/issues/2945" format="html" scope="external">#2945</xref>
</li>
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/3.0.3...3.0.4" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v303">
<title>DITA-OT 3.0.3 <ph outputclass="small">released March 10, 2018</ph></title>
<refbody>
<section>
<p>DITA Open Toolkit 3.0.3 is a maintenance release that includes the following bug fixes.</p>
<ul>
<li id="2892">In some scenarios on Windows, the version of Saxon shipped in DITA-OT 3.0 caches one copy of the
toolkit module <filepath>functions.xsl</filepath> and then uses that copy in place of a second (different)
module with the same name. This causes problems when using the <cmdname>ant</cmdname> command to run HTML5
builds. Adding an explicit path to one of the imports works around the problem.
<xref href="https://github.com/dita-ot/dita-ot/pull/2892" format="html" scope="external">#2892</xref>
</li>
<li id="2894">If an XSLT message is declared to be fatal, throwing that message should halt the build. This
stopped working with a refactored message process several releases ago, but was missed because the default
toolkit does not declare any fatal messages for XSLT modules.
<xref href="https://github.com/dita-ot/dita-ot/pull/2894" format="html" scope="external">#2894</xref>
</li>
<li id="2896">When a DITAVAL document contains a typo in the <xmlatt>action</xmlatt> attribute (which should
be set to one of <codeph>include</codeph>, <codeph>exclude</codeph>, <codeph>flag</codeph>, or
<codeph>passthrough</codeph>), the build ends with a message that is difficult to diagnose. The message
has been updated to be more explicit and to use the toolkit’s standard message format.
<xref href="https://github.com/dita-ot/dita-ot/pull/2896" format="html" scope="external">#2896</xref></li>
<li id="2897">When the <xmlelement>navtitle</xmlelement> element is used in a map, it should be ignored by
default (for the purposes of TOC titles, PDF bookmarks or generated links), except in cases where the
<xmlatt>locktitle</xmlatt> attribute on the containing topic reference is set to <codeph>yes</codeph>.
This has always worked when using the <xmlatt>navtitle</xmlatt> attribute on topic references, but
previously the <xmlelement>navtitle</xmlelement> element in maps was used even if it was not locked.
<xref href="https://github.com/dita-ot/dita-ot/pull/2897" format="html" scope="external">#2897</xref>
</li>
<li id="2900">When a DITA document contains more than one <xmlelement>glossentry</xmlelement> element, and
keys are defined for those entries using the file name but <i>without</i> including the entry ID, XHTML and
HTML5 builds would fail to process topics that reference the key. This error has been corrected so that
terms linking to glossary entries will go to the correct file, and no error will be generated.
<xref href="https://github.com/dita-ot/dita-ot/pull/2900" format="html" scope="external">#2900</xref>
</li>
<li id="2904">In PDF builds, the <xmlelement>navtitle</xmlelement> element inside of a topic was ignored when
creating bookmarks and the table of contents. The <xmlelement>navtitle</xmlelement> element in topics is now
used for each of those cases except when a map overrides the navigation title.
<xref href="https://github.com/dita-ot/dita-ot/issues/2904" format="html" scope="external">#2904</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2906" format="html" scope="external">#2906</xref>
</li>
<li id="2908"> When the <xmlelement>choicetable</xmlelement> element does not specify a table header, it
should generate default values for the "Option" and "Description" fields. In PDF, the "Description" column
was not generating the correct header. This has been fixed so that each column gets the proper header.
<xref href="https://github.com/dita-ot/dita-ot/issues/2908" format="html" scope="external">#2908</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2909" format="html" scope="external">#2909</xref></li>
<li id="2912">In HTML5, the default output process generates a Dublin Core metadata tag that specifies the
content format as XHTML. This is left over from earlier releases when the two formats shared the same code.
The format value is now correctly set to HTML5.
<xref href="https://github.com/dita-ot/dita-ot/pull/2912" format="html" scope="external">#2912</xref></li>
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/3.0.2...3.0.3" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v302">
<title>DITA-OT 3.0.2 <ph outputclass="small">released February 5, 2018</ph></title>
<refbody>
<section>
<p>DITA Open Toolkit 3.0.2 is a maintenance release that includes the following bug fixes.</p>
<ul>
<li id="1550">If a map or branch of a map was chunked to create a single document, but that portion of the map
also contained a <xmlelement>topicref</xmlelement> reference to a non-DITA resource, earlier versions of
DITA-OT attempted to read and chunk the non-DITA file. This resulted in build errors and a broken reference.
The non-DITA references are no longer read or renamed when chunking.
<xref href="https://github.com/dita-ot/dita-ot/issues/1550" format="html" scope="external">#1550</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2883" format="html" scope="external">#2883</xref></li>
<li id="2432">Several issues related to relationship table column headings have been resolved:
<xref href="https://github.com/dita-ot/dita-ot/issues/2432" format="html" scope="external">#2432</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2873" format="html" scope="external">#2873</xref>.
<ul>
<li>If a relationship table heading uses a <xmlatt>navtitle</xmlatt> without a topic, earlier versions of
DITA-OT would fail with an XSLT error. If the <xmlatt>href</xmlatt> attribute is not present, the
navigation title will now be used as expected. </li>
<li>You can now set a heading on any relationship table column to apply that heading to the group of links
generated by cells in that column. For example, if you create a column for
<xmlelement>glossentry</xmlelement> topics and set a title of “Related terms”, the generated links
will appear in a group titled “Related terms” (rather than the default “Related concepts”). In earlier
releases, these headings were ignored unless every column specified its own heading.</li>
</ul>
</li>
<li id="2596">If a bookmap is referenced from within another map or topic reference, earlier versions of
DITA-OT generated an invalid <xmlelement>fo:page-sequence</xmlelement> within an
<xmlelement>fo:block</xmlelement>, which caused FO processing to fail. DITA-OT now checks the bookmap
elements at the root level to determine whether page sequences and static content should be generated. This
allows processing to complete without errors.
<xref href="https://github.com/dita-ot/dita-ot/issues/2596" format="html" scope="external">#2596</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2859" format="html" scope="external">#2859</xref>
</li>
<li id="2725">The bundled DITA grammar files have been updated to reflect the latest changes from the OASIS
DITA Technical Committee (Errata 02, 16 January 2018). These changes allow XML Schema-based validators like
Saxon EE to resolve schema references based on URI mappings, and replace declarations of the
<xmlatt>domains</xmlatt> attribute in modules with <codeph>domains-att</codeph> references to facilitate
domain attribute substitution.
<xref href="https://github.com/dita-ot/dita-ot/issues/2725" format="html" scope="external">#2725</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2818" format="html" scope="external">#2818</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2860" format="html" scope="external">#2860</xref>
</li>
<li id="2828">In DITA-OT 3.0, image references in bookmap bookmeta data caused builds to fail. Processing has
been corrected to ignore images when reading topics from the map, allowing builds to complete successfully.
<xref href="https://github.com/dita-ot/dita-ot/issues/2828" format="html" scope="external">#2828</xref>
</li>
<li id="2829">Earlier versions of DITA-OT failed to process resources where the filename includes the percent
<codeph>%</codeph> character. The URI parser has been corrected to escape these characters correctly and
rewrite references in valid URI syntax.
<xref href="https://github.com/dita-ot/dita-ot/issues/2829" format="html" scope="external">#2829</xref>
</li>
<li id="2837">The Lightweight DITA plug-in has been updated to the latest version (2.0.2) to prevent errors
when processing Markdown input that contains typographic quotation marks.
<xref href="https://github.com/dita-ot/dita-ot/issues/2837" format="html" scope="external">#2837</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2866" format="html" scope="external">#2866</xref>
</li>
<li id="2862">In DITA-OT 3.0, cross-references to external resources caused problems if the
<xmlatt>scope</xmlatt> attribute was not explicitly set to <codeph>external</codeph>. The preprocess
validation filter has been revised to implicitly treat such references as external in lax processing mode
per the DITA specification and issue a warning.
<xref href="https://github.com/dita-ot/dita-ot/issues/2862" format="html" scope="external">#2862</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2877" format="html" scope="external">#2877</xref>
</li>
<li id="2864">The German translation for <codeph>danger</codeph> note labels has been changed from <cite
xml:lang="de">VORSICHT</cite> to <cite xml:lang="de">GEFAHR</cite> to align with recommendations in ANSI
Z535.4 Annex D.
<xref href="https://github.com/dita-ot/dita-ot/issues/2864" format="html" scope="external">#2864</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2871" format="html" scope="external">#2871</xref>
</li>
<li id="2867">DITA-OT 3.0 would fail with an error when generating HTML output with non-DITA resource
references such as MathML, which were treated as <codeph>html</codeph>. The <xmlatt>format</xmlatt> tracking
has been corrected to use the correct format in the job configuration instead of <codeph>html</codeph>.
<xref href="https://github.com/dita-ot/dita-ot/issues/2867" format="html" scope="external">#2867</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2889" format="html" scope="external">#2889</xref>
</li>
<li id="2874">The DITA 1.2 schemas have been corrected to use DITA 1.2 version-specific identifiers in all
<xmlatt>schemaLocation</xmlatt> references. Previously one module was referenced with an unversioned
identifier, causing DITA 1.3 rules to be pulled into the DITA 1.2 task schema.
<xref href="https://github.com/dita-ot/dita-ot/issues/2874" format="html" scope="external">#2874</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2878" format="html" scope="external">#2878</xref>
</li>
<li id="2887">The bundled Saxon-HE library was updated to version 9.8.0.7, which restores the ability to run
XSLT 1.0–based stylesheets. This change will allow existing plug-ins that still use XSLT 1.0 syntax to work
in DITA-OT 3.0.2 without migration.
<xref href="https://github.com/dita-ot/dita-ot/issues/2887" format="html" scope="external">#2887</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2888" format="html" scope="external">#2888</xref>
</li>
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/3.0.1...3.0.2" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v301">
<title>DITA-OT 3.0.1 <ph outputclass="small">released November 30, 2017</ph></title>
<refbody>
<section>
<p>DITA Open Toolkit 3.0.1 is a maintenance release that includes the following bug fixes.</p>
<ul>
<li id="1151">Microsoft Compiled HTML Help requires a Windows codepage rather than UTF-8, so many characters
are converted to HTML entities to ensure they are preserved during the codepage conversion. In earlier
versions of DITA-OT, these entities were not rendered correctly in index terms or in topic titles on the
<uicontrol>Contents</uicontrol> tab of the .chm file. This is now fixed; characters that exist in the
target codepage are not converted to entities, so they will appear properly in the compiled help file.
<xref href="https://github.com/dita-ot/dita-ot/issues/1151" format="html" scope="external">#1151</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/1271" format="html" scope="external">#1271</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2852" format="html" scope="external">#2852</xref>
</li>
<li id="2824">When unordered lists nest greater than 4 levels, PDF processing generates a warning about a
missing variable, and deeply nested lists use text such as <codeph>Unordered List bullet 5</codeph> instead
of a bullet character. Characters for levels 1 through 4 now repeat in deeply nested lists.
<xref href="https://github.com/dita-ot/dita-ot/issues/2824" format="html" scope="external">#2824</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2853" format="html" scope="external">#2853</xref>
</li>
<li id="2830">Map-first processing in 3.0 uses generated file names in the temp directory for HTML Help, but
this breaks any existing context-sensitive help projects that call topics directly by file name rather than
by aliased constants (topic IDs) or help context numbers. Topics in the compiled help file are now restored
to their original names to support external applications that to link to topics within a CHM by file name.
<xref href="https://github.com/dita-ot/dita-ot/issues/2830" format="html" scope="external">#2830</xref>
</li>
<li id="2833">Simplified common variable definitions in 3.0 could not be overridden using the traditional
customization approach; the override process now checks for common variables to ensure those in the
configuration directory are used.
<xref href="https://github.com/dita-ot/dita-ot/issues/2833" format="html" scope="external">#2833</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2838" format="html" scope="external">#2838</xref>
</li>
<li id="2836">Generating Markdown output with DITA-OT 3.0 failed with references to a missing stylesheet. The
Lightweight DITA plug-in has been updated to the latest version (2.0.1), which corrects the plug-in
directory path in the stylesheet reference, so Markdown output is now generated as expected.
<xref href="https://github.com/dita-ot/dita-ot/issues/2836" format="html" scope="external">#2836</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2846" format="html" scope="external">#2846</xref>
</li>
<li id="2851">In 3.0, HTML Help project files would not compile to CHM files because a property definition was
not properly initialized. This has been fixed and CHM files are generated using the original map name.
<xref href="https://github.com/dita-ot/dita-ot/issues/2851" format="html" scope="external">#2851</xref>
</li>
<li id="2854">In 3.0, the <parmname>args.output.base</parmname> property to name output files does not work
properly for HTML Help. The property is now used to produce a CHM file with the correct name and contents.
<xref href="https://github.com/dita-ot/dita-ot/pull/2854" format="html" scope="external">#2854</xref>
</li>
<li id="2856">In 3.0, content references to warehouse topics that contain unresolved cross-references would
cause PDF builds to fail, even if the invalid reference was not explicitly included in the content
reference. DITA-OT now checks to make sure such files exist and only parses them if available.
<xref href="https://github.com/dita-ot/dita-ot/issues/2856" format="html" scope="external">#2856</xref>
</li>
<li>
<p>The documentation includes minor
<xref href="https://github.com/dita-ot/docs/compare/3.0...3.0.1" format="html" scope="external">
changes</xref> with
<xref href="https://github.com/dita-ot/docs/milestone/30?closed=1" format="html" scope="external"
>corrections and improvements</xref> to existing topics.</p>
</li>
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/3.0...3.0.1" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="highlights">
<title>DITA-OT 3.0 <ph outputclass="small">released October 28, 2017</ph></title>
<refbody>
<section>
<p>DITA-OT 3.0
<ph id="summary">adds support for Markdown, normalized DITA output, and the alternative authoring formats
proposed for Lightweight DITA. The map-first preprocessing approach provides a modern alternative to the
default <codeph>preprocess</codeph> operation.</ph></p>
</section>
<section id="markdown">
<title>Markdown support</title>
<p>The
<xref keyref="markdown"/> implementation previously provided by the external <codeph>dita-ot-markdown</codeph>
plug-in has been updated to support additional edge cases and bundled into the DITA-OT 3.0 release.
<xref href="https://github.com/dita-ot/dita-ot/issues/2774" format="html" scope="external">#2774</xref></p>
<p>Markdown topics can be added to DITA publications by setting the <xmlatt>format</xmlatt> attribute to
<codeph>markdown</codeph> so the toolkit will recognize the source file as Markdown and convert it to
DITA:</p>
<p>
<codeblock>&lt;map>
&lt;topicref href="markdown-dita-topic.md" <b>format="markdown"</b>/>
&lt;/map></codeblock>
</p>
<p>Along with Markdown input, DITA-OT now provides three new output formats to convert DITA content to Markdown,
including the original <codeph>markdown</codeph> syntax, <codeph>markdown_github</codeph> for
<xref keyref="gfm-spec"/>, and <codeph>markdown_gitbook</codeph> for publishing via GitBook.</p>
<p>Markdown output can be generated by passing one of these keywords to the <cmdname>dita</cmdname> command with
the <option>--format</option> option:</p>
<p>
<codeblock>dita --input=userguide.ditamap --format=markdown</codeblock></p>
<p>The new output formats can be used to feed DITA content into Markdown-based publishing systems or other
workflows that lack the ability to process DITA XML.</p>
<note>The Markdown support is based on
<xref keyref="commonmark"/>, a strongly defined, highly compatible specification of Markdown and implemented
via the <codeph>flexmark-java</codeph> parser.</note>
</section>
<section id="lwdita">
<title>Preview support for Lightweight DITA</title>
<p>The new <codeph>org.lwdita</codeph> plug-in replaces the earlier <codeph>dita-ot-markdown</codeph> plug-in
and provides preview support for the MDITA and HDITA authoring formats proposed for
<xref keyref="lwdita"/>.</p>
<p>The <xmlatt>format</xmlatt> attribute can be set to <codeph>mdita</codeph> to apply LwDITA-specific
processing to Markdown topics:</p>
<p>
<codeblock>&lt;map>
&lt;topicref href="mdita-topic.md" <b>format="mdita"</b>/>
&lt;/map></codeblock>
</p>
<p>In this case, the first paragraph in the topic will be treated as a short description, for example, and
additional metadata can be specified for the topic via a YAML front matter block.</p>
<note type="attention">Since
<xref keyref="lwdita"/> has not yet been released as a formal specification, the implementation for MDITA and
HDITA authoring formats is subject to change. Future versions of DITA Open Toolkit will be updated as LwDITA
proposals evolve.</note>
</section>
<section id="norm-dita">
<title>Normalized DITA output</title>
<p>The new <codeph>dita</codeph> transformation generates normalized topics and maps from DITA input. The
normalized output includes the results of the DITA Open Toolkit pre-processing operations, which resolve map
references, keys, content references, code references and push metadata back and forth between maps and
topics.</p>
<p>In comparison to the source DITA files, the normalized DITA files are modified in the following ways:</p>
<ul>
<li>References from one DITA map to another are resolved</li>
<li>Map-based links, such as those generated by map hierarchy and relationship tables, are added to the
topics.</li>
<li>Link text is resolved.</li>
<li>Map attributes that cascade are made explicit on child elements.</li>
<li>Map metadata such as index entries and copyrights are pushed into topics.</li>
<li>Topic metadata such as navigation titles, link text and short descriptions are pulled from topics into the
map.</li>
<li>XML comments are removed.</li>
</ul>
<p>Normalized output can be used during plug-in development to troubleshoot the results of preprocessing
routines, or in situations where post-processing of DITA content is required, but the downstream systems are
limited in their ability to resolve DITA references.
<xref href="https://github.com/dita-ot/dita-ot/issues/2775" format="html" scope="external">#2775</xref></p>
<note type="tip">The <codeph>dita</codeph> transformation can also be used to convert Markdown topics or the
alternative input formats supported by the <codeph>org.lwdita</codeph> plug-in to standard DITA XML.</note>
</section>
<section id="map-first">
<title>Map-first preprocessing</title>
<p><ph conref="../reference/map-first-preprocessing.dita#ID/map-first-preproc-desc"/>
<xref href="https://github.com/dita-ot/dita-ot/pull/2763" format="html" scope="external">#2763</xref></p>
<p conref="../reference/map-first-preprocessing.dita#ID/map-first-preproc-gain"/>
<note conref="../reference/map-first-preprocessing.dita#ID/map-first-preproc-note"/>
</section>
</refbody>
</reference>
<reference id="issues">
<title>Resolved issues</title>
<refbody>
<section>
<p>In addition to the highlights mentioned above, DITA Open Toolkit Release 3.0 includes
the following changes.</p>
</section>
<section id="features">
<title>Features</title>
<p>DITA Open Toolkit Release 3.0 includes the following new features:</p>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.0+is%3Aclosed+label%3Afeature+sort%3Acreated-asc -->
<ul>
<li id="1200">A new property named <parmname>args.output.base</parmname> can be used to control the name of
the output file for transformation types that produce a single output file. The value of the property is the
base file name of the output file, without file extension. The file extension is defined by the
transformation type.
<xref href="https://github.com/dita-ot/dita-ot/issues/1200" format="html" scope="external">#1200</xref>
</li>
<li id="1471">The custom logging implementation used by earlier toolkit versions has been replaced with the
Simple Logging Facade for Java (SLF4J) and the Logback logging framework to better support parameterized log
messages and reduce dependencies on the underlying logging mechanisms.
<xref href="https://github.com/dita-ot/dita-ot/issues/1471" format="html" scope="external">#1471</xref>
</li>
<li id="1551">HTML Help project files are now generated in a temporary directory, so that only the Compiled
HTML Help (.chm) file is returned.
<xref href="https://github.com/dita-ot/dita-ot/issues/1551" format="html" scope="external">#1551</xref>
</li>
<li id="2626">The
<xref keyref="map-first-preproc"/> routine has been extended to support subject schemes
<xref href="https://github.com/dita-ot/dita-ot/issues/2626" format="html" scope="external">#2626</xref>
</li>
<li id="2766">A new <codeph>ant.import</codeph> extension point has been added to make it easier to add new
targets to the Ant processing pipeline.
<xref href="https://github.com/dita-ot/dita-ot/issues/2766" format="html" scope="external">#2766</xref>
<note type="tip">See
<xref keyref="plugin-anttarget"/> for details.</note>
</li>
</ul>
</section>
<section id="enhancements">
<title>Enhancements and changes</title>
<p>DITA Open Toolkit Release 3.0 includes the following enhancements and changes to
existing features:</p>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.0+is%3Aclosed+label%3Aenhancement+sort%3Acreated-asc -->
<ul>
<li id="2121">Legacy plug-ins that were removed from the distribution package in earlier releases have been
moved to their own repositories. The following plug-ins have been moved: DocBook, Eclipse Content, Eclipse
map specialization, RTF, ODT, and support for pre-OASIS DITA document types.
<xref href="https://github.com/dita-ot/dita-ot/issues/2121" format="html" scope="external">#2121</xref>
</li>
<li id="2232">Use XMLUnit 2
<xref href="https://github.com/dita-ot/dita-ot/issues/2232" format="html" scope="external">#2232</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2723" format="html" scope="external">#2723</xref>
</li>
<li id="2447">Generated link groups in XHTML and HTML5 now use list markup rather than
<xmlelement>div</xmlelement>, as required to comply with WCAG 2.0 accessibility guidelines.
<xref href="https://github.com/dita-ot/dita-ot/issues/2447" format="html" scope="external">#2447</xref>
</li>
<li id="2713">Upgrade Gradle to version 3.5
<xref href="https://github.com/dita-ot/dita-ot/pull/2713" format="html" scope="external">#2713</xref>
</li>
<li id="2718">When building PDF from files that do not use <filepath>.dita</filepath> or
<filepath>.ditamap</filepath> extensions, the input file extension (such as <filepath>.xml</filepath>) is
no longer included in the generated PDF file name.
<xref href="https://github.com/dita-ot/dita-ot/issues/2718" format="html" scope="external">#2718</xref>
</li>
<li id="2721">Upgrade Saxon-HE to version 9.8
<xref href="https://github.com/dita-ot/dita-ot/issues/2721" format="html" scope="external">#2721</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2727" format="html" scope="external">#2727</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2822" format="html" scope="external">#2822</xref>
</li>
<li id="2736">Upgrade <tm tmtype="tm">Apache</tm> FOP to version 2.2
<xref href="https://github.com/dita-ot/dita-ot/issues/2736" format="html" scope="external">#2736</xref>
</li>
<li id="2739">When merging submaps for processing, preserve titles and metadata from the referenced submap so
that they may be used in later processing stages.
<xref href="https://github.com/dita-ot/dita-ot/pull/2739" format="html" scope="external">#2739</xref>
</li>
<li id="2748">Add flagging information from DITAVAL during the same step that handles DITAVAL filtering.
<xref href="https://github.com/dita-ot/dita-ot/pull/2748" format="html" scope="external">#2748</xref>
</li>
<li id="2755">Allow plug-ins to specify custom parameters of type <codeph>url</codeph>
<xref href="https://github.com/dita-ot/dita-ot/issues/2755" format="html" scope="external">#2755</xref>
</li>
<li id="2765">Move or rename Java classes
<xref href="https://github.com/dita-ot/dita-ot/issues/2765" format="html" scope="external">#2765</xref>
</li>
<li id="2770">Make it easier for PDF plug-ins or overrides to customize how processing handles the DITA
<xmlatt>outputclass</xmlatt> attribute, such as by mapping it to corresponding XSL:FO attributes.
<xref href="https://github.com/dita-ot/dita-ot/issues/2770" format="html" scope="external">#2770</xref>
</li>
<li id="2780">Topics exploded by chunk should be written to the topic folder
<xref href="https://github.com/dita-ot/dita-ot/pull/2780" format="html" scope="external">#2780</xref>
</li>
<li id="2781">Move configuration files to a dedicated <filepath>config/</filepath> directory, which ensures
that configuration files and generated files like <filepath>messages.xml</filepath> will not be bundled into
the compiled <filepath>dost.jar</filepath>
<xref href="https://github.com/dita-ot/dita-ot/issues/2781" format="html" scope="external">#2781</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2783" format="html" scope="external">#2783</xref>
</li>
<li id="2784">Allow any attribute to be used for profiling
<xref href="https://github.com/dita-ot/dita-ot/pull/2784" format="html" scope="external">#2784</xref>
</li>
<li id="2789">Support language-independent variable files. For variables common to all (or nearly all)
languages, this means we no longer need to maintain an individual copy of the variable for every language.
Plugins may also now define variables that are used by all languages.
<xref href="https://github.com/dita-ot/dita-ot/pull/2789" format="html" scope="external">#2789</xref>
</li>
<li id="2808">Use double-hyphen syntax for CLI options in error messages
<xref href="https://github.com/dita-ot/dita-ot/issues/2808" format="html" scope="external">#2808</xref>
</li>
<li id="2811">Refactor HTML5 <xmlelement>simpletable</xmlelement> accessibility to use more modern attributes
to associate table entries with header cells.
<xref href="https://github.com/dita-ot/dita-ot/pull/2811" format="html" scope="external">#2811</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2448" format="html" scope="external">#2448</xref>
</li>
</ul>
</section>
<section id="bugs">
<title>Bugs</title>
<p>DITA Open Toolkit Release 3.0 provides fixes for the following bugs:</p>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.0+is%3Aclosed+label%3Abug+sort%3Acreated-asc -->
<ul>
<!--
<li id="1364">Images referenced in conref source copied to output
<xref href="https://github.com/dita-ot/dita-ot/issues/1364" format="html" scope="external">#1364</xref>
</li>
-->
<li id="2654">Email links without a scope or format previously generated a NullPointerException. The
<codeph>mailto:</codeph> syntax is now recognized as an email link and will not be read as a file
reference.
<xref href="https://github.com/dita-ot/dita-ot/issues/2654" format="html" scope="external">#2654</xref>
</li>
<li id="2742">The wrong language code was previously set when documents set <xmlatt>xml:lang</xmlatt> to the
value <codeph>zh-Hans</codeph>
<xref href="https://github.com/dita-ot/dita-ot/issues/2742" format="html" scope="external">#2742</xref>
</li>
<li id="2752">According to the DITA 1.3 specification, when key definitions refer to images, text that would
otherwise become link text should be placed in the images <xmlatt>alt</xmlatt> element as alternative text.
Previously the text was placed directly into the <xmlelement>image</xmlelement>, which was not valid and
ignored by later processing.
<xref href="https://github.com/dita-ot/dita-ot/issues/2752" format="html" scope="external">#2752</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2814" format="html" scope="external">#2814</xref>
</li>
<li id="2782">In earlier releases, when a <xmlelement>table</xmlelement> element included too many entries in
a row, FOP would crash during PDF processing. The extra entries are now ignored with an error message.
<xref href="https://github.com/dita-ot/dita-ot/pull/2782" format="html" scope="external">#2782</xref>
</li>
<li id="2797">A Java method for generating relative paths failed on Windows when comparing two paths from
different drives. The method has been fixed so that it does not try to construct a relative path between
drives.
<xref href="https://github.com/dita-ot/dita-ot/pull/2797" format="html" scope="external">#2797</xref>
</li>
<li id="2807">In HTML5, a DITA <xmlelement>stepsction</xmlelement> that contained paragraphs resulted in HTML5
<xmlelement>p</xmlelement> elements that contained <xmlelement>p</xmlelement>. The
<xmlelement>stepsection</xmlelement> now generates a <xmlelement>div</xmlelement> to ensure valid HTML5
output regardless of what it contains.
<xref href="https://github.com/dita-ot/dita-ot/issues/2807" format="html" scope="external">#2807</xref>
</li>
<li id="2810">An updated errata has been approved for DITA 1.3 that removes default values for
<xmlatt>rowheader</xmlatt> on <xmlelement>colspec</xmlelement>. The relevant grammar file modules from
OASIS have been updated to include this errata.
<xref href="https://github.com/dita-ot/dita-ot/pull/2810" format="html" scope="external">#2810</xref>
</li>
</ul>
</section>
<section id="contrib">
<title>Contributors</title>
<p>DITA Open Toolkit Release 3.0 includes
<xref keyref="contributions"/> by the following people:</p>
<!-- https://github.com/tj/git-extras/blob/master/Commands.md#git-summary – `git summary 2.4..` -->
<draft-comment author="Roger">NOTE: This lists contributions to the core toolkit, not docs.</draft-comment>
<ol>
<li>Jarno Elovirta</li>
<li>Robert D. Anderson</li>
<li>Roger Sheen</li>
<li>Alexey Mironov</li>
</ol>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/2.5...3.0" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
<section id="docs">
<title>Documentation updates</title>
<p>The documentation for DITA Open Toolkit Release 3.0 provides corrections and
improvements to existing topics, along with new information:</p>
<ul>
<li>The top-level documentation structure has been revised to replace book-based paradigms (<cite>User
Guide</cite>, <cite>Developer Reference</cite>) with more task-oriented groupings
<xref href="https://github.com/dita-ot/docs/issues/121" format="html" scope="external">#121</xref>
<ul>
<li>
<xref keyref="installing-client"/></li>
<li>
<xref keyref="building-output"/></li>
<li>
<xref keyref="extending-the-ot"/></li>
<li>
<xref keyref="troubleshooting-overview"/></li>
</ul>
</li>
<li>New input formats
<xref href="https://github.com/dita-ot/docs/issues/150" format="html" scope="external">#150</xref>
<xref href="https://github.com/dita-ot/docs/issues/151" format="html" scope="external">#151</xref>
<ul>
<li>
<xref keyref="markdown-input"/></li>
<li>
<xref keyref="lwdita-input"/></li>
</ul></li>
<li>New output formats
<xref href="https://github.com/dita-ot/docs/issues/152" format="html" scope="external">#152</xref>
<ul>
<li>
<xref keyref="dita2markdown"/></li>
<li>
<xref keyref="dita2dita"/></li>
</ul>
</li>
<li>
<xref keyref="map-first-preproc"/></li>
<li>
<xref keyref="migrating-to-3.0"/></li>
</ul>
<p>For additional information on documentation issues resolved in DITA Open Toolkit Release <keyword
keyref="release"/>, see the
<xref href="https://github.com/dita-ot/docs/issues?q=milestone%3A3.0+is%3Aclosed" format="html"
scope="external">
3.0 milestone</xref> in the documentation repository.</p>
<p>DITA Open Toolkit Release 3.0 includes
<xref keyref="docs-contributions"/> by the following people:</p>
<draft-comment author="Roger">NOTE: This lists contributions to docs, not to the core toolkit.</draft-comment>
<ol>
<li>Roger Sheen</li>
<li>Robert D. Anderson</li>
<li>Jarno Elovirta</li>
<li>Shane Taylor</li>
<li>Misti Pinter</li>
<li>Garrett Guillotte</li>
<li>Lionel Moizeau</li>
<li>Stefan Eike</li>
</ol>
<p>For the complete list of documentation changes since the previous release, see the
<xref href="https://github.com/dita-ot/docs/compare/2.5...3.0" format="html" scope="external">
changelog</xref>.</p>
</section>
</refbody>
</reference>
</reference>

459
dita-ot-3.6/docsrc/release-notes/rel3.1.dita Normal file
View file

@ -0,0 +1,459 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
<reference id="ID" rev="3.1">
<title>DITA Open Toolkit 3.1.3 Release Notes</title>
<titlealts>
<navtitle>Release Notes</navtitle>
</titlealts>
<abstract>
<shortdesc>DITA Open Toolkit 3.1.3 is a maintenance release that fixes issues
reported in DITA-OT 3.1, which includes <ph conref="#v3.1/summary"/>.</shortdesc>
<p conkeyref="conref-task/semver-info"/>
<note type="tip"><ph conref="../resources/conref-task.dita#ID/download-ot"/></note>
</abstract>
<reference id="requirements">
<title>Requirements</title>
<refbody>
<section>
<draft-comment author="Roger">Add info on new minimum Java version or any other requirements that have changed
since previous release.</draft-comment>
<p>DITA Open Toolkit Release 3.1 requires the Java Runtime Environment (JRE) version
<keyword keyref="tool.java.version"/> or later.</p>
</section>
</refbody>
</reference>
<reference id="v3.1.3">
<title>DITA-OT 3.1.3 <ph outputclass="small">released October 3, 2018</ph></title>
<refbody>
<section>
<p>DITA Open Toolkit 3.1.3 is a maintenance release that includes the
following bug fixes.</p>
<ul>
<li id="3060">In earlier releases, if a footnote was defined in a table cell that specified
<codeph>align="center"</codeph>, the footnote content at the bottom of a PDF page would also be
center-aligned. This has been fixed so that PDF footnotes always align to the start of the page.
<xref href="https://github.com/dita-ot/dita-ot/issues/3060" format="html" scope="external">#3060</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/3065" format="html" scope="external">#3065</xref>
</li>
<li id="3064">In DITA-OT 3.0 and 3.1, unresolved <xmlatt>conref</xmlatt> errors may appear when nested submaps
that are not in the same directory as the referencing map have <xmlelement>title</xmlelement> elements with
valid content references. This issue has been fixed.
<xref href="https://github.com/dita-ot/dita-ot/issues/3064" format="html" scope="external">#3064</xref>
</li>
<li id="3066">In PDF output, index entries inside of <xmlelement>draft-comment</xmlelement> and
<xmlelement>required-cleanup</xmlelement> would appear in the generated index as broken links when draft
content was excluded. This has been fixed, and the entries will not appear in the index unless draft content
is included.
<xref href="https://github.com/dita-ot/dita-ot/issues/3066" format="html" scope="external">#3066</xref>
</li>
<li id="3071">In earlier releases, missing images could result in a missing file warning that suggested that a
<xmlelement>navtitle</xmlelement> was needed to use the image in a table of contents. This message has
been fixed to simply describe the missing file.
<xref href="https://github.com/dita-ot/dita-ot/issues/3071" format="html" scope="external">#3071</xref>
</li>
<li id="3073">In earlier releases, many PDF index entries were defined in the XSL-FO file using
<xmlatt>id</xmlatt> attributes that worked but were technically invalid. This could result in a large
number of warnings from tools that rendered the XSL-FO file. The <xmlatt>id</xmlatt> attributes have been
fixed to ensure validity.
<xref href="https://github.com/dita-ot/dita-ot/issues/3073" format="html" scope="external">#3073</xref>
</li>
<li id="3077">When maps use content outside of the map directory, and some <xmlelement>topicref</xmlelement>
elements in the build specify <codeph>chunk="by-topic"</codeph>, earlier releases could fail with Java
errors when evaluating the <xmlatt>chunk</xmlatt> attribute. This has been fixed so that chunking is
resolved properly when content is referenced outside of the map directory.
<xref href="https://github.com/dita-ot/dita-ot/issues/3077" format="html" scope="external">#3077</xref>
</li>
<li id="3081">In PDF processing for DITA-OT 3.0 and 3.1, a variable that stores navigation titles was typed in
a way that caused XSLT errors for some values. The variable type has been corrected.
<xref href="https://github.com/dita-ot/dita-ot/pull/3081" format="html" scope="external">#3081</xref>
</li>
<li id="3082">In earlier releases, PDF builds with broken links improperly reported a fatal error. DITA-OT 3.0
was changed to halt the build on fatal errors, which caused these PDF builds to fail. The error message
level has been corrected from <codeph>FATAL</codeph> to <codeph>ERROR</codeph>, allowing builds to finish.
<xref href="https://github.com/dita-ot/dita-ot/pull/3082" format="html" scope="external">#3082</xref>
</li>
<li id="3083">In DITA-OT 3.0 and 3.1, the PDF build using <codeph>preprocess2</codeph> had build errors
when the <xmlatt>copy-to</xmlatt> attribute was used. This error has been resolved, and the
<xmlatt>copy-to</xmlatt> attribute is evaluated correctly in <codeph>preprocess2</codeph>.
<xref href="https://github.com/dita-ot/dita-ot/issues/3083" format="html" scope="external">#3083</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/3085" format="html" scope="external">#3085</xref>
</li>
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/3.1.2...3.1.3" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v3.1.2">
<title>DITA-OT 3.1.2 <ph outputclass="small">released August 13, 2018</ph></title>
<refbody>
<section>
<p>DITA Open Toolkit 3.1.2 is a maintenance release that includes the following bug fixes.</p>
<ul>
<li id="2222">When a content reference was combined with <xmlatt>conrefend</xmlatt> to reference a sequence of
topics, all but the first topic were copied without a required <xmlatt>id</xmlatt> attribute. This resulted
in NullPointerExceptions from later processing steps that expected <xmlatt>id</xmlatt> on all topics. The
content reference behavior has been fixed to avoid the error.
<xref href="https://github.com/dita-ot/dita-ot/issues/2222" format="html" scope="external">#2222</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/3033" format="html" scope="external">#3033</xref></li>
<li id="2940">In earlier versions, when a topic with index terms had an empty title (or a title with only
metadata), HTML Help and Eclipse Help index processing would end in a NullPointerException. This error has
been fixed.
<xref href="https://github.com/dita-ot/dita-ot/issues/2940" format="html" scope="external">#2940</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/3043" format="html" scope="external">#3043</xref>
</li>
<li id="2948">In earlier versions, when the input file was a topic that contained a <xmlatt>conref</xmlatt>
reference to itself, that topic would not generate output for XHTML or HTML5. The issue has been fixed.
<xref href="https://github.com/dita-ot/dita-ot/issues/2948" format="html" scope="external">#2948</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/3045" format="html" scope="external">#3045</xref>
</li>
<li id="3008">When processing without schema validation, it is possible to add <xmlatt>keyref</xmlatt>
attributes on elements where they are not legal. In earlier releases, this resulted in a
NullPointerException from the keyref resolution module. These invalid attributes are now ignored.
<xref href="https://github.com/dita-ot/dita-ot/issues/3008" format="html" scope="external">#3008</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/3034" format="html" scope="external">#3034</xref></li>
<li id="3023">The Lightweight DITA plug-in has been updated to version 2.0.6, which provides improved support
for inline HTML elements.
<xref href="https://github.com/dita-ot/dita-ot/pull/3023" format="html" scope="external">#3023</xref>
</li>
<li id="3024">In DITA-OT 3.1, configuration data is read from two files, but some processes would incorrectly
load only one file and miss properties in the other. This is fixed by removing
<filepath>lib/configuration.properties</filepath> and storing all configuration properties in
<filepath>config/configuration.properties</filepath>.
<xref href="https://github.com/dita-ot/dita-ot/pull/3024" format="html" scope="external">#3024</xref>
</li>
<li id="3027">In earlier releases, when the "same file" reference syntax <codeph>href="#./elementid</codeph>
was pulled into another file as part of a content reference, the <xmlatt>href</xmlatt> attribute was
corrupted, resulting in broken links. These references have been fixed and now refer to the element with
<codeph>id="elementid"</codeph> in the new resolved context.
<xref href="https://github.com/dita-ot/dita-ot/pull/3027" format="html" scope="external">#3027</xref>
</li>
<li id="3029">In DITA-OT 3.0 and 3.1, Saxon would generate XSLT errors when it encountered
<xmlelement>cite</xmlelement> or <xmlelement>term</xmlelement> inside of a
<xmlelement>linktext</xmlelement> element in the related links section of a topic. The XSLT syntax has
been fixed to avoid this error.
<xref href="https://github.com/dita-ot/dita-ot/pull/3029" format="html" scope="external">#3029</xref>
</li>
<li id="3040">In earlier versions, the Ant build code for PDF2 set up a <codeph>CLASSPATH</codeph> variable
that referenced JAR files that no longer exist. These references have been removed.
<xref href="https://github.com/dita-ot/dita-ot/issues/2832" format="html" scope="external">#2832</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/3040" format="html" scope="external">#3040</xref>
</li>
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/3.1.1...3.1.2" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v3.1.1">
<title>DITA-OT 3.1.1 <ph outputclass="small">released July 16, 2018</ph></title>
<refbody>
<section>
<p>DITA Open Toolkit 3.1.1 is a maintenance release that includes the following bug fixes.</p>
<ul>
<li id="2662">When generating PDF output with Antenna House Formatter, earlier versions would sometimes fail
when interpreting the Antenna House log. Processing has been updated to improve test coverage and handle
these cases more gracefully.
<xref href="https://github.com/dita-ot/dita-ot/issues/2662" format="html" scope="external">#2662</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3012" format="html" scope="external">#3012</xref>
</li>
<li id="2855">Earlier versions treated image files referenced in <xmlelement>data</xmlelement> elements and
certain other non-DITA resources as DITA topics. The map reader processing phase has been corrected to
reliably collect non-DITA resources and record them as such in the <filepath>.job.xml</filepath> file.
<xref href="https://github.com/dita-ot/dita-ot/issues/2855" format="html" scope="external">#2855</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3010" format="html" scope="external">#3010</xref>
</li>
<li id="2870">DITA-OT 3.0 failed to produce Eclipse help output. A missing library import has been restored to
ensure that Eclipse help is generated correctly.
<xref href="https://github.com/dita-ot/dita-ot/issues/2870" format="html" scope="external">#2870</xref>
</li>
<li id="2983">When generating output for HTML-based formats, earlier versions failed to handle
<xmlatt>conkeyref</xmlatt> attribute references to topics outside the map directory hierarchy, resulting
in missing content and invalid paths to CSS resources. Processing has been corrected to ensure the paths to
such files are calculated correctly.
<xref href="https://github.com/dita-ot/dita-ot/issues/2983" format="html" scope="external">#2983</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3014" format="html" scope="external">#3014</xref>
</li>
<li id="3005">A missing reference to the <parmname>$file-being-processed</parmname> parameter has been
restored to ensure that the current file is correctly tracked while resolving map references in
pre-processing.
<xref href="https://github.com/dita-ot/dita-ot/issues/3005" format="html" scope="external">#3005</xref>
</li>
<li id="3007">In earlier versions, key references to duplicate topics created via <xmlatt>copy-to</xmlatt>
attributes caused builds to fail. The original source information is now correctly recorded for copy-to
targets, allowing builds to continue.
<xref href="https://github.com/dita-ot/dita-ot/issues/3007" format="html" scope="external">#3007</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3015" format="html" scope="external">#3015</xref>
</li>
<li id="3017">In earlier versions, <xmlelement>screen</xmlelement> elements resulted in a build failure when
published to troff. Updating the plugin to version 3.1.1 resolves the issue.
<xref href="https://github.com/dita-ot/dita-ot/issues/3017" format="html" scope="external">#3017</xref>
</li>
<li>
<p>The documentation includes minor
<xref href="https://github.com/dita-ot/docs/compare/3.1...3.1.1" format="html" scope="external">
changes</xref> with
<xref href="https://github.com/dita-ot/docs/milestone/34?closed=1" format="html" scope="external"
>corrections and improvements</xref> to existing topics.</p>
</li>
</ul>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/3.1...3.1.1" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v3.1">
<title>DITA-OT 3.1 <ph outputclass="small">released June 9, 2018</ph></title>
<refbody>
<section>
<p>DITA Open Toolkit Release 3.1 includes <ph id="summary">support for DITA 1.3 SVG
domain elements, enhanced <xmlelement>codeblock</xmlelement> processing, and incremental improvements to
Lightweight DITA processing and PDF output</ph>.</p>
</section>
<section id="features">
<title>Features</title>
<p>DITA Open Toolkit Release 3.1 includes the following new features:</p>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.1+is%3Aclosed+label%3Afeature+sort%3Acreated-asc -->
<ul>
<li id="2875">A new Java wrapper for the XSLT <codeph>mapref</codeph> map resolution module allows for better
handling of content references and key references in nested maps.
<xref href="https://github.com/dita-ot/dita-ot/pull/2875" format="html" scope="external">#2875</xref>
</li>
<li id="2880">Updates to the Java code that calls Saxon now support integrated extension functions for Saxon
HE (versions ≥ 9.2).
<xref href="https://github.com/dita-ot/dita-ot/pull/2880" format="html" scope="external">#2880</xref>
</li>
<li id="2932">A new end-to-end test case ensures a basic test is run for all supported transformation types
with every update to DITA-OT.
<xref href="https://github.com/dita-ot/dita-ot/pull/2932" format="html" scope="external">#2932</xref>
</li>
<li id="2960">DITA-OT now supports the DITA 1.3 SVG domain elements, including <xmlelement>svgref</xmlelement>
for pulling in external SVG markup.
<xref href="https://github.com/dita-ot/dita-ot/pull/2960" format="html" scope="external">#2960</xref>
</li>
<li id="2961">PDF output now supports key-based linking for phrase like elements, including
<xmlelement>cite</xmlelement>, <xmlelement>ph</xmlelement>, and <xmlelement>dt</xmlelement>. When key
definitions specify a URI for linking, the links will now appear in PDF. This markup already resulted in
links in HTML output, and resulted in PDF links for key references on <xmlelement>keyword</xmlelement> and
<xmlelement>term</xmlelement>.
<xref href="https://github.com/dita-ot/dita-ot/issues/2025" format="html" scope="external">#2025</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2961" format="html" scope="external">#2961</xref>
</li>
<li>Processing for <xmlelement>codeblock</xmlelement> elements has been enhanced to support new
<xmlatt>outputclass</xmlatt> keywords that can be used to adjust the presentation of code samples.
<ul>
<li id="2907">To remove leading whitespace in external code references, set the
<xmlatt>outputclass</xmlatt> attribute to include the <codeph>normalize-space</codeph> keyword. With
this setting, DITA-OT trims any leading whitespace that is common to all lines in the code block to
remove excess indentation and keep lines short.
<xref href="https://github.com/dita-ot/dita-ot/issues/2907" format="html" scope="external">#2907</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2953" format="html" scope="external">#2953</xref>
</li>
<li id="2975">To highlight whitespace characters in code blocks, set the <xmlatt>outputclass</xmlatt>
attribute to include the <codeph>show-whitespace</codeph> keyword. When PDF output is generated, space
characters in the code will be replaced with a middle dot or “interpunct” character
( <codeph>·</codeph> ); tab characters are replaced with a rightwards arrow and three spaces
( <codeph>→   </codeph> ).
<xref href="https://github.com/dita-ot/dita-ot/pull/2975" format="html" scope="external">#2975</xref>
</li>
<li>To add line numbers to code blocks in PDF output, set the <xmlatt>outputclass</xmlatt> attribute to
include the <codeph>show-line-numbers</codeph> keyword. <note>Line numbering has been available since
DITA-OT 2.0, but previously required custom PDF plug-ins to override the
<codeph>codeblock.generate-line-number</codeph> template mode to return <codeph>true()</codeph>.
DITA-OT 3.1 now checks for the keyword in the <xmlatt>outputclass</xmlatt>, so line numbering can be
enabled without custom PDF plug-ins.</note>
</li>
</ul>
</li>
</ul>
</section>
<section id="enhancements">
<title>Enhancements and changes</title>
<p>DITA Open Toolkit Release 3.1 includes the following enhancements and changes to
existing features:</p>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.1+is%3Aclosed+label%3Aenhancement+sort%3Acreated-asc -->
<ul>
<li id="2079">The error message generated for duplicate key definitions has been updated for clarity.
<xref href="https://github.com/dita-ot/dita-ot/issues/2079" format="html" scope="external">#2079</xref>
</li>
<li id="2890">Ant scripts for DITA-OT builds now make use of <xmlatt>if:set</xmlatt> and
<xmlatt>unless:set</xmlatt> attributes in the Ant namespace, which can be used to control whether
parameters are passed to XSLT modules. These attributes replace custom implementations of
<codeph>if</codeph> and <codeph>unless</codeph> logic introduced before Ant had this capability.
<xref href="https://github.com/dita-ot/dita-ot/pull/2890" format="html" scope="external">#2890</xref>
</li>
<li id="2938">The PDF build code has been refactored and simplified to use the
<xmlelement>xmlcatalog</xmlelement> element instead of using a custom <codeph>xml.catalog.files</codeph>
property.
<xref href="https://github.com/dita-ot/dita-ot/pull/2938" format="html" scope="external">#2938</xref>
</li>
<!--
<li id="2939">Removes the redundant map2html5Impl.xsl import
<xref href="https://github.com/dita-ot/dita-ot/pull/2939" format="html" scope="external">#2939</xref>
</li>
-->
<li id="2964">Alternate text for images is now preserved in the XSL-FO files generated for PDF, using the
custom attributes necessary for <tm trademark="Apache" tmtype="tm">Apache</tm> FOP, RenderX XEP, and Antenna
House processors. The alternate text is now available in the final output file when processors generate
accessible PDF.
<xref href="https://github.com/dita-ot/dita-ot/issues/2850" format="html" scope="external">#2850</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2964" format="html" scope="external">#2964</xref></li>
<li id="2967">In PDF processing with <tm trademark="Apache" tmtype="tm">Apache</tm> FOP, DITA-OT 3.1 now uses
the Simple Logging Facade for Java (SLF4J), allowing for better control and formatting of FOP log messages.
To reduce noise on the console, all FOP messages are set to the Info level and hidden by default.
<xref href="https://github.com/dita-ot/dita-ot/pull/2967" format="html" scope="external">#2967</xref>
</li>
<li id="2970">The HTML5 XSLT stylesheets used to create TOC navigation have been refactored to use a new
processing mode. This removes the "Duplicate import of <filepath>map2html5Impl.xsl</filepath>" message that
appeared with DITA-OT 3.0.
<xref href="https://github.com/dita-ot/dita-ot/issues/2821" format="html" scope="external">#2821</xref>
<xref href="https://github.com/dita-ot/dita-ot/pull/2970" format="html" scope="external">#2970</xref>
</li>
<li id="2972">The distribution build has been updated to use the documentation Gradle build instead of Ant.
<xref href="https://github.com/dita-ot/dita-ot/issues/2972" format="html" scope="external">#2972</xref>
</li>
<li id="2974">The bundled <tm trademark="Apache" tmtype="tm">Apache</tm> FOP version has been updated to <ph
keyref="tool.fop.version"/>. (For details on recent changes, see the
<xref keyref="fop-23-rn"/>.)
<xref href="https://github.com/dita-ot/dita-ot/issues/2974" format="html" scope="external">#2974</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2976" format="html" scope="external">#2976</xref>
</li>
<li id="2978">The <xmlatt>frame</xmlatt> attribute on <xmlelement>choicetable</xmlelement> elements is now
respected in PDF output; previously all values for <xmlatt>frame</xmlatt> on this element were ignored in
PDF.
<xref href="https://github.com/dita-ot/dita-ot/pull/2978" format="html" scope="external">#2978</xref>
</li>
<li id="2982">The LwDITA plugin has been updated to version 2.0.5, pulling in a number of fixes for
Lightweight DITA processing. (Topic metadata is now preserved in YAML headers when generating Markdown for
composite topics, autolinks in Markdown topics are treated as external cross references, and definition
lists in Markdown input and links to ID fragments are now handled correctly.)
<xref href="https://github.com/dita-ot/dita-ot/pull/2982" format="html" scope="external">#2982</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/2993" format="html" scope="external">#2993</xref>
</li>
<li id="2984">PDF processing now includes a hook that can be used to add custom
<xmlelement>fo:marker</xmlelement> elements on any topic. New processing hooks are also available to add
custom anchors on any topic or titled sub-topic element, intended as a way to enable stable links into a
location within a PDF.
<xref href="https://github.com/dita-ot/dita-ot/pull/2984" format="html" scope="external">#2984</xref>
</li>
<li id="2991">The Gradle wrapper used to run the documentation build has been updated to version 4.8.
<xref href="https://github.com/dita-ot/dita-ot/pull/2991" format="html" scope="external">#2991</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2994" format="html" scope="external">#2994</xref>
</li>
</ul>
</section>
<section id="bugs">
<title>Bugs</title>
<p>DITA Open Toolkit Release 3.1 provides fixes for the following bugs:</p>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.0+is%3Aclosed+label%3Abug+sort%3Acreated-asc -->
<ul>
<li id="2494">When a nested map uses <xmlatt>conref</xmlatt> to pull content from another map, but the root
map does <i>not</i> use <xmlatt>conref</xmlatt>, the content reference was not previously resolved. This is
now fixed, and content references in all maps used by the build are resolved properly.
<xref href="https://github.com/dita-ot/dita-ot/issues/2494" format="html" scope="external">#2494</xref>
</li>
<li id="2898">When a <xmlelement>chapter</xmlelement> element refers to another map that is not a bookmap, PDF
processing now formats the referenced content as a chapter. In earlier versions, the content could be
formatted as a generic topic that did not match other chapters in the same map.
<xref href="https://github.com/dita-ot/dita-ot/issues/2898" format="html" scope="external">#2898</xref>
</li>
<li id="2958">The error message <msgnum>DOTJ007E</msgnum>, which appeared for duplicate filter conditions in
DITAVAL properties, has been switched from an Error to a Warning. This message, which usually does not
indicate a problem that results in broken output, will now appear as <msgnum>DOTJ007W</msgnum>.
<xref href="https://github.com/dita-ot/dita-ot/pull/2958" format="html" scope="external">#2958</xref>
</li>
<li id="2973">The empty <filepath>temp/</filepath> directory included in DITA-OT 3.0 distribution packages has
been removed.
<xref href="https://github.com/dita-ot/dita-ot/issues/2973" format="html" scope="external">#2973</xref>
</li>
<!--
<li id="2978">
<xref href="https://github.com/dita-ot/dita-ot/pull/2978" format="html" scope="external">#2978</xref>
</li>
-->
<li id="2985">Several duplicate ID messages that appeared in PDF processing have been fixed by removing
incorrect ID definitions. These messages could previously appear when nested elements inside of topic titles
or topic short descriptions specified their own <xmlatt>id</xmlatt> attribute; in DITA-OT 3.0, this also
appeared for all <xmlelement>pt</xmlelement> elements that specified <xmlatt>id</xmlatt>.
<xref href="https://github.com/dita-ot/dita-ot/pull/2985" format="html" scope="external">#2985</xref>
</li>
<li id="2990">Several unnecessary files have been removed from the <filepath>docsrc/</filepath> folder of the
distribution package.
<xref href="https://github.com/dita-ot/dita-ot/pull/2990" format="html" scope="external">#2990</xref>
</li>
</ul>
</section>
<section id="contrib">
<title>Contributors</title>
<p>DITA Open Toolkit Release 3.1 includes
<xref keyref="contributions"/> by the following people:</p>
<!-- https://github.com/tj/git-extras/blob/master/Commands.md#git-summary – `git summary 3.0..` -->
<draft-comment author="Roger">NOTE: This lists contributions to the core toolkit, not docs.</draft-comment>
<ol>
<li>Jarno Elovirta</li>
<li>Robert D. Anderson</li>
<li>Roger Sheen</li>
<li>Radu Coravu </li>
<li>Alexey Mironov</li>
<li>Stefan Eike</li>
<li>Shane Taylor</li>
</ol>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/2.5...3.0" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
<section id="docs">
<title>Documentation updates</title>
<p>The documentation for DITA Open Toolkit Release 3.1 provides corrections and
improvements to existing topics, along with new information in the following topics:</p>
<ul>
<li>
<xref keyref="extended-functionality"/></li>
<li>
<xref keyref="plugin-coding-conventions"/></li>
<li>
<xref keyref="migrating-to-3.1"/></li>
<li>
<xref keyref="log-files"/></li>
</ul>
<p>For additional information on documentation issues resolved in DITA Open Toolkit Release <keyword
keyref="release"/>, see the
<xref href="https://github.com/dita-ot/docs/issues?q=milestone%3A3.1+is%3Aclosed" format="html"
scope="external">
3.1 milestone</xref> in the documentation repository.</p>
<p>DITA Open Toolkit Release 3.1 includes
<xref keyref="docs-contributions"/> by the following people:</p>
<draft-comment author="Roger">NOTE: This lists contributions to docs, not to the core toolkit.</draft-comment>
<ol>
<li>Roger Sheen</li>
<li>Robert D. Anderson</li>
<li>Lief Erickson</li>
<li>Stefan Eike</li>
<li>Jarno Elovirta</li>
<li>Eero Helenius</li>
<li>François Violette</li>
</ol>
<p>For the complete list of documentation changes since the previous release, see the
<xref href="https://github.com/dita-ot/docs/compare/3.0...3.1" format="html" scope="external">
changelog</xref>.</p>
</section>
</refbody>
</reference>
</reference>

422
dita-ot-3.6/docsrc/release-notes/rel3.2.dita Normal file
View file

@ -0,0 +1,422 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
<reference id="ID" rev="3.2">
<title>DITA Open Toolkit 3.2.1 Release Notes</title>
<titlealts>
<navtitle>Release Notes</navtitle>
</titlealts>
<abstract>
<shortdesc>DITA Open Toolkit 3.2.1 is a maintenance release that fixes issues
reported in DITA-OT 3.2, which includes <ph conref="#v3.2/summary"/>.</shortdesc>
<p conkeyref="conref-task/semver-info"/>
<note type="tip"><ph conref="../resources/conref-task.dita#ID/download-ot"/></note>
</abstract>
<reference id="requirements">
<title>Requirements</title>
<refbody>
<section>
<draft-comment author="Roger">Add info on new minimum Java version or any other requirements that have changed
since previous release.</draft-comment>
<p>DITA Open Toolkit Release 3.2 requires the Java Runtime Environment (JRE) version
<keyword keyref="tool.java.version"/> or later.</p>
</section>
</refbody>
</reference>
<reference id="v3.2.1">
<title>DITA-OT 3.2.1
<ph outputclass="small">released December 6, 2018</ph></title>
<refbody>
<section>
<p>DITA Open Toolkit 3.2.1 is a maintenance release that includes the
following bug fixes.</p>
<ul>
<li id="3140">In earlier releases, the base directory resolution treated input files as local resources. Input
file handling has been extended to support non-local (HTTP and HTTPS) input URIs.
<xref href="https://github.com/dita-ot/dita-ot/pull/3140" format="html" scope="external">#3140</xref>
</li>
<li id="3148">The parsing mechanism for <keyword keyref="semver"/> was extended to support pre-release
versions and build metadata in plug-in repository version information.
<xref href="https://github.com/dita-ot/dita-ot/pull/3148" format="html" scope="external">#3148</xref>
</li>
<li id="3155">In earlier releases, branch filtering using <xmlelement>ditavalref</xmlelement> elements failed
when the map included references outside the scope of the map directory. This has been fixed and filtered
topics are handled as expected.
<xref href="https://github.com/dita-ot/dita-ot/pull/3155" format="html" scope="external">#3155</xref>
</li>
<li id="3156">To make XSLT import and include elements consistent, remaining relative URIs in the default
plug-ins were rewritten to use the absolute <codeph>plugin</codeph> URI scheme. This allows Saxon to detect
duplicate imports more easily and makes it easier to copy import and include elements to other stylesheets.
<xref href="https://github.com/dita-ot/dita-ot/issues/3156" format="html" scope="external">#3156</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/3159" format="html" scope="external">#3159</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/3163" format="html" scope="external">#3163</xref>
</li>
<li id="112">The plugin registry UI at <keyword keyref="site-plugin-registry"/> was not working on certain
older Windows browsers that do not support all of the necessary Javascript features. Polyfills were added to
allow these browsers to correctly display the list of available plug-ins.
<xref href="https://github.com/dita-ot/dita-ot.github.io/issues/112" format="html" scope="external"
>#112</xref>,
<xref href="https://github.com/dita-ot/dita-ot.github.io/pull/113" format="html" scope="external"
>#113</xref>,
<xref href="https://github.com/dita-ot/dita-ot.github.io/pull/114" format="html" scope="external"
>#114</xref>
</li>
</ul>
<p>For additional information on the issues resolved since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.2.1+is%3Aclosed" format="html"
scope="external">
3.2 milestone</xref> and
<xref href="https://github.com/dita-ot/dita-ot/compare/3.2...3.2.1" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v3.2">
<title>DITA-OT 3.2
<ph outputclass="small">released November 3, 2018</ph></title>
<refbody>
<section>
<p>DITA Open Toolkit Release 3.2 includes <ph id="summary">new command-line options,
support for RELAX NG parsing and validation, preliminary processing for the XDITA authoring format proposed
for Lightweight DITA, and a plug-in registry that makes it easier to discover and install new
plug-ins</ph>.</p>
</section>
<section id="features">
<title>Feature Highlights</title>
<p>DITA Open Toolkit Release 3.2 includes the following new features:</p>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.2+is%3Aclosed+label%3Afeature+sort%3Acreated-asc -->
<ul>
<li id="1960">
<p>The <cmdname>dita</cmdname> command has been extended with several new arguments and options to improve
the usability of the plug-in installation and removal processes.</p>
<ul>
<li>The <parmname>--plugins</parmname> argument shows a list of the currently installed plug-ins</li>
<li>The <parmname>--transtypes</parmname> argument shows the available output formats (transformation
types)</li>
<li>The <parmname>--force</parmname> option can be passed to
<cmdname>dita</cmdname> <parmname>--install</parmname> to overwrite an existing plug-in with a new
version.</li>
</ul>
<p>When the plug-in integration process runs, the console now shows a list of plug-ins that were added or
removed.
<xref href="https://github.com/dita-ot/dita-ot/issues/1960" format="html" scope="external">#1960</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/3037" format="html" scope="external">#3037</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3070" format="html" scope="external">#3070</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/3120" format="html" scope="external">#3120</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3109" format="html" scope="external">#3109</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/3110" format="html" scope="external">#3110</xref></p>
</li>
<li id="2019">
<p>RELAX NG schemas can now be used to parse and validate DITA topics and maps without installing additional
plug-ins.
<xref href="https://github.com/dita-ot/dita-ot/issues/2019" format="html" scope="external">#2019</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/3106" format="html" scope="external">#3106</xref></p>
<p>To use a RELAX NG schema instead of a DTD or schema, add an <xmlpi>xml-model</xmlpi> processing
instruction at the beginning of the file, immediately after the XML prolog, for example:</p>
<p><xmlpi>xml-model href="urn:oasis:names:tc:dita:rng:topic.rng"
schematypens="http://relaxng.org/ns/structure/1.0"</xmlpi>
</p>
</li>
<li id="3108">
<p>DITA-OT 3.2 adds preliminary processing for the XDITA authoring format proposed for Lightweight DITA in
addition to the preview support for the MDITA and HDITA authoring formats provided in DITA-OT 3.0.</p>
<p>The <codeph>org.oasis-open.xdita</codeph> plug-in version 0.2.2 is now bundled with the default
distribution. XDITA is a subset of DITA designed for users who want to write DITA content but who do not
want (or need) the full power of DITA.
<xref href="https://github.com/dita-ot/dita-ot/issues/3108" format="html" scope="external">#3108</xref>
<xref href="https://github.com/dita-ot/dita-ot/issues/3136" format="html" scope="external">#3136</xref>
</p>
<note type="tip">For examples of cross-format content sharing between topics in XDITA, HDITA,
extended-profile MDITA, and DITA 1.3, see the LwDITA sample files in the DITA-OT installation directory
under <filepath>plugins/org.oasis-open.xdita.v0_2_2/samples</filepath>.</note>
</li>
<li id="3028">
<p><ph conkeyref="plugins-registry/registry-summary"/></p>
<p>For more information, see
<xref keyref="plugins-registry"/>.
<xref href="https://github.com/dita-ot/dita-ot/pull/3028" format="html" scope="external">#3028</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/3101" format="html" scope="external">#3101</xref>
</p>
</li>
<li id="3102">
<p>A new parameter <parmname>link-crawl</parmname> has been added to control whether links within topics are
followed.</p>
<p>By default, links within topics are followed, as are links in any found topics, so that a map with one
topic can end up processing any number of topics. When <parmname>link-crawl</parmname> is set to
<codeph>map</codeph> instead of the default <codeph>topic</codeph>, DITA-OT will only process topics
that are actually referenced in the map.
<xref href="https://github.com/dita-ot/dita-ot/pull/3102" format="html" scope="external">#3102</xref>
</p>
</li>
</ul>
</section>
<section id="enhancements">
<title>Enhancements and changes</title>
<p>DITA Open Toolkit Release 3.2 includes the following enhancements and changes to
existing features:</p>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.2+is%3Aclosed+label%3Aenhancement+sort%3Acreated-asc -->
<ul>
<li id="1132">Text-only entries in relationship tables (with link text but no <xmlatt>href</xmlatt> attribute)
now create plain text entries in the related links section of relevant topics. This update also removes an
unnecessary error message for <xmlelement>link</xmlelement> or <xmlelement>xref</xmlelement> elements that
do not specify <xmlatt>href</xmlatt>.
<xref href="https://github.com/dita-ot/dita-ot/issues/1132" format="html" scope="external">#1132</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3030" format="html" scope="external">#3030</xref></li>
<li id="1248">XSL-FO output for for <xmlelement>section</xmlelement> and <xmlelement>example</xmlelement>
elements has been updated for consistency, ensuring that all default sections use the same blocks and
attribute sets.
<xref href="https://github.com/dita-ot/dita-ot/issues/1248" format="html" scope="external">#1248</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3057" format="html" scope="external">#3057</xref></li>
<li id="1414">In earlier versions, PDF builds would finish with <msgph>BUILD SUCCESSFUL</msgph> even when the
XSL-FO process failed. This behavior has been adjusted so the build fails if the XSL-FO processor cannot
create the PDF file.
<xref href="https://github.com/dita-ot/dita-ot/issues/1414" format="html" scope="external">#1414</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/1831" format="html" scope="external">#1831</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3137" format="html" scope="external">#3137</xref>
</li>
<li id="2033">In earlier releases, when XHTML and HTML5 processing encountered an unknown element with no
fallback processing, the result appeared in yellow. These output processes have been updated to generate a
warning for this case, and to remove the yellow formatting.
<xref href="https://github.com/dita-ot/dita-ot/issues/2033" format="html" scope="external">#2033</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/3035" format="html" scope="external">#3035</xref>
</li>
<li id="2403">The default TOC alignment of "justify" has been removed for PDF output with FOP. This was
originally added to work around a defect in FOP; that defect is resolved, so the workaround can be removed.
<xref href="https://github.com/dita-ot/dita-ot/issues/2403" format="html" scope="external">#2403</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/3036" format="html" scope="external">#3036</xref>
</li>
<li id="2461">When a grammar file (DTD, Schema, or RNG) cannot be found, DITA-OT previously issued a "file
cannot be loaded" exception that only referred to the map or topic. A new message has been added to
distinguish between topics that cannot be found and grammar files that are not available or not installed
properly.
<xref href="https://github.com/dita-ot/dita-ot/issues/2461" format="html" scope="external">#2461</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/3124" format="html" scope="external">#3124</xref>
</li>
<li id="2479">Most values for the <xmlatt>chunk</xmlatt> attribute have no meaning for PDF processing, which
always produces a single output file. Beginning with this release, chunk processing will be disabled by
default in PDF. It can be re-enabled for <xmlatt>chunk</xmlatt> attribute edge cases by setting
<codeph>org.dita.pdf2.chunk.enabled=true</codeph>.
<xref href="https://github.com/dita-ot/dita-ot/issues/2479" format="html" scope="external">#2479</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/3118" format="html" scope="external">#3118</xref>
</li>
<li id="2481">The quote element <xmlelement>q</xmlelement> now generates an equivalent XHTML and HTML5
<xmlelement>q</xmlelement> element, rather than generating quote characters. This improves accessibility
of the XHTML and HTML5 output, and defers any internationalization concerns to settings within the browser.
<xref href="https://github.com/dita-ot/dita-ot/issues/2481" format="html" scope="external">#2481</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/3032" format="html" scope="external">#3032</xref>
</li>
<li id="3009">In PDF output, the long quote element <xmlelement>lq</xmlelement> is now indented by default, as
with other output formats.
<xref href="https://github.com/dita-ot/dita-ot/issues/3009" format="html" scope="external">#3009</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/3031" format="html" scope="external">#3031</xref>
</li>
<li id="3011">The previously deprecated <codeph>dost.jar.path</codeph> alias has been removed, and the
<codeph>dost.class.path</codeph> property to which it referred has been deprecated, as the classpath is
now defined outside the Ant process.
<xref href="https://github.com/dita-ot/dita-ot/issues/3011" format="html" scope="external">#3011</xref>
</li>
<li id="3020">HTML5 CSS configuration has been refactored to improve test coverage and simplify property
declarations.
<xref href="https://github.com/dita-ot/dita-ot/issues/3020" format="html" scope="external">#3020</xref>
</li>
<li id="3025">Legacy arguments for the old Java command-line interface that were deprecated in DITA-OT 2.3
have now been removed.
<xref href="https://github.com/dita-ot/dita-ot/issues/3025" format="html" scope="external">#3025</xref>
</li>
<li id="3039">PDF output now provides generic hazard statement styling based on the ISO 3864 and ANSI Z535
standards, with an SVG icon and XSL variables for the corresponding ISO and ANSI color definitions.
<xref href="https://github.com/dita-ot/dita-ot/issues/3039" format="html" scope="external">#3039</xref>
</li>
<li id="3050">The XSL import tree for PDF output has been flattened by moving
<filepath>topic-attr.xsl</filepath> and <filepath>concept-attr.xsl</filepath> imports to the
<filepath>topic2fo.xsl</filepath> shell. In earlier versions, overriding these files required additional
modifications to <filepath>commons-attr.xsl</filepath>, from which they were imported.
<xref href="https://github.com/dita-ot/dita-ot/issues/3050" format="html" scope="external">#3050</xref>
</li>
<li id="3056">In all earlier releases, links to topics or other elements with titles would automatically
retrieve the title for use as link text, but links to the title would not. With the growing use of WYSIWYG
editors, it is easy to set (and link to) IDs directly on titles rather than on the container. Accordingly,
output transforms have been updated to pull the same link text when a reference points to a title as for a
reference to a container. The same update is made for links to definition list terms and the containing
definition list entries.
<xref href="https://github.com/dita-ot/dita-ot/issues/3056" format="html" scope="external">#3056</xref>
</li>
<li id="3059">An alternative installation method can now be used to install DITA-OT on macOS via the
<xref keyref="homebrew"/> package manager. See
<xref keyref="installing-via-homebrew"/> for details.
<xref href="https://github.com/dita-ot/dita-ot/issues/3059" format="html" scope="external">#3059</xref>
</li>
<li id="3079">The <codeph>topicpull</codeph> step of DITA-OT preprocessing is used primarily to update link
text. This step previously ran on all located topics in the build, but this processing was not useful for
<codeph>resource-only</codeph> topics that are not published. Accordingly, the <codeph>topicpull</codeph>
step has been updated to only run on normal-role topics.
<xref href="https://github.com/dita-ot/dita-ot/issues/3079" format="html" scope="external">#3079</xref>
</li>
<li id="3084">In earlier releases, <xmlatt>conref</xmlatt> resolution would fail with an error when the
referring document had a constraint that was not also specified on the target document (as when referencing
DITA content from an XDITA topic, for example). Based on the DITA specification, this is an error condition
but should only fail when the constraint is defined as "strict". Accordingly, the <xmlatt>conref</xmlatt>
processor has been updated to allow resolution of <xmlatt>conref</xmlatt> with an error for ordinary
constraints.
<xref href="https://github.com/dita-ot/dita-ot/issues/3084" format="html" scope="external">#3084</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/3097" format="html" scope="external">#3097</xref>
</li>
<li id="3090">ARIA role attributes have been extracted from structural HTML5 elements into attribute sets to
make it easier to override roles or add custom class attributes as required by popular web frameworks.
<xref href="https://github.com/dita-ot/dita-ot/issues/3090" format="html" scope="external">#3090</xref>
</li>
<li id="3100">PDF output has been updated so that if change bars are used for revisions and an entire topic is
revised, the change bar will also appear alongside the title in the table of contents and the full topic.
Previously the bar only appeared alongside the topic body.
<xref href="https://github.com/dita-ot/dita-ot/issues/3100" format="html" scope="external">#3100</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3111" format="html" scope="external">#3111</xref>
</li>
<li id="3107">Unnecessary dependencies for common Java libraries have been removed.
<xref href="https://github.com/dita-ot/dita-ot/issues/3107" format="html" scope="external">#3107</xref>
</li>
<li id="3114">The command-line help for the <cmdname>dita</cmdname> command has been updated to clarify the
list of arguments and options.
<xref href="https://github.com/dita-ot/dita-ot/issues/3114" format="html" scope="external">#3114</xref>
</li>
<li id="3121">A single NOTICES file is now generated with the license information for all third-party
libraries included in the distribution package.
<xref href="https://github.com/dita-ot/dita-ot/issues/3121" format="html" scope="external">#3121</xref>
</li>
</ul>
</section>
<section id="bugs">
<title>Bugs</title>
<p>DITA Open Toolkit Release 3.2 provides fixes for the following bugs:</p>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.2+is%3Aclosed+label%3Abug+sort%3Acreated-asc -->
<ul>
<li id="3063">When a <xmlelement>shortdesc</xmlelement> element is nested in <xmlelement>abstract</xmlelement>
along with other elements and PDF output is generated with the default chapter layout, earlier versions of
DITA-OT indented the short description further than its siblings. Processing has been updated to ensure that
the correct indentation from the parent is applied for both BASIC and MINITOC layouts.
<xref href="https://github.com/dita-ot/dita-ot/issues/3063" format="html" scope="external">#3063</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/3116" format="html" scope="external">#3116</xref>
</li>
<li id="3091">In earlier releases, footnotes defined inside elements with extra styling (such as bold, italic,
or centered text) erroneously applied the anchor style to the footnote body in PDF output. These footnotes
are now rendered with the same formatting as other footnotes.
<xref href="https://github.com/dita-ot/dita-ot/issues/3091" format="html" scope="external">#3091</xref>
</li>
<li id="3115">In PDF output generated with earlier releases, <xmlelement>div</xmlelement> elements were
rendered with nothing more than a new line. This has been corrected to render logical division elements like
other blocks, separated by a bit of space from the previous block (and pick up any standard overrides from
the <codeph>common.block</codeph> attribute set).
<xref href="https://github.com/dita-ot/dita-ot/issues/3115" format="html" scope="external">#3115</xref>
</li>
<li id="3117">Default formatting for <xmlelement>xmlpi</xmlelement> elements has been added to all output
types (including HTML-based formats, PDF, and troff) to ensure that XML processing instructions are wrapped
in question marks and angle brackets. A processing instruction tagged as <codeph>&lt;xmlpi&gt;test
this&lt;/xmlpi&gt;</codeph> is now rendered in the output as <codeph>&lt;?test this?&gt;</codeph>.
<xref format="html" href="https://github.com/dita-ot/dita-ot/issues/3117" scope="external">#3117</xref>
</li>
<li id="3119">In earlier releases, the conref push module did not properly handle namespaced debugging
attributes. (It wrote out the attribute but removed the namespace declaration.) The namespaces are now
preserved.
<xref href="https://github.com/dita-ot/dita-ot/issues/3119" format="html" scope="external">#3119</xref>
</li>
<li id="3127">When the same document appeared more than once in a map, cascading metadata was added for every
instance of that document. For maps that reference individual topics in a large document (such as a document
with 500 small topics), this resulted in <msgph>OutOfMemory</msgph> errors from the
<codeph>move-meta</codeph> preprocessing step. This has been fixed so metadata is handled properly for
each reference to a document.
<xref href="https://github.com/dita-ot/dita-ot/issues/3127" format="html" scope="external">#3127</xref>
</li>
<li id="3128">In earlier releases, input documents that included tables with the <xmlatt>frame</xmlatt>
attribute set to <codeph>"none"</codeph> generated invalid HTML5 markup (<codeph>border="0"</codeph>).
Processing has been corrected to ensure that the <xmlatt>border</xmlatt> attribute is omitted for tables
that have no border.
<xref href="https://github.com/dita-ot/dita-ot/issues/3128" format="html" scope="external">#3128</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3139" format="html" scope="external">#3139</xref>
</li>
</ul>
</section>
<section id="contrib">
<title>Contributors</title>
<p>DITA Open Toolkit Release 3.2 includes
<xref keyref="contributions"/> by the following people:</p>
<!-- https://github.com/tj/git-extras/blob/master/Commands.md#git-summary – `git summary 3.1..` -->
<draft-comment author="Roger">NOTE: This lists contributions to the core toolkit, not docs.</draft-comment>
<ol>
<li>Jarno Elovirta</li>
<li>Robert D Anderson</li>
<li>Roger Sheen</li>
<li>Stefan Gentz</li>
<li>Radu Coravu</li>
<li>Lief Erickson</li>
<li>Stefan Eike</li>
<li>Alexey Mironov</li>
<li>Eero Helenius</li>
<li>Sean Molenaar</li>
</ol>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/3.1...3.2" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
<section id="docs">
<title>Documentation updates</title>
<p>The documentation for DITA Open Toolkit Release 3.2 provides corrections and
improvements to existing topics, along with new information in the following topics:</p>
<ul>
<li>
<xref keyref="installing-via-homebrew"/></li>
<li>
<xref keyref="lwdita-input"/></li>
<li>
<xref keyref="plugins-registry"/></li>
<li>
<xref keyref="plugin-coding-conventions"/></li>
<li>
<xref keyref="plugin-configfile"/></li>
<li>
<xref keyref="books"/></li>
</ul>
<p>Additional use cases and sample files are now provided in
<xref keyref="html-customization-plugins"/>, including:
<ul>
<li>
<xref keyref="html-customization-plugin-bundle-css"/></li>
<li>
<xref keyref="html-customization-plugin-javascript"/></li>
<li>
<xref keyref="html-customization-plugin-webfont"/></li>
</ul>
<note type="tip">The files for these sample plug-ins are available on
<xref href="https://github.com/dita-ot/docs/tree/develop/samples/plugins" format="html" scope="external"
>GitHub</xref> and included in the DITA-OT installation directory under
<filepath>docsrc/samples/plugins/</filepath>.</note>
</p>
<p>For additional information on documentation issues resolved in DITA Open Toolkit Release <keyword
keyref="release"/>, see the
<xref href="https://github.com/dita-ot/docs/issues?q=milestone%3A3.2+is%3Aclosed" format="html"
scope="external">
3.2 milestone</xref> in the documentation repository.</p>
<p>DITA Open Toolkit Release 3.2 includes
<xref keyref="docs-contributions"/> by the following people:</p>
<draft-comment author="Roger">NOTE: This lists contributions to docs, not to the core toolkit.</draft-comment>
<ol>
<li>Roger Sheen</li>
<li>Robert D Anderson</li>
<li>Mark Giffin</li>
<li>Jarno Elovirta</li>
</ol>
<p>For the complete list of documentation changes since the previous release, see the
<xref href="https://github.com/dita-ot/docs/compare/3.1...3.2" format="html" scope="external">
changelog</xref>.</p>
</section>
</refbody>
</reference>
</reference>

710
dita-ot-3.6/docsrc/release-notes/rel3.3.dita Normal file
View file

@ -0,0 +1,710 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
<reference id="ID" rev="3.3">
<title>DITA Open Toolkit 3.3 Release Notes</title>
<titlealts>
<navtitle>Release Notes</navtitle>
</titlealts>
<abstract>
<shortdesc>DITA Open Toolkit 3.3.4 is a maintenance release that fixes issues
reported in DITA-OT 3.3, which includes <ph conref="#v3.3/summary"/>.</shortdesc>
<p conkeyref="conref-task/semver-info"/>
<note type="tip"><ph conref="../resources/conref-task.dita#ID/download-ot"/></note>
</abstract>
<reference id="requirements">
<title>Requirements</title>
<refbody>
<section>
<draft-comment author="Roger">Add info on new minimum Java version or any other requirements that have changed
since previous release.</draft-comment>
<p conkeyref="reusable-components/java-clients"/>
</section>
</refbody>
</reference>
<reference id="v3.3.4">
<title>DITA-OT 3.3.4
<ph outputclass="small text-muted">released September 9, 2019</ph>
</title>
<prolog>
<metadata>
<keywords/>
</metadata>
</prolog>
<refbody>
<section>
<p>DITA Open Toolkit 3.3.4 is a maintenance release that includes the
following bug fixes.</p>
<ul>
<li id="3333">In earlier releases, when a topic contained links to files outside of the map directory (but the
map itself did not link to anything outside of the map directory), setting the parameter
<parmname>onlytopic.in.map</parmname> to <codeph>true</codeph> would corrupt those peer links in the
topics. This has been fixed, and relative links within topics use the expected path.
<xref href="https://github.com/dita-ot/dita-ot/issues/3333" format="html" scope="external">#3333</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3350" format="html" scope="external">#3350</xref>
</li>
<li id="3346">In earlier releases, when a <xmlelement>link</xmlelement> element without link text also
specified attributes that resulted in DITAVAL-based flag images, generated link text used the target
document’s file name instead of a title. The link text has been fixed to pull a title from the referenced
document.
<xref href="https://github.com/dita-ot/dita-ot/issues/3346" format="html" scope="external">#3346</xref>
</li>
<li id="3347">When a topic title contains elements with <xmlatt>id</xmlatt> attributes, and those topics are
converted to PDF, earlier releases would place an extra copy of the ID in <xmlelement>fo:marker</xmlelement>
elements used to help with headers. The duplicate ID, which resulted in warnings from some FO processors,
has been removed.
<xref href="https://github.com/dita-ot/dita-ot/issues/3347" format="html" scope="external">#3347</xref>
</li>
<li id="3348">DITA-OT distribution packages are now built and tested with the open-source Java distribution
<xref keyref="download.openjdk">OpenJDK 8</xref>.
<xref href="https://github.com/dita-ot/dita-ot/issues/3348" format="html" scope="external">#3348</xref>
</li>
<li id="3349">In earlier releases, cross references to footnotes in XHTML and HTML5 applied superscript
styling too early in the build, resulting in errors from later processing stages. This has been corrected,
and the build creates the expected styling without any errors.
<xref href="https://github.com/dita-ot/dita-ot/issues/3349" format="html" scope="external">#3349</xref>
</li>
<li id="3351">In earlier releases, when a map included an <xmlelement>authorinformation</xmlelement> element
that did not provide an author or organization, formatters would generate errors when creating PDF metadata
based on that empty metadata. The build has been updated to ignore empty author information in source
documents.
<xref href="https://github.com/dita-ot/dita-ot/issues/3351" format="html" scope="external">#3351</xref>
</li>
<li id="3356">In DITA-OT 3.3.3, we updated XHTML and HTML5 processing to make more efficient use of table
metadata when calculating table cell positions for accessibility. That processing failed for some tables
that used invalid CALS markup. The processing has been updated to make it more tolerant of incorrect input.
<xref href="https://github.com/dita-ot/dita-ot/issues/3356" format="html" scope="external">#3356</xref>
</li>
</ul>
<p>For additional information on the issues resolved since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.3.4+is%3Aclosed" format="html"
scope="external">3.3.4 milestone</xref> and
<xref href="https://github.com/dita-ot/dita-ot/compare/3.3.3...3.3.4" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v3.3.3">
<title>DITA-OT 3.3.3 <ph outputclass="small text-muted">released July 13, 2019</ph>
</title>
<prolog>
<metadata>
<keywords>
<indexterm>HTML5
<indexterm>table <xmlatt>headers</xmlatt></indexterm></indexterm>
<indexterm>flagging</indexterm>
<indexterm><xmlatt>xml:lang</xmlatt></indexterm>
<indexterm><xmlelement>linklist</xmlelement></indexterm>
<indexterm>languages
<indexterm><xmlelement>linklist</xmlelement></indexterm></indexterm>
<indexterm>link processing</indexterm>
<indexterm>Trouble note labels</indexterm>
<indexterm><xmlelement>note</xmlelement></indexterm>
<indexterm>passthrough</indexterm>
<indexterm>DITAVAL
<indexterm>passthrough action</indexterm></indexterm>
<indexterm><xmlatt>action</xmlatt></indexterm>
<indexterm><xmlelement>prop</xmlelement></indexterm>
<indexterm>Saxon
<indexterm>tables</indexterm>
<indexterm>screen readers</indexterm></indexterm>
</keywords>
</metadata>
</prolog>
<refbody>
<section>
<p>DITA Open Toolkit 3.3.3 is a maintenance release that includes the following bug fixes.</p>
<ul>
<li id="3313">The code that generates <xmlatt>headers</xmlatt> attributes in HTML-based output formats has
been simplified to prevent Saxon crashes when processing complex tables. (These attributes help screen
readers to identify the header cells to which table cells are related.)
<xref href="https://github.com/dita-ot/dita-ot/issues/3313" format="html" scope="external">#3313</xref>
</li>
<!--
<li id="3316">For HTML-based output formats, image flag processing has been improved to ensure that flag
images are reliably copied to the correct location(s) in the output directory, regardless of whether the
DITAVAL is outside the map directory, in the map directory, or in a subdirectory of the map location.
<xref href="https://github.com/dita-ot/dita-ot/issues/3316" format="html" scope="external">#3316</xref>
</li>
-->
<li id="3317">In recent (3.x) versions of DITA-OT, flagging information is added before generated links are
created, so any flags on the topic reference are ignored. Processing has been updated to copy flags from the
<xmlelement>topicref</xmlelement> to the links that are generated to point to that topic.
<xref href="https://github.com/dita-ot/dita-ot/issues/3317" format="html" scope="external">#3317</xref>
</li>
<li id="3321">Earlier versions of DITA-OT failed to honor the effective <xmlatt>xml:lang</xmlatt> attribute
value when processing links. This error has been corrected to ensure that the closest language value is
preserved on the generated <xmlelement>linklist</xmlelement>, so locale-based headings such as ”Related
information” are applied correctly.
<xref href="https://github.com/dita-ot/dita-ot/issues/3321" format="html" scope="external">#3321</xref>
</li>
<li id="3322">The strings files for each supported language now include default translations for the “Trouble”
note label that is used for <xmlelement>note</xmlelement> elements with the <xmlatt>type</xmlatt> attribute
set to <codeph>trouble</codeph>.
<xref href="https://github.com/dita-ot/dita-ot/issues/3322" format="html" scope="external">#3322</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3336" format="html" scope="external">#3336</xref>
</li>
<li id="3325">When generating HTML5 output, DITAVAL files can now preserve profiling attributes by default by
setting the <xmlatt>action</xmlatt> attribute of a <xmlelement>prop</xmlelement> element to
<codeph>passthrough</codeph>. Earlier versions of DITA-OT would only pass values through if the DITAVAL
filter defined matching attribute/value pairs via specific <xmlatt>att</xmlatt> and <xmlatt>val</xmlatt>
settings.
<xref href="https://github.com/dita-ot/dita-ot/issues/3325" format="html" scope="external">#3325</xref>
</li>
<li id="3338">The LwDITA plugin has been updated to version 2.3.0 to fix several issues in Lightweight DITA
processing. (Nested lists are now properly generated in Markdown output when list items starts with inline
markup such as bold, or italics. Topic references with the <xmlatt>format</xmlatt> attribute set to
<codeph>html</codeph> will no longer be interpreted as DITA content. LwDITA-specific processing can be
applied to HTML topics by setting the <xmlatt>format</xmlatt> attribute to <codeph>hdita</codeph>.)
<xref href="https://github.com/dita-ot/dita-ot/issues/3338" format="html" scope="external">#3338</xref>
</li>
</ul>
<p>For additional information on the issues resolved since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.3.3+is%3Aclosed" format="html"
scope="external">3.3.3 milestone</xref> and
<xref href="https://github.com/dita-ot/dita-ot/compare/3.3.2...3.3.3" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v3.3.2">
<title>DITA-OT 3.3.2 <ph outputclass="small text-muted">released May 28, 2019</ph>
</title>
<prolog>
<metadata>
<keywords>
<indexterm>Bosnian</indexterm>
<indexterm>Danish</indexterm>
<indexterm>Montenegrin</indexterm>
<indexterm>Vietnamese</indexterm>
<indexterm>Saxon
<indexterm>version</indexterm></indexterm>
<indexterm>media
<index-see-also>images</index-see-also></indexterm>
<indexterm>video
<index-see>media</index-see></indexterm>
</keywords>
</metadata>
</prolog>
<refbody>
<section>
<p>DITA Open Toolkit 3.3.2 is a maintenance release that includes the following bug fixes.</p>
<ul>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.3.2+sort%3Acreated-asc -->
<li id="2722">Earlier versions of DITA-OT would attempt to download remote media objects referenced via the
<xmlatt>data</xmlatt> attribute of the <xmlelement>object</xmlelement> element, and failed to copy local
media objects to the output folder. Processing has been corrected to handle these references correctly.
<xref href="https://github.com/dita-ot/dita-ot/issues/2722" format="html" scope="external">#2722</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2861" format="html" scope="external">#2861</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2947" format="html" scope="external">#2947</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3306" format="html" scope="external">#3306</xref>
</li>
<li id="3284">DITA-OT 3.3.1 would generate an invalid catalog file with an empty XML namespace when the
bundled version 9.8.0.14 of Saxon Home Edition was replaced with Saxon-HE 9.8.0.15. This has been corrected
to ensure that the OASIS namespace is used when generating the <filepath>catalog-dita.xml</filepath> file.
<xref href="https://github.com/dita-ot/dita-ot/issues/3284" format="html" scope="external">#3284</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3287" format="html" scope="external">#3287</xref>
<note>DITA-OT 3.3.2 still ships with <keyword keyref="tool.saxon.edition"/>
<keyword keyref="tool.saxon.version"/>, but now also works with version 9.8.0.15.</note>
</li>
<li id="3304">In PDF output, the bitmap warning icon has been replaced with the SVG image previously added for
the PDF implementation of the hazard domain. The new image appears in <xmlelement>note</xmlelement> elements
of type <codeph>attention</codeph>, <codeph>caution</codeph>, <codeph>danger</codeph>,
<codeph>trouble</codeph>, and <codeph>warning</codeph> and is scaled to match the previous icon size.
<xref href="https://github.com/dita-ot/dita-ot/issues/3304" format="html" scope="external">#3304</xref>
<note type="attention">The legacy <filepath>warning.gif</filepath> file remains available in the common
artwork folder, but will be removed in an upcoming version.</note>
</li>
<li id="3310">Translations of the generated string for “continued” index entries have been added to the
Bosnian, Danish, Montenegrin, and Vietnamese localizations.
<xref href="https://github.com/dita-ot/dita-ot/issues/3310" format="html" scope="external">#3310</xref>
</li>
</ul>
<p>For additional information on the issues resolved since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.3.2+is%3Aclosed" format="html"
scope="external">3.3.2 milestone</xref> and
<xref href="https://github.com/dita-ot/dita-ot/compare/3.3.1...3.3.2" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v3.3.1">
<title>DITA-OT 3.3.1 <ph outputclass="small text-muted">released April 8, 2019</ph></title>
<prolog>
<metadata>
<keywords>
<indexterm>security</indexterm>
<indexterm>TLS</indexterm>
<indexterm>registry</indexterm>
<indexterm><xmlelement>draft-comment</xmlelement></indexterm>
<indexterm><xmlelement>required-cleanup</xmlelement></indexterm>
<indexterm><xmlatt>conref</xmlatt>
<indexterm>multiple targets</indexterm></indexterm>
<indexterm><xmlatt>type</xmlatt></indexterm>
<indexterm><xmlatt>conkeyref</xmlatt></indexterm>
<indexterm><cmdname>dita</cmdname> command
<indexterm>plug-in registry</indexterm></indexterm>
<indexterm>integrator</indexterm>
<indexterm>transtype
<indexterm>string</indexterm></indexterm>
</keywords>
</metadata>
</prolog>
<refbody>
<section>
<p>DITA Open Toolkit 3.3.1 is a maintenance release that includes the following bug fixes.</p>
<ul>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.3.1+sort%3Acreated-asc -->
<li id="3248">When processing content references in cases with more than one possible target for the
<xmlatt>conref</xmlatt> value, recent versions of DITA-OT warned about the duplicate ID, but failed to
include the reference target in the message. The <msgnum>DOTX011W</msgnum> warning now restores this context
to aid in troubleshooting.
<xref href="https://github.com/dita-ot/dita-ot/issues/3248" format="html" scope="external">#3248</xref>
</li>
<li id="3249">When processing source files with tables or figures in <xmlelement>draft-comment</xmlelement> or
<xmlelement>required-cleanup</xmlelement> elements, earlier versions of DITA-OT included them in lists and
numbered references even when DRAFT output was not active. Hidden elements are now excluded from lists of
figures and tables, and when numbering references.
<xref href="https://github.com/dita-ot/dita-ot/issues/3249" format="html" scope="external">#3249</xref>
</li>
<li id="3251">The <xmlatt>type</xmlatt> attribute of the <parmname>args.css</parmname> and
<parmname>args.cssroot</parmname> parameters has been changed to <codeph>string</codeph> to better support
values that include relative paths. The <parmname>transtype</parmname> has also been corrected to
<codeph>string</codeph>.
<xref href="https://github.com/dita-ot/dita-ot/issues/3251" format="html" scope="external">#3251</xref>
</li>
<li id="3260">When copying files to a temporary file scheme that flattens the directory structure, the
map-first preprocessing routine will now correctly handle indirect content references defined via
<xmlatt>conkeyref</xmlatt>.
<xref href="https://github.com/dita-ot/dita-ot/issues/3260" format="html" scope="external">#3260</xref>
</li>
<li id="3272">The integrator and topic reader modules have been modified to use an alternative method
supported by the XML APIs library to prevent errors when compiling the toolkit’s JAR file.
<xref href="https://github.com/dita-ot/dita-ot/issues/3272" format="html" scope="external">#3272</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3273" format="html" scope="external">#3273</xref>
</li>
<li id="3278">The <cmdname>dita</cmdname> command now uses a secure connection to the plug-in registry when
installing new plug-ins.
<xref href="https://github.com/dita-ot/dita-ot/issues/3278" format="html" scope="external">#3278</xref>
<note type="attention">To ensure data integrity during the plug-in installation process, Transport Layer
Security (TLS) will soon be required to access the plug-in registry. If you are using DITA-OT 3.3, 3.2, or
3.2.1 and are unable to upgrade to 3.3.1, modify the <codeph>registry</codeph> key in the
<filepath>config/configuration.properties</filepath> file to switch the URI schema to
<codeph>http<b>s</b>://</codeph>, so the entry reads
<codeph>https://plugins.dita-ot.org/</codeph>.</note>
</li>
</ul>
<p>For additional information on the issues resolved since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.3.1+is%3Aclosed" format="html"
scope="external">3.3.1 milestone</xref> and
<xref href="https://github.com/dita-ot/dita-ot/compare/3.3...3.3.1" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v3.3">
<title>DITA-OT 3.3
<ph outputclass="small text-muted">released February 28, 2019</ph></title>
<prolog>
<metadata>
<keywords>
<indexterm><xmlelement>entry</xmlelement></indexterm>
<indexterm><xmlatt>rotate</xmlatt></indexterm>
<indexterm>DITA 1.3
<indexterm><xmlatt>rotate</xmlatt></indexterm></indexterm>
<indexterm>tables
<indexterm>attribute sets</indexterm>
<indexterm>rotated cells</indexterm></indexterm>
</keywords>
</metadata>
</prolog>
<refbody>
<section>
<p>DITA Open Toolkit Release 3.3 includes <ph id="summary">new attribute sets for HTML5
customization, support for custom integration processing, rotated table cells in PDF output, and hazard
statements in HTML output</ph>.</p>
</section>
<section id="features">
<title>Feature Highlights</title>
<p>DITA Open Toolkit Release 3.3 includes the following new features:</p>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.3+is%3Aclosed+label%3Afeature+sort%3Acreated-asc -->
<ul>
<li id="1778">
<p>The <xmlatt>rotate</xmlatt> attribute on table <xmlelement>entry</xmlelement> elements, which was added
in the DITA 1.3 specification, is now supported in PDF output.
<xref href="https://github.com/dita-ot/dita-ot/issues/1778" format="html" scope="external">#1778</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2717" format="html" scope="external">#2717</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3161" format="html" scope="external">#3161</xref>
</p></li>
<li id="3175">
<p>A new <codeph>CustomIntegrator</codeph> interface provides a mechanism for custom plug-ins to extend the
default integration process via service provider classes declared via a
<xref href="https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html" scope="external"
format="html">Java <codeph>ServiceLoader</codeph></xref>.
<xref href="https://github.com/dita-ot/dita-ot/issues/3175" format="html" scope="external">#3175</xref>
</p></li>
<li id="3207">
<p>HTML5 and XHTML output now provide generic hazard statement styling based on the ISO 3864 and ANSI Z535
standards, with an SVG icon and
<xref keyref="sass-lang"/> variables for the corresponding ISO and ANSI color definitions. The ANSI colors
are used by default to match the PDF styling previously added in DITA-OT 3.2.
<xref href="https://github.com/dita-ot/dita-ot/issues/3207" format="html" scope="external">#3207</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3231" format="html" scope="external">#3231</xref>
</p></li>
<li>
<p conkeyref="migrating-to-3.3/html5-att-sets"/>
</li>
</ul>
</section>
<section id="enhancements">
<title>Enhancements and changes</title>
<indexterm><xmlelement>steps</xmlelement></indexterm>
<indexterm><xmlelement>section</xmlelement></indexterm>
<indexterm><xmlelement>example</xmlelement></indexterm>
<indexterm><xmlelement>prereq</xmlelement></indexterm>
<indexterm><xmlelement>stepsection</xmlelement></indexterm>
<indexterm><xmlelement>mapref</xmlelement></indexterm>
<indexterm><xmlelement>topicref</xmlelement></indexterm>
<indexterm>schema
<indexterm>RELAX NG</indexterm></indexterm>
<indexterm><cmdname>dita</cmdname> command
<indexterm>property values</indexterm></indexterm>
<indexterm>XSLT
<indexterm>file location</indexterm></indexterm>
<indexterm>Saxon
<indexterm>version</indexterm></indexterm>
<indexterm><xmlatt>conref</xmlatt>
<indexterm>empty</indexterm></indexterm>
<p>DITA Open Toolkit Release 3.3 includes the following enhancements and changes to
existing features:</p>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.3+is%3Aclosed+label%3Aenhancement+sort%3Acreated-asc -->
<ul>
<li id="2225">The <cmdname>dita</cmdname> command now recognizes a wider range of “truthy” property values,
including <codeph>true</codeph>, <codeph>yes</codeph>, <codeph>1</codeph>, and <codeph>on</codeph> and
handles inconsistently cased values more gracefully.
<xref href="https://github.com/dita-ot/dita-ot/issues/2225" format="html" scope="external">#2225</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3197" format="html" scope="external">#3197</xref>
</li>
<li id="3157">Various XSLT files and other resources have been moved from the root of the DITA-OT installation
directory to the base plug-in directory <filepath>plugins/org.dita.base</filepath>.
<xref href="https://github.com/dita-ot/dita-ot/issues/3157" format="html" scope="external">#3157</xref> (If
your plug-ins use the <codeph>plugin</codeph> URI scheme as recommended in the
<xref keyref="plugin-coding-conventions"/>, this change should not require any modifications to custom
plug-in code.) </li>
<li id="3176"><ph conkeyref="migrating-to-3.3/templates"/>
<xref href="https://github.com/dita-ot/dita-ot/issues/3176" format="html" scope="external">#3176</xref>
</li>
<li id="3177">In HTML5 output, task <xmlelement>steps</xmlelement> are now wrapped in
<xmlelement>section</xmlelement> elements and DITA <xmlelement>example</xmlelement>,
<xmlelement>prereq</xmlelement>, and <xmlelement>stepsection</xmlelement> elements are also generated as
HTML5 <xmlelement>section</xmlelement> elements.
<xref href="https://github.com/dita-ot/dita-ot/issues/3177" format="html" scope="external">#3177</xref>
</li>
<li id="3178">Java code has been refactored to add missing DITA classes to the list of available Java
constants and re-sort the constant definitions.
<xref href="https://github.com/dita-ot/dita-ot/issues/3178" format="html" scope="external">#3178</xref>
</li>
<li id="3182">Custom <xmlelement>pipeline</xmlelement> modules can now use SAX filters. This makes it possible
to configure the module’s behavior at the Ant level and add additional processing to a module. Modules do
not have to define nested filters if they prefer not to expose this extension point or do not use SAX
internally.
<xref href="https://github.com/dita-ot/dita-ot/issues/3182" format="html" scope="external">#3182</xref>
<codeblock outputclass="language-xml">&lt;pipeline>
&lt;module class="com.example.Module">
&lt;filter class="com.example.XmlFilter"/>
&lt;/module>
&lt;/pipeline></codeblock></li>
<li id="3187">New extension points have been added to contribute parameters to the debug-filter, map reader,
and topic reader Java preprocessing modules.
<xref format="html" href="https://github.com/dita-ot/dita-ot/issues/3187" scope="external">#3187</xref>
<ul>
<li>
<parmname>dita.preprocess.debug-filter.param</parmname></li>
<li>
<parmname>dita.preprocess.map-reader.param</parmname></li>
<li>
<parmname>dita.preprocess.topic-reader.param</parmname></li>
</ul>
</li>
<li id="3188">The DITA-OT fork of the
<xref href="https://github.com/relaxng/jing-trang" format="html" scope="external">jing-trang</xref> project
used to provide RELAX NG schema validation in DITA-OT 3.2 has been replaced with the upstream code after the
patches provided by George Bina were included.
<xref href="https://github.com/dita-ot/dita-ot/issues/3188" format="html" scope="external">#3188</xref>
</li>
<li id="3191">Several bundled dependencies have been upgraded to the latest versions.
<xref href="https://github.com/dita-ot/dita-ot/issues/3191" format="html" scope="external">#3191</xref>
<ul>
<li>Ant 1.10.5</li>
<li>Jackson 2.9.8</li>
<li>Saxon-HE 9.8.0-14</li>
<li>Xerces-J2 2.12.0</li>
</ul>
</li>
<li id="3193">An additional keyscope test has been added to test interactions with submaps referenced via
<xmlelement>mapref</xmlelement>.
<xref href="https://github.com/dita-ot/dita-ot/issues/3193" format="html" scope="external">#3193</xref>
</li>
<li id="3195">The default character set for code references can now be changed by adding the
<parmname>default.coderef-charset</parmname> key to the
<xref keyref="configuration-properties-file">configuration.properties</xref> file. The character set values
are those supported by the Java
<xref format="html" href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html"
scope="external">Charset</xref> class.
<xref href="https://github.com/dita-ot/dita-ot/issues/3195" format="html" scope="external">#3195</xref>
</li>
<li id="3196">The <xmlelement>ditafileset</xmlelement> now supports nested <xmlelement>includes</xmlelement>
and <xmlelement>excludes</xmlelement> elements to more easily control which files get processed (or do not
get processed) by each processing step. The <codeph>copy-files</codeph> task has been been moved to the end
of the preprocessing pipeline to match the order in map-first preprocessing (<codeph>preprocess2</codeph>).
<xref href="https://github.com/dita-ot/dita-ot/issues/3196" format="html" scope="external">#3196</xref>
<indexterm>ditafileset</indexterm>
</li>
<li id="3204">The
<xref keyref="gradle"/> build system has been updated to the latest patch release (5.2.1).
<xref href="https://github.com/dita-ot/dita-ot/issues/3204" format="html" scope="external">#3204</xref>
</li>
<li id="3217">When source files contain an empty <codeph>conref=""</codeph> attribute value, DITA-OT now
provides a meaningful warning and then ignores this construct, which previously resulted in parser errors.
<xref href="https://github.com/dita-ot/dita-ot/issues/3217" format="html" scope="external">#3217</xref>
</li>
<li id="3230"><ph conkeyref="migrating-to-3.3/catalog"/>
<xref href="https://github.com/dita-ot/dita-ot/issues/3230" format="html" scope="external">#3230</xref>
</li>
</ul>
</section>
<section id="bugs">
<title>Bugs</title>
<indexterm><xmlelement>topicgroup</xmlelement></indexterm>
<indexterm><xmlelement>topichead</xmlelement></indexterm>
<indexterm><xmlelement>dt</xmlelement></indexterm>
<indexterm><xmlelement>tm</xmlelement></indexterm>
<indexterm><xmlatt>conref</xmlatt>
<indexterm>-dita-use-conref-target</indexterm></indexterm>
<indexterm><xmlatt>keyref</xmlatt></indexterm>
<indexterm><xmlatt>chunk</xmlatt>
<indexterm>processing changes</indexterm></indexterm>
<indexterm><xmlatt>id</xmlatt>
<indexterm><xmlelement>dt</xmlelement></indexterm></indexterm>
<indexterm>DITAVAL
<indexterm>duplicate conditions</indexterm>
<indexterm>change bars</indexterm></indexterm>
<indexterm>Linux
<indexterm>installation directory</indexterm></indexterm>
<indexterm>macOS
<indexterm>installation directory</indexterm></indexterm>
<indexterm>Windows
<indexterm>installation directory</indexterm></indexterm>
<indexterm>RELAX NG
<index-see>schema</index-see></indexterm>
<indexterm>schema
<indexterm>RELAX NG</indexterm></indexterm>
<indexterm><cmdname>dita</cmdname> command
<indexterm>= (equals sign)</indexterm></indexterm>
<indexterm>nav-toc</indexterm>
<p>DITA Open Toolkit Release 3.3 provides fixes for the following bugs:</p>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.3+is%3Aclosed+label%3Abug+sort%3Acreated-asc -->
<ul>
<li id="1439">In earlier releases, external URIs referenced via <xmlatt>keyref</xmlatt> from within
relationship tables resulted in links with broken link text. This has been fixed, and metadata including
link text or titles is preserved for external URIs referenced by key within a map.
<xref href="https://github.com/dita-ot/dita-ot/issues/1439" format="html" scope="external">#1439</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pulls/3179" format="html" scope="external">#3179</xref></li>
<li id="1951">Relative paths in peer or non-DITA key references were not handled correctly in earlier
releases. The paths are now adjusted as needed to stay valid in any referencing location.
<xref href="https://github.com/dita-ot/dita-ot/issues/1951" format="html" scope="external">#1951</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2250" format="html" scope="external">#2250</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2581" format="html" scope="external">#2581</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2620" format="html" scope="external">#2620</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3234" format="html" scope="external">#3234</xref>
</li>
<li id="2428">Several fixes have been added to improve support for the <xmlatt>chunk</xmlatt> attribute on
topic groups (covering both <xmlelement>topicgroup</xmlelement> and any other
<xmlelement>topicref</xmlelement> style container that does not reference a file).
<xref href="https://github.com/dita-ot/dita-ot/issues/2428" format="html" scope="external">#2428</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2730" format="html" scope="external">#2730</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2843" format="html" scope="external">#2843</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3216" format="html" scope="external">#3216</xref>
<ul>
<li>In earlier releases, using <codeph>chunk="to-content"</codeph> on a grouping element <i>within</i>
another branch or map that specified <codeph>chunk="to-content"</codeph> would result in a
NullPointerException. This error has been fixed.</li>
<li>In earlier releases, using <codeph>chunk="to-content"</codeph> on a nested map would result in the
same NullPointerExceptions when the map reference was inside of a chunked branch or map.</li>
<li>In earlier releases, <xmlelement>topicgroup</xmlelement> elements with no title that used
<codeph>chunk="to-content"</codeph> would result in a generated heading in the output file, such as
"Chunk1234567". Chunked containers without a heading will no longer result in a generated heading in the
output.</li>
<li>In earlier releases, <xmlelement>topichead</xmlelement> elements inside of a chunked branch would
result in headings that appeared out of order for PDF. This has been fixed; topic headings will appear
where expected in the PDF flow.</li>
</ul>
</li>
<li id="2523">In earlier versions, references to keys in local scopes were not processed correctly. In certain
other cases, files referenced through mapref were parsed with the root scope instead of their parent scope.
Keyref parsing has been improved to reliably detect and preserve key scopes to ensure that all key
references are resolved in the correct scopes.
<xref href="https://github.com/dita-ot/dita-ot/issues/2523" format="html" scope="external">#2523</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3141" format="html" scope="external">#3141</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3194" format="html" scope="external">#3194</xref>
</li>
<li id="2899">In some recent releases, cross references to local, non-DITA files with formats such as "pdf" or
"txt" did not copy those referenced files to the output directory. When appropriate, such as when generating
HTML output, these files are now copied to the output directory as they were in earlier releases.
<xref href="https://github.com/dita-ot/dita-ot/issues/2899" format="html" scope="external">#2899</xref>
</li>
<li id="3162">On Linux and other systems where the DITA-OT installation directory and temporary directory are
not on the same volume, plug-in installation would fail when DITA-OT tried to move a non-empty directory.
The installation process has been refactored to ensure that plug-ins are correctly installed in these cases.
<xref href="https://github.com/dita-ot/dita-ot/issues/3162" format="html" scope="external">#3162</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3238" format="html" scope="external">#3238</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3239" format="html" scope="external">#3239</xref>
</li>
<li id="3180">In earlier versions, setting an <xmlatt>id</xmlatt> attribute on a <xmlelement>dt</xmlelement>
created duplicate IDs in the XSL-FO file, which caused warnings when rendering FO to PDF.
<xref href="https://github.com/dita-ot/dita-ot/issues/3180" format="html" scope="external">#3180</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3185" format="html" scope="external">#3185</xref>
</li>
<li id="3183">The <filepath>plugin.rnc</filepath> RELAX NG Compact Syntax schema used to validate plug-in
descriptor files was inadvertently removed from the distribution package and has been restored.
<xref href="https://github.com/dita-ot/dita-ot/issues/3183" format="html" scope="external">#3183</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3220" format="html" scope="external">#3220</xref>
</li>
<li id="3198">The codeblock normalization process would sometimes fail to recognize certain combinations of
characters at the beginning of code blocks, resulting in error messages. These adjacent text events are now
merged before the indentation is adjusted.
<xref href="https://github.com/dita-ot/dita-ot/issues/3198" format="html" scope="external">#3198</xref>
</li>
<li id="3210">In earlier releases, some indirect key references to glossary entries could result in XSLT
errors when more than one possible key target existed. This is corrected by using the single desired target
to resolve such links.
<xref href="https://github.com/dita-ot/dita-ot/issues/3210" format="html" scope="external">#3210</xref>
</li>
<li id="3211">When the input file set contained resources with different URI schemes (for example local files
and external files referenced via HTTPS), earlier versions of DITA-OT would fail with errors. Preprocessing
routines have been corrected to ensure the the base directory is correctly calculated in these cases.
<xref href="https://github.com/dita-ot/dita-ot/issues/3211" format="html" scope="external">#3211</xref>
</li>
<li id="3213">When generating HTML5 output with the <parmname>nav-toc</parmname> parameter set to
<codeph>partial</codeph>, earlier versions would fail to insert table-of-contents navigation in topics
whose names contained spaces. The path normalization process has been corrected to ensure that spaces in
file and directory names are correctly URL-encoded as <codeph>%20</codeph>, and navigation is included.
<xref href="https://github.com/dita-ot/dita-ot/issues/3213" format="html" scope="external">#3213</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3229" format="html" scope="external">#3229</xref>
</li>
<li id="3214">In earlier releases, some revision properties were ignored on <xmlelement>tm</xmlelement>
elements in PDF output. This is now corrected, so that revision flagging such as text color or background
color are properly supported on trademarks.
<xref href="https://github.com/dita-ot/dita-ot/issues/3214" format="html" scope="external">#3214</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3215" format="html" scope="external">#3215</xref>
</li>
<li id="3219">In documentation and error messages about available transformation types, extensions of an
existing transformation could result in duplicate values (such as 3 instances of "pdf"). Duplicates are now
removed when listing the available transformation types.
<xref href="https://github.com/dita-ot/dita-ot/issues/3219" format="html" scope="external">#3219</xref>
</li>
<li id="3223">In earlier releases, duplicate conditions in DITAVAL properties (such as using two DITAVAL
documents for a build that each set up rules for <codeph>rev="rev3"</codeph>) would generate a warning. This
message has been reduced in severity and will now appear only as an informational message with verbose
logging.
<xref href="https://github.com/dita-ot/dita-ot/issues/3223" format="html" scope="external">#3223</xref>
</li>
<li id="3224">In earlier releases, content references on elements that specified
<codeph>href="-dita-use-conref-target"</codeph> would evaluate that value as a literal file name. That
token (defined in the
<xref
href="http://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part1-base/langRef/attributes/ditauseconreftarget.html"
format="html" scope="external">DITA specification</xref>) is now ignored on elements that also use
<xmlatt>conref</xmlatt>.
<xref href="https://github.com/dita-ot/dita-ot/issues/3224" format="html" scope="external">#3224</xref>
<indexterm>-dita-use-conref-target</indexterm>
</li>
<li id="3235">Revised figures and tables are now marked with change bars in booklists when DITAVAL files
define flagging for the corresponding revision values.
<xref href="https://github.com/dita-ot/dita-ot/issues/3235" format="html" scope="external">#3235</xref>
</li>
<li id="3245">The command line syntax for the <cmdname>dita</cmdname>
<parmname>--install</parmname> option has been updated to support the “=” equals sign.
<xref href="https://github.com/dita-ot/dita-ot/issues/3245" format="html" scope="external">#3245</xref>
<p>Both of the following formats are now supported:
<codeblock><cmdname>dita</cmdname> <parmname>--install</parmname>=<varname>plug-in-zip</varname>
<cmdname>dita</cmdname> <parmname>--install</parmname> <varname>plug-in-zip</varname></codeblock></p>
</li>
</ul>
</section>
<section id="contrib">
<title>Contributors</title>
<p>DITA Open Toolkit Release 3.3 includes
<xref keyref="contributions"/> by the following people:</p>
<!-- https://github.com/tj/git-extras/blob/master/Commands.md#git-summary – `git summary 3.2..` -->
<draft-comment author="Roger">NOTE: This lists contributions to the core toolkit, not docs.</draft-comment>
<ol>
<li>Jarno Elovirta</li>
<li>Robert D Anderson</li>
<li>Roger Sheen</li>
<li>Simen Tinderholt</li>
<li>Eliot Kimber</li>
<li>Eric Sirois</li>
</ol>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/3.2...3.3" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
<section id="docs">
<title>Documentation updates</title>
<p>The documentation for DITA Open Toolkit Release 3.3 provides corrections and
improvements to existing topics, along with new information in the following topics:</p>
<ul>
<li>
<xref keyref="prerequisite-software"/></li>
<li>
<xref keyref="dita-command-arguments"/></li>
<li>
<xref keyref="pdf2-creating-change-bars"/></li>
<li>
<xref keyref="plugins-registry"/></li>
<li>
<xref keyref="plugin-javalib"/></li>
<li>
<xref keyref="plugin-implement-saxon-customizations"/></li>
<li>
<xref keyref="plugin-extension-points-pre-processing"/></li>
<li>
<xref keyref="migrating-to-3.3"/></li>
</ul>
<p>For additional information on documentation issues resolved in DITA Open Toolkit Release <keyword
keyref="release"/>, see the
<xref href="https://github.com/dita-ot/docs/issues?q=milestone%3A3.3+is%3Aclosed" format="html"
scope="external">
3.3 milestone</xref> in the documentation repository.</p>
<p>DITA Open Toolkit Release 3.3 includes
<xref keyref="docs-contributions"/> by the following people:</p>
<draft-comment author="Roger">NOTE: This lists contributions to docs, not to the core toolkit.</draft-comment>
<ol>
<li>Roger Sheen</li>
<li>Eliot Kimber</li>
<li>Robert D Anderson</li>
<li>Jarno Elovirta</li>
<li>Quick van Rijt</li>
</ol>
<p>For the complete list of documentation changes since the previous release, see the
<xref href="https://github.com/dita-ot/docs/compare/3.2...3.3" format="html" scope="external">
changelog</xref>.</p>
</section>
</refbody>
</reference>
</reference>

416
dita-ot-3.6/docsrc/release-notes/rel3.4.dita Normal file
View file

@ -0,0 +1,416 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
<reference id="ID" rev="3.4">
<title>DITA Open Toolkit 3.4 Release Notes</title>
<titlealts>
<navtitle>Release Notes</navtitle>
</titlealts>
<abstract>
<shortdesc>DITA Open Toolkit 3.4.1 is a maintenance release that fixes issues
reported in DITA-OT 3.4, which includes <ph conref="#v3.4/summary"/>.</shortdesc>
<p conkeyref="conref-task/semver-info"/>
<note type="tip"><ph conref="../resources/conref-task.dita#ID/download-ot"/></note>
</abstract>
<prolog>
<author type="contributor">infotexture</author>
<critdates>
<!--infotexture-->
<revised modified="2020-03-26"/>
</critdates>
</prolog>
<reference id="requirements">
<title>Requirements</title>
<refbody>
<section>
<draft-comment author="Roger">Add info on new minimum Java version or any other requirements that have changed
since previous release.</draft-comment>
<p conkeyref="reusable-components/java-clients"/>
</section>
</refbody>
</reference>
<reference id="v3.4.1">
<title>DITA-OT 3.4.1
<!--<ph outputclass="small text-muted">(release date)</ph>-->
</title>
<prolog>
<metadata>
<keywords>
<indexterm><filepath>project.rnc</filepath> file</indexterm>
<indexterm><xmlelement>dvrResourcePrefix</xmlelement></indexterm>
<indexterm><xmlelement>dvrResourceSuffix</xmlelement></indexterm>
<indexterm>classification maps</indexterm>
<indexterm>Jackson data binding library</indexterm>
<indexterm>missing SVG images</indexterm>
<indexterm>project files
<indexterm>validating</indexterm></indexterm>
<indexterm>SVG</indexterm>
</keywords>
</metadata>
</prolog>
<refbody>
<section>
<p>DITA Open Toolkit 3.4.1 is a maintenance release that includes the
following bug fixes.</p>
<ul>
<li id="2980">Earlier versions of DITA-OT created extra files in the output folder when the DITA 1.3
<xmlelement>dvrResourcePrefix</xmlelement> or <xmlelement>dvrResourceSuffix</xmlelement> elements were
used to rename filtered topics. When conditions on topic references within a branch filtered out one or more
copies of those files, the renamed resources were removed from the ToC, but still copied to the output
folder. The branch filtering process has been revised to ensure those filtered copies are no longer created.
In some (but not all) cases, this also resolves a related issue where an extra copy of the file was created
in the output folder with the original file name.
<xref href="https://github.com/dita-ot/dita-ot/issues/2980" format="html" scope="external">#2980</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3411" format="html" scope="external">#3411</xref>
</li>
<li id="3202">Due to an omission in the DITA 1.3 shell files provided by the
<xref keyref="dita-tc"/>, classification maps based on the XML Schema Definition were considered invalid.
The error was reported to the TC and resolved in the official OASIS repository and in the grammar files
bundled with DITA-OT.
<xref href="https://github.com/dita-ot/dita-ot/issues/3202" format="html" scope="external">#3202</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3426" format="html" scope="external">#3426</xref>
</li>
<li id="3409">The RELAX NG schema required to validate XML project files was missing in the 3.4 distribution
package. The <filepath>project.rnc</filepath> file is now provided in the <filepath>resources</filepath>
folder of the DITA-OT installation.
<xref href="https://github.com/dita-ot/dita-ot/issues/3409" format="html" scope="external">#3409</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3410" format="html" scope="external">#3410</xref>
</li>
<li id="3414">When the bundled <tm trademark="Apache" tmtype="tm">Apache</tm> Formatting Objects Processor
(FOP) was upgraded to version 2.4 for DITA-OT 3.4, a required library reference was omitted, which prevented
embedded SVG images from appearing in PDF output. The library has been restored to the distribution package
to ensure that SVGs are rendered as expected.
<xref href="https://github.com/dita-ot/dita-ot/issues/3414" format="html" scope="external">#3414</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3419" format="html" scope="external">#3419</xref>
</li>
<li id="3420">The bundled Jackson data binding library was updated to version 2.10.1 to resolve several
vulnerabilities reported in previous versions.
<xref href="https://github.com/dita-ot/dita-ot/issues/3420" format="html" scope="external">#3420</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3421" format="html" scope="external">#3421</xref>
</li>
<li id="3447">With DITA-OT 3.1.3 or later, generating PDFs from maps with index terms with the RenderX XEP
processor throws “<msgph>no entries for index key</msgph>” errors and fails to generate PDF files. Index
processing has been corrected to take the new <xmlatt>indexid</xmlatt> attribute into account, which
resolves the error and allows builds to complete successfully.
<xref href="https://github.com/dita-ot/dita-ot/issues/3447" format="html" scope="external">#3447</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3450" format="html" scope="external">#3450</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3455" format="html" scope="external">#3455</xref>
</li>
<li id="3444">The license for the bundled ICU4J library has been updated to the latest version.
<xref href="https://github.com/dita-ot/dita-ot/issues/3444" format="html" scope="external">#3444</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3451" format="html" scope="external">#3451</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3454" format="html" scope="external">#3454</xref>
</li>
</ul>
<p>For additional information on the issues resolved since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.4.1+is%3Aclosed" format="html"
scope="external">3.4.1 milestone</xref> and
<xref href="https://github.com/dita-ot/dita-ot/compare/3.4...3.4.1" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v3.4">
<title>DITA-OT 3.4
<ph outputclass="small text-muted">released November 9, 2019</ph>
</title>
<titlealts>
<navtitle>DITA-OT 3.4</navtitle>
</titlealts>
<prolog>
<metadata>
<keywords>
<indexterm><codeph>org.dita.index</codeph></indexterm>
<indexterm><filepath>project.rnc</filepath> file</indexterm>
<indexterm><parmname>html5.toc.generate</parmname></indexterm>
<indexterm>Docker images</indexterm>
<indexterm>parameters
<indexterm><parmname>html5.toc.generate</parmname></indexterm></indexterm>
</keywords>
</metadata>
</prolog>
<refbody>
<section>
<p>DITA Open Toolkit Release 3.4 includes <ph id="summary">an official Docker container
image, a separate plug-in for PDF indexing, a new option to skip HTML5 cover pages, and initial support for
project files that allow you to define multiple deliverables in advance, and publish them all at
once</ph>.</p>
</section>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.4+is%3Aclosed+label%3Afeature+sort%3Acreated-asc -->
<section id="docker">
<title>Docker container image</title>
<p id="3358"><ph conkeyref="using-docker-images/docker-desc"/>
<xref href="https://github.com/dita-ot/dita-ot/issues/3358" format="html" scope="external">#3358</xref>
</p>
</section>
<section id="indexing-plugin">
<title>New indexing plug-in</title>
<sectiondiv conkeyref="migrating-to-3.4/indexing-plugin"/>
<p id="3390">
<xref href="https://github.com/dita-ot/dita-ot/issues/3390" format="html" scope="external">#3390</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3396" format="html" scope="external">#3396</xref>
</p>
</section>
<section id="html5-toc">
<title>Skip HTML5 cover pages</title>
<p id="3301">The HTML5 transformation supports a new property that determines whether a table of contents file
should be generated to link to the other topics from the input map. The
<parmname>html5.toc.generate</parmname> parameter is set to <option>yes</option> by default, and creates a
cover page named <filepath>index.html</filepath> as with previous versions of DITA-OT. If you’re using the
<parmname>nav-toc</parmname> parameter to embed navigation links in topics, you can set
<parmname>html5.toc.generate</parmname> to <option>no</option> to stop creating the extra file.
<xref href="https://github.com/dita-ot/dita-ot/issues/3301" format="html" scope="external">#3301</xref>
</p></section>
<section id="projects">
<title>Project files</title>
<p id="3243"><ph conkeyref="using-project-files/projects-desc"/></p>
<p conkeyref="using-project-files/projects-formats"/>
<p>
<xref href="https://github.com/dita-ot/dita-ot/issues/3243" format="html" scope="external">#3243</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3256" format="html" scope="external">#3256</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3262" format="html" scope="external">#3262</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3265" format="html" scope="external">#3265</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3268" format="html" scope="external">#3268</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3269" format="html" scope="external">#3269</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3276" format="html" scope="external">#3276</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3298" format="html" scope="external">#3298</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3300" format="html" scope="external">#3300</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3382" format="html" scope="external">#3382</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3388" format="html" scope="external">#3388</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3394" format="html" scope="external">#3394</xref>
</p>
</section>
<section id="enhancements">
<title>Enhancements and changes</title>
<indexterm><parmname>args.logdir</parmname></indexterm>
<indexterm>parameters
<indexterm><parmname>args.logdir</parmname></indexterm></indexterm>
<indexterm>Lightweight DITA</indexterm>
<indexterm>TocJS</indexterm>
<indexterm>troff</indexterm>
<p>In addition to the highlights mentioned above, DITA Open Toolkit Release 3.4 includes
the following enhancements and changes to existing features:</p>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.4+is%3Aclosed+label%3Aenhancement+sort%3Acreated-asc -->
<ul>
<li id="3250">The original preprocessing and map-first preprocessing pipelines have been simplified to process
only the merged root map, where previous versions would redundantly process all DITA maps.
<xref href="https://github.com/dita-ot/dita-ot/issues/3250" format="html" scope="external">#3250</xref>
</li>
<li id="3264">Conref processing has been updated to resolve content references to specializations of the
referencing element
<xref href="https://github.com/dita-ot/dita-ot/issues/3264" format="html" scope="external">#3264</xref>
</li>
<li id="3288">The obsolete <filepath>build_demo.xml</filepath> script that was previously used to build Ant
samples has been removed from the source code repository. (The file was removed from distribution packages
with version 2.1.)
<xref href="https://github.com/dita-ot/dita-ot/issues/3288" format="html" scope="external">#3288</xref>
</li>
<li id="3297">Ant scripts have been refactored to simplify <xmlelement>condition</xmlelement> elements with
<xmlelement>isset</xmlelement> guards to set properties with plain <xmlelement>property</xmlelement>
declarations instead.
<xref href="https://github.com/dita-ot/dita-ot/issues/3297" format="html" scope="external">#3297</xref>
</li>
<li id="3307">The logging level for Apache HTTP Client libraries has been reduced to <codeph>INFO</codeph> to
quiet the default log output. This information can be displayed if necessary by enabling verbose logging.
<xref href="https://github.com/dita-ot/dita-ot/issues/3307" format="html" scope="external">#3307</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3308" format="html" scope="external">#3308</xref>
</li>
<li id="3315">The <codeph>ConrefPushParser</codeph> has been converted from a SAX filter to a DOM filter.
<xref href="https://github.com/dita-ot/dita-ot/issues/3315" format="html" scope="external">#3315</xref>
</li>
<li id="3329">
<xref href="https://travis-ci.org/" format="html" scope="external">Travis CI</xref> build stages are now
used to run tests and deployments in parallel to speed up continuous integration builds.
<xref href="https://github.com/dita-ot/dita-ot/issues/3329" format="html" scope="external">#3329</xref>
</li>
<li id="3330">Several bundled dependencies have been upgraded to the latest versions.
<ul>
<li>Ant 1.10.6
<xref href="https://github.com/dita-ot/dita-ot/issues/3354" format="html" scope="external">#3354</xref>
</li>
<li>FOP 2.4
<xref href="https://github.com/dita-ot/dita-ot/issues/3406" format="html" scope="external">#3406</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3407" format="html" scope="external">#3407</xref>
</li>
<li>Gradle 5.6.3
<xref href="https://github.com/dita-ot/dita-ot/issues/3375" format="html" scope="external">#3375</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3402" format="html" scope="external">#3402</xref>
</li>
<li>Jackson 2.9.9
<xref href="https://github.com/dita-ot/dita-ot/issues/3362" format="html" scope="external">#3362</xref>
</li>
<li>Saxon-HE 9.9.1.4
<xref href="https://github.com/dita-ot/dita-ot/issues/3330" format="html" scope="external">#3330</xref>
</li>
</ul>
</li>
<li id="3334">XSLT error messages now include location information in more cases to make it easier to find the
source of the problem.
<xref href="https://github.com/dita-ot/dita-ot/issues/3334" format="html" scope="external">#3334</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3339" format="html" scope="external">#3339</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3341" format="html" scope="external">#3341</xref>
</li>
<li id="3363">DITA-OT 3.4 no longer includes the TocJS and troff transformation plug-ins in the default
distribution.
<xref href="https://github.com/dita-ot/dita-ot/issues/3363" format="html" scope="external">#3363</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3364" format="html" scope="external">#3364</xref>
<note conkeyref="reusable-components/legacy-plugins-note"/>
</li>
<li id="3371">The LwDITA plug-in has been updated to version 2.3.2, pulling in a number of fixes for
Lightweight DITA processing, including support for absolute links and strikethrough in Markdown input, and
updated processing for escaped characters and nested blocks in Markdown output.
<xref href="https://github.com/dita-ot/dita-ot/issues/3371" format="html" scope="external">#3371</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3408" format="html" scope="external">#3408</xref>
</li>
<li id="3399">The <parmname>args.logdir</parmname> parameter (deprecated since DITA-OT 2.5) has been removed.
To write the log to a file, use <cmdname>dita</cmdname>
<parmname>--logfile</parmname>=<varname>file</varname> or <cmdname>ant</cmdname>
<parmname>-l</parmname>
<varname>file</varname> and specify the path to the log file.
<xref href="https://github.com/dita-ot/dita-ot/issues/3398" format="html" scope="external">#3398</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3399" format="html" scope="external">#3399</xref>
</li>
<li id="3401">The source code for the DITA 1.1 and 1.2 plug-ins has been removed from the core repository and
extracted to dedicated code repositories. The plug-ins themselves remain available in the DITA-OT 3.4
distribution package.
<xref href="https://github.com/dita-ot/dita-ot/issues/3401" format="html" scope="external">#3401</xref>
</li>
</ul>
</section>
<section id="bugs">
<title>Bugs</title>
<indexterm><xmlelement>fo:block</xmlelement></indexterm>
<indexterm><xmlelement>fo:inline</xmlelement></indexterm>
<indexterm><xmlelement>fo:wrapper</xmlelement></indexterm>
<indexterm><xmlelement>index-see-also</xmlelement></indexterm>
<indexterm><xmlelement>index-see</xmlelement></indexterm>
<p>DITA Open Toolkit Release 3.4 provides fixes for the following bugs:</p>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.4+is%3Aclosed+label%3Abug+sort%3Acreated-asc -->
<ul>
<li>Several issues have been resolved in the PDF rendering of a generated index:
<ul>
<li id="2455">To work around an open issue with Apache Formatting Objects Processor
<xref href="https://issues.apache.org/jira/browse/FOP-2520" format="html" scope="external"
>FOP-2520</xref>, DITA-OT 3.4 uses <xmlelement>fo:block</xmlelement> instead of
<xmlelement>fo:wrapper</xmlelement> to create the destinations for index links. In previous versions
of DITA-OT, index terms that appeared in source files between section titles and paragraph content (and
several other places) created empty space in PDF output.
<xref href="https://github.com/dita-ot/dita-ot/issues/2455" format="html" scope="external">#2455</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2914" format="html" scope="external">#2914</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3381" format="html" scope="external">#3381</xref>
</li>
<li id="3042">When publishing to PDF with Antenna House Formatter, destination anchors for index links now
use <xmlelement>fo:wrapper</xmlelement> instead of <xmlelement>fo:inline</xmlelement>. In previous
versions of DITA-OT, index terms that appeared in source files between section titles and other section
content created empty space in PDF output.
<xref href="https://github.com/dita-ot/dita-ot/issues/3042" format="html" scope="external">#3042</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3379" format="html" scope="external">#3379</xref>
</li>
<li id="3314">Index links are now created correctly when entries have subterms. In previous versions,
terms with multiple <xmlelement>index-see-also</xmlelement> subterms failed to generate links for all
but the first reference, and dropped all instances of a term if even one instance had a sub-term, an
<xmlelement>index-see</xmlelement> or <xmlelement>index-see-also</xmlelement> child.
<xref href="https://github.com/dita-ot/dita-ot/issues/3314" format="html" scope="external">#3314</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3320" format="html" scope="external">#3320</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3373" format="html" scope="external">#3373</xref>
</li>
<li id="3391">References to unavailable <xmlelement>index-see</xmlelement> terms are filtered from the
final index. Previous versions would create invalid links if the target terms were not available in the
current publication context.
<xref href="https://github.com/dita-ot/dita-ot/issues/3391" format="html" scope="external">#3391</xref>
</li>
</ul>
</li>
<li id="3078">Cross-reference links to other topics from short descriptions no longer cause build errors.
<xref href="https://github.com/dita-ot/dita-ot/issues/3078" format="html" scope="external">#3078</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3324" format="html" scope="external">#3324</xref>
</li>
<li id="3360">In earlier versions, incorrect parameters passed to the <cmdname>dita</cmdname> command could
cause the build to fail with a NullPointerException. The Java code has been updated to issue an appropriate
error message in these cases, instead of crashing the build.
<xref href="https://github.com/dita-ot/dita-ot/issues/3360" format="html" scope="external">#3360</xref>
</li>
</ul>
</section>
<section id="contrib">
<title>Contributors</title>
<p>DITA Open Toolkit Release 3.4 includes
<xref keyref="contributions"/> by the following people:</p>
<!-- https://github.com/tj/git-extras/blob/master/Commands.md#git-summary – `git summary 3.3..` -->
<draft-comment author="Roger">NOTE: This lists contributions to the core toolkit, not docs.</draft-comment>
<ol>
<li>Jarno Elovirta</li>
<li>Robert D Anderson</li>
<li>Roger Sheen</li>
<li>Radu Coravu</li>
<li>Eliot Kimber</li>
<li>Toshihiko Makita</li>
</ol>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/3.3...3.4" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
<section id="docs">
<title>Documentation updates</title>
<p>The documentation for DITA Open Toolkit Release 3.4 provides corrections and
improvements to existing topics, sample project files in the <filepath>docsrc/samples/</filepath> folder, a
<xref keyref="glossary"/>, PDF index, and new information in the following topics:</p>
<ul>
<li>
<xref keyref="using-project-files"/>
<ul>
<li>
<xref keyref="project-files-xml"/></li>
<li>
<xref keyref="project-files-json"/></li>
<li>
<xref keyref="project-files-yaml"/></li>
</ul></li>
<li>
<xref keyref="using-docker-images"/>
<ul>
<li>
<xref keyref="creating-docker-images"/></li>
</ul></li>
<li>
<xref keyref="migrating-to-3.4"/></li>
</ul>
<p>For additional information on documentation issues resolved in DITA Open Toolkit Release <keyword
keyref="release"/>, see the
<xref href="https://github.com/dita-ot/docs/issues?q=milestone%3A3.4+is%3Aclosed" format="html"
scope="external">
3.4 milestone</xref> in the documentation repository.</p>
<p>DITA Open Toolkit Release 3.4 includes
<xref keyref="docs-contributions"/> by the following people:</p>
<draft-comment author="Roger">NOTE: This lists contributions to docs, not to the core toolkit.</draft-comment>
<ol>
<li>Roger Sheen</li>
<li>Lief Erickson</li>
<li>Jarno Elovirta</li>
<li>Robert D Anderson</li>
<li>Eliot Kimber</li>
<li>Ursula Kallio</li>
<li>Jason Fox</li>
<li>Radu Coravu</li>
</ol>
<p>For the complete list of documentation changes since the previous release, see the
<xref href="https://github.com/dita-ot/docs/compare/3.3...3.4" format="html" scope="external">
changelog</xref>.</p>
</section>
</refbody>
</reference>
</reference>

584
dita-ot-3.6/docsrc/release-notes/rel3.5.dita Normal file
View file

@ -0,0 +1,584 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
<reference id="ID" rev="3.5">
<title>DITA Open Toolkit 3.5 Release Notes</title>
<titlealts>
<navtitle>Release Notes</navtitle>
</titlealts>
<abstract>
<shortdesc>DITA Open Toolkit 3.5.4 is a maintenance release that fixes issues
reported in DITA-OT 3.5, which includes <ph conref="#v3.5/summary"/>.</shortdesc>
<p conkeyref="conref-task/semver-info"/>
<note type="tip"><ph conkeyref="conref-task/download-ot"/></note>
</abstract>
<reference id="requirements">
<title>Requirements</title>
<refbody>
<section>
<draft-comment author="Roger">Add info on new minimum Java version or any other requirements that have changed
since previous release.</draft-comment>
<p conkeyref="reusable-components/java-clients"/>
</section>
</refbody>
</reference>
<reference id="v3.5.4" outputclass="mark">
<title>DITA-OT 3.5.4
<ph outputclass="small text-muted">released September 19, 2020</ph>
</title>
<refbody>
<section>
<p>DITA Open Toolkit 3.5.4 is a maintenance release that includes the
following bug fixes.</p>
<ul>
<li id="2147">In cases where maps contain references to submaps within key scopes, earlier versions of DITA-OT
failed to apply the scopes to relationship tables in the submaps. Processing has been updated to cascade key
scope information to the relationship table of the target map, so links between topics in different key
scopes work as expected.
<xref href="https://github.com/dita-ot/dita-ot/issues/2147" format="html" scope="external">#2147</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/2393" format="html" scope="external">#2393</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3563" format="html" scope="external">#3563</xref>
</li>
<li id="2410">In earlier versions, keys in nested key scopes were not resolved correctly. Key processing has
been updated to correctly generate key definitions from sibling key scopes.
<xref href="https://github.com/dita-ot/dita-ot/issues/2410" format="html" scope="external">#2410</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3567" format="html" scope="external">#3567</xref>
</li>
<li id="2981">In previous versions, the <parmname>dita.xsl.html5.cover</parmname> extension point did not
work. The corresponding templates have been moved from the
<filepath>org.dita.html5/xsl/map2html5-coverImpl_template.xsl</filepath> wrapper to a new
<filepath>org.dita.html5/xsl/cover.xsl</filepath> file to allow custom plug-ins to override the HTML5
cover page with a custom stylesheet.
<xref href="https://github.com/dita-ot/dita-ot/issues/2981" format="html" scope="external">#2981</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3579" format="html" scope="external">#3579</xref>
</li>
<li id="3566">DITA-OT 3.5.2 introduced a regression that caused builds to fail with a Java error when source
files contained irregular table markup. Table processing has been updated to normalize tables with multiple
groups and emit a <msgnum>DOTJ082E</msgnum> error when invalid table markup prevents processing.
<xref href="https://github.com/dita-ot/dita-ot/issues/3566" format="html" scope="external">#3566</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3573" format="html" scope="external">#3573</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3575" format="html" scope="external">#3575</xref>
</li>
<li id="3574">When parsing topics that contain DTD references, public IDs are now preferred when comparing
grammar descriptors with those stored in the grammar cache. This speeds up processing in projects with a
large number of topics and subfolders by allowing the parser to re-use the DTD grammars between them.
<xref href="https://github.com/dita-ot/dita-ot/issues/3574" format="html" scope="external">#3574</xref>
</li>
<li deliveryTarget="html">HTML versions of the documentation include new information in the following topics:
<ul>
<li id="docs-218">A list of <cite>DITA-OT Day</cite> conference videos has been added to the
<xref keyref="dita-and-dita-ot-resources">Resources</xref> section. Where applicable, individual topics
include links to relevant presentations from recent events.
<xref href="https://github.com/dita-ot/docs/issues/218" format="html" scope="external">#218</xref>,
<xref href="https://github.com/dita-ot/docs/pull/304" format="html" scope="external">#304</xref>
</li>
<li id="docs-305">A new
<xref keyref="release-history"/> topic was added for easier access to details on prior releases.
<xref href="https://github.com/dita-ot/docs/pull/305" format="html" scope="external">#305</xref>
</li>
<li id="docsearch-2364">In addition to the latest development version of the documentation, the site
search now returns results from all <cite>Release Notes</cite> from DITA-OT 2.0 forward, to make it
easier to find information about the changes in earlier releases.
<xref
href="https://github.com/algolia/docsearch-configs/pull/2364"
format="html"
scope="external"
>algolia/docsearch-configs#2364</xref>
</li>
</ul>
</li>
</ul>
<p>For additional information on the issues resolved since the previous release, see the
<xref
href="https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.5.4+is%3Aclosed"
format="html"
scope="external"
>3.5.4 milestone</xref> and
<xref href="https://github.com/dita-ot/dita-ot/compare/3.5.3...3.5.4" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v3.5.3">
<title>DITA-OT 3.5.3 <ph outputclass="small text-muted">released August 18, 2020</ph>
</title>
<refbody>
<section>
<p>DITA Open Toolkit 3.5.3 is a maintenance release that includes the following bug fixes.</p>
<ul>
<li id="3549">In DITA-OT 3.5, certain branch filtering scenarios prevented key references and content key
references from resolving correctly in map-first preprocessing, resulting in missing content in PDF output.
The Java code for the reader module has been updated to ensure that all filtered and renamed topics contain
the correct information.
<xref href="https://github.com/dita-ot/dita-ot/issues/3549" format="html" scope="external">#3549</xref>
</li>
<li id="3550">In HTML5 output, a new <xmlelement>div</xmlelement> wrapper element has been added to preserve
attributes like <xmlatt>outputclass</xmlatt> or <xmlatt>id</xmlatt> from the <xmlelement>steps</xmlelement>
element in single-step tasks. Earlier versions discarded this information when generating output.
<xref href="https://github.com/dita-ot/dita-ot/issues/3550" format="html" scope="external">#3550</xref>
</li>
</ul>
<p>For additional information on the issues resolved since the previous release, see the
<xref
href="https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.5.3+is%3Aclosed"
format="html"
scope="external"
>3.5.3 milestone</xref> and
<xref href="https://github.com/dita-ot/dita-ot/compare/3.5.2...3.5.3" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v3.5.2">
<title>DITA-OT 3.5.2 <ph outputclass="small text-muted">released July 2, 2020</ph>
</title>
<refbody>
<section>
<p>DITA Open Toolkit 3.5.2 is a maintenance release that includes the following bug fixes.</p>
<ul>
<li id="3524">DITA-OT 3.5 introduced a regression in key scope processing that saved the effective map too
early, before all topic references were updated. In certain cases, keys that were intended to point to
different reference targets were merged to a single reference. The keyref processing module has been updated
to handle these cases correctly.
<xref href="https://github.com/dita-ot/dita-ot/issues/3524" format="html" scope="external">#3524</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3542" format="html" scope="external">#3542</xref>
</li>
<li id="3526">In DITA-OT 3.5.1, generating output from a project file without setting the
<parmname>--output</parmname> option caused the build to fail with a NullPointerException. The Java code
has been updated to properly initialize the output directory.
<xref href="https://github.com/dita-ot/dita-ot/issues/3526" format="html" scope="external">#3526</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3531" format="html" scope="external">#3531</xref>
</li>
<li id="3533">Builds would also fail with a NullPointerException when publishing bookmap chapters with keys to
a single file by setting the <xmlatt>chunk</xmlatt> attribute <option>to-content</option>. The metadata push
process has been updated to properly handle this case.
<xref href="https://github.com/dita-ot/dita-ot/issues/3533" format="html" scope="external">#3533</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3534" format="html" scope="external">#3534</xref>
</li>
<li id="3538">Earlier versions of DITA-OT would sometimes render tables incorrectly when cells were set to
span several rows. Processing for <xmlelement>table</xmlelement> and <xmlelement>simpletable</xmlelement>
elements has been updated to ensure that cell coordinates are calculated correctly.
<xref href="https://github.com/dita-ot/dita-ot/issues/3538" format="html" scope="external">#3538</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3539" format="html" scope="external">#3539</xref>
</li>
<li id="3540">When processing maps with flagging information, temporary files include
<xmlelement>ditaval-startprop</xmlelement> elements that contain <xmlelement>prop</xmlelement> elements
without <xmlatt>class</xmlatt> attributes, which generated errors in earlier versions. Processing has been
updated to ignore foreign content at this stage, allowing Saxon to proceed without errors.
<xref href="https://github.com/dita-ot/dita-ot/issues/3540" format="html" scope="external">#3540</xref>
</li>
<li>The documentation includes corrections and new information in the following topics:
<ul>
<li>
<xref keyref="markdown-input"/></li>
<li>
<xref keyref="markdown-dita-syntax-reference"/></li>
<li>
<xref keyref="dita2dita"/></li>
<li>
<xref keyref="lwdita-input"/></li>
</ul></li>
</ul>
<p>For additional information on the issues resolved since the previous release, see the
<xref
href="https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.5.2+is%3Aclosed"
format="html"
scope="external"
>3.5.2 milestone</xref> and
<xref href="https://github.com/dita-ot/dita-ot/compare/3.5.1...3.5.2" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v3.5.1">
<title>DITA-OT 3.5.1 <ph outputclass="small text-muted">released June 4, 2020</ph>
</title>
<refbody>
<section>
<p>DITA Open Toolkit 3.5.1 is a maintenance release that includes the following bug fixes.</p>
<ul>
<li id="3508">In DITA-OT 3.5, Markdown builds failed due to an incompatible plug-in version. The LwDITA
plug-in has been updated to version 2.4, which is compatible with DITA-OT 2.4 and newer.
<xref href="https://github.com/dita-ot/dita-ot/issues/3508" format="html" scope="external">#3508</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3512" format="html" scope="external">#3512</xref>
</li>
<li id="3509">On macOS, DITA-OT 3.5 failed to build output if the input file was specified with a relative
path based at the current working directory with the <codeph>./</codeph> notation. Paths specified on the
command line are now normalized to support this syntax.
<xref href="https://github.com/dita-ot/dita-ot/issues/3509" format="html" scope="external">#3509</xref>
</li>
<li id="3513">Several bundled dependencies have been updated to address security vulnerabilities, including:
<ul>
<li id="3515">The bundled Jackson data binding library was updated to version 2.11.0 to resolve several
vulnerabilities reported in previous versions, including an OWASP false positive for the SnakeYAML
library, which has been updated to version 1.27.
<xref href="https://github.com/dita-ot/dita-ot/issues/3513" format="html" scope="external">#3513</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3515" format="html" scope="external">#3515</xref>
</li>
<li id="3522">The bundled Ant version has been updated to version 1.10.8 to address
<xref
href="https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-1945"
format="html"
scope="external"
>CVE-2020-1945</xref>.
<xref
href="https://github.com/dita-ot/dita-ot/issues/3522"
format="html"
scope="external"
>#3522</xref></li>
</ul>
</li>
<li id="3517">In DITA-OT 3.5, PDF customizations (and other plug-ins that use <xmlelement>xslt</xmlelement>
elements within custom <xmlelement>pipeline</xmlelement> elements) failed to properly compile the custom
XSLT code. The XSLT module has been corrected to resolve custom code correctly and apply the customizations.
<xref href="https://github.com/dita-ot/dita-ot/issues/3517" format="html" scope="external">#3517</xref>
</li>
</ul>
<p>For additional information on the issues resolved since the previous release, see the
<xref
href="https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.5.1+is%3Aclosed"
format="html"
scope="external"
>3.5.1 milestone</xref> and
<xref href="https://github.com/dita-ot/dita-ot/compare/3.5...3.5.1" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
</refbody>
</reference>
<reference id="v3.5">
<title>DITA-OT 3.5
<ph outputclass="small text-muted">released April 27, 2020</ph>
</title>
<prolog>
<metadata>
<keywords>
<indexterm/>
</keywords>
</metadata>
</prolog>
<refbody>
<section>
<p>DITA Open Toolkit Release 3.5 includes <ph id="summary">support for additional input
resources, an alternative subcommand syntax for the <cmdname>dita</cmdname> command, and an initial preview
of features for the latest draft of the upcoming DITA 2.0 standard</ph>.</p>
</section>
<section id="dita-2-0-preview">
<title>DITA 2.0 preview</title>
<p id="3449">DITA-OT 3.5 includes processing support for the latest DRAFT versions of
the DITA 2.0 DTD and RELAX NG grammar files from OASIS (as of April 2020).
<xref href="https://github.com/dita-ot/dita-ot/issues/3449" format="html" scope="external">#3449</xref>
</p>
<p conkeyref="dita-v2-0-support/grammar-files"/>
<ul>
<li id="3453">
<p>
<ph conkeyref="dita-v2-0-support/include"/>
<xref href="https://github.com/dita-ot/dita-ot/issues/3453" format="html" scope="external">#3453</xref>
</p>
</li>
<li id="3462">
<p>
<ph conkeyref="dita-v2-0-support/specializations"/>
<xref href="https://github.com/dita-ot/dita-ot/issues/3440" format="html" scope="external">#3440</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3462" format="html" scope="external">#3462</xref>
</p>
</li>
<li id="3463">
<p>
<ph conkeyref="dita-v2-0-support/outputclass"/>
<xref href="https://github.com/dita-ot/dita-ot/issues/3463" format="html" scope="external">#3463</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3482" format="html" scope="external">#3482</xref>
</p>
</li>
<li id="3464">
<p>
<ph conkeyref="dita-v2-0-support/simple-table-titles"/>
<xref href="https://github.com/dita-ot/dita-ot/issues/3464" format="html" scope="external">#3464</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3465" format="html" scope="external">#3465</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3479" format="html" scope="external">#3479</xref>
</p>
</li>
<li id="3483">
<p>
<ph conkeyref="dita-v2-0-support/topic-based-classes"/>
<xref href="https://github.com/dita-ot/dita-ot/issues/3483" format="html" scope="external">#3483</xref>
</p>
</li>
</ul>
<note conkeyref="dita-v2-0-support/more-to-come"/>
</section>
<section id="features">
<title>New features</title>
<indexterm><parmname>--resource</parmname></indexterm>
<indexterm><parmname>result.rewrite-rule.class</parmname></indexterm>
<indexterm><parmname>result.rewrite-rule.xsl</parmname></indexterm>
<indexterm><cmdname>deliverables</cmdname> subcommand</indexterm>
<indexterm><cmdname>install</cmdname> subcommand</indexterm>
<indexterm><cmdname>plugins</cmdname> subcommand</indexterm>
<indexterm><cmdname>transtypes</cmdname> subcommand</indexterm>
<indexterm><cmdname>uninstall</cmdname> subcommand</indexterm>
<indexterm><cmdname>version</cmdname> subcommand</indexterm>
<p>DITA-OT 3.5 also includes the following new features:</p>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.5+is%3Aclosed+label%3Afeature+sort%3Acreated-asc -->
<ul>
<li id="3412">
<p>You can now pass additional input resources to the <cmdname>dita</cmdname> command with the
<parmname>--resource</parmname> option.
<xref
href="https://github.com/dita-ot/dita-ot/issues/3412"
format="html"
scope="external"
>#3412</xref></p>
<p>For example, to process a single topic file with a map that contains key definitions, use a command like
this:
<codeblock><cmdname>dita</cmdname> <parmname>--input</parmname>=<filepath>topic.dita</filepath> <parmname
>--resource</parmname>=<filepath>keys.ditamap</filepath> <parmname>--format</parmname>=<option
>html5</option></codeblock>
</p></li>
<li id="3413">Two new parameters can be used to dynamically adjust the names and locations of output files in
transformations that use the map-first pre-processing routine (<codeph>preprocess2</codeph>). <ph>These
parameters can be passed on the command line, or included in a custom plug-in via
<xmlelement>property</xmlelement> elements in an Ant script as described in
<xref keyref="plugin-rewrite-rules"/>.</ph>
<xref href="https://github.com/dita-ot/dita-ot/issues/3413" format="html" scope="external">#3413</xref>
<ul>
<li>Use <parmname>result.rewrite-rule.class</parmname> to rewrite filenames with a Java class that
implements the <codeph>org.dita.dost.module.RewriteRule</codeph> interface</li>
<li>Use <parmname>result.rewrite-rule.xsl</parmname> to rewrite via an XSLT stylesheet</li>
</ul>
</li>
<li id="3437">
<p>The <cmdname>dita</cmdname> command line interface has been refactored to support subcommands for common
operations.
<xref href="https://github.com/dita-ot/dita-ot/issues/3437" format="html" scope="external">#3437</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3492" format="html" scope="external">#3492</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3494" format="html" scope="external">#3494</xref>
</p>
<dl conkeyref="reusable-components/3.5-subcommands">
<dlentry>
<dt/>
<dd/>
</dlentry>
</dl>
<p>For syntax details, see
<xref keyref="dita-command-arguments"/>.</p>
<note>The double-hyphen option syntax has been retained for backwards compatibility, so if you use
<cmdname>dita</cmdname>
<parmname>--install</parmname> in scripts (or out of habit), it will still work.</note>
<note type="tip">Each subcommand has its own <parmname>--help</parmname> option, so you can run
<cmdname>dita install</cmdname>
<parmname>--help</parmname> for details on the available arguments and options.</note>
</li>
<li id="3489">
<p>DITAVAL <xmlatt>style</xmlatt> tokens are now also generated as CSS classes that are added to the
<xmlatt>class</xmlatt> attribute values in the generated HTML.
<xref
href="https://github.com/dita-ot/dita-ot/issues/3489"
format="html"
scope="external"
>#3489</xref></p>
<p>Rules with corresponding class selectors have been added to the default stylesheets to implement the same
appearance that previous versions of DITA-OT achieved with inline styles. You can override these flagging
styles if necessary using the following classes: </p>
<ul>
<li><codeph>.flag__style--bold</codeph></li>
<li><codeph>.flag__style--italics</codeph></li>
<li><codeph>.flag__style--overline</codeph></li>
<li><codeph>.flag__style--underline</codeph></li>
<li><codeph>.flag__style--double-underline</codeph></li>
</ul></li>
</ul>
</section>
<section id="enhancements">
<title>Enhancements and changes</title>
<indexterm/>
<p>DITA Open Toolkit Release 3.5 includes the following enhancements and changes to
existing features:</p>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.5+is%3Aclosed+label%3Aenhancement+sort%3Acreated-asc -->
<ul>
<li id="3383">The Java code has been refactored to generate <codeph>xsl:message</codeph> output using methods
that are compatible with Saxon Enterprise Edition.
<xref href="https://github.com/dita-ot/dita-ot/issues/3383" format="html" scope="external">#3383</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3452" format="html" scope="external">#3452</xref>
</li>
<li id="3395">Handling for <msgph>UncheckedXPathException</msgph> errors has been improved to provide more
details on the source of the error including line and column information.
<xref href="https://github.com/dita-ot/dita-ot/issues/3395" format="html" scope="external">#3395</xref>
</li>
<li id="3425">The integration tests for the map-first preprocessing routine (<codeph>preprocess2</codeph>)
have been separated from the previous preprocessing tests, with dedicated results defined to evaluate the
compliance of map-first preprocessing with the expected output.
<xref href="https://github.com/dita-ot/dita-ot/issues/3425" format="html" scope="external">#3425</xref>
</li>
<li id="3430">The HTML5 plug-in includes new attribute sets for link lists that make it easier for custom
plug-ins to add supplementary classes or other customizations without overriding entire templates. The
default output includes the same CSS classes as previous versions of DITA-OT (<codeph>relconcepts</codeph>,
<codeph>relinfo</codeph>, <codeph>relref</codeph>, <codeph>reltasks</codeph>), so existing customizations
that rely on these classes will behave as expected.
<xref href="https://github.com/dita-ot/dita-ot/issues/3430" format="html" scope="external">#3430</xref>
</li>
<li id="3434">Various unused and deprecated Ant properties, list files, and targets have been removed from the
preprocessing configuration. Recent DITA-OT versions provide alternative mechanisms to achieve the same
results, such as the <xmlelement>ditafileset</xmlelement> element to select resources in the temporary
directory.
<xref href="https://github.com/dita-ot/dita-ot/issues/3434" format="html" scope="external">#3434</xref>
</li>
<li id="3442">The <codeph>org.dita.eclipsehelp</codeph> plugin, which is still bundled with DITA-OT, is now
installed from a separate repository.
<xref href="https://github.com/dita-ot/dita-ot/issues/3442" format="html" scope="external">#3442</xref>
</li>
<li id="3471">XSLT processing has been adjusted to use Saxon’s preferred Java API for XSLT, XQuery, XPath, and
XML Schema processing (S9API) directly instead of the JAXP wrapper used by previous versions of DITA-OT.
<xref href="https://github.com/dita-ot/dita-ot/issues/3471" format="html" scope="external">#3471</xref>
</li>
<li id="3473">Java code has been refactored to use a single instance of XML utilities during processing. This
approach allows other XML-related resources to be shared, including Saxon processors and name pools.
<xref href="https://github.com/dita-ot/dita-ot/issues/3473" format="html" scope="external">#3473</xref>
</li>
</ul>
</section>
<section id="bugs">
<title>Bugs</title>
<indexterm/>
<p>DITA Open Toolkit Release 3.5 provides fixes for the following bugs:</p>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.5+is%3Aclosed+label%3Abug+sort%3Acreated-asc -->
<ul>
<li id="1899">The DITA 1.x specification defines cascade behaviors for maps such that
<xmlelement>othermeta</xmlelement> and <xmlelement>source</xmlelement> do not cascade to child
<xmlelement>topicref</xmlelement> elements. In earlier releases the <codeph>mappull</codeph> stage of
processing pushed these to nested elements; that behavior is now corrected to match the specification.
<xref href="https://github.com/dita-ot/dita-ot/issues/1899" format="html" scope="external">#1899</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3326" format="html" scope="external">#3326</xref></li>
<li id="3232">When <xmlelement>coderef</xmlelement> elements imported code samples with key references via the
<xmlatt>keyref</xmlatt> attribute, earlier versions of DITA-OT appended the (temporary) file name of the
referenced code sample to the last line of the parent <xmlelement>codeblock</xmlelement> element. Processing
has been corrected to ensure that code blocks contain only the referenced code samples.
<xref href="https://github.com/dita-ot/dita-ot/issues/3232" format="html" scope="external">#3232</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3496" format="html" scope="external">#3496</xref>
</li>
<li id="3429">To support
<xref href="#v3.5/3412">additional resources</xref>, the <codeph>mapref</codeph> preprocessing stage now
runs even if the input file is not a map. DITA-OT now checks whether maps with additional resources are
available, even if they are not specified as input files.
<xref href="https://github.com/dita-ot/dita-ot/issues/3429" format="html" scope="external">#3429</xref>
</li>
<li id="3484">In some earlier releases, a call to an empty stub template for table <xmlatt>summary</xmlatt>
attributes was dropped. Calls to that template have been restored, making it available for easy overrides.
<xref href="https://github.com/dita-ot/dita-ot/issues/3484" format="html" scope="external">#3484</xref>
</li>
<li id="3497">When key definitions with external scope were defined in maps in subdirectories, earlier
versions treated absolute paths beginning with slashes as relative paths, and prefixed the name of the
enclosing directory to the output path, resulting in broken links. Map reference processing has been
corrected to ensure that absolute paths are recognized as such and passed to the output as intended.
<xref href="https://github.com/dita-ot/dita-ot/issues/3497" format="html" scope="external">#3497</xref>
</li>
<li id="3498">If <xmlelement>term</xmlelement> elements pointed to missing topics using the
<xmlatt>keyref</xmlatt> attribute, earlier versions of DITA-OT would crash during the build process. An
additional check has been implemented to catch these cases, allowing the build to finish and report errors
for any unresolved term references.
<xref href="https://github.com/dita-ot/dita-ot/issues/3498" format="html" scope="external">#3498</xref>
</li>
<li id="3499">Earlier versions of DITA-OT stripped namespace declarations from <xmlelement>mathml</xmlelement>
and <xmlelement>svg</xmlelement> elements in topics based on RELAX NG syntax. Pre-processing has been
corrected to preserve the namespaces.
<xref href="https://github.com/dita-ot/dita-ot/issues/3499" format="html" scope="external">#3499</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3501" format="html" scope="external">#3501</xref>
</li>
<li id="3502">In HTML5 output, earlier versions of DITA-OT displayed the “Note” label when the
<xmlatt>type</xmlatt> attribute of a <xmlelement>note</xmlelement> element was set to
<codeph>notice</codeph>. Processing has been updated to ensure that the “Notice” label is correctly
applied.
<xref href="https://github.com/dita-ot/dita-ot/issues/3502" format="html" scope="external">#3502</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/3503" format="html" scope="external">#3503</xref>
</li>
<li id="3505">In previous releases, when <xmlelement>chunk</xmlelement> was used to combine a branch of
content, and a file within that branch was missing or invalid, processing within the chunk module could fail
with a NullPointerException. This condition has been fixed, and processing will continue without the missing
file.
<xref href="https://github.com/dita-ot/dita-ot/issues/3505" format="html" scope="external">#3505</xref>
</li>
</ul>
</section>
<section id="contrib">
<title>Contributors</title>
<p>DITA Open Toolkit Release 3.5 includes
<xref keyref="contributions"/> by the following people:</p>
<!-- https://github.com/tj/git-extras/blob/master/Commands.md#git-summary – `git summary 3.4..` -->
<draft-comment author="Roger">NOTE: This lists contributions to the core toolkit, not docs.</draft-comment>
<ol>
<li>Jarno Elovirta</li>
<li>Robert D Anderson</li>
<li>Radu Coravu</li>
<li>Roger Sheen</li>
<li>Lionel Moizeau</li>
<li>Stefan Weil</li>
</ol>
<p>For the complete list of changes since the previous release, see the
<xref href="https://github.com/dita-ot/dita-ot/compare/3.4...3.5" format="html" scope="external">
changelog</xref> on GitHub.</p>
</section>
<section id="docs">
<title>Documentation updates</title>
<p>The documentation for DITA Open Toolkit Release 3.5 provides corrections and
improvements to existing topics, along with new information in the following topics:</p>
<ul>
<li>
<xref keyref="dita-command-arguments"/></li>
<li>
<xref keyref="plugins-installing"/></li>
<li>
<xref keyref="plugins-removing"/></li>
<li>
<xref keyref="migrating-to-3.5"/></li>
<li>
<xref keyref="dita-v2-0-support"/></li>
</ul>
<p>The topic hierarchy has been revised to promote information on common customization scenarios, including
<xref keyref="html-customization"/> and
<xref keyref="pdf-customization"/>, and how to extend the toolkit by
<xref keyref="adding-plugins"/> and
<xref keyref="custom-plugins"/>.</p>
<p>For additional information on documentation issues resolved in DITA Open Toolkit Release <keyword
keyref="release"
/>, see the
<xref
href="https://github.com/dita-ot/docs/issues?q=milestone%3A3.5+is%3Aclosed"
format="html"
scope="external"
>
3.5 milestone</xref> in the documentation repository.</p>
<p>DITA Open Toolkit Release 3.5 includes
<xref keyref="docs-contributions"/> by the following people:</p>
<draft-comment author="Roger">NOTE: This lists contributions to docs, not to the core toolkit.</draft-comment>
<ol>
<li>Roger Sheen</li>
<li>Robert D Anderson</li>
<li>Jarno Elovirta</li>
<li>Shane Taylor</li>
<li>Lief Erickson</li>
<li>Heston Hoffman</li>
</ol>
<p>For the complete list of documentation changes since the previous release, see the
<xref href="https://github.com/dita-ot/docs/compare/3.4...3.5" format="html" scope="external">
changelog</xref>.</p>
</section>
</refbody>
</reference>
</reference>