index.dita 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
  3. <!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
  4. <reference id="ID" rev="3.3">
  5. <title>DITA Open Toolkit <keyword keyref="release"/> Release Notes</title>
  6. <titlealts>
  7. <navtitle>Release Notes</navtitle>
  8. </titlealts>
  9. <abstract>
  10. <shortdesc>DITA Open Toolkit <keyword keyref="maintenance-version"/> is a maintenance release that fixes issues
  11. reported in DITA-OT <keyword keyref="release"/>, which includes <ph conref="#v3.3/summary"/>.</shortdesc>
  12. <p conkeyref="conref-task/semver-info"/>
  13. <note type="tip"><ph conref="../resources/conref-task.dita#ID/download-ot"/></note>
  14. </abstract>
  15. <reference id="requirements">
  16. <title>Requirements</title>
  17. <refbody>
  18. <section>
  19. <draft-comment author="Roger">Add info on new minimum Java version or any other requirements that have changed
  20. since previous release.</draft-comment>
  21. <p conkeyref="reusable-components/java-clients"/>
  22. </section>
  23. </refbody>
  24. </reference>
  25. <reference id="v3.3.3">
  26. <title>DITA-OT <keyword keyref="maintenance-version"/>
  27. <!--<ph outputclass="small text-muted">released MMMM DD, 2019</ph>-->
  28. </title>
  29. <prolog>
  30. <metadata>
  31. <keywords>
  32. <indexterm>HTML5<indexterm>table <xmlatt>headers</xmlatt></indexterm></indexterm>
  33. <indexterm>flagging</indexterm>
  34. <indexterm><xmlatt>xml:lang</xmlatt></indexterm>
  35. <indexterm><xmlelement>linklist</xmlelement></indexterm>
  36. <indexterm>languages<indexterm><xmlelement>linklist</xmlelement></indexterm></indexterm>
  37. <indexterm>link processing</indexterm>
  38. <indexterm>Trouble note labels</indexterm>
  39. <indexterm><xmlelement>note</xmlelement></indexterm>
  40. <indexterm>passthrough</indexterm>
  41. <indexterm>DITAVAL<indexterm>passthrough action</indexterm></indexterm>
  42. <indexterm><xmlatt>action</xmlatt></indexterm>
  43. <indexterm><xmlelement>prop</xmlelement></indexterm>
  44. <indexterm>Saxon<indexterm>tables</indexterm><indexterm>screen readers</indexterm></indexterm>
  45. </keywords>
  46. </metadata>
  47. </prolog>
  48. <refbody>
  49. <section>
  50. <p>DITA Open Toolkit <keyword keyref="maintenance-version"/> is a maintenance release that includes the
  51. following bug fixes.</p>
  52. <ul>
  53. <li id="3313">The code that generates <xmlatt>headers</xmlatt> attributes in HTML-based output formats has
  54. been simplified to prevent Saxon crashes when processing complex tables. (These attributes help screen
  55. readers to identify the header cells to which table cells are related.)
  56. <xref href="https://github.com/dita-ot/dita-ot/issues/3313" format="html" scope="external">#3313</xref>
  57. </li>
  58. <!--
  59. <li id="3316">For HTML-based output formats, image flag processing has been improved to ensure that flag
  60. images are reliably copied to the correct location(s) in the output directory, regardless of whether the
  61. DITAVAL is outside the map directory, in the map directory, or in a subdirectory of the map location.
  62. <xref href="https://github.com/dita-ot/dita-ot/issues/3316" format="html" scope="external">#3316</xref>
  63. </li>
  64. -->
  65. <li id="3317">In recent (3.x) versions of DITA-OT, flagging information is added before generated links are
  66. created, so any flags on the topic reference are ignored. Processing has been updated to copy flags from the
  67. <xmlelement>topicref</xmlelement> to the links that are generated to point to that topic.
  68. <xref href="https://github.com/dita-ot/dita-ot/issues/3317" format="html" scope="external">#3317</xref>
  69. </li>
  70. <li id="3321">Earlier versions of DITA-OT failed to honor the effective <xmlatt>xml:lang</xmlatt> attribute
  71. value when processing links. This error has been corrected to ensure that the closest language value is
  72. preserved on the generated <xmlelement>linklist</xmlelement>, so locale-based headings such as ”Related
  73. information” are applied correctly.
  74. <xref href="https://github.com/dita-ot/dita-ot/issues/3321" format="html" scope="external">#3321</xref>
  75. </li>
  76. <li id="3322">The strings files for each supported language now include default translations for the “Trouble”
  77. note label that is used for <xmlelement>note</xmlelement> elements with the <xmlatt>type</xmlatt> attribute
  78. set to <codeph>trouble</codeph>.
  79. <xref href="https://github.com/dita-ot/dita-ot/issues/3322" format="html" scope="external">#3322</xref>,
  80. <xref href="https://github.com/dita-ot/dita-ot/issues/3336" format="html" scope="external">#3336</xref>
  81. </li>
  82. <li id="3325">When generating HTML5 output, DITAVAL files can now preserve profiling attributes by default by
  83. setting the <xmlatt>action</xmlatt> attribute of a <xmlelement>prop</xmlelement> element to
  84. <codeph>passthrough</codeph>. Earlier versions of DITA-OT would only pass values through if the DITAVAL
  85. filter defined matching attribute/value pairs via specific <xmlatt>att</xmlatt> and <xmlatt>val</xmlatt>
  86. settings.
  87. <xref href="https://github.com/dita-ot/dita-ot/issues/3325" format="html" scope="external">#3325</xref>
  88. </li>
  89. <li id="3338">The LwDITA plugin has been updated to version 2.3.0 to fix several issues in Lightweight DITA
  90. processing. (Nested lists are now properly generated in Markdown output when list items starts with inline
  91. markup such as bold, or italics. Topic references with the <xmlatt>format</xmlatt> attribute set to
  92. <codeph>html</codeph> will no longer be interpreted as DITA content. LwDITA-specific processing can be
  93. applied to HTML topics by setting the <xmlatt>format</xmlatt> attribute to <codeph>hdita</codeph>.)
  94. <xref href="https://github.com/dita-ot/dita-ot/issues/3338" format="html" scope="external">#3338</xref>
  95. </li>
  96. </ul>
  97. <p>For additional information on the issues resolved since the previous release, see the
  98. <xref href="https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.3.3+is%3Aclosed" format="html"
  99. scope="external">3.3.3 milestone</xref> and
  100. <xref href="https://github.com/dita-ot/dita-ot/compare/3.3.2...3.3.3" format="html" scope="external">
  101. changelog</xref> on GitHub.</p>
  102. </section>
  103. </refbody>
  104. </reference>
  105. <reference id="v3.3.2">
  106. <title>DITA-OT 3.3.2 <ph outputclass="small text-muted">released May 28, 2019</ph>
  107. </title>
  108. <prolog>
  109. <metadata>
  110. <keywords>
  111. <indexterm>Bosnian</indexterm>
  112. <indexterm>Danish</indexterm>
  113. <indexterm>Montenegrin</indexterm>
  114. <indexterm>Vietnamese</indexterm>
  115. <indexterm>Saxon<indexterm>version</indexterm></indexterm>
  116. <indexterm>media<index-see-also>images</index-see-also></indexterm>
  117. <indexterm>video<index-see>media</index-see></indexterm>
  118. </keywords>
  119. </metadata>
  120. </prolog>
  121. <refbody>
  122. <section>
  123. <p>DITA Open Toolkit 3.3.2 is a maintenance release that includes the following bug fixes.</p>
  124. <ul>
  125. <!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.3.2+sort%3Acreated-asc -->
  126. <li id="2722">Earlier versions of DITA-OT would attempt to download remote media objects referenced via the
  127. <xmlatt>data</xmlatt> attribute of the <xmlelement>object</xmlelement> element, and failed to copy local
  128. media objects to the output folder. Processing has been corrected to handle these references correctly.
  129. <xref href="https://github.com/dita-ot/dita-ot/issues/2722" format="html" scope="external">#2722</xref>,
  130. <xref href="https://github.com/dita-ot/dita-ot/issues/2861" format="html" scope="external">#2861</xref>,
  131. <xref href="https://github.com/dita-ot/dita-ot/issues/2947" format="html" scope="external">#2947</xref>,
  132. <xref href="https://github.com/dita-ot/dita-ot/issues/3306" format="html" scope="external">#3306</xref>
  133. </li>
  134. <li id="3284">DITA-OT 3.3.1 would generate an invalid catalog file with an empty XML namespace when the
  135. bundled version 9.8.0.14 of Saxon Home Edition was replaced with Saxon-HE 9.8.0.15. This has been corrected
  136. to ensure that the OASIS namespace is used when generating the <filepath>catalog-dita.xml</filepath> file.
  137. <xref href="https://github.com/dita-ot/dita-ot/issues/3284" format="html" scope="external">#3284</xref>,
  138. <xref href="https://github.com/dita-ot/dita-ot/issues/3287" format="html" scope="external">#3287</xref>
  139. <note>DITA-OT 3.3.2 still ships with <keyword keyref="tool.saxon.edition"/>
  140. <keyword keyref="tool.saxon.version"/>, but now also works with version 9.8.0.15.</note>
  141. </li>
  142. <li id="3304">In PDF output, the bitmap warning icon has been replaced with the SVG image previously added for
  143. the PDF implementation of the hazard domain. The new image appears in <xmlelement>note</xmlelement> elements
  144. of type <codeph>attention</codeph>, <codeph>caution</codeph>, <codeph>danger</codeph>,
  145. <codeph>trouble</codeph>, and <codeph>warning</codeph> and is scaled to match the previous icon size.
  146. <xref href="https://github.com/dita-ot/dita-ot/issues/3304" format="html" scope="external">#3304</xref>
  147. <note type="attention">The legacy <filepath>warning.gif</filepath> file remains available in the common
  148. artwork folder, but will be removed in an upcoming version.</note>
  149. </li>
  150. <li id="3310">Translations of the generated string for “continued” index entries have been added to the
  151. Bosnian, Danish, Montenegrin, and Vietnamese localizations.
  152. <xref href="https://github.com/dita-ot/dita-ot/issues/3310" format="html" scope="external">#3310</xref>
  153. </li>
  154. </ul>
  155. <p>For additional information on the issues resolved since the previous release, see the
  156. <xref href="https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.3.2+is%3Aclosed" format="html"
  157. scope="external">3.3.2 milestone</xref> and
  158. <xref href="https://github.com/dita-ot/dita-ot/compare/3.3.1...3.3.2" format="html" scope="external">
  159. changelog</xref> on GitHub.</p>
  160. </section>
  161. </refbody>
  162. </reference>
  163. <reference id="v3.3.1">
  164. <title>DITA-OT 3.3.1 <ph outputclass="small text-muted">released April 8, 2019</ph></title>
  165. <prolog>
  166. <metadata>
  167. <keywords>
  168. <indexterm>security</indexterm>
  169. <indexterm>TLS</indexterm>
  170. <indexterm>registry</indexterm>
  171. <indexterm><xmlelement>draft-comment</xmlelement></indexterm>
  172. <indexterm><xmlelement>required-cleanup</xmlelement></indexterm>
  173. <indexterm><xmlatt>conref</xmlatt><indexterm>multiple targets</indexterm></indexterm>
  174. <indexterm><xmlatt>type</xmlatt></indexterm>
  175. <indexterm><xmlatt>conkeyref</xmlatt></indexterm>
  176. <indexterm><cmdname>dita</cmdname> command<indexterm>plug-in registry</indexterm></indexterm>
  177. <indexterm>integrator</indexterm>
  178. <indexterm>transtype<indexterm>string</indexterm></indexterm>
  179. </keywords>
  180. </metadata>
  181. </prolog>
  182. <refbody>
  183. <section>
  184. <p>DITA Open Toolkit 3.3.1 is a maintenance release that includes the following bug fixes.</p>
  185. <ul>
  186. <!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.3.1+sort%3Acreated-asc -->
  187. <li id="3248">When processing content references in cases with more than one possible target for the
  188. <xmlatt>conref</xmlatt> value, recent versions of DITA-OT warned about the duplicate ID, but failed to
  189. include the reference target in the message. The <msgnum>DOTX011W</msgnum> warning now restores this context
  190. to aid in troubleshooting.
  191. <xref href="https://github.com/dita-ot/dita-ot/issues/3248" format="html" scope="external">#3248</xref>
  192. </li>
  193. <li id="3249">When processing source files with tables or figures in <xmlelement>draft-comment</xmlelement> or
  194. <xmlelement>required-cleanup</xmlelement> elements, earlier versions of DITA-OT included them in lists and
  195. numbered references even when DRAFT output was not active. Hidden elements are now excluded from lists of
  196. figures and tables, and when numbering references.
  197. <xref href="https://github.com/dita-ot/dita-ot/issues/3249" format="html" scope="external">#3249</xref>
  198. </li>
  199. <li id="3251">The <xmlatt>type</xmlatt> attribute of the <parmname>args.css</parmname> and
  200. <parmname>args.cssroot</parmname> parameters has been changed to <codeph>string</codeph> to better support
  201. values that include relative paths. The <parmname>transtype</parmname> has also been corrected to
  202. <codeph>string</codeph>.
  203. <xref href="https://github.com/dita-ot/dita-ot/issues/3251" format="html" scope="external">#3251</xref>
  204. </li>
  205. <li id="3260">When copying files to a temporary file scheme that flattens the directory structure, the
  206. map-first preprocessing routine will now correctly handle indirect content references defined via
  207. <xmlatt>conkeyref</xmlatt>.
  208. <xref href="https://github.com/dita-ot/dita-ot/issues/3260" format="html" scope="external">#3260</xref>
  209. </li>
  210. <li id="3272">The integrator and topic reader modules have been modified to use an alternative method
  211. supported by the XML APIs library to prevent errors when compiling the toolkit’s JAR file.
  212. <xref href="https://github.com/dita-ot/dita-ot/issues/3272" format="html" scope="external">#3272</xref>,
  213. <xref href="https://github.com/dita-ot/dita-ot/issues/3273" format="html" scope="external">#3273</xref>
  214. </li>
  215. <li id="3278">The <cmdname>dita</cmdname> command now uses a secure connection to the plug-in registry when
  216. installing new plug-ins.
  217. <xref href="https://github.com/dita-ot/dita-ot/issues/3278" format="html" scope="external">#3278</xref>
  218. <note type="attention">To ensure data integrity during the plug-in installation process, Transport Layer
  219. Security (TLS) will soon be required to access the plug-in registry. If you are using DITA-OT 3.3, 3.2, or
  220. 3.2.1 and are unable to upgrade to 3.3.1, modify the <codeph>registry</codeph> key in the
  221. <filepath>config/configuration.properties</filepath> file to switch the URI schema to
  222. <codeph>http<b>s</b>://</codeph>, so the entry reads
  223. <codeph>https://plugins.dita-ot.org/</codeph>.</note>
  224. </li>
  225. </ul>
  226. <p>For additional information on the issues resolved since the previous release, see the
  227. <xref href="https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.3.1+is%3Aclosed" format="html"
  228. scope="external">3.3.1 milestone</xref> and
  229. <xref href="https://github.com/dita-ot/dita-ot/compare/3.3...3.3.1" format="html" scope="external">
  230. changelog</xref> on GitHub.</p>
  231. </section>
  232. </refbody>
  233. </reference>
  234. <reference id="v3.3">
  235. <title>DITA-OT <keyword keyref="release"/>
  236. <ph outputclass="small text-muted">released February 28, 2019</ph></title>
  237. <prolog>
  238. <metadata>
  239. <keywords>
  240. <indexterm><xmlelement>entry</xmlelement></indexterm>
  241. <indexterm><xmlatt>rotate</xmlatt></indexterm>
  242. <indexterm>DITA 1.3<indexterm><xmlatt>rotate</xmlatt></indexterm></indexterm>
  243. <indexterm>tables<indexterm>attribute sets</indexterm><indexterm>rotated cells</indexterm></indexterm>
  244. </keywords>
  245. </metadata>
  246. </prolog>
  247. <refbody>
  248. <section>
  249. <p>DITA Open Toolkit Release <keyword keyref="release"/> includes <ph id="summary">new attribute sets for HTML5
  250. customization, support for custom integration processing, rotated table cells in PDF output, and hazard
  251. statements in HTML output</ph>.</p>
  252. </section>
  253. <section id="features">
  254. <title>Feature Highlights</title>
  255. <p>DITA Open Toolkit Release <keyword keyref="release"/> includes the following new features:</p>
  256. <!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.3+is%3Aclosed+label%3Afeature+sort%3Acreated-asc -->
  257. <ul>
  258. <li id="1778">
  259. <p>The <xmlatt>rotate</xmlatt> attribute on table <xmlelement>entry</xmlelement> elements, which was added
  260. in the DITA 1.3 specification, is now supported in PDF output.
  261. <xref href="https://github.com/dita-ot/dita-ot/issues/1778" format="html" scope="external">#1778</xref>,
  262. <xref href="https://github.com/dita-ot/dita-ot/issues/2717" format="html" scope="external">#2717</xref>,
  263. <xref href="https://github.com/dita-ot/dita-ot/issues/3161" format="html" scope="external">#3161</xref>
  264. </p></li>
  265. <li id="3175">
  266. <p>A new <codeph>CustomIntegrator</codeph> interface provides a mechanism for custom plug-ins to extend the
  267. default integration process via service provider classes declared via a
  268. <xref href="https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html" scope="external"
  269. format="html">Java <codeph>ServiceLoader</codeph></xref>.
  270. <xref href="https://github.com/dita-ot/dita-ot/issues/3175" format="html" scope="external">#3175</xref>
  271. </p></li>
  272. <li id="3207">
  273. <p>HTML5 and XHTML output now provide generic hazard statement styling based on the ISO 3864 and ANSI Z535
  274. standards, with an SVG icon and
  275. <xref keyref="sass-lang"/> variables for the corresponding ISO and ANSI color definitions. The ANSI colors
  276. are used by default to match the PDF styling previously added in DITA-OT 3.2.
  277. <xref href="https://github.com/dita-ot/dita-ot/issues/3207" format="html" scope="external">#3207</xref>,
  278. <xref href="https://github.com/dita-ot/dita-ot/issues/3231" format="html" scope="external">#3231</xref>
  279. </p></li>
  280. <li>
  281. <p conkeyref="migrating-to-3.3/html5-att-sets"/>
  282. </li>
  283. </ul>
  284. </section>
  285. <section id="enhancements">
  286. <title>Enhancements and changes</title>
  287. <div outputclass="div-index">
  288. <indexterm><xmlelement>steps</xmlelement></indexterm>
  289. <indexterm><xmlelement>section</xmlelement></indexterm>
  290. <indexterm><xmlelement>example</xmlelement></indexterm>
  291. <indexterm><xmlelement>prereq</xmlelement></indexterm>
  292. <indexterm><xmlelement>stepsection</xmlelement></indexterm>
  293. <indexterm><xmlelement>mapref</xmlelement></indexterm>
  294. <indexterm><xmlelement>topicref</xmlelement></indexterm>
  295. <indexterm>schema<indexterm>RELAX NG</indexterm></indexterm>
  296. <indexterm><cmdname>dita</cmdname> command<indexterm>property values</indexterm></indexterm>
  297. <indexterm>XSLT<indexterm>file location</indexterm></indexterm>
  298. <indexterm>Saxon<indexterm>version</indexterm></indexterm>
  299. <indexterm><xmlatt>conref</xmlatt><indexterm>empty</indexterm></indexterm>
  300. </div>
  301. <p>DITA Open Toolkit Release <keyword keyref="release"/> includes the following enhancements and changes to
  302. existing features:</p>
  303. <!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.3+is%3Aclosed+label%3Aenhancement+sort%3Acreated-asc -->
  304. <ul>
  305. <li id="2225">The <cmdname>dita</cmdname> command now recognizes a wider range of “truthy” property values,
  306. including <codeph>true</codeph>, <codeph>yes</codeph>, <codeph>1</codeph>, and <codeph>on</codeph> and
  307. handles inconsistently cased values more gracefully.
  308. <xref href="https://github.com/dita-ot/dita-ot/issues/2225" format="html" scope="external">#2225</xref>,
  309. <xref href="https://github.com/dita-ot/dita-ot/issues/3197" format="html" scope="external">#3197</xref>
  310. </li>
  311. <li id="3157">Various XSLT files and other resources have been moved from the root of the DITA-OT installation
  312. directory to the base plug-in directory <filepath>plugins/org.dita.base</filepath>.
  313. <xref href="https://github.com/dita-ot/dita-ot/issues/3157" format="html" scope="external">#3157</xref> (If
  314. your plug-ins use the <codeph>plugin</codeph> URI scheme as recommended in the
  315. <xref keyref="plugin-coding-conventions"/>, this change should not require any modifications to custom
  316. plug-in code.) </li>
  317. <li id="3176"><ph conkeyref="migrating-to-3.3/templates"/>
  318. <xref href="https://github.com/dita-ot/dita-ot/issues/3176" format="html" scope="external">#3176</xref>
  319. </li>
  320. <li id="3177">In HTML5 output, task <xmlelement>steps</xmlelement> are now wrapped in
  321. <xmlelement>section</xmlelement> elements and DITA <xmlelement>example</xmlelement>,
  322. <xmlelement>prereq</xmlelement>, and <xmlelement>stepsection</xmlelement> elements are also generated as
  323. HTML5 <xmlelement>section</xmlelement> elements.
  324. <xref href="https://github.com/dita-ot/dita-ot/issues/3177" format="html" scope="external">#3177</xref>
  325. </li>
  326. <li id="3178">Java code has been refactored to add missing DITA classes to the list of available Java
  327. constants and re-sort the constant definitions.
  328. <xref href="https://github.com/dita-ot/dita-ot/issues/3178" format="html" scope="external">#3178</xref>
  329. </li>
  330. <li id="3182">Custom <xmlelement>pipeline</xmlelement> modules can now use SAX filters. This makes it possible
  331. to configure the module’s behavior at the Ant level and add additional processing to a module. Modules do
  332. not have to define nested filters if they prefer not to expose this extension point or do not use SAX
  333. internally.
  334. <xref href="https://github.com/dita-ot/dita-ot/issues/3182" format="html" scope="external">#3182</xref>
  335. <codeblock outputclass="language-xml">&lt;pipeline>
  336. &lt;module class="com.example.Module">
  337. &lt;filter class="com.example.XmlFilter"/>
  338. &lt;/module>
  339. &lt;/pipeline></codeblock></li>
  340. <li id="3187">New extension points have been added to contribute parameters to the debug-filter, map reader,
  341. and topic reader Java preprocessing modules.
  342. <xref format="html" href="https://github.com/dita-ot/dita-ot/issues/3187" scope="external">#3187</xref>
  343. <ul>
  344. <li>
  345. <parmname>dita.preprocess.debug-filter.param</parmname></li>
  346. <li>
  347. <parmname>dita.preprocess.map-reader.param</parmname></li>
  348. <li>
  349. <parmname>dita.preprocess.topic-reader.param</parmname></li>
  350. </ul>
  351. </li>
  352. <li id="3188">The DITA-OT fork of the
  353. <xref href="https://github.com/relaxng/jing-trang" format="html" scope="external">jing-trang</xref> project
  354. used to provide RELAX NG schema validation in DITA-OT 3.2 has been replaced with the upstream code after the
  355. patches provided by George Bina were included.
  356. <xref href="https://github.com/dita-ot/dita-ot/issues/3188" format="html" scope="external">#3188</xref>
  357. </li>
  358. <li id="3191">Several bundled dependencies have been upgraded to the latest versions.
  359. <xref href="https://github.com/dita-ot/dita-ot/issues/3191" format="html" scope="external">#3191</xref>
  360. <ul>
  361. <li>Ant 1.10.5</li>
  362. <li>Jackson 2.9.8</li>
  363. <li>Saxon-HE 9.8.0-14</li>
  364. <li>Xerces-J2 2.12.0</li>
  365. </ul>
  366. </li>
  367. <li id="3193">An additional keyscope test has been added to test interactions with submaps referenced via
  368. <xmlelement>mapref</xmlelement>.
  369. <xref href="https://github.com/dita-ot/dita-ot/issues/3193" format="html" scope="external">#3193</xref>
  370. </li>
  371. <li id="3195">The default character set for code references can now be changed by adding the
  372. <parmname>default.coderef-charset</parmname> key to the
  373. <xref keyref="configuration-properties-file">configuration.properties</xref> file. The character set values
  374. are those supported by the Java
  375. <xref format="html" href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html"
  376. scope="external">Charset</xref> class.
  377. <xref href="https://github.com/dita-ot/dita-ot/issues/3195" format="html" scope="external">#3195</xref>
  378. </li>
  379. <li id="3196">The <xmlelement>ditafileset</xmlelement> now supports nested <xmlelement>includes</xmlelement>
  380. and <xmlelement>excludes</xmlelement> elements to more easily control which files get processed (or do not
  381. get processed) by each processing step. The <codeph>copy-files</codeph> task has been been moved to the end
  382. of the preprocessing pipeline to match the order in map-first preprocessing (<codeph>preprocess2</codeph>).
  383. <xref href="https://github.com/dita-ot/dita-ot/issues/3196" format="html" scope="external">#3196</xref>
  384. <indexterm>ditafileset</indexterm>
  385. </li>
  386. <li id="3204">The
  387. <xref keyref="gradle"/> build system has been updated to the latest patch release (5.2.1).
  388. <xref href="https://github.com/dita-ot/dita-ot/issues/3204" format="html" scope="external">#3204</xref>
  389. </li>
  390. <li id="3217">When source files contain an empty <codeph>conref=""</codeph> attribute value, DITA-OT now
  391. provides a meaningful warning and then ignores this construct, which previously resulted in parser errors.
  392. <xref href="https://github.com/dita-ot/dita-ot/issues/3217" format="html" scope="external">#3217</xref>
  393. </li>
  394. <li id="3230"><ph conkeyref="migrating-to-3.3/catalog"/>
  395. <xref href="https://github.com/dita-ot/dita-ot/issues/3230" format="html" scope="external">#3230</xref>
  396. </li>
  397. </ul>
  398. </section>
  399. <section id="bugs">
  400. <title>Bugs</title>
  401. <div outputclass="div-index">
  402. <indexterm><xmlelement>topicgroup</xmlelement></indexterm>
  403. <indexterm><xmlelement>topichead</xmlelement></indexterm>
  404. <indexterm><xmlelement>dt</xmlelement></indexterm>
  405. <indexterm><xmlelement>tm</xmlelement></indexterm>
  406. <indexterm><xmlatt>conref</xmlatt><indexterm>-dita-use-conref-target</indexterm></indexterm>
  407. <indexterm><xmlatt>keyref</xmlatt></indexterm>
  408. <indexterm><xmlatt>chunk</xmlatt><indexterm>processing changes</indexterm></indexterm>
  409. <indexterm><xmlatt>id</xmlatt><indexterm><xmlelement>dt</xmlelement></indexterm></indexterm>
  410. <indexterm>DITAVAL<indexterm>duplicate conditions</indexterm><indexterm>change bars</indexterm></indexterm>
  411. <indexterm>Linux<indexterm>installation directory</indexterm></indexterm>
  412. <indexterm>macOS<indexterm>installation directory</indexterm></indexterm>
  413. <indexterm>Windows<indexterm>installation directory</indexterm></indexterm>
  414. <indexterm>RELAX NG<index-see>schema</index-see></indexterm>
  415. <indexterm>schema<indexterm>RELAX NG</indexterm></indexterm>
  416. <indexterm><cmdname>dita</cmdname> command<indexterm>= (equals sign)</indexterm></indexterm>
  417. <indexterm>nav-toc</indexterm>
  418. </div>
  419. <p>DITA Open Toolkit Release <keyword keyref="release"/> provides fixes for the following bugs:</p>
  420. <!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.3+is%3Aclosed+label%3Abug+sort%3Acreated-asc -->
  421. <ul>
  422. <li id="1439">In earlier releases, external URIs referenced via <xmlatt>keyref</xmlatt> from within
  423. relationship tables resulted in links with broken link text. This has been fixed, and metadata including
  424. link text or titles is preserved for external URIs referenced by key within a map.
  425. <xref href="https://github.com/dita-ot/dita-ot/issues/1439" format="html" scope="external">#1439</xref>,
  426. <xref href="https://github.com/dita-ot/dita-ot/pulls/3179" format="html" scope="external">#3179</xref></li>
  427. <li id="1951">Relative paths in peer or non-DITA key references were not handled correctly in earlier
  428. releases. The paths are now adjusted as needed to stay valid in any referencing location.
  429. <xref href="https://github.com/dita-ot/dita-ot/issues/1951" format="html" scope="external">#1951</xref>,
  430. <xref href="https://github.com/dita-ot/dita-ot/issues/2250" format="html" scope="external">#2250</xref>,
  431. <xref href="https://github.com/dita-ot/dita-ot/issues/2581" format="html" scope="external">#2581</xref>,
  432. <xref href="https://github.com/dita-ot/dita-ot/issues/2620" format="html" scope="external">#2620</xref>,
  433. <xref href="https://github.com/dita-ot/dita-ot/issues/3234" format="html" scope="external">#3234</xref>
  434. </li>
  435. <li id="2428">Several fixes have been added to improve support for the <xmlatt>chunk</xmlatt> attribute on
  436. topic groups (covering both <xmlelement>topicgroup</xmlelement> and any other
  437. <xmlelement>topicref</xmlelement> style container that does not reference a file).
  438. <xref href="https://github.com/dita-ot/dita-ot/issues/2428" format="html" scope="external">#2428</xref>,
  439. <xref href="https://github.com/dita-ot/dita-ot/issues/2730" format="html" scope="external">#2730</xref>,
  440. <xref href="https://github.com/dita-ot/dita-ot/issues/2843" format="html" scope="external">#2843</xref>,
  441. <xref href="https://github.com/dita-ot/dita-ot/issues/3216" format="html" scope="external">#3216</xref>
  442. <ul>
  443. <li>In earlier releases, using <codeph>chunk="to-content"</codeph> on a grouping element <i>within</i>
  444. another branch or map that specified <codeph>chunk="to-content"</codeph> would result in a
  445. NullPointerException. This error has been fixed.</li>
  446. <li>In earlier releases, using <codeph>chunk="to-content"</codeph> on a nested map would result in the
  447. same NullPointerExceptions when the map reference was inside of a chunked branch or map.</li>
  448. <li>In earlier releases, <xmlelement>topicgroup</xmlelement> elements with no title that used
  449. <codeph>chunk="to-content"</codeph> would result in a generated heading in the output file, such as
  450. "Chunk1234567". Chunked containers without a heading will no longer result in a generated heading in the
  451. output.</li>
  452. <li>In earlier releases, <xmlelement>topichead</xmlelement> elements inside of a chunked branch would
  453. result in headings that appeared out of order for PDF. This has been fixed; topic headings will appear
  454. where expected in the PDF flow.</li>
  455. </ul>
  456. </li>
  457. <li id="2523">In earlier versions, references to keys in local scopes were not processed correctly. In certain
  458. other cases, files referenced through mapref were parsed with the root scope instead of their parent scope.
  459. Keyref parsing has been improved to reliably detect and preserve key scopes to ensure that all key
  460. references are resolved in the correct scopes.
  461. <xref href="https://github.com/dita-ot/dita-ot/issues/2523" format="html" scope="external">#2523</xref>,
  462. <xref href="https://github.com/dita-ot/dita-ot/issues/3141" format="html" scope="external">#3141</xref>,
  463. <xref href="https://github.com/dita-ot/dita-ot/issues/3194" format="html" scope="external">#3194</xref>
  464. </li>
  465. <li id="2899">In some recent releases, cross references to local, non-DITA files with formats such as "pdf" or
  466. "txt" did not copy those referenced files to the output directory. When appropriate, such as when generating
  467. HTML output, these files are now copied to the output directory as they were in earlier releases.
  468. <xref href="https://github.com/dita-ot/dita-ot/issues/2899" format="html" scope="external">#2899</xref>
  469. </li>
  470. <li id="3162">On Linux and other systems where the DITA-OT installation directory and temporary directory are
  471. not on the same volume, plug-in installation would fail when DITA-OT tried to move a non-empty directory.
  472. The installation process has been refactored to ensure that plug-ins are correctly installed in these cases.
  473. <xref href="https://github.com/dita-ot/dita-ot/issues/3162" format="html" scope="external">#3162</xref>,
  474. <xref href="https://github.com/dita-ot/dita-ot/issues/3238" format="html" scope="external">#3238</xref>,
  475. <xref href="https://github.com/dita-ot/dita-ot/issues/3239" format="html" scope="external">#3239</xref>
  476. </li>
  477. <li id="3180">In earlier versions, setting an <xmlatt>id</xmlatt> attribute on a <xmlelement>dt</xmlelement>
  478. created duplicate IDs in the XSL-FO file, which caused warnings when rendering FO to PDF.
  479. <xref href="https://github.com/dita-ot/dita-ot/issues/3180" format="html" scope="external">#3180</xref>,
  480. <xref href="https://github.com/dita-ot/dita-ot/issues/3185" format="html" scope="external">#3185</xref>
  481. </li>
  482. <li id="3183">The <filepath>plugin.rnc</filepath> RELAX NG Compact Syntax schema used to validate plug-in
  483. descriptor files was inadvertently removed from the distribution package and has been restored.
  484. <xref href="https://github.com/dita-ot/dita-ot/issues/3183" format="html" scope="external">#3183</xref>,
  485. <xref href="https://github.com/dita-ot/dita-ot/issues/3220" format="html" scope="external">#3220</xref>
  486. </li>
  487. <li id="3198">The codeblock normalization process would sometimes fail to recognize certain combinations of
  488. characters at the beginning of code blocks, resulting in error messages. These adjacent text events are now
  489. merged before the indentation is adjusted.
  490. <xref href="https://github.com/dita-ot/dita-ot/issues/3198" format="html" scope="external">#3198</xref>
  491. </li>
  492. <li id="3210">In earlier releases, some indirect key references to glossary entries could result in XSLT
  493. errors when more than one possible key target existed. This is corrected by using the single desired target
  494. to resolve such links.
  495. <xref href="https://github.com/dita-ot/dita-ot/issues/3210" format="html" scope="external">#3210</xref>
  496. </li>
  497. <li id="3211">When the input file set contained resources with different URI schemes (for example local files
  498. and external files referenced via HTTPS), earlier versions of DITA-OT would fail with errors. Preprocessing
  499. routines have been corrected to ensure the the base directory is correctly calculated in these cases.
  500. <xref href="https://github.com/dita-ot/dita-ot/issues/3211" format="html" scope="external">#3211</xref>
  501. </li>
  502. <li id="3213">When generating HTML5 output with the <parmname>nav-toc</parmname> parameter set to
  503. <codeph>partial</codeph>, earlier versions would fail to insert table-of-contents navigation in topics
  504. whose names contained spaces. The path normalization process has been corrected to ensure that spaces in
  505. file and directory names are correctly URL-encoded as <codeph>%20</codeph>, and navigation is included.
  506. <xref href="https://github.com/dita-ot/dita-ot/issues/3213" format="html" scope="external">#3213</xref>,
  507. <xref href="https://github.com/dita-ot/dita-ot/issues/3229" format="html" scope="external">#3229</xref>
  508. </li>
  509. <li id="3214">In earlier releases, some revision properties were ignored on <xmlelement>tm</xmlelement>
  510. elements in PDF output. This is now corrected, so that revision flagging such as text color or background
  511. color are properly supported on trademarks.
  512. <xref href="https://github.com/dita-ot/dita-ot/issues/3214" format="html" scope="external">#3214</xref>,
  513. <xref href="https://github.com/dita-ot/dita-ot/issues/3215" format="html" scope="external">#3215</xref>
  514. </li>
  515. <li id="3219">In documentation and error messages about available transformation types, extensions of an
  516. existing transformation could result in duplicate values (such as 3 instances of "pdf"). Duplicates are now
  517. removed when listing the available transformation types.
  518. <xref href="https://github.com/dita-ot/dita-ot/issues/3219" format="html" scope="external">#3219</xref>
  519. </li>
  520. <li id="3223">In earlier releases, duplicate conditions in DITAVAL properties (such as using two DITAVAL
  521. documents for a build that each set up rules for <codeph>rev="rev3"</codeph>) would generate a warning. This
  522. message has been reduced in severity and will now appear only as an informational message with verbose
  523. logging.
  524. <xref href="https://github.com/dita-ot/dita-ot/issues/3223" format="html" scope="external">#3223</xref>
  525. </li>
  526. <li id="3224">In earlier releases, content references on elements that specified
  527. <codeph>href="-dita-use-conref-target"</codeph> would evaluate that value as a literal file name. That
  528. token (defined in the
  529. <xref
  530. href="http://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part1-base/langRef/attributes/ditauseconreftarget.html"
  531. format="html" scope="external">DITA specification</xref>) is now ignored on elements that also use
  532. <xmlatt>conref</xmlatt>.
  533. <xref href="https://github.com/dita-ot/dita-ot/issues/3224" format="html" scope="external">#3224</xref>
  534. <indexterm>-dita-use-conref-target</indexterm>
  535. </li>
  536. <li id="3235">Revised figures and tables are now marked with change bars in booklists when DITAVAL files
  537. define flagging for the corresponding revision values.
  538. <xref href="https://github.com/dita-ot/dita-ot/issues/3235" format="html" scope="external">#3235</xref>
  539. </li>
  540. <li id="3245">The command line syntax for the <cmdname>dita</cmdname>
  541. <parmname>--install</parmname> option has been updated to support the “=” equals sign.
  542. <xref href="https://github.com/dita-ot/dita-ot/issues/3245" format="html" scope="external">#3245</xref>
  543. <p>Both of the following formats are now supported:
  544. <codeblock><cmdname>dita</cmdname> <parmname>--install</parmname>=<varname>plug-in-zip</varname>
  545. <cmdname>dita</cmdname> <parmname>--install</parmname> <varname>plug-in-zip</varname></codeblock></p>
  546. </li>
  547. </ul>
  548. </section>
  549. <section id="contrib">
  550. <title>Contributors</title>
  551. <p>DITA Open Toolkit Release <keyword keyref="release"/> includes
  552. <xref keyref="contributions"/> by the following people:</p>
  553. <!-- https://github.com/tj/git-extras/blob/master/Commands.md#git-summary – `git summary 3.2..` -->
  554. <draft-comment author="Roger">NOTE: This lists contributions to the core toolkit, not docs.</draft-comment>
  555. <ol>
  556. <li>Jarno Elovirta</li>
  557. <li>Robert D Anderson</li>
  558. <li>Roger Sheen</li>
  559. <li>Simen Tinderholt</li>
  560. <li>Eliot Kimber</li>
  561. <li>Eric Sirois</li>
  562. </ol>
  563. <p>For the complete list of changes since the previous release, see the
  564. <xref href="https://github.com/dita-ot/dita-ot/compare/3.2...3.3" format="html" scope="external">
  565. changelog</xref> on GitHub.</p>
  566. </section>
  567. <section id="docs">
  568. <title>Documentation updates</title>
  569. <p>The documentation for DITA Open Toolkit Release <keyword keyref="release"/> provides corrections and
  570. improvements to existing topics, along with new information in the following topics:</p>
  571. <ul>
  572. <li>
  573. <xref keyref="prerequisite-software"/></li>
  574. <li>
  575. <xref keyref="dita-command-arguments"/></li>
  576. <li>
  577. <xref keyref="pdf2-creating-change-bars"/></li>
  578. <li>
  579. <xref keyref="plugins-registry"/></li>
  580. <li>
  581. <xref keyref="plugin-javalib"/></li>
  582. <li>
  583. <xref keyref="plugin-implement-saxon-customizations"/></li>
  584. <li>
  585. <xref keyref="plugin-extension-points-pre-processing"/></li>
  586. <li>
  587. <xref keyref="migrating-to-3.3"/></li>
  588. </ul>
  589. <p>For additional information on documentation issues resolved in DITA Open Toolkit Release <keyword
  590. keyref="release"/>, see the
  591. <xref href="https://github.com/dita-ot/docs/issues?q=milestone%3A3.3+is%3Aclosed" format="html"
  592. scope="external">
  593. <keyword keyref="release"/> milestone</xref> in the documentation repository.</p>
  594. <p>DITA Open Toolkit Release <keyword keyref="release"/> includes
  595. <xref keyref="docs-contributions"/> by the following people:</p>
  596. <draft-comment author="Roger">NOTE: This lists contributions to docs, not to the core toolkit.</draft-comment>
  597. <ol>
  598. <li>Roger Sheen</li>
  599. <li>Eliot Kimber</li>
  600. <li>Robert D Anderson</li>
  601. <li>Jarno Elovirta</li>
  602. <li>Quick van Rijt</li>
  603. </ol>
  604. <p>For the complete list of documentation changes since the previous release, see the
  605. <xref href="https://github.com/dita-ot/docs/compare/3.2...3.3" format="html" scope="external">
  606. changelog</xref>.</p>
  607. </section>
  608. </refbody>
  609. </reference>
  610. </reference>