index.html 49 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593
  1. <!DOCTYPE html
  2. SYSTEM "about:legacy-compat">
  3. <html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2019"><meta name="DC.rights.owner" content="(C) Copyright 2019"><meta name="DC.type" content="reference"><meta name="abstract" content="DITA Open Toolkit 3.3.3 is a maintenance release that fixes issues reported in DITA-OT 3.3, which includes new attribute sets for HTML5 customization, support for custom integration processing, rotated table cells in PDF output, and hazard statements in HTML output."><meta name="description" content="DITA Open Toolkit 3.3.3 is a maintenance release that fixes issues reported in DITA-OT 3.3, which includes new attribute sets for HTML5 customization, support for custom integration processing, rotated table cells in PDF output, and hazard statements in HTML output."><meta name="DC.subject" content="HTML5, table, headers, flagging, xml:lang, linklist, languages, link processing, Trouble note labels, note, passthrough, DITAVAL, passthrough action, action, prop, Saxon, tables, screen readers, Bosnian, Danish, Montenegrin, Vietnamese, version, media, images, video, security, TLS, registry, draft-comment, required-cleanup, conref, multiple targets, type, conkeyref, command, dita, plug-in registry, integrator, transtype, string, entry, rotate, DITA 1.3, attribute sets, rotated cells"><meta name="keywords" content="HTML5, table, headers, flagging, xml:lang, linklist, languages, link processing, Trouble note labels, note, passthrough, DITAVAL, passthrough action, action, prop, Saxon, tables, screen readers, Bosnian, Danish, Montenegrin, Vietnamese, version, media, images, video, security, TLS, registry, draft-comment, required-cleanup, conref, multiple targets, type, conkeyref, command, dita, plug-in registry, integrator, transtype, string, entry, rotate, DITA 1.3, attribute sets, rotated cells"><meta name="DC.format" content="HTML5"><meta name="DC.identifier" content="ID"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>DITA Open Toolkit 3.3 Release Notes</title></head><body id="ID"><header role="banner"><div class="header">
  4. <p>DITA Open Toolkit</p>
  5. <hr>
  6. </div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.3</a></li><li class="active"><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/alternative-input-formats.html">Authoring formats</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../parameters/index.html">Setting parameters</a></li><li><a href="../topics/customizing.html">Customizing DITA-OT</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
  7. <h1 class="title topictitle1" id="ariaid-title1">DITA Open Toolkit <span class="keyword">3.3</span> Release Notes</h1>
  8. <div class="abstract">
  9. <p class="shortdesc">DITA Open Toolkit <span class="keyword">3.3.3</span> is a maintenance release that fixes issues
  10. reported in DITA-OT <span class="keyword">3.3</span>, which includes <span class="ph">new attribute sets for HTML5
  11. customization, support for custom integration processing, rotated table cells in PDF output, and hazard
  12. statements in HTML output</span>.</p>
  13. <p class="p">DITA-OT releases follow
  14. <a class="xref" href="https://semver.org" target="_blank">Semantic Versioning 2.0.0</a> guidelines. Version numbers use the
  15. <code class="ph codeph"><var class="keyword varname">major</var>.<var class="keyword varname">minor</var>.<var class="keyword varname">patch</var></code> syntax, where
  16. <var class="keyword varname">major</var> versions may include incompatible API changes, <var class="keyword varname">minor</var> versions add
  17. functionality in a backwards-compatible manner and <var class="keyword varname">patch</var> versions are maintenance releases
  18. that include backwards-compatible bug fixes.</p>
  19. <div class="note tip note_tip"><span class="note__title">Tip:</span> <span class="ph">Download the <span class="ph filepath">dita-ot-<span class="keyword">3.3.3</span>.zip</span>
  20. package from the project website at <a class="xref" href="https://www.dita-ot.org/download" target="_blank">dita-ot.org/download</a>.</span></div>
  21. </div>
  22. <article class="topic reference nested1" aria-labelledby="ariaid-title2" id="requirements">
  23. <h2 class="title topictitle2" id="ariaid-title2">Requirements</h2>
  24. <div class="body refbody">
  25. <section class="section">
  26. <div class="p">DITA-OT is designed to run on Java version <span class="keyword">8u101</span> or later.
  27. Compatible Java distributions are available from multiple sources:
  28. <div class="div div-index">
  29. </div>
  30. <ul class="ul">
  31. <li class="li">You can download the Oracle JRE or JDK from
  32. <a class="xref" href="http://www.oracle.com/technetwork/java/javase/downloads" target="_blank">oracle.com/technetwork/java</a>.</li>
  33. <li class="li">OpenJDK is an open-source implementation of Java available from
  34. <a class="xref" href="https://adoptopenjdk.net" target="_blank">adoptopenjdk.net</a>.</li>
  35. <li class="li">Amazon Corretto is an OpenJDK distribution with no-cost long-term support from
  36. <a class="xref" href="https://aws.amazon.com/corretto/" target="_blank">aws.amazon.com/corretto</a>.</li>
  37. </ul>
  38. </div>
  39. </section>
  40. </div>
  41. </article>
  42. <article class="topic reference nested1" aria-labelledby="ariaid-title3" id="v3.3.3">
  43. <h2 class="title topictitle2" id="ariaid-title3">DITA-OT <span class="keyword">3.3.3</span>
  44. </h2>
  45. <div class="body refbody">
  46. <section class="section">
  47. <p class="p">DITA Open Toolkit <span class="keyword">3.3.3</span> is a maintenance release that includes the
  48. following bug fixes.</p>
  49. <ul class="ul">
  50. <li class="li" id="v3.3.3__3313">The code that generates <code class="keyword markupname xmlatt">@headers</code> attributes in HTML-based output formats has
  51. been simplified to prevent Saxon crashes when processing complex tables. (These attributes help screen
  52. readers to identify the header cells to which table cells are related.)
  53. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3313" target="_blank">#3313</a>
  54. </li>
  55. <li class="li" id="v3.3.3__3317">In recent (3.x) versions of DITA-OT, flagging information is added before generated links are
  56. created, so any flags on the topic reference are ignored. Processing has been updated to copy flags from the
  57. <code class="keyword markupname xmlelement">&lt;topicref&gt;</code> to the links that are generated to point to that topic.
  58. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3317" target="_blank">#3317</a>
  59. </li>
  60. <li class="li" id="v3.3.3__3321">Earlier versions of DITA-OT failed to honor the effective <code class="keyword markupname xmlatt">@xml:lang</code> attribute
  61. value when processing links. This error has been corrected to ensure that the closest language value is
  62. preserved on the generated <code class="keyword markupname xmlelement">&lt;linklist&gt;</code>, so locale-based headings such as ”Related
  63. information” are applied correctly.
  64. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3321" target="_blank">#3321</a>
  65. </li>
  66. <li class="li" id="v3.3.3__3322">The strings files for each supported language now include default translations for the “Trouble”
  67. note label that is used for <code class="keyword markupname xmlelement">&lt;note&gt;</code> elements with the <code class="keyword markupname xmlatt">@type</code> attribute
  68. set to <code class="ph codeph">trouble</code>.
  69. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3322" target="_blank">#3322</a>,
  70. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3336" target="_blank">#3336</a>
  71. </li>
  72. <li class="li" id="v3.3.3__3325">When generating HTML5 output, DITAVAL files can now preserve profiling attributes by default by
  73. setting the <code class="keyword markupname xmlatt">@action</code> attribute of a <code class="keyword markupname xmlelement">&lt;prop&gt;</code> element to
  74. <code class="ph codeph">passthrough</code>. Earlier versions of DITA-OT would only pass values through if the DITAVAL
  75. filter defined matching attribute/value pairs via specific <code class="keyword markupname xmlatt">@att</code> and <code class="keyword markupname xmlatt">@val</code>
  76. settings.
  77. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3325" target="_blank">#3325</a>
  78. </li>
  79. <li class="li" id="v3.3.3__3338">The LwDITA plugin has been updated to version 2.3.0 to fix several issues in Lightweight DITA
  80. processing. (Nested lists are now properly generated in Markdown output when list items starts with inline
  81. markup such as bold, or italics. Topic references with the <code class="keyword markupname xmlatt">@format</code> attribute set to
  82. <code class="ph codeph">html</code> will no longer be interpreted as DITA content. LwDITA-specific processing can be
  83. applied to HTML topics by setting the <code class="keyword markupname xmlatt">@format</code> attribute to <code class="ph codeph">hdita</code>.)
  84. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3338" target="_blank">#3338</a>
  85. </li>
  86. </ul>
  87. <p class="p">For additional information on the issues resolved since the previous release, see the
  88. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.3.3+is%3Aclosed" target="_blank">3.3.3 milestone</a> and
  89. <a class="xref" href="https://github.com/dita-ot/dita-ot/compare/3.3.2...3.3.3" target="_blank">
  90. changelog</a> on GitHub.</p>
  91. </section>
  92. </div>
  93. </article>
  94. <article class="topic reference nested1" aria-labelledby="ariaid-title4" id="v3.3.2">
  95. <h2 class="title topictitle2" id="ariaid-title4">DITA-OT 3.3.2 <span class="ph small text-muted">released May 28, 2019</span>
  96. </h2>
  97. <div class="body refbody">
  98. <section class="section">
  99. <p class="p">DITA Open Toolkit 3.3.2 is a maintenance release that includes the following bug fixes.</p>
  100. <ul class="ul">
  101. <li class="li" id="v3.3.2__2722">Earlier versions of DITA-OT would attempt to download remote media objects referenced via the
  102. <code class="keyword markupname xmlatt">@data</code> attribute of the <code class="keyword markupname xmlelement">&lt;object&gt;</code> element, and failed to copy local
  103. media objects to the output folder. Processing has been corrected to handle these references correctly.
  104. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2722" target="_blank">#2722</a>,
  105. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2861" target="_blank">#2861</a>,
  106. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2947" target="_blank">#2947</a>,
  107. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3306" target="_blank">#3306</a>
  108. </li>
  109. <li class="li" id="v3.3.2__3284">DITA-OT 3.3.1 would generate an invalid catalog file with an empty XML namespace when the
  110. bundled version 9.8.0.14 of Saxon Home Edition was replaced with Saxon-HE 9.8.0.15. This has been corrected
  111. to ensure that the OASIS namespace is used when generating the <span class="ph filepath">catalog-dita.xml</span> file.
  112. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3284" target="_blank">#3284</a>,
  113. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3287" target="_blank">#3287</a>
  114. <div class="note note note_note"><span class="note__title">Note:</span> DITA-OT 3.3.2 still ships with <span class="keyword">Saxon-HE</span>
  115. <span class="keyword">9.8.0.14</span>, but now also works with version 9.8.0.15.</div>
  116. </li>
  117. <li class="li" id="v3.3.2__3304">In PDF output, the bitmap warning icon has been replaced with the SVG image previously added for
  118. the PDF implementation of the hazard domain. The new image appears in <code class="keyword markupname xmlelement">&lt;note&gt;</code> elements
  119. of type <code class="ph codeph">attention</code>, <code class="ph codeph">caution</code>, <code class="ph codeph">danger</code>,
  120. <code class="ph codeph">trouble</code>, and <code class="ph codeph">warning</code> and is scaled to match the previous icon size.
  121. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3304" target="_blank">#3304</a>
  122. <div class="note attention note_attention"><span class="note__title">Attention:</span> The legacy <span class="ph filepath">warning.gif</span> file remains available in the common
  123. artwork folder, but will be removed in an upcoming version.</div>
  124. </li>
  125. <li class="li" id="v3.3.2__3310">Translations of the generated string for “continued” index entries have been added to the
  126. Bosnian, Danish, Montenegrin, and Vietnamese localizations.
  127. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3310" target="_blank">#3310</a>
  128. </li>
  129. </ul>
  130. <p class="p">For additional information on the issues resolved since the previous release, see the
  131. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.3.2+is%3Aclosed" target="_blank">3.3.2 milestone</a> and
  132. <a class="xref" href="https://github.com/dita-ot/dita-ot/compare/3.3.1...3.3.2" target="_blank">
  133. changelog</a> on GitHub.</p>
  134. </section>
  135. </div>
  136. </article>
  137. <article class="topic reference nested1" aria-labelledby="ariaid-title5" id="v3.3.1">
  138. <h2 class="title topictitle2" id="ariaid-title5">DITA-OT 3.3.1 <span class="ph small text-muted">released April 8, 2019</span></h2>
  139. <div class="body refbody">
  140. <section class="section">
  141. <p class="p">DITA Open Toolkit 3.3.1 is a maintenance release that includes the following bug fixes.</p>
  142. <ul class="ul">
  143. <li class="li" id="v3.3.1__3248">When processing content references in cases with more than one possible target for the
  144. <code class="keyword markupname xmlatt">@conref</code> value, recent versions of DITA-OT warned about the duplicate ID, but failed to
  145. include the reference target in the message. The <span class="keyword msgnum">DOTX011W</span> warning now restores this context
  146. to aid in troubleshooting.
  147. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3248" target="_blank">#3248</a>
  148. </li>
  149. <li class="li" id="v3.3.1__3249">When processing source files with tables or figures in <code class="keyword markupname xmlelement">&lt;draft-comment&gt;</code> or
  150. <code class="keyword markupname xmlelement">&lt;required-cleanup&gt;</code> elements, earlier versions of DITA-OT included them in lists and
  151. numbered references even when DRAFT output was not active. Hidden elements are now excluded from lists of
  152. figures and tables, and when numbering references.
  153. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3249" target="_blank">#3249</a>
  154. </li>
  155. <li class="li" id="v3.3.1__3251">The <code class="keyword markupname xmlatt">@type</code> attribute of the <span class="keyword parmname">args.css</span> and
  156. <span class="keyword parmname">args.cssroot</span> parameters has been changed to <code class="ph codeph">string</code> to better support
  157. values that include relative paths. The <span class="keyword parmname">transtype</span> has also been corrected to
  158. <code class="ph codeph">string</code>.
  159. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3251" target="_blank">#3251</a>
  160. </li>
  161. <li class="li" id="v3.3.1__3260">When copying files to a temporary file scheme that flattens the directory structure, the
  162. map-first preprocessing routine will now correctly handle indirect content references defined via
  163. <code class="keyword markupname xmlatt">@conkeyref</code>.
  164. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3260" target="_blank">#3260</a>
  165. </li>
  166. <li class="li" id="v3.3.1__3272">The integrator and topic reader modules have been modified to use an alternative method
  167. supported by the XML APIs library to prevent errors when compiling the toolkit’s JAR file.
  168. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3272" target="_blank">#3272</a>,
  169. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3273" target="_blank">#3273</a>
  170. </li>
  171. <li class="li" id="v3.3.1__3278">The <span class="keyword cmdname">dita</span> command now uses a secure connection to the plug-in registry when
  172. installing new plug-ins.
  173. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3278" target="_blank">#3278</a>
  174. <div class="note attention note_attention"><span class="note__title">Attention:</span> To ensure data integrity during the plug-in installation process, Transport Layer
  175. Security (TLS) will soon be required to access the plug-in registry. If you are using DITA-OT 3.3, 3.2, or
  176. 3.2.1 and are unable to upgrade to 3.3.1, modify the <code class="ph codeph">registry</code> key in the
  177. <span class="ph filepath">config/configuration.properties</span> file to switch the URI schema to
  178. <code class="ph codeph">http<strong class="ph b">s</strong>://</code>, so the entry reads
  179. <code class="ph codeph">https://plugins.dita-ot.org/</code>.</div>
  180. </li>
  181. </ul>
  182. <p class="p">For additional information on the issues resolved since the previous release, see the
  183. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.3.1+is%3Aclosed" target="_blank">3.3.1 milestone</a> and
  184. <a class="xref" href="https://github.com/dita-ot/dita-ot/compare/3.3...3.3.1" target="_blank">
  185. changelog</a> on GitHub.</p>
  186. </section>
  187. </div>
  188. </article>
  189. <article class="topic reference nested1" aria-labelledby="ariaid-title6" id="v3.3">
  190. <h2 class="title topictitle2" id="ariaid-title6">DITA-OT <span class="keyword">3.3</span>
  191. <span class="ph small text-muted">released February 28, 2019</span></h2>
  192. <div class="body refbody">
  193. <section class="section">
  194. <p class="p">DITA Open Toolkit Release <span class="keyword">3.3</span> includes <span class="ph" id="v3.3__summary">new attribute sets for HTML5
  195. customization, support for custom integration processing, rotated table cells in PDF output, and hazard
  196. statements in HTML output</span>.</p>
  197. </section>
  198. <section class="section" id="v3.3__features"><h3 class="title sectiontitle">Feature Highlights</h3>
  199. <p class="p">DITA Open Toolkit Release <span class="keyword">3.3</span> includes the following new features:</p>
  200. <ul class="ul">
  201. <li class="li" id="v3.3__1778">
  202. <p class="p">The <code class="keyword markupname xmlatt">@rotate</code> attribute on table <code class="keyword markupname xmlelement">&lt;entry&gt;</code> elements, which was added
  203. in the DITA 1.3 specification, is now supported in PDF output.
  204. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/1778" target="_blank">#1778</a>,
  205. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2717" target="_blank">#2717</a>,
  206. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3161" target="_blank">#3161</a>
  207. </p></li>
  208. <li class="li" id="v3.3__3175">
  209. <p class="p">A new <code class="ph codeph">CustomIntegrator</code> interface provides a mechanism for custom plug-ins to extend the
  210. default integration process via service provider classes declared via a
  211. <a class="xref" href="https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html" target="_blank">Java <code class="ph codeph">ServiceLoader</code></a>.
  212. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3175" target="_blank">#3175</a>
  213. </p></li>
  214. <li class="li" id="v3.3__3207">
  215. <p class="p">HTML5 and XHTML output now provide generic hazard statement styling based on the ISO&nbsp;3864 and ANSI&nbsp;Z535
  216. standards, with an SVG icon and
  217. <a class="xref" href="http://sass-lang.com" target="_blank">Sass</a> variables for the corresponding ISO and ANSI color definitions. The ANSI colors
  218. are used by default to match the PDF styling previously added in DITA-OT 3.2.
  219. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3207" target="_blank">#3207</a>,
  220. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3231" target="_blank">#3231</a>
  221. </p></li>
  222. <li class="li">
  223. <div class="p">A series of new attribute sets has been added to the default HTML5 transformation to
  224. facilitate customization with additional ARIA roles, attributes, or CSS classes. Attribute sets are provided
  225. for:
  226. <ul class="ul">
  227. <li class="li"><code class="ph codeph">article</code></li>
  228. <li class="li"><code class="ph codeph">banner</code></li>
  229. <li class="li"><code class="ph codeph">footer</code></li>
  230. <li class="li"><code class="ph codeph">main</code></li>
  231. <li class="li"><code class="ph codeph">navigation</code></li>
  232. <li class="li"><code class="ph codeph">toc</code></li>
  233. </ul>If you have previously copied XSL templates (or template modes) to custom plug-ins only to add classes
  234. required by web frameworks such as Bootstrap or Foundation (or your company CSS), you may be able to simplify
  235. your customizations by using the new attribute sets instead of overriding the default templates.</div>
  236. </li>
  237. </ul>
  238. </section>
  239. <section class="section" id="v3.3__enhancements"><h3 class="title sectiontitle">Enhancements and changes</h3>
  240. <div class="div div-index">
  241. </div>
  242. <p class="p">DITA Open Toolkit Release <span class="keyword">3.3</span> includes the following enhancements and changes to
  243. existing features:</p>
  244. <ul class="ul">
  245. <li class="li" id="v3.3__2225">The <span class="keyword cmdname">dita</span> command now recognizes a wider range of “truthy” property values,
  246. including <code class="ph codeph">true</code>, <code class="ph codeph">yes</code>, <code class="ph codeph">1</code>, and <code class="ph codeph">on</code> and
  247. handles inconsistently cased values more gracefully.
  248. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2225" target="_blank">#2225</a>,
  249. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3197" target="_blank">#3197</a>
  250. </li>
  251. <li class="li" id="v3.3__3157">Various XSLT files and other resources have been moved from the root of the DITA-OT installation
  252. directory to the base plug-in directory <span class="ph filepath">plugins/org.dita.base</span>.
  253. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3157" target="_blank">#3157</a> (If
  254. your plug-ins use the <code class="ph codeph">plugin</code> URI scheme as recommended in the
  255. <a class="xref" href="../topics/plugin-coding-conventions.html" title="To ensure custom plug-ins work well with the core toolkit code and remain compatible with future releases, the DITA Open Toolkit project recommends that plug-ins use modern development practices and common coding patterns.">Plug-in coding conventions</a>, this change should not require any modifications to custom
  256. plug-in code.) </li>
  257. <li class="li" id="v3.3__3176"><span class="ph">The <code class="ph codeph">templates</code> key in configuration properties has been deprecated in favor
  258. of the <code class="keyword markupname xmlelement">&lt;template&gt;</code> element in <span class="ph filepath">plugin.xml</span>.</span>
  259. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3176" target="_blank">#3176</a>
  260. </li>
  261. <li class="li" id="v3.3__3177">In HTML5 output, task <code class="keyword markupname xmlelement">&lt;steps&gt;</code> are now wrapped in
  262. <code class="keyword markupname xmlelement">&lt;section&gt;</code> elements and DITA <code class="keyword markupname xmlelement">&lt;example&gt;</code>,
  263. <code class="keyword markupname xmlelement">&lt;prereq&gt;</code>, and <code class="keyword markupname xmlelement">&lt;stepsection&gt;</code> elements are also generated as
  264. HTML5 <code class="keyword markupname xmlelement">&lt;section&gt;</code> elements.
  265. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3177" target="_blank">#3177</a>
  266. </li>
  267. <li class="li" id="v3.3__3178">Java code has been refactored to add missing DITA classes to the list of available Java
  268. constants and re-sort the constant definitions.
  269. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3178" target="_blank">#3178</a>
  270. </li>
  271. <li class="li" id="v3.3__3182">Custom <code class="keyword markupname xmlelement">&lt;pipeline&gt;</code> modules can now use SAX filters. This makes it possible
  272. to configure the module’s behavior at the Ant level and add additional processing to a module. Modules do
  273. not have to define nested filters if they prefer not to expose this extension point or do not use SAX
  274. internally.
  275. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3182" target="_blank">#3182</a>
  276. <pre class="pre codeblock language-xml"><code>&lt;pipeline&gt;
  277. &lt;module class="com.example.Module"&gt;
  278. &lt;filter class="com.example.XmlFilter"/&gt;
  279. &lt;/module&gt;
  280. &lt;/pipeline&gt;</code></pre></li>
  281. <li class="li" id="v3.3__3187">New extension points have been added to contribute parameters to the debug-filter, map reader,
  282. and topic reader Java preprocessing modules.
  283. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3187" target="_blank">#3187</a>
  284. <ul class="ul">
  285. <li class="li">
  286. <span class="keyword parmname">dita.preprocess.debug-filter.param</span></li>
  287. <li class="li">
  288. <span class="keyword parmname">dita.preprocess.map-reader.param</span></li>
  289. <li class="li">
  290. <span class="keyword parmname">dita.preprocess.topic-reader.param</span></li>
  291. </ul>
  292. </li>
  293. <li class="li" id="v3.3__3188">The DITA-OT fork of the
  294. <a class="xref" href="https://github.com/relaxng/jing-trang" target="_blank">jing-trang</a> project
  295. used to provide RELAX NG schema validation in DITA-OT 3.2 has been replaced with the upstream code after the
  296. patches provided by George Bina were included.
  297. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3188" target="_blank">#3188</a>
  298. </li>
  299. <li class="li" id="v3.3__3191">Several bundled dependencies have been upgraded to the latest versions.
  300. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3191" target="_blank">#3191</a>
  301. <ul class="ul">
  302. <li class="li">Ant 1.10.5</li>
  303. <li class="li">Jackson 2.9.8</li>
  304. <li class="li">Saxon-HE 9.8.0-14</li>
  305. <li class="li">Xerces-J2 2.12.0</li>
  306. </ul>
  307. </li>
  308. <li class="li" id="v3.3__3193">An additional keyscope test has been added to test interactions with submaps referenced via
  309. <code class="keyword markupname xmlelement">&lt;mapref&gt;</code>.
  310. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3193" target="_blank">#3193</a>
  311. </li>
  312. <li class="li" id="v3.3__3195">The default character set for code references can now be changed by adding the
  313. <span class="keyword parmname">default.coderef-charset</span> key to the
  314. <a class="xref" href="../parameters/configuration-properties-file.html" title="The configuration.properties file controls certain common properties, as well as some properties that control PDF processing.">configuration.properties</a> file. The character set values
  315. are those supported by the Java
  316. <a class="xref" href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html" target="_blank">Charset</a> class.
  317. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3195" target="_blank">#3195</a>
  318. </li>
  319. <li class="li" id="v3.3__3196">The <code class="keyword markupname xmlelement">&lt;ditafileset&gt;</code> now supports nested <code class="keyword markupname xmlelement">&lt;includes&gt;</code>
  320. and <code class="keyword markupname xmlelement">&lt;excludes&gt;</code> elements to more easily control which files get processed (or do not
  321. get processed) by each processing step. The <code class="ph codeph">copy-files</code> task has been been moved to the end
  322. of the preprocessing pipeline to match the order in map-first preprocessing (<code class="ph codeph">preprocess2</code>).
  323. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3196" target="_blank">#3196</a>
  324. </li>
  325. <li class="li" id="v3.3__3204">The
  326. <a class="xref" href="https://gradle.org" target="_blank">Gradle</a> build system has been updated to the latest patch release (5.2.1).
  327. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3204" target="_blank">#3204</a>
  328. </li>
  329. <li class="li" id="v3.3__3217">When source files contain an empty <code class="ph codeph">conref=""</code> attribute value, DITA-OT now
  330. provides a meaningful warning and then ignores this construct, which previously resulted in parser errors.
  331. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3217" target="_blank">#3217</a>
  332. </li>
  333. <li class="li" id="v3.3__3230"><span class="ph">Along with the other base plug-in files, the <span class="ph filepath">catalog-dita.xml</span> file has
  334. been moved from the root of the DITA-OT installation directory to <span class="ph filepath">plugins/org.dita.base</span>.
  335. External systems that rely on this catalog should be updated with the new location. Ant scripts and DITA-OT
  336. plug-ins should use the plug-in directory property to refer to the file as
  337. <code class="ph codeph">${dita.plugin.org.dita.base.dir}/catalog-dita.xml</code>. A placeholder with a
  338. <code class="keyword markupname xmlelement">&lt;nextCatalog&gt;</code> entry is provided in the original location for backwards compatibility,
  339. but this file may be removed in an upcoming release.</span>
  340. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3230" target="_blank">#3230</a>
  341. </li>
  342. </ul>
  343. </section>
  344. <section class="section" id="v3.3__bugs"><h3 class="title sectiontitle">Bugs</h3>
  345. <div class="div div-index">
  346. </div>
  347. <p class="p">DITA Open Toolkit Release <span class="keyword">3.3</span> provides fixes for the following bugs:</p>
  348. <ul class="ul">
  349. <li class="li" id="v3.3__1439">In earlier releases, external URIs referenced via <code class="keyword markupname xmlatt">@keyref</code> from within
  350. relationship tables resulted in links with broken link text. This has been fixed, and metadata including
  351. link text or titles is preserved for external URIs referenced by key within a map.
  352. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/1439" target="_blank">#1439</a>,
  353. <a class="xref" href="https://github.com/dita-ot/dita-ot/pulls/3179" target="_blank">#3179</a></li>
  354. <li class="li" id="v3.3__1951">Relative paths in peer or non-DITA key references were not handled correctly in earlier
  355. releases. The paths are now adjusted as needed to stay valid in any referencing location.
  356. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/1951" target="_blank">#1951</a>,
  357. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2250" target="_blank">#2250</a>,
  358. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2581" target="_blank">#2581</a>,
  359. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2620" target="_blank">#2620</a>,
  360. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3234" target="_blank">#3234</a>
  361. </li>
  362. <li class="li" id="v3.3__2428">Several fixes have been added to improve support for the <code class="keyword markupname xmlatt">@chunk</code> attribute on
  363. topic groups (covering both <code class="keyword markupname xmlelement">&lt;topicgroup&gt;</code> and any other
  364. <code class="keyword markupname xmlelement">&lt;topicref&gt;</code> style container that does not reference a file).
  365. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2428" target="_blank">#2428</a>,
  366. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2730" target="_blank">#2730</a>,
  367. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2843" target="_blank">#2843</a>,
  368. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3216" target="_blank">#3216</a>
  369. <ul class="ul">
  370. <li class="li">In earlier releases, using <code class="ph codeph">chunk="to-content"</code> on a grouping element <em class="ph i">within</em>
  371. another branch or map that specified <code class="ph codeph">chunk="to-content"</code> would result in a
  372. NullPointerException. This error has been fixed.</li>
  373. <li class="li">In earlier releases, using <code class="ph codeph">chunk="to-content"</code> on a nested map would result in the
  374. same NullPointerExceptions when the map reference was inside of a chunked branch or map.</li>
  375. <li class="li">In earlier releases, <code class="keyword markupname xmlelement">&lt;topicgroup&gt;</code> elements with no title that used
  376. <code class="ph codeph">chunk="to-content"</code> would result in a generated heading in the output file, such as
  377. "Chunk1234567". Chunked containers without a heading will no longer result in a generated heading in the
  378. output.</li>
  379. <li class="li">In earlier releases, <code class="keyword markupname xmlelement">&lt;topichead&gt;</code> elements inside of a chunked branch would
  380. result in headings that appeared out of order for PDF. This has been fixed; topic headings will appear
  381. where expected in the PDF flow.</li>
  382. </ul>
  383. </li>
  384. <li class="li" id="v3.3__2523">In earlier versions, references to keys in local scopes were not processed correctly. In certain
  385. other cases, files referenced through mapref were parsed with the root scope instead of their parent scope.
  386. Keyref parsing has been improved to reliably detect and preserve key scopes to ensure that all key
  387. references are resolved in the correct scopes.
  388. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2523" target="_blank">#2523</a>,
  389. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3141" target="_blank">#3141</a>,
  390. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3194" target="_blank">#3194</a>
  391. </li>
  392. <li class="li" id="v3.3__2899">In some recent releases, cross references to local, non-DITA files with formats such as "pdf" or
  393. "txt" did not copy those referenced files to the output directory. When appropriate, such as when generating
  394. HTML output, these files are now copied to the output directory as they were in earlier releases.
  395. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2899" target="_blank">#2899</a>
  396. </li>
  397. <li class="li" id="v3.3__3162">On Linux and other systems where the DITA-OT installation directory and temporary directory are
  398. not on the same volume, plug-in installation would fail when DITA-OT tried to move a non-empty directory.
  399. The installation process has been refactored to ensure that plug-ins are correctly installed in these cases.
  400. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3162" target="_blank">#3162</a>,
  401. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3238" target="_blank">#3238</a>,
  402. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3239" target="_blank">#3239</a>
  403. </li>
  404. <li class="li" id="v3.3__3180">In earlier versions, setting an <code class="keyword markupname xmlatt">@id</code> attribute on a <code class="keyword markupname xmlelement">&lt;dt&gt;</code>
  405. created duplicate IDs in the XSL-FO file, which caused warnings when rendering FO to PDF.
  406. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3180" target="_blank">#3180</a>,
  407. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3185" target="_blank">#3185</a>
  408. </li>
  409. <li class="li" id="v3.3__3183">The <span class="ph filepath">plugin.rnc</span> RELAX NG Compact Syntax schema used to validate plug-in
  410. descriptor files was inadvertently removed from the distribution package and has been restored.
  411. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3183" target="_blank">#3183</a>,
  412. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3220" target="_blank">#3220</a>
  413. </li>
  414. <li class="li" id="v3.3__3198">The codeblock normalization process would sometimes fail to recognize certain combinations of
  415. characters at the beginning of code blocks, resulting in error messages. These adjacent text events are now
  416. merged before the indentation is adjusted.
  417. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3198" target="_blank">#3198</a>
  418. </li>
  419. <li class="li" id="v3.3__3210">In earlier releases, some indirect key references to glossary entries could result in XSLT
  420. errors when more than one possible key target existed. This is corrected by using the single desired target
  421. to resolve such links.
  422. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3210" target="_blank">#3210</a>
  423. </li>
  424. <li class="li" id="v3.3__3211">When the input file set contained resources with different URI schemes (for example local files
  425. and external files referenced via HTTPS), earlier versions of DITA-OT would fail with errors. Preprocessing
  426. routines have been corrected to ensure the the base directory is correctly calculated in these cases.
  427. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3211" target="_blank">#3211</a>
  428. </li>
  429. <li class="li" id="v3.3__3213">When generating HTML5 output with the <span class="keyword parmname">nav-toc</span> parameter set to
  430. <code class="ph codeph">partial</code>, earlier versions would fail to insert table-of-contents navigation in topics
  431. whose names contained spaces. The path normalization process has been corrected to ensure that spaces in
  432. file and directory names are correctly URL-encoded as <code class="ph codeph">%20</code>, and navigation is included.
  433. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3213" target="_blank">#3213</a>,
  434. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3229" target="_blank">#3229</a>
  435. </li>
  436. <li class="li" id="v3.3__3214">In earlier releases, some revision properties were ignored on <code class="keyword markupname xmlelement">&lt;tm&gt;</code>
  437. elements in PDF output. This is now corrected, so that revision flagging such as text color or background
  438. color are properly supported on trademarks.
  439. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3214" target="_blank">#3214</a>,
  440. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3215" target="_blank">#3215</a>
  441. </li>
  442. <li class="li" id="v3.3__3219">In documentation and error messages about available transformation types, extensions of an
  443. existing transformation could result in duplicate values (such as 3 instances of "pdf"). Duplicates are now
  444. removed when listing the available transformation types.
  445. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3219" target="_blank">#3219</a>
  446. </li>
  447. <li class="li" id="v3.3__3223">In earlier releases, duplicate conditions in DITAVAL properties (such as using two DITAVAL
  448. documents for a build that each set up rules for <code class="ph codeph">rev="rev3"</code>) would generate a warning. This
  449. message has been reduced in severity and will now appear only as an informational message with verbose
  450. logging.
  451. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3223" target="_blank">#3223</a>
  452. </li>
  453. <li class="li" id="v3.3__3224">In earlier releases, content references on elements that specified
  454. <code class="ph codeph">href="-dita-use-conref-target"</code> would evaluate that value as a literal file name. That
  455. token (defined in the
  456. <a class="xref" href="http://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part1-base/langRef/attributes/ditauseconreftarget.html" target="_blank">DITA specification</a>) is now ignored on elements that also use
  457. <code class="keyword markupname xmlatt">@conref</code>.
  458. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3224" target="_blank">#3224</a>
  459. </li>
  460. <li class="li" id="v3.3__3235">Revised figures and tables are now marked with change bars in booklists when DITAVAL files
  461. define flagging for the corresponding revision values.
  462. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3235" target="_blank">#3235</a>
  463. </li>
  464. <li class="li" id="v3.3__3245">The command line syntax for the <span class="keyword cmdname">dita</span>
  465. <span class="keyword parmname">--install</span> option has been updated to support the “=” equals sign.
  466. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/3245" target="_blank">#3245</a>
  467. <div class="p">Both of the following formats are now supported:
  468. <pre class="pre codeblock"><code><span class="keyword cmdname">dita</span> <span class="keyword parmname">--install</span>=<var class="keyword varname">plug-in-zip</var>
  469. <span class="keyword cmdname">dita</span> <span class="keyword parmname">--install</span> <var class="keyword varname">plug-in-zip</var></code></pre></div>
  470. </li>
  471. </ul>
  472. </section>
  473. <section class="section" id="v3.3__contrib"><h3 class="title sectiontitle">Contributors</h3>
  474. <p class="p">DITA Open Toolkit Release <span class="keyword">3.3</span> includes
  475. <a class="xref" href="https://github.com/dita-ot/dita-ot/graphs/contributors" target="_blank">code contributions</a> by the following people:</p>
  476. <ol class="ol">
  477. <li class="li">Jarno Elovirta</li>
  478. <li class="li">Robert D Anderson</li>
  479. <li class="li">Roger Sheen</li>
  480. <li class="li">Simen Tinderholt</li>
  481. <li class="li">Eliot Kimber</li>
  482. <li class="li">Eric Sirois</li>
  483. </ol>
  484. <p class="p">For the complete list of changes since the previous release, see the
  485. <a class="xref" href="https://github.com/dita-ot/dita-ot/compare/3.2...3.3" target="_blank">
  486. changelog</a> on GitHub.</p>
  487. </section>
  488. <section class="section" id="v3.3__docs"><h3 class="title sectiontitle">Documentation updates</h3>
  489. <p class="p">The documentation for DITA Open Toolkit Release <span class="keyword">3.3</span> provides corrections and
  490. improvements to existing topics, along with new information in the following topics:</p>
  491. <ul class="ul">
  492. <li class="li">
  493. <a class="xref" href="../topics/prerequisite-software.html" title="The prerequisite software that DITA-OT requires depends on the types of transformations that you want to use.">Prerequisite software</a></li>
  494. <li class="li">
  495. <a class="xref" href="../parameters/dita-command-arguments.html" title="The dita command takes mandatory arguments to process DITA content, manage plug-ins, or print information about the command. Options can be used to modify the command behavior or specify additional configuration parameters.">Arguments and options for the dita command</a></li>
  496. <li class="li">
  497. <a class="xref" href="../topics/pdf2-creating-change-bars.html" title="If you use Antenna House Formatter or RenderX XEP, you can generate revision bars in your PDF output by using the changebar and color attributes of the DITAVAL revprop element.">Generating revision bars</a></li>
  498. <li class="li">
  499. <a class="xref" href="../topics/plugins-registry.html" title="DITA-OT 3.2 supports a new plug-in registry that makes it easier to discover and install new plug-ins. The registry provides a searchable list of plug-ins at dita-ot.org/plugins.">Adding plug-ins via the registry</a></li>
  500. <li class="li">
  501. <a class="xref" href="../topics/plugin-javalib.html" title="You can use the dita.conductor.lib.import extension point to add an additional Java library to the DITA-OT classpath parameter.">Adding a Java library to the DITA-OT classpath</a></li>
  502. <li class="li">
  503. <a class="xref" href="../topics/implement-saxon-customizations.html" title="Plug-ins can contribute XSLT extension functions and collation URI resolvers. These customizations are automatically configured to work with Saxon when transformations are run using the DITA-OT pipeline task with custom XSLT.">Adding Saxon customizations</a></li>
  504. <li class="li">
  505. <a class="xref" href="../extension-points/plugin-extension-points-pre-processing.html" title="You can use these extension points to run an Ant target before or after the pre-processing stage. If necessary, you can also run an Ant target before a specific pre-processing step — but this approach is not recommended.">Pre-processing extension points</a></li>
  506. <li class="li">
  507. <a class="xref" href="../topics/migrating-to-3.3.html" title="DITA-OT 3.3 includes new attribute sets for HTML5 customization, support for custom integration processing, rotated table cells in PDF output, and hazard statements in HTML output.">Migrating to release 3.3</a></li>
  508. </ul>
  509. <p class="p">For additional information on documentation issues resolved in DITA Open Toolkit Release <span class="keyword">3.3</span>, see the
  510. <a class="xref" href="https://github.com/dita-ot/docs/issues?q=milestone%3A3.3+is%3Aclosed" target="_blank">
  511. <span class="keyword">3.3</span> milestone</a> in the documentation repository.</p>
  512. <p class="p">DITA Open Toolkit Release <span class="keyword">3.3</span> includes
  513. <a class="xref" href="https://github.com/dita-ot/docs/graphs/contributors" target="_blank">documentation contributions</a> by the following people:</p>
  514. <ol class="ol">
  515. <li class="li">Roger Sheen</li>
  516. <li class="li">Eliot Kimber</li>
  517. <li class="li">Robert D Anderson</li>
  518. <li class="li">Jarno Elovirta</li>
  519. <li class="li">Quick van Rijt</li>
  520. </ol>
  521. <p class="p">For the complete list of documentation changes since the previous release, see the
  522. <a class="xref" href="https://github.com/dita-ot/docs/compare/3.2...3.3" target="_blank">
  523. changelog</a>.</p>
  524. </section>
  525. </div>
  526. </article>
  527. </article></main></body></html>