rel3.1.dita 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459
  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.1">
  5. <title>DITA Open Toolkit 3.1.3 Release Notes</title>
  6. <titlealts>
  7. <navtitle>Release Notes</navtitle>
  8. </titlealts>
  9. <abstract>
  10. <shortdesc>DITA Open Toolkit 3.1.3 is a maintenance release that fixes issues
  11. reported in DITA-OT 3.1, which includes <ph conref="#v3.1/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>DITA Open Toolkit Release 3.1 requires the Java Runtime Environment (JRE) version
  22. <keyword keyref="tool.java.version"/> or later.</p>
  23. </section>
  24. </refbody>
  25. </reference>
  26. <reference id="v3.1.3">
  27. <title>DITA-OT 3.1.3 <ph outputclass="small">released October 3, 2018</ph></title>
  28. <refbody>
  29. <section>
  30. <p>DITA Open Toolkit 3.1.3 is a maintenance release that includes the
  31. following bug fixes.</p>
  32. <ul>
  33. <li id="3060">In earlier releases, if a footnote was defined in a table cell that specified
  34. <codeph>align="center"</codeph>, the footnote content at the bottom of a PDF page would also be
  35. center-aligned. This has been fixed so that PDF footnotes always align to the start of the page.
  36. <xref href="https://github.com/dita-ot/dita-ot/issues/3060" format="html" scope="external">#3060</xref>,
  37. <xref href="https://github.com/dita-ot/dita-ot/pull/3065" format="html" scope="external">#3065</xref>
  38. </li>
  39. <li id="3064">In DITA-OT 3.0 and 3.1, unresolved <xmlatt>conref</xmlatt> errors may appear when nested submaps
  40. that are not in the same directory as the referencing map have <xmlelement>title</xmlelement> elements with
  41. valid content references. This issue has been fixed.
  42. <xref href="https://github.com/dita-ot/dita-ot/issues/3064" format="html" scope="external">#3064</xref>
  43. </li>
  44. <li id="3066">In PDF output, index entries inside of <xmlelement>draft-comment</xmlelement> and
  45. <xmlelement>required-cleanup</xmlelement> would appear in the generated index as broken links when draft
  46. content was excluded. This has been fixed, and the entries will not appear in the index unless draft content
  47. is included.
  48. <xref href="https://github.com/dita-ot/dita-ot/issues/3066" format="html" scope="external">#3066</xref>
  49. </li>
  50. <li id="3071">In earlier releases, missing images could result in a missing file warning that suggested that a
  51. <xmlelement>navtitle</xmlelement> was needed to use the image in a table of contents. This message has
  52. been fixed to simply describe the missing file.
  53. <xref href="https://github.com/dita-ot/dita-ot/issues/3071" format="html" scope="external">#3071</xref>
  54. </li>
  55. <li id="3073">In earlier releases, many PDF index entries were defined in the XSL-FO file using
  56. <xmlatt>id</xmlatt> attributes that worked but were technically invalid. This could result in a large
  57. number of warnings from tools that rendered the XSL-FO file. The <xmlatt>id</xmlatt> attributes have been
  58. fixed to ensure validity.
  59. <xref href="https://github.com/dita-ot/dita-ot/issues/3073" format="html" scope="external">#3073</xref>
  60. </li>
  61. <li id="3077">When maps use content outside of the map directory, and some <xmlelement>topicref</xmlelement>
  62. elements in the build specify <codeph>chunk="by-topic"</codeph>, earlier releases could fail with Java
  63. errors when evaluating the <xmlatt>chunk</xmlatt> attribute. This has been fixed so that chunking is
  64. resolved properly when content is referenced outside of the map directory.
  65. <xref href="https://github.com/dita-ot/dita-ot/issues/3077" format="html" scope="external">#3077</xref>
  66. </li>
  67. <li id="3081">In PDF processing for DITA-OT 3.0 and 3.1, a variable that stores navigation titles was typed in
  68. a way that caused XSLT errors for some values. The variable type has been corrected.
  69. <xref href="https://github.com/dita-ot/dita-ot/pull/3081" format="html" scope="external">#3081</xref>
  70. </li>
  71. <li id="3082">In earlier releases, PDF builds with broken links improperly reported a fatal error. DITA-OT 3.0
  72. was changed to halt the build on fatal errors, which caused these PDF builds to fail. The error message
  73. level has been corrected from <codeph>FATAL</codeph> to <codeph>ERROR</codeph>, allowing builds to finish.
  74. <xref href="https://github.com/dita-ot/dita-ot/pull/3082" format="html" scope="external">#3082</xref>
  75. </li>
  76. <li id="3083">In DITA-OT 3.0 and 3.1, the PDF build using <codeph>preprocess2</codeph> had build errors
  77. when the <xmlatt>copy-to</xmlatt> attribute was used. This error has been resolved, and the
  78. <xmlatt>copy-to</xmlatt> attribute is evaluated correctly in <codeph>preprocess2</codeph>.
  79. <xref href="https://github.com/dita-ot/dita-ot/issues/3083" format="html" scope="external">#3083</xref>,
  80. <xref href="https://github.com/dita-ot/dita-ot/pull/3085" format="html" scope="external">#3085</xref>
  81. </li>
  82. </ul>
  83. <p>For the complete list of changes since the previous release, see the
  84. <xref href="https://github.com/dita-ot/dita-ot/compare/3.1.2...3.1.3" format="html" scope="external">
  85. changelog</xref> on GitHub.</p>
  86. </section>
  87. </refbody>
  88. </reference>
  89. <reference id="v3.1.2">
  90. <title>DITA-OT 3.1.2 <ph outputclass="small">released August 13, 2018</ph></title>
  91. <refbody>
  92. <section>
  93. <p>DITA Open Toolkit 3.1.2 is a maintenance release that includes the following bug fixes.</p>
  94. <ul>
  95. <li id="2222">When a content reference was combined with <xmlatt>conrefend</xmlatt> to reference a sequence of
  96. topics, all but the first topic were copied without a required <xmlatt>id</xmlatt> attribute. This resulted
  97. in NullPointerExceptions from later processing steps that expected <xmlatt>id</xmlatt> on all topics. The
  98. content reference behavior has been fixed to avoid the error.
  99. <xref href="https://github.com/dita-ot/dita-ot/issues/2222" format="html" scope="external">#2222</xref>,
  100. <xref href="https://github.com/dita-ot/dita-ot/pull/3033" format="html" scope="external">#3033</xref></li>
  101. <li id="2940">In earlier versions, when a topic with index terms had an empty title (or a title with only
  102. metadata), HTML Help and Eclipse Help index processing would end in a NullPointerException. This error has
  103. been fixed.
  104. <xref href="https://github.com/dita-ot/dita-ot/issues/2940" format="html" scope="external">#2940</xref>,
  105. <xref href="https://github.com/dita-ot/dita-ot/pull/3043" format="html" scope="external">#3043</xref>
  106. </li>
  107. <li id="2948">In earlier versions, when the input file was a topic that contained a <xmlatt>conref</xmlatt>
  108. reference to itself, that topic would not generate output for XHTML or HTML5. The issue has been fixed.
  109. <xref href="https://github.com/dita-ot/dita-ot/issues/2948" format="html" scope="external">#2948</xref>,
  110. <xref href="https://github.com/dita-ot/dita-ot/pull/3045" format="html" scope="external">#3045</xref>
  111. </li>
  112. <li id="3008">When processing without schema validation, it is possible to add <xmlatt>keyref</xmlatt>
  113. attributes on elements where they are not legal. In earlier releases, this resulted in a
  114. NullPointerException from the keyref resolution module. These invalid attributes are now ignored.
  115. <xref href="https://github.com/dita-ot/dita-ot/issues/3008" format="html" scope="external">#3008</xref>,
  116. <xref href="https://github.com/dita-ot/dita-ot/pull/3034" format="html" scope="external">#3034</xref></li>
  117. <li id="3023">The Lightweight DITA plug-in has been updated to version 2.0.6, which provides improved support
  118. for inline HTML elements.
  119. <xref href="https://github.com/dita-ot/dita-ot/pull/3023" format="html" scope="external">#3023</xref>
  120. </li>
  121. <li id="3024">In DITA-OT 3.1, configuration data is read from two files, but some processes would incorrectly
  122. load only one file and miss properties in the other. This is fixed by removing
  123. <filepath>lib/configuration.properties</filepath> and storing all configuration properties in
  124. <filepath>config/configuration.properties</filepath>.
  125. <xref href="https://github.com/dita-ot/dita-ot/pull/3024" format="html" scope="external">#3024</xref>
  126. </li>
  127. <li id="3027">In earlier releases, when the "same file" reference syntax <codeph>href="#./elementid</codeph>
  128. was pulled into another file as part of a content reference, the <xmlatt>href</xmlatt> attribute was
  129. corrupted, resulting in broken links. These references have been fixed and now refer to the element with
  130. <codeph>id="elementid"</codeph> in the new resolved context.
  131. <xref href="https://github.com/dita-ot/dita-ot/pull/3027" format="html" scope="external">#3027</xref>
  132. </li>
  133. <li id="3029">In DITA-OT 3.0 and 3.1, Saxon would generate XSLT errors when it encountered
  134. <xmlelement>cite</xmlelement> or <xmlelement>term</xmlelement> inside of a
  135. <xmlelement>linktext</xmlelement> element in the related links section of a topic. The XSLT syntax has
  136. been fixed to avoid this error.
  137. <xref href="https://github.com/dita-ot/dita-ot/pull/3029" format="html" scope="external">#3029</xref>
  138. </li>
  139. <li id="3040">In earlier versions, the Ant build code for PDF2 set up a <codeph>CLASSPATH</codeph> variable
  140. that referenced JAR files that no longer exist. These references have been removed.
  141. <xref href="https://github.com/dita-ot/dita-ot/issues/2832" format="html" scope="external">#2832</xref>,
  142. <xref href="https://github.com/dita-ot/dita-ot/pull/3040" format="html" scope="external">#3040</xref>
  143. </li>
  144. </ul>
  145. <p>For the complete list of changes since the previous release, see the
  146. <xref href="https://github.com/dita-ot/dita-ot/compare/3.1.1...3.1.2" format="html" scope="external">
  147. changelog</xref> on GitHub.</p>
  148. </section>
  149. </refbody>
  150. </reference>
  151. <reference id="v3.1.1">
  152. <title>DITA-OT 3.1.1 <ph outputclass="small">released July 16, 2018</ph></title>
  153. <refbody>
  154. <section>
  155. <p>DITA Open Toolkit 3.1.1 is a maintenance release that includes the following bug fixes.</p>
  156. <ul>
  157. <li id="2662">When generating PDF output with Antenna House Formatter, earlier versions would sometimes fail
  158. when interpreting the Antenna House log. Processing has been updated to improve test coverage and handle
  159. these cases more gracefully.
  160. <xref href="https://github.com/dita-ot/dita-ot/issues/2662" format="html" scope="external">#2662</xref>,
  161. <xref href="https://github.com/dita-ot/dita-ot/issues/3012" format="html" scope="external">#3012</xref>
  162. </li>
  163. <li id="2855">Earlier versions treated image files referenced in <xmlelement>data</xmlelement> elements and
  164. certain other non-DITA resources as DITA topics. The map reader processing phase has been corrected to
  165. reliably collect non-DITA resources and record them as such in the <filepath>.job.xml</filepath> file.
  166. <xref href="https://github.com/dita-ot/dita-ot/issues/2855" format="html" scope="external">#2855</xref>,
  167. <xref href="https://github.com/dita-ot/dita-ot/issues/3010" format="html" scope="external">#3010</xref>
  168. </li>
  169. <li id="2870">DITA-OT 3.0 failed to produce Eclipse help output. A missing library import has been restored to
  170. ensure that Eclipse help is generated correctly.
  171. <xref href="https://github.com/dita-ot/dita-ot/issues/2870" format="html" scope="external">#2870</xref>
  172. </li>
  173. <li id="2983">When generating output for HTML-based formats, earlier versions failed to handle
  174. <xmlatt>conkeyref</xmlatt> attribute references to topics outside the map directory hierarchy, resulting
  175. in missing content and invalid paths to CSS resources. Processing has been corrected to ensure the paths to
  176. such files are calculated correctly.
  177. <xref href="https://github.com/dita-ot/dita-ot/issues/2983" format="html" scope="external">#2983</xref>,
  178. <xref href="https://github.com/dita-ot/dita-ot/issues/3014" format="html" scope="external">#3014</xref>
  179. </li>
  180. <li id="3005">A missing reference to the <parmname>$file-being-processed</parmname> parameter has been
  181. restored to ensure that the current file is correctly tracked while resolving map references in
  182. pre-processing.
  183. <xref href="https://github.com/dita-ot/dita-ot/issues/3005" format="html" scope="external">#3005</xref>
  184. </li>
  185. <li id="3007">In earlier versions, key references to duplicate topics created via <xmlatt>copy-to</xmlatt>
  186. attributes caused builds to fail. The original source information is now correctly recorded for copy-to
  187. targets, allowing builds to continue.
  188. <xref href="https://github.com/dita-ot/dita-ot/issues/3007" format="html" scope="external">#3007</xref>,
  189. <xref href="https://github.com/dita-ot/dita-ot/issues/3015" format="html" scope="external">#3015</xref>
  190. </li>
  191. <li id="3017">In earlier versions, <xmlelement>screen</xmlelement> elements resulted in a build failure when
  192. published to troff. Updating the plugin to version 3.1.1 resolves the issue.
  193. <xref href="https://github.com/dita-ot/dita-ot/issues/3017" format="html" scope="external">#3017</xref>
  194. </li>
  195. <li>
  196. <p>The documentation includes minor
  197. <xref href="https://github.com/dita-ot/docs/compare/3.1...3.1.1" format="html" scope="external">
  198. changes</xref> with
  199. <xref href="https://github.com/dita-ot/docs/milestone/34?closed=1" format="html" scope="external"
  200. >corrections and improvements</xref> to existing topics.</p>
  201. </li>
  202. </ul>
  203. <p>For the complete list of changes since the previous release, see the
  204. <xref href="https://github.com/dita-ot/dita-ot/compare/3.1...3.1.1" format="html" scope="external">
  205. changelog</xref> on GitHub.</p>
  206. </section>
  207. </refbody>
  208. </reference>
  209. <reference id="v3.1">
  210. <title>DITA-OT 3.1 <ph outputclass="small">released June 9, 2018</ph></title>
  211. <refbody>
  212. <section>
  213. <p>DITA Open Toolkit Release 3.1 includes <ph id="summary">support for DITA 1.3 SVG
  214. domain elements, enhanced <xmlelement>codeblock</xmlelement> processing, and incremental improvements to
  215. Lightweight DITA processing and PDF output</ph>.</p>
  216. </section>
  217. <section id="features">
  218. <title>Features</title>
  219. <p>DITA Open Toolkit Release 3.1 includes the following new features:</p>
  220. <!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.1+is%3Aclosed+label%3Afeature+sort%3Acreated-asc -->
  221. <ul>
  222. <li id="2875">A new Java wrapper for the XSLT <codeph>mapref</codeph> map resolution module allows for better
  223. handling of content references and key references in nested maps.
  224. <xref href="https://github.com/dita-ot/dita-ot/pull/2875" format="html" scope="external">#2875</xref>
  225. </li>
  226. <li id="2880">Updates to the Java code that calls Saxon now support integrated extension functions for Saxon
  227. HE (versions ≥ 9.2).
  228. <xref href="https://github.com/dita-ot/dita-ot/pull/2880" format="html" scope="external">#2880</xref>
  229. </li>
  230. <li id="2932">A new end-to-end test case ensures a basic test is run for all supported transformation types
  231. with every update to DITA-OT.
  232. <xref href="https://github.com/dita-ot/dita-ot/pull/2932" format="html" scope="external">#2932</xref>
  233. </li>
  234. <li id="2960">DITA-OT now supports the DITA 1.3 SVG domain elements, including <xmlelement>svgref</xmlelement>
  235. for pulling in external SVG markup.
  236. <xref href="https://github.com/dita-ot/dita-ot/pull/2960" format="html" scope="external">#2960</xref>
  237. </li>
  238. <li id="2961">PDF output now supports key-based linking for phrase like elements, including
  239. <xmlelement>cite</xmlelement>, <xmlelement>ph</xmlelement>, and <xmlelement>dt</xmlelement>. When key
  240. definitions specify a URI for linking, the links will now appear in PDF. This markup already resulted in
  241. links in HTML output, and resulted in PDF links for key references on <xmlelement>keyword</xmlelement> and
  242. <xmlelement>term</xmlelement>.
  243. <xref href="https://github.com/dita-ot/dita-ot/issues/2025" format="html" scope="external">#2025</xref>,
  244. <xref href="https://github.com/dita-ot/dita-ot/pull/2961" format="html" scope="external">#2961</xref>
  245. </li>
  246. <li>Processing for <xmlelement>codeblock</xmlelement> elements has been enhanced to support new
  247. <xmlatt>outputclass</xmlatt> keywords that can be used to adjust the presentation of code samples.
  248. <ul>
  249. <li id="2907">To remove leading whitespace in external code references, set the
  250. <xmlatt>outputclass</xmlatt> attribute to include the <codeph>normalize-space</codeph> keyword. With
  251. this setting, DITA-OT trims any leading whitespace that is common to all lines in the code block to
  252. remove excess indentation and keep lines short.
  253. <xref href="https://github.com/dita-ot/dita-ot/issues/2907" format="html" scope="external">#2907</xref>,
  254. <xref href="https://github.com/dita-ot/dita-ot/pull/2953" format="html" scope="external">#2953</xref>
  255. </li>
  256. <li id="2975">To highlight whitespace characters in code blocks, set the <xmlatt>outputclass</xmlatt>
  257. attribute to include the <codeph>show-whitespace</codeph> keyword. When PDF output is generated, space
  258. characters in the code will be replaced with a middle dot or “interpunct” character
  259. ( <codeph>·</codeph> ); tab characters are replaced with a rightwards arrow and three spaces
  260. ( <codeph>→   </codeph> ).
  261. <xref href="https://github.com/dita-ot/dita-ot/pull/2975" format="html" scope="external">#2975</xref>
  262. </li>
  263. <li>To add line numbers to code blocks in PDF output, set the <xmlatt>outputclass</xmlatt> attribute to
  264. include the <codeph>show-line-numbers</codeph> keyword. <note>Line numbering has been available since
  265. DITA-OT 2.0, but previously required custom PDF plug-ins to override the
  266. <codeph>codeblock.generate-line-number</codeph> template mode to return <codeph>true()</codeph>.
  267. DITA-OT 3.1 now checks for the keyword in the <xmlatt>outputclass</xmlatt>, so line numbering can be
  268. enabled without custom PDF plug-ins.</note>
  269. </li>
  270. </ul>
  271. </li>
  272. </ul>
  273. </section>
  274. <section id="enhancements">
  275. <title>Enhancements and changes</title>
  276. <p>DITA Open Toolkit Release 3.1 includes the following enhancements and changes to
  277. existing features:</p>
  278. <!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.1+is%3Aclosed+label%3Aenhancement+sort%3Acreated-asc -->
  279. <ul>
  280. <li id="2079">The error message generated for duplicate key definitions has been updated for clarity.
  281. <xref href="https://github.com/dita-ot/dita-ot/issues/2079" format="html" scope="external">#2079</xref>
  282. </li>
  283. <li id="2890">Ant scripts for DITA-OT builds now make use of <xmlatt>if:set</xmlatt> and
  284. <xmlatt>unless:set</xmlatt> attributes in the Ant namespace, which can be used to control whether
  285. parameters are passed to XSLT modules. These attributes replace custom implementations of
  286. <codeph>if</codeph> and <codeph>unless</codeph> logic introduced before Ant had this capability.
  287. <xref href="https://github.com/dita-ot/dita-ot/pull/2890" format="html" scope="external">#2890</xref>
  288. </li>
  289. <li id="2938">The PDF build code has been refactored and simplified to use the
  290. <xmlelement>xmlcatalog</xmlelement> element instead of using a custom <codeph>xml.catalog.files</codeph>
  291. property.
  292. <xref href="https://github.com/dita-ot/dita-ot/pull/2938" format="html" scope="external">#2938</xref>
  293. </li>
  294. <!--
  295. <li id="2939">Removes the redundant map2html5Impl.xsl import
  296. <xref href="https://github.com/dita-ot/dita-ot/pull/2939" format="html" scope="external">#2939</xref>
  297. </li>
  298. -->
  299. <li id="2964">Alternate text for images is now preserved in the XSL-FO files generated for PDF, using the
  300. custom attributes necessary for <tm trademark="Apache" tmtype="tm">Apache</tm> FOP, RenderX XEP, and Antenna
  301. House processors. The alternate text is now available in the final output file when processors generate
  302. accessible PDF.
  303. <xref href="https://github.com/dita-ot/dita-ot/issues/2850" format="html" scope="external">#2850</xref>,
  304. <xref href="https://github.com/dita-ot/dita-ot/pull/2964" format="html" scope="external">#2964</xref></li>
  305. <li id="2967">In PDF processing with <tm trademark="Apache" tmtype="tm">Apache</tm> FOP, DITA-OT 3.1 now uses
  306. the Simple Logging Facade for Java (SLF4J), allowing for better control and formatting of FOP log messages.
  307. To reduce noise on the console, all FOP messages are set to the Info level and hidden by default.
  308. <xref href="https://github.com/dita-ot/dita-ot/pull/2967" format="html" scope="external">#2967</xref>
  309. </li>
  310. <li id="2970">The HTML5 XSLT stylesheets used to create TOC navigation have been refactored to use a new
  311. processing mode. This removes the "Duplicate import of <filepath>map2html5Impl.xsl</filepath>" message that
  312. appeared with DITA-OT 3.0.
  313. <xref href="https://github.com/dita-ot/dita-ot/issues/2821" format="html" scope="external">#2821</xref>
  314. <xref href="https://github.com/dita-ot/dita-ot/pull/2970" format="html" scope="external">#2970</xref>
  315. </li>
  316. <li id="2972">The distribution build has been updated to use the documentation Gradle build instead of Ant.
  317. <xref href="https://github.com/dita-ot/dita-ot/issues/2972" format="html" scope="external">#2972</xref>
  318. </li>
  319. <li id="2974">The bundled <tm trademark="Apache" tmtype="tm">Apache</tm> FOP version has been updated to <ph
  320. keyref="tool.fop.version"/>. (For details on recent changes, see the
  321. <xref keyref="fop-23-rn"/>.)
  322. <xref href="https://github.com/dita-ot/dita-ot/issues/2974" format="html" scope="external">#2974</xref>,
  323. <xref href="https://github.com/dita-ot/dita-ot/pull/2976" format="html" scope="external">#2976</xref>
  324. </li>
  325. <li id="2978">The <xmlatt>frame</xmlatt> attribute on <xmlelement>choicetable</xmlelement> elements is now
  326. respected in PDF output; previously all values for <xmlatt>frame</xmlatt> on this element were ignored in
  327. PDF.
  328. <xref href="https://github.com/dita-ot/dita-ot/pull/2978" format="html" scope="external">#2978</xref>
  329. </li>
  330. <li id="2982">The LwDITA plugin has been updated to version 2.0.5, pulling in a number of fixes for
  331. Lightweight DITA processing. (Topic metadata is now preserved in YAML headers when generating Markdown for
  332. composite topics, autolinks in Markdown topics are treated as external cross references, and definition
  333. lists in Markdown input and links to ID fragments are now handled correctly.)
  334. <xref href="https://github.com/dita-ot/dita-ot/pull/2982" format="html" scope="external">#2982</xref>,
  335. <xref href="https://github.com/dita-ot/dita-ot/pull/2993" format="html" scope="external">#2993</xref>
  336. </li>
  337. <li id="2984">PDF processing now includes a hook that can be used to add custom
  338. <xmlelement>fo:marker</xmlelement> elements on any topic. New processing hooks are also available to add
  339. custom anchors on any topic or titled sub-topic element, intended as a way to enable stable links into a
  340. location within a PDF.
  341. <xref href="https://github.com/dita-ot/dita-ot/pull/2984" format="html" scope="external">#2984</xref>
  342. </li>
  343. <li id="2991">The Gradle wrapper used to run the documentation build has been updated to version 4.8.
  344. <xref href="https://github.com/dita-ot/dita-ot/pull/2991" format="html" scope="external">#2991</xref>,
  345. <xref href="https://github.com/dita-ot/dita-ot/issues/2994" format="html" scope="external">#2994</xref>
  346. </li>
  347. </ul>
  348. </section>
  349. <section id="bugs">
  350. <title>Bugs</title>
  351. <p>DITA Open Toolkit Release 3.1 provides fixes for the following bugs:</p>
  352. <!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A3.0+is%3Aclosed+label%3Abug+sort%3Acreated-asc -->
  353. <ul>
  354. <li id="2494">When a nested map uses <xmlatt>conref</xmlatt> to pull content from another map, but the root
  355. map does <i>not</i> use <xmlatt>conref</xmlatt>, the content reference was not previously resolved. This is
  356. now fixed, and content references in all maps used by the build are resolved properly.
  357. <xref href="https://github.com/dita-ot/dita-ot/issues/2494" format="html" scope="external">#2494</xref>
  358. </li>
  359. <li id="2898">When a <xmlelement>chapter</xmlelement> element refers to another map that is not a bookmap, PDF
  360. processing now formats the referenced content as a chapter. In earlier versions, the content could be
  361. formatted as a generic topic that did not match other chapters in the same map.
  362. <xref href="https://github.com/dita-ot/dita-ot/issues/2898" format="html" scope="external">#2898</xref>
  363. </li>
  364. <li id="2958">The error message <msgnum>DOTJ007E</msgnum>, which appeared for duplicate filter conditions in
  365. DITAVAL properties, has been switched from an Error to a Warning. This message, which usually does not
  366. indicate a problem that results in broken output, will now appear as <msgnum>DOTJ007W</msgnum>.
  367. <xref href="https://github.com/dita-ot/dita-ot/pull/2958" format="html" scope="external">#2958</xref>
  368. </li>
  369. <li id="2973">The empty <filepath>temp/</filepath> directory included in DITA-OT 3.0 distribution packages has
  370. been removed.
  371. <xref href="https://github.com/dita-ot/dita-ot/issues/2973" format="html" scope="external">#2973</xref>
  372. </li>
  373. <!--
  374. <li id="2978">
  375. <xref href="https://github.com/dita-ot/dita-ot/pull/2978" format="html" scope="external">#2978</xref>
  376. </li>
  377. -->
  378. <li id="2985">Several duplicate ID messages that appeared in PDF processing have been fixed by removing
  379. incorrect ID definitions. These messages could previously appear when nested elements inside of topic titles
  380. or topic short descriptions specified their own <xmlatt>id</xmlatt> attribute; in DITA-OT 3.0, this also
  381. appeared for all <xmlelement>pt</xmlelement> elements that specified <xmlatt>id</xmlatt>.
  382. <xref href="https://github.com/dita-ot/dita-ot/pull/2985" format="html" scope="external">#2985</xref>
  383. </li>
  384. <li id="2990">Several unnecessary files have been removed from the <filepath>docsrc/</filepath> folder of the
  385. distribution package.
  386. <xref href="https://github.com/dita-ot/dita-ot/pull/2990" format="html" scope="external">#2990</xref>
  387. </li>
  388. </ul>
  389. </section>
  390. <section id="contrib">
  391. <title>Contributors</title>
  392. <p>DITA Open Toolkit Release 3.1 includes
  393. <xref keyref="contributions"/> by the following people:</p>
  394. <!-- https://github.com/tj/git-extras/blob/master/Commands.md#git-summary – `git summary 3.0..` -->
  395. <draft-comment author="Roger">NOTE: This lists contributions to the core toolkit, not docs.</draft-comment>
  396. <ol>
  397. <li>Jarno Elovirta</li>
  398. <li>Robert D. Anderson</li>
  399. <li>Roger Sheen</li>
  400. <li>Radu Coravu </li>
  401. <li>Alexey Mironov</li>
  402. <li>Stefan Eike</li>
  403. <li>Shane Taylor</li>
  404. </ol>
  405. <p>For the complete list of changes since the previous release, see the
  406. <xref href="https://github.com/dita-ot/dita-ot/compare/2.5...3.0" format="html" scope="external">
  407. changelog</xref> on GitHub.</p>
  408. </section>
  409. <section id="docs">
  410. <title>Documentation updates</title>
  411. <p>The documentation for DITA Open Toolkit Release 3.1 provides corrections and
  412. improvements to existing topics, along with new information in the following topics:</p>
  413. <ul>
  414. <li>
  415. <xref keyref="extended-functionality"/></li>
  416. <li>
  417. <xref keyref="plugin-coding-conventions"/></li>
  418. <li>
  419. <xref keyref="migrating-to-3.1"/></li>
  420. <li>
  421. <xref keyref="log-files"/></li>
  422. </ul>
  423. <p>For additional information on documentation issues resolved in DITA Open Toolkit Release <keyword
  424. keyref="release"/>, see the
  425. <xref href="https://github.com/dita-ot/docs/issues?q=milestone%3A3.1+is%3Aclosed" format="html"
  426. scope="external">
  427. 3.1 milestone</xref> in the documentation repository.</p>
  428. <p>DITA Open Toolkit Release 3.1 includes
  429. <xref keyref="docs-contributions"/> by the following people:</p>
  430. <draft-comment author="Roger">NOTE: This lists contributions to docs, not to the core toolkit.</draft-comment>
  431. <ol>
  432. <li>Roger Sheen</li>
  433. <li>Robert D. Anderson</li>
  434. <li>Lief Erickson</li>
  435. <li>Stefan Eike</li>
  436. <li>Jarno Elovirta</li>
  437. <li>Eero Helenius</li>
  438. <li>François Violette</li>
  439. </ol>
  440. <p>For the complete list of documentation changes since the previous release, see the
  441. <xref href="https://github.com/dita-ot/docs/compare/3.0...3.1" format="html" scope="external">
  442. changelog</xref>.</p>
  443. </section>
  444. </refbody>
  445. </reference>
  446. </reference>