rel2.4.dita 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594
  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="2.4">
  5. <title>DITA Open Toolkit 2.4.6 Release Notes</title>
  6. <abstract>
  7. <shortdesc>DITA Open Toolkit 2.4.6 is a maintenance release that fixes issues reported in DITA-OT 2.4, which
  8. includes <ph conref="#highlights/summary"/>.</shortdesc>
  9. <p>Issue numbers correspond to the tracking number in the <ph>
  10. <xref keyref="dita-ot-issues">GitHub issues tracker</xref></ph>.</p>
  11. </abstract>
  12. <reference id="v246">
  13. <title>Maintenance Release 2.4.6</title>
  14. <refbody>
  15. <section>
  16. <p>DITA Open Toolkit Release 2.4.6 includes the following bug fixes.</p>
  17. <ul>
  18. <li id="2212">
  19. <p>Earlier versions of DITA-OT would fail with XSLT errors when processing invalid table markup.</p>
  20. <p>The toolkit is now more lenient when handling column settings that do not match the table contents,
  21. including:
  22. <ul>
  23. <li><xmlelement>table</xmlelement> elements that contain incorrect <xmlelement>colspec</xmlelement>
  24. entries</li>
  25. <li><xmlelement>tgroup</xmlelement> elements with incorrect <xmlatt>cols</xmlatt> attribute values</li>
  26. <li><xmlelement>simpletable</xmlelement> elements with invalid <xmlatt>relcolwidth</xmlatt>
  27. attributes</li>
  28. <li><xmlelement>sthead</xmlelement> header rows with the wrong number of cells</li>
  29. </ul></p>
  30. <p>Processing will now continue in these cases, though output may not be generated entirely as expected.
  31. <xref href="https://github.com/dita-ot/dita-ot/issues/2212" scope="external" format="html">#2212</xref>,
  32. <xref href="https://github.com/dita-ot/dita-ot/pull/2651" scope="external" format="html">#2651</xref>
  33. </p>
  34. </li>
  35. <li id="2549">DITA-OT 2.4 failed to process maps with multiple references to a single topic file that contains
  36. key references. Processing has been revised to properly handle duplicate topics within key scopes.
  37. <xref href="https://github.com/dita-ot/dita-ot/issues/2549" scope="external" format="html">#2549</xref>
  38. </li>
  39. <li id="2650">Several XSL stylesheets used incorrect <xmlatt>extension-element-prefixes</xmlatt> attributes,
  40. which have been replaced with <xmlatt>exclude-result-prefixes</xmlatt> to ensure no unnecessary namespace
  41. nodes are copied to the result tree.
  42. <xref href="https://github.com/dita-ot/dita-ot/issues/2650" scope="external" format="html">#2650</xref>
  43. </li>
  44. <li>
  45. <p>The documentation includes minor
  46. <xref href="https://github.com/dita-ot/docs/compare/2.4.5...2.4.6" scope="external" format="html">
  47. changes</xref> with
  48. <xref href="https://github.com/dita-ot/docs/milestone/24?closed=1" scope="external" format="html"
  49. >corrections and improvements</xref> to existing topics.</p>
  50. </li>
  51. </ul>
  52. <p>For the complete list of changes since the previous release, see the
  53. <xref href="https://github.com/dita-ot/dita-ot/compare/2.4.5...2.4.6" scope="external" format="html">
  54. changelog</xref> on GitHub.</p>
  55. </section>
  56. </refbody>
  57. </reference>
  58. <reference id="v245">
  59. <title>Maintenance Release 2.4.5</title>
  60. <refbody>
  61. <section>
  62. <p>DITA Open Toolkit Release 2.4.5 includes the following bug fixes.</p>
  63. <ul>
  64. <li id="2559">DITA-OT 2.4 reported errors when filtering HTML5 output with a DITAVAL file and failed to
  65. preserve attributes that were set to <option>passthrough</option> via the <xmlatt>action</xmlatt> attribute.
  66. The order in which properties are initialized has been corrected and profiling conditions are now propagated
  67. to corresponding <xmlatt>data-</xmlatt> attributes in HTML5 output to support filtering.
  68. <xref href="https://github.com/dita-ot/dita-ot/issues/2559" scope="external" format="html">#2559</xref>,
  69. <xref href="https://github.com/dita-ot/dita-ot/issues/2598" scope="external" format="html">#2598</xref>, <!--
  70. <xref href="https://github.com/dita-ot/dita-ot/pull/2611" scope="external" format="html">#2611</xref>-->
  71. <xref href="https://github.com/dita-ot/dita-ot/issues/2627" scope="external" format="html">#2627</xref>
  72. </li>
  73. <li id="2567">Remaining XHTML property references in the HTML5 transformation have been corrected to point to
  74. their HTML5 equivalents.
  75. <xref href="https://github.com/dita-ot/dita-ot/issues/2567" scope="external" format="html">#2567</xref>
  76. </li>
  77. <li id="2570">In DITA-OT 2.4, the HTML5 transformation failed to process topics with tables when the
  78. <parmname>args.html5.classattr</parmname> parameter was set to <option>no</option>. Processing has been
  79. updated to ensure that tables are handled correctly when the DITA class ancestry is not passed to output.
  80. <xref href="https://github.com/dita-ot/dita-ot/issues/2570" scope="external" format="html">#2570</xref>
  81. </li>
  82. <li id="2622">The HTML5 transformation has been updated to preserve the <xmlatt>class</xmlatt> attribute on
  83. ordered lists when <xmlelement>steps</xmlelement> contain a <xmlelement>stepsection</xmlelement> element.
  84. <xref href="https://github.com/dita-ot/dita-ot/issues/2622" scope="external" format="html">#2622</xref>,
  85. <xref href="https://github.com/dita-ot/dita-ot/issues/2631" scope="external" format="html">#2631</xref>
  86. </li>
  87. <li id="2623">Earlier versions of DITA-OT ignored any <xmlelement>navref</xmlelement> and
  88. <xmlelement>anchor</xmlelement> elements that were declared as direct children of referenced submaps. The
  89. map reference implementation has been updated to preserve these elements as-is when resolving nested maps.
  90. <xref href="https://github.com/dita-ot/dita-ot/issues/2623" scope="external" format="html">#2623</xref>
  91. </li>
  92. <li id="2628">HTML5 processing has been corrected to respect the <parmname>args.outext</parmname> setting.
  93. <xref href="https://github.com/dita-ot/dita-ot/issues/2628" scope="external" format="html">#2628</xref>
  94. </li>
  95. <li id="2629">The Finnish translations for attention and warning notes have been corrected to “Huomio” and
  96. “Varoitus”, respectively.
  97. <xref href="https://github.com/dita-ot/dita-ot/issues/2629" scope="external" format="html">#2629</xref>
  98. </li>
  99. <li id="2636">DITA-OT 2.4.4 introduced a regression that prevented table cells from spanning multiple columns.
  100. Table processing has been corrected to produce the proper table structure.
  101. <xref href="https://github.com/dita-ot/dita-ot/issues/2636" scope="external" format="html">#2636</xref>
  102. </li>
  103. <li>
  104. <p>The documentation includes minor
  105. <xref href="https://github.com/dita-ot/docs/compare/2.4.4...2.4.5" scope="external" format="html">
  106. changes</xref> with
  107. <xref href="https://github.com/dita-ot/docs/milestone/23?closed=1" scope="external" format="html"
  108. >corrections and improvements</xref> to existing topics.</p>
  109. </li>
  110. </ul>
  111. <p>For the complete list of changes since the previous release, see the
  112. <xref href="https://github.com/dita-ot/dita-ot/compare/2.4.4...2.4.5" scope="external" format="html">
  113. changelog</xref> on GitHub.</p>
  114. </section>
  115. </refbody>
  116. </reference>
  117. <reference id="v244">
  118. <title>Maintenance Release 2.4.4</title>
  119. <refbody>
  120. <section>
  121. <p>DITA Open Toolkit Release 2.4.4 includes the following bug fixes.</p>
  122. <ul>
  123. <li id="2564">DITA-OT 2.4 threw errors if non-XML DITA topics (such as Markdown files) were referenced in DITA
  124. maps. The source format information is now retained to ensure these topics are processed correctly when the
  125. <xref href="https://github.com/jelovirt/dita-ot-markdown" format="html" scope="external">DITA-OT Markdown
  126. plug-in</xref> is installed.
  127. <xref href="https://github.com/dita-ot/dita-ot/issues/2564" scope="external" format="html">#2564</xref>
  128. </li>
  129. <li id="2573">In HTML5 transformations, DITA-OT 2.4 threw XSLT warnings if a topic included copyright metadata
  130. in the prolog. The redundant templates have been removed to ensure that copyright metadata is correctly
  131. processed.
  132. <xref href="https://github.com/dita-ot/dita-ot/issues/2573" scope="external" format="html">#2573</xref>,
  133. <xref href="https://github.com/dita-ot/dita-ot/pull/2574" scope="external" format="html">#2574</xref>,
  134. <xref href="https://github.com/dita-ot/dita-ot/pull/2610" scope="external" format="html">#2610</xref>
  135. </li>
  136. <li id="2577">In earlier versions of DITA-OT, the HTML5 transformation generated an empty
  137. <xmlelement>nav</xmlelement> element for table-of-contents navigation when the
  138. <parmname>nav-toc</parmname> parameter was set to <option>partial</option> and the <xmlatt>chunk</xmlatt>
  139. attribute for a topic reference was set <option>to-content</option>. Processing has been updated to produce
  140. valid navigation links with to-content chunks.
  141. <xref href="https://github.com/dita-ot/dita-ot/issues/2577" scope="external" format="html">#2577</xref>
  142. <xref href="https://github.com/dita-ot/dita-ot/pull/2578" scope="external" format="html">#2578</xref>
  143. </li>
  144. <li id="2584">If an index term was defined in a map, a redundant empty citation was created in the index when
  145. generating PDF output with Apache FOP. Index processing has been revised to ensure that links to index terms
  146. defined in maps work properly for FOP.
  147. <xref href="https://github.com/dita-ot/dita-ot/issues/2584" scope="external" format="html">#2584</xref>,
  148. <xref href="https://github.com/dita-ot/dita-ot/pull/2589" scope="external" format="html">#2589</xref>
  149. </li>
  150. <li id="2586">When reading the <filepath>local.properties</filepath> file, the Ant <codeph>basedir</codeph>
  151. property is set to the root directory of the DITA-OT installation. This change ensures that the
  152. <filepath>local.properties</filepath> file in the installation directory can be read consistently, even in
  153. cases when custom build scripts override the <codeph>basedir</codeph> property beforehand.
  154. <xref href="https://github.com/dita-ot/dita-ot/issues/2586" scope="external" format="html">#2586</xref>
  155. </li>
  156. <li id="2602">When generating PDF output, earlier versions of DITA-OT applied the
  157. <xmlatt>keep-with-next.within-line</xmlatt> attribute to list item labels, which is not valid on
  158. <xmlelement>fo:list-item-label</xmlelement> formatting objects. The list label attribute sets have been
  159. revised to generate valid XSL:FO output.
  160. <xref href="https://github.com/dita-ot/dita-ot/issues/2602" scope="external" format="html">#2602</xref>
  161. </li>
  162. <li id="2603">Parameter processing in variable resolution has been adjusted to ensure that nested
  163. <xmlelement>param</xmlelement> elements are taken into account when parameters are passed as a document
  164. node.
  165. <xref href="https://github.com/dita-ot/dita-ot/issues/2603" scope="external" format="html">#2603</xref>
  166. </li>
  167. <li id="2605">The command-line help and documentation for the <cmdname>dita</cmdname> command mistakenly
  168. included the equals sign in the descriptions of the <option>--install</option> and
  169. <option>--uninstall</option> options. The correct syntax separates these options from their values with a
  170. space instead. To install a single plug-in from a local ZIP file, for example, use
  171. <cmdname>dita</cmdname> <parmname>--install</parmname> <varname>filename</varname>.
  172. <xref href="https://github.com/dita-ot/dita-ot/issues/2605" scope="external" format="html">#2605</xref>
  173. </li>
  174. <li>
  175. <p>The documentation includes minor
  176. <xref href="https://github.com/dita-ot/docs/compare/2.4.3...2.4.4" scope="external" format="html">
  177. changes</xref> with
  178. <xref href="https://github.com/dita-ot/docs/milestone/22?closed=1" scope="external" format="html"
  179. >corrections and improvements</xref> to existing topics.</p>
  180. </li>
  181. </ul>
  182. <p>For the complete list of changes since the previous release, see the
  183. <xref href="https://github.com/dita-ot/dita-ot/compare/2.4.3...2.4.4" scope="external" format="html">
  184. changelog</xref> on GitHub.</p>
  185. </section>
  186. </refbody>
  187. </reference>
  188. <reference id="v243">
  189. <title>Maintenance Release 2.4.3</title>
  190. <refbody>
  191. <section>
  192. <p>DITA Open Toolkit Release 2.4.3 includes the following bug fixes.</p>
  193. <ul>
  194. <li id="1525">In PDF output generated with earlier versions of DITA-OT and RenderX XEP, the
  195. <xmlelement>indexterm</xmlelement> hierarchy for multilevel entries in the PDF index was not properly
  196. indented. Index term indentation has been corrected to properly reflect the entry hierarchy as authored in
  197. DITA source files.
  198. <xref href="https://github.com/dita-ot/dita-ot/issues/1525" scope="external" format="html">#1525</xref>
  199. </li>
  200. <li id="2038">In earlier versions of DITA-OT, specifying a relative path for the temporary directory on the
  201. command line would cause PDF processing to fail. DITA-OT now checks whether the
  202. <parmname>dita.temp.dir</parmname> property is set to an absolute path and responds with an error message
  203. otherwise.
  204. <xref href="https://github.com/dita-ot/dita-ot/issues/2038" scope="external" format="html">#2038</xref>
  205. </li>
  206. <li id="2522">In certain cases, DITA-OT 2.4 generated broken links in PDF output for related topics and
  207. reported “unresolved internal destination” warnings in the console when processing topic references with the
  208. <xmlatt>collection-type</xmlatt> attribute set to <option>family</option>. Link rewrite processing has
  209. been corrected to ensure that links are generated properly.
  210. <xref href="https://github.com/dita-ot/dita-ot/issues/2522" scope="external" format="html">#2522</xref>
  211. </li>
  212. <li id="2555">Default settings for several parameters have been removed from the
  213. <filepath>configuration.properties</filepath> file.
  214. <xref href="https://github.com/dita-ot/dita-ot/issues/2555" scope="external" format="html">#2555</xref>
  215. <p>Values for these parameters can be passed as usual to the <cmdname>dita</cmdname> command or included in
  216. build scripts:
  217. <ul>
  218. <li><parmname>default.language</parmname></li>
  219. <li><parmname>generate-debug-attributes</parmname></li>
  220. <li><parmname>processing-mode</parmname></li>
  221. </ul></p>
  222. </li>
  223. <li id="2563">In previous versions of DITA-OT, the HTML5 transformation generated
  224. <xmlelement>simpletable</xmlelement> output with column widths specified in <xmlelement>col</xmlelement>
  225. elements as direct children of the <xmlelement>table</xmlelement> element. A
  226. <xmlelement>colgroup</xmlelement> wrapper element has been added for compatibility with the HTML5
  227. standard.
  228. <xref href="https://github.com/dita-ot/dita-ot/issues/2563" scope="external" format="html">#2563</xref>
  229. </li>
  230. </ul>
  231. <p>For the complete list of changes since the previous release, see the
  232. <xref href="https://github.com/dita-ot/dita-ot/compare/2.4.2...2.4.3" scope="external" format="html">
  233. changelog</xref> on GitHub.</p>
  234. </section>
  235. <section>
  236. <title>Documentation updates</title>
  237. <p>The DITA-OT 2.4.3 documentation includes corrections and improvements to existing topics, along with new
  238. content on
  239. <xref keyref="configuration-properties"/>.</p>
  240. </section>
  241. </refbody>
  242. </reference>
  243. <reference id="v242">
  244. <title>Maintenance Release 2.4.2</title>
  245. <refbody>
  246. <section>
  247. <p>DITA Open Toolkit Release 2.4.2 includes the following bug fixes.</p>
  248. <ul>
  249. <li id="1885">DITA-OT 2.0 threw a null pointer exception when producing Eclipse Help output from a bookmap
  250. with a <xmlelement>glossarylist</xmlelement> that referenced a composite <xmlelement>dita</xmlelement>
  251. topic. Processing has been updated to properly handle root <xmlelement>dita</xmlelement> elements or any
  252. other elements without <xmlatt>class</xmlatt> attributes.
  253. <xref href="https://github.com/dita-ot/dita-ot/issues/1885" scope="external" format="html">#1885</xref>
  254. </li>
  255. <li id="2542">HTML5 output generated with DITA-OT 2.4.1 included spurious namespace attributes for
  256. <xmlelement>taskbody</xmlelement> and <xmlelement>simpletable</xmlelement> elements. The extra result
  257. prefixes (<xmlnsname>ditamsg</xmlnsname>, <xmlnsname>dita2html</xmlnsname> and
  258. <xmlnsname>related-links</xmlnsname>) have been excluded to ensure they no longer appear in output files.
  259. <xref href="https://github.com/dita-ot/dita-ot/issues/2542" scope="external" format="html">#2542</xref>
  260. </li>
  261. <li id="2547">Earlier versions of DITA-OT failed to ignore empty props specialization attributes during the
  262. filtering process. Processing has been updated to treat any empty attributes specialized from
  263. <xmlatt>props</xmlatt> like empty default profiling attributes such as
  264. <xmlatt>audience</xmlatt><codeph>=""</codeph>, which are ignored.
  265. <xref href="https://github.com/dita-ot/dita-ot/issues/2547" scope="external" format="html">#2547</xref>
  266. </li>
  267. <li id="2548">The <codeph>xml-apis-ext</codeph> library that FOP depends on to render SVG images was missing
  268. in DITA-OT 2.4. The distribution package has been updated to provide support for SVG images in PDF output.
  269. <xref href="https://github.com/dita-ot/dita-ot/issues/2548" scope="external" format="html">#2548</xref>
  270. </li>
  271. <li id="2551">If an input map contained topic references with duplicate <xmlatt>copy-to</xmlatt> attribute
  272. values, earlier versions of DITA-OT failed to generate additional output topics. Processing now applies the
  273. <parmname>force-unique</parmname> parameter to ensure that unique output files are created for each
  274. instance of a resource when a map contains multiple references to a single topic.
  275. <xref href="https://github.com/dita-ot/dita-ot/issues/2551" scope="external" format="html">#2551</xref>
  276. </li>
  277. <li id="2554">Support for the <parmname>args.breadcrumbs</parmname> parameter provided in earlier versions of
  278. DITA-OT was never fully implemented and has been removed. HTML customizations that rely on the XSLT
  279. <parmname>BREADCRUMBS</parmname> parameter will need to re-implement this functionality in custom plug-in
  280. code.
  281. <xref href="https://github.com/dita-ot/dita-ot/issues/2554" scope="external" format="html">#2554</xref>
  282. </li>
  283. </ul>
  284. <p>For the complete list of changes since the previous release, see the
  285. <xref href="https://github.com/dita-ot/dita-ot/compare/2.4.1...2.4.2" scope="external" format="html">
  286. changelog</xref> on GitHub.</p>
  287. </section>
  288. </refbody>
  289. </reference>
  290. <reference id="v241">
  291. <title>Maintenance Release 2.4.1</title>
  292. <refbody>
  293. <section>
  294. <p>DITA Open Toolkit Release 2.4.1 includes the following bug fixes.</p>
  295. <ul>
  296. <li id="2520">In DITA-OT 2.3 and 2.4, setting the <parmname>force-unique</parmname> parameter to
  297. <option>true</option> had no effect. Processing has been corrected to properly generate the copy-to
  298. attributes that ensure unique file names for each instance of a resource when a map contains multiple
  299. references to a single topic.
  300. <xref href="https://github.com/dita-ot/dita-ot/issues/2520" scope="external" format="html">#2520</xref>
  301. </li>
  302. <li id="2524">HTML5: In DITA-OT 2.4, the text content of table cells was partially propagated to the CSS
  303. <xmlatt>class</xmlatt> attribute. Table processing has been updated to remove the legacy XHTML CSS class
  304. mode and ensure that <xmlatt>class</xmlatt> attribute values are generated correctly.
  305. <xref href="https://github.com/dita-ot/dita-ot/issues/2524" scope="external" format="html">#2524</xref>
  306. </li>
  307. <li id="2526">Saxon 9.7.0.11 reported an error when producing output from DITA content: <msgph>The context
  308. item for axis step ./@class is absent</msgph>. This was resolved by modifying the
  309. <codeph>$localclass</codeph> variable in the <codeph>output-message</codeph> template to use the
  310. <codeph>$ctx</codeph> context variable as a parent.
  311. <xref href="https://github.com/dita-ot/dita-ot/issues/2526" scope="external" format="html">#2526</xref>,
  312. <xref href="https://github.com/dita-ot/dita-ot/pull/2535" scope="external" format="html">#2535</xref>
  313. </li>
  314. <li id="2529">Earlier versions of DITA-OT did not correctly override the default <xmlatt>scope</xmlatt> and
  315. <xmlatt>format</xmlatt> attribute values for topic references with values from the key definition. Keyref
  316. processing has been updated to properly handle scope and format definition for non-local non-DITA targets.
  317. <xref href="https://github.com/dita-ot/dita-ot/issues/2529" scope="external" format="html">#2529</xref>
  318. </li>
  319. <li id="2537">In earlier versions of DITA-OT, the <codeph>dita.xsl.html5.cover</codeph> extension point did
  320. not respond to overrides declared in custom plug-ins. The extension point has now been moved to the template
  321. file to ensure that it can be overridden as intended.
  322. <xref href="https://github.com/dita-ot/dita-ot/issues/2537" scope="external" format="html">#2537</xref>
  323. </li>
  324. <li id="2539">In cases where a single topic is used in multiple key scopes (and copies of the topic are
  325. created), earlier versions of DITA-OT used the same target for key references to both key scopes. Key
  326. targets are now rewritten to point to the new resource to ensure that duplicate link targets in key scopes
  327. are correctly resolved.
  328. <xref href="https://github.com/dita-ot/dita-ot/issues/2539" scope="external" format="html">#2539</xref>
  329. </li>
  330. </ul>
  331. <p>For the complete list of changes since the previous release, see the
  332. <xref href="https://github.com/dita-ot/dita-ot/compare/2.4...2.4.1" scope="external" format="html">
  333. changelog</xref> on GitHub.</p>
  334. </section>
  335. <section>
  336. <title>Documentation updates</title>
  337. <p>The DITA-OT 2.4.1 documentation includes corrections and improvements to existing topics, along with new
  338. content.</p>
  339. <ul>
  340. <li>
  341. <xref keyref="html-customization"/> provides examples that illustrate various approaches for customizing
  342. HTML-based output, including:
  343. <ul>
  344. <li>
  345. <xref keyref="html-customization-navigation"/></li>
  346. <li>
  347. <xref keyref="html-customization-plugin-bundle-css"/></li>
  348. </ul>
  349. </li>
  350. <li>
  351. <xref keyref="languages"/> provides a common overview of languages supported for PDF and HTML-based output
  352. formats.</li>
  353. <li>
  354. <xref keyref="third-party-software"/> lists bundled software components with version and license information
  355. for each library.</li>
  356. </ul>
  357. </section>
  358. </refbody>
  359. </reference>
  360. <reference id="requirements">
  361. <title>Requirements</title>
  362. <refbody>
  363. <section>
  364. <draft-comment author="Roger">Add info on new minimum Java version or any other requirements that have changed
  365. since previous release.</draft-comment>
  366. <p>DITA Open Toolkit Release 2.4 requires the Java Runtime Environment (JRE) version <keyword
  367. keyref="tool.java.version"/> or later.</p>
  368. </section>
  369. </refbody>
  370. </reference>
  371. <reference id="highlights">
  372. <title>Release Highlights</title>
  373. <shortdesc>DITA-OT 2.4 includes <ph id="summary">Apache FOP <ph keyref="tool.fop.version"/>, a new long-form syntax
  374. for <cmdname>dita</cmdname> command options, and additional code referencing extensions</ph>.</shortdesc>
  375. <refbody>
  376. <section id="1958">
  377. <title>Apache FOP <ph keyref="tool.fop.version"/></title>
  378. <p>DITA-OT 2.4 bundles the latest version of <tm trademark="Apache" tmtype="tm">Apache</tm> FOP (Formatting
  379. Objects Processor).
  380. <xref href="https://github.com/dita-ot/dita-ot/issues/1958" scope="external" format="html">#1958</xref>,
  381. <xref href="https://github.com/dita-ot/dita-ot/pull/2399" scope="external" format="html">#2399</xref></p>
  382. <p>FOP <ph keyref="tool.fop.version"/> builds on the OpenType CFF font support added in FOP 2.0, with additional
  383. font support and enhancements for PDF accessibility, including PDF/UA (PDF/Universal Accessibility) and
  384. PDF/A-3.</p>
  385. <p>For details on recent changes in FOP, see the <cite>Release Notes</cite> for versions
  386. <xref keyref="fop-20-rn">2.0</xref> and
  387. <xref keyref="fop-20-rn">2.1</xref>.</p>
  388. <note>
  389. <p>To conserve memory, accessible PDF output is disabled by default in FOP 2.1. To generate accessible PDFs
  390. from DITA-OT, set the <parmname>args.fo.userconfig</parmname> parameter and include the
  391. <option>&lt;accessibility>true&lt;/accessibility></option> option in your custom FOP configuration
  392. file.</p>
  393. <p>For more information, see
  394. <xref keyref="fop-accessibility"/>.</p>
  395. </note>
  396. </section>
  397. <section id="2422">
  398. <title>New long-form syntax for <cmdname>dita</cmdname> command options</title>
  399. <p>All <cmdname>dita</cmdname> command options can now be specified with a GNU-style option keyword preceded by
  400. two hyphens. For example:</p>
  401. <p>
  402. <codeblock><cmdname>dita</cmdname> <parmname>--input</parmname>=<filepath>userguide.ditamap</filepath> <parmname>--format</parmname>=<option>html5</option></codeblock>
  403. </p>
  404. <p>DITA-OT parameters can now be passed to the <cmdname>dita</cmdname> command with this same syntax:
  405. <parmname>--parameter</parmname>=<varname>value</varname>.</p>
  406. <p>When set with this method, properties are validated against the toolkit’s plug-in configuration. An error
  407. message appears if a property is not recognized or if an enumerated property value is invalid.
  408. <xref href="https://github.com/dita-ot/dita-ot/issues/2422" scope="external" format="html">#2422</xref>,
  409. <xref href="https://github.com/dita-ot/dita-ot/pull/2492" scope="external" format="html">#2492</xref>
  410. <note type="attention">Unix-style single-letter options (preceded by a single hyphen) are also available in
  411. some cases for backwards compatibility. The X-Toolkit–style single-hyphen keyword variants supported by
  412. previous releases (such as <parmname>-input</parmname>) have been deprecated and may be removed in an
  413. upcoming release.</note></p>
  414. </section>
  415. <section id="2469">
  416. <title>Extended code reference processing</title>
  417. <p>DITA-OT 2.4 provides additional support for extracting a range of lines from code references based on the
  418. content of the target file. Instead of specifying line numbers, you can now also select lines to include in
  419. the code reference by specifying keywords (or “<term>tokens</term>”) that appear in the referenced file.
  420. <xref href="https://github.com/dita-ot/dita-ot/pull/2469" scope="external" format="html">#2469</xref>
  421. </p>
  422. <div conref="../reference/extended-functionality.dita#code-reference/coderef-by-content"/>
  423. <note conref="../reference/extended-functionality.dita#code-reference/coderef-by-content-tip"/>
  424. <p>For more information, see
  425. <xref href="../reference/extended-functionality.dita#code-reference"/>.</p>
  426. </section>
  427. <section id="2405">
  428. <title>Standalone <option>HTML5</option> plug-in</title>
  429. <div conref="../reference/migrating-to-2.4.dita#migrating-to-2.4/24-html5-split"/>
  430. <p>
  431. <xref href="https://github.com/dita-ot/dita-ot/pull/2405" scope="external" format="html">#2405</xref>,
  432. <xref href="https://github.com/dita-ot/dita-ot/issues/2511" scope="external" format="html">#2511</xref>
  433. </p>
  434. </section>
  435. <section id="1542" conref="../reference/migrating-to-2.4.dita#migrating-to-2.4/24-legacy-plugin-removal"/>
  436. <section>
  437. <p>
  438. <xref href="https://github.com/dita-ot/dita-ot/issues/1542" scope="external" format="html">#1542</xref></p>
  439. </section>
  440. </refbody>
  441. </reference>
  442. <reference id="issues">
  443. <title>Resolved issues</title>
  444. <shortdesc>In addition to the highlights mentioned above, DITA Open Toolkit Release 2.4 includes the following
  445. changes.</shortdesc>
  446. <refbody>
  447. <!--
  448. <section id="features">
  449. <title>Features</title>
  450. <p>DITA Open Toolkit Release 2.4 includes the following new features:</p>
  451. <ul>
  452. <li/>
  453. </ul>
  454. </section>
  455. -->
  456. <section id="enhancements">
  457. <title>Enhancements and changes</title>
  458. <p>DITA Open Toolkit Release 2.4 includes the following enhancements and changes to existing features:</p>
  459. <ul>
  460. <li id="2026">Move to Java 8
  461. <xref href="https://github.com/dita-ot/dita-ot/issues/2026" scope="external" format="html">#2026</xref>
  462. </li>
  463. <li id="1245">TM output
  464. <xref href="https://github.com/dita-ot/dita-ot/issues/1245" scope="external" format="html">#1245</xref>,
  465. <xref href="https://github.com/dita-ot/dita-ot/pull/2404" scope="external" format="html">#2404</xref>
  466. </li>
  467. <li id="2512">Bug in "dita-utilities.xsl" getVariable when called from string context
  468. <xref href="https://github.com/dita-ot/dita-ot/issues/2512" scope="external" format="html">#2512</xref>,
  469. <xref href="https://github.com/dita-ot/dita-ot/pull/2513" scope="external" format="html">#2513</xref>
  470. </li>
  471. <li id="2503">HTML5 generates duplicate class attributes
  472. <xref href="https://github.com/dita-ot/dita-ot/issues/2503" scope="external" format="html">#2503</xref>
  473. </li>
  474. <li id="2502">Use Sass <codeph>// comment</codeph> syntax for partials copyrights
  475. <xref href="https://github.com/dita-ot/dita-ot/issues/2502" scope="external" format="html">#2502</xref>
  476. </li>
  477. <li id="2499">Change HTML5 to use libsass instead of Compass
  478. <xref href="https://github.com/dita-ot/dita-ot/issues/2499" scope="external" format="html">#2499</xref>
  479. </li>
  480. <li id="2471">Add sign-off requirement to contribution
  481. <xref href="https://github.com/dita-ot/dita-ot/issues/2471" scope="external" format="html">#2471</xref>
  482. </li>
  483. <li id="2467">Add copyright based on Git history
  484. <xref href="https://github.com/dita-ot/dita-ot/issues/2467" scope="external" format="html">#2467</xref>
  485. </li>
  486. <li id="2465">Run dita command with only properties file
  487. <xref href="https://github.com/dita-ot/dita-ot/issues/2465" scope="external" format="html">#2465</xref>,
  488. <xref href="https://github.com/dita-ot/dita-ot/issues/2468" scope="external" format="html">#2468</xref>
  489. </li>
  490. <li id="2462">Map temporary files to source/result files using job configuration
  491. <xref href="https://github.com/dita-ot/dita-ot/issues/2462" scope="external" format="html">#2462</xref>
  492. </li>
  493. <li id="2453">Use job mapper when transforming topics to final output
  494. <xref href="https://github.com/dita-ot/dita-ot/issues/2453" scope="external" format="html">#2453</xref>
  495. </li>
  496. <li id="2437">Move chunk target detection to chunk module
  497. <xref href="https://github.com/dita-ot/dita-ot/issues/2437" scope="external" format="html">#2437</xref>
  498. </li>
  499. <!--
  500. <li id="2419">Drop empty fo:inline elements
  501. <xref href="https://github.com/dita-ot/dita-ot/issues/2419" scope="external" format="html">#2419</xref>
  502. </li>
  503. -->
  504. <li id="2412">Replace named template with mode for easy override of static content
  505. <xref href="https://github.com/dita-ot/dita-ot/issues/2412" scope="external" format="html">#2412</xref>
  506. </li>
  507. <li id="2151">Remove lax integration process
  508. <xref href="https://github.com/dita-ot/dita-ot/issues/2151" scope="external" format="html">#2151</xref>
  509. </li>
  510. </ul>
  511. </section>
  512. <section id="bugs">
  513. <title>Bugs</title>
  514. <p>DITA Open Toolkit Release 2.4 provides fixes for the following bugs:</p>
  515. <ul>
  516. <li id="2394">Fix error when <xmlelement>linktext</xmlelement> contains <xmlelement>tm</xmlelement> #2303
  517. <xref href="https://github.com/dita-ot/dita-ot/pull/2394" scope="external" format="html">#2394</xref>
  518. </li>
  519. <li id="2347">Build fails when <xmlelement>navtitle</xmlelement> in <xmlelement>relcell</xmlelement> has child
  520. elements
  521. <xref href="https://github.com/dita-ot/dita-ot/issues/2347" scope="external" format="html">#2347</xref>,
  522. <xref href="https://github.com/dita-ot/dita-ot/pull/2390" scope="external" format="html">#2390</xref>
  523. </li>
  524. </ul>
  525. </section>
  526. <section id="contrib">
  527. <title>Contributors</title>
  528. <p>DITA Open Toolkit Release 2.4 includes
  529. <xref keyref="contributions"/> by the following people:</p>
  530. <!-- https://github.com/tj/git-extras/blob/master/Commands.md#git-summary – `git summary 2.3..` -->
  531. <draft-comment author="Roger">NOTE: This lists contributions to the core toolkit, not docs.</draft-comment>
  532. <ol>
  533. <li>Jarno Elovirta</li>
  534. <li>Robert D. Anderson</li>
  535. <li>Eliot Kimber</li>
  536. <li>Eero Helenius</li>
  537. <li>Roger Sheen</li>
  538. <li>Radu Coravu</li>
  539. </ol>
  540. <p>For the complete list of changes since the previous release, see the
  541. <xref href="https://github.com/dita-ot/dita-ot/compare/2.3...2.4" scope="external" format="html">
  542. changelog</xref> on GitHub.</p>
  543. </section>
  544. <section id="docs">
  545. <title>Documentation updates</title>
  546. <p>The documentation for DITA Open Toolkit Release 2.4 includes corrections and improvements to existing topics,
  547. along with new content.</p>
  548. <ul>
  549. <li>Like the generated
  550. <xref keyref="dita-ot-params"/> and
  551. <xref keyref="messages"/> topics, a new
  552. <xref keyref="extension-points-by-plugin"/> section is now generated from the installed DITA-OT plug-ins to
  553. provide an overview of the extension points supported by each plug-in.</li>
  554. <li>A new
  555. <xref keyref="features-in-docs"/> topic provides examples of how the project documentation uses various
  556. recent DITA features.</li>
  557. <li>A new topic provides information on
  558. <xref keyref="migrating-to-2-4">Migrating to release 2.4</xref>.</li>
  559. </ul>
  560. <p>For additional information on documentation issues resolved in DITA Open Toolkit Release 2.4, see the
  561. <xref href="https://github.com/dita-ot/docs/issues?q=milestone%3A2.4+is%3Aclosed" format="html"
  562. scope="external">2.4 milestone</xref> in the documentation repository.</p>
  563. <p>DITA Open Toolkit Release 2.4 includes
  564. <xref keyref="docs-contributions"/> by the following people:</p>
  565. <draft-comment author="Roger">NOTE: This lists contributions to docs, not to the core toolkit.</draft-comment>
  566. <ol>
  567. <li>Roger Sheen</li>
  568. <li>Jarno Elovirta</li>
  569. <li>Mark Giffin</li>
  570. </ol>
  571. <p>For the complete list of documentation changes since the previous release, see the
  572. <xref href="https://github.com/dita-ot/docs/compare/2.3...2.4" scope="external" format="html">
  573. changelog</xref>.</p>
  574. </section>
  575. </refbody>
  576. </reference>
  577. </reference>