index.html 61 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700
  1. <!DOCTYPE html
  2. SYSTEM "about:legacy-compat">
  3. <html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2018"><meta name="DC.rights.owner" content="(C) Copyright 2018"><meta name="DC.Type" content="reference"><meta name="abstract" content="DITA Open Toolkit 3.0.4 is a maintenance release that fixes issues reported in DITA-OT 3.0, which adds support for Markdown, normalized DITA output, and the alternative authoring formats proposed for Lightweight DITA. The map-first preprocessing approach provides a modern alternative to the default preprocess operation."><meta name="description" content="DITA Open Toolkit 3.0.4 is a maintenance release that fixes issues reported in DITA-OT 3.0, which adds support for Markdown, normalized DITA output, and the alternative authoring formats proposed for Lightweight DITA. The map-first preprocessing approach provides a modern alternative to the default preprocess operation."><meta name="DC.Format" content="HTML5"><meta name="DC.Identifier" content="ID"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>DITA Open Toolkit 3.0.4 Release Notes</title></head><body id="ID"><header role="banner"><div class="header">
  4. <p>DITA Open Toolkit</p>
  5. <hr>
  6. </div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.0</a></li><li class="active"><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/alternative-input-formats.html">Authoring formats</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../parameters/index.html">Setting parameters</a></li><li><a href="../topics/extending-the-ot.html">Customizing DITA-OT</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
  7. <h1 class="title topictitle1" id="ariaid-title1">DITA Open Toolkit <span class="keyword">3.0.4</span> Release Notes</h1>
  8. <div class="abstract">
  9. <p class="shortdesc">DITA Open Toolkit <span class="keyword">3.0.4</span> is a maintenance release that fixes issues
  10. reported in DITA-OT <span class="keyword">3.0</span>, which <span class="ph">adds support for Markdown, normalized DITA output, and the alternative authoring formats
  11. proposed for Lightweight DITA. The map-first preprocessing approach provides a modern alternative to the
  12. default <code class="ph codeph">preprocess</code> operation.</span></p>
  13. <p class="p">DITA-OT releases follow
  14. <a class="xref" href="https://semver.org" target="_blank">semantic versioning</a> guidelines. Version numbers use the
  15. <code class="ph codeph"><var class="keyword varname">major</var>.<var class="keyword varname">minor</var>.<var class="keyword varname">patch</var></code> syntax, where
  16. <var class="keyword varname">major</var> versions may include incompatible API changes, <var class="keyword varname">minor</var> versions add
  17. functionality in a backwards-compatible manner and <var class="keyword varname">patch</var> versions are maintenance releases
  18. that include backwards-compatible bug fixes.</p>
  19. <div class="note tip note_tip"><span class="note__title">Tip:</span> <span class="ph">Download the <span class="ph filepath">dita-ot-<span class="keyword">3.0.4</span>.zip</span>
  20. package from the project website at <a class="xref" href="https://www.dita-ot.org/download" target="_blank">dita-ot.org/download</a>.</span></div>
  21. </div>
  22. <article class="topic reference nested1" aria-labelledby="ariaid-title2" id="requirements">
  23. <h2 class="title topictitle2" id="ariaid-title2">Requirements</h2>
  24. <div class="body refbody">
  25. <section class="section">
  26. <p class="p">DITA Open Toolkit Release <span class="keyword">3.0</span> requires the Java Runtime Environment (JRE) version
  27. <span class="keyword">8</span> or later.</p>
  28. </section>
  29. </div>
  30. </article>
  31. <article class="topic reference nested1" aria-labelledby="ariaid-title3" id="v304">
  32. <h2 class="title topictitle2" id="ariaid-title3">DITA-OT <span class="keyword">3.0.4</span>
  33. <span class="ph small">released May 10, 2018</span></h2>
  34. <div class="body refbody">
  35. <section class="section">
  36. <p class="p">DITA Open Toolkit <span class="keyword">3.0.4</span> is a maintenance release that includes the
  37. following bug fixes.</p>
  38. <ul class="ul">
  39. <li class="li" id="v304__2005">In previous releases, including a <code class="ph codeph">&lt;!DOCTYPE&gt;</code> declaration in a DITAVAL
  40. document resulted in a build failure. This is now fixed, and the referenced grammar file will be found using
  41. the same catalog that is used to locate other grammar files.
  42. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2005" target="_blank">#2005</a>,
  43. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2922" target="_blank">#2922</a>
  44. </li>
  45. <li class="li" id="v304__2835">DITA-OT 3.0 failed to recognize PDF customizations if the custom plug-in used the same file
  46. names as the base PDF plug-in. The default catalog has been removed from the catalog configuration file to
  47. ensure that only explicitly configured catalogs are used and customizations take precedence regardless of
  48. the file names in the custom plug-in.
  49. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2835" target="_blank">#2835</a>,
  50. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2937" target="_blank">#2937</a>
  51. </li>
  52. <li class="li" id="v304__2841">In DITA-OT 3.0, URI-based links may cause NullPointerExceptions when link targets do not exist
  53. until after <code class="keyword markupname xmlatt">@copy-to</code> attributes are evaluated. The build failure has been removed, and this
  54. type of link will now generate normal build errors as in previous releases.
  55. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2841" target="_blank">#2841</a>,
  56. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2936" target="_blank">#2936</a>
  57. </li>
  58. <li class="li" id="v304__2842">In previous releases, if a key definition specified both <code class="keyword markupname xmlatt">@href</code> and
  59. <code class="keyword markupname xmlatt">@copy-to</code> attributes, references to that key always resolved to the original
  60. <code class="keyword markupname xmlatt">@href</code> rather than to the new copy specified with <code class="keyword markupname xmlatt">@copy-to</code>. Key references
  61. to this type of definition will now resolve to the appropriate copy of the resource.
  62. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2842" target="_blank">#2842</a>,
  63. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2935" target="_blank">#2935</a>
  64. </li>
  65. <li class="li" id="v304__2901">In DITA-OT 3.0.1, <code class="keyword markupname xmlelement">&lt;coderef&gt;</code> elements that contained references to line
  66. ranges in DITA map files were not reliably included in PDF output as the preprocessing routine may change
  67. maps. All code references are now resolved from the original files to ensure that code blocks reflect the
  68. intended source range.
  69. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2901" target="_blank">#2901</a>,
  70. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2916" target="_blank">#2916</a>
  71. </li>
  72. <li class="li" id="v304__2910">In DITA-OT 3.0, PDF output files were created outside of the specified output directory when the
  73. map referenced content outside of the map directory. This has been fixed to ensure that PDFs are always
  74. placed in the specified output directory.
  75. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2910" target="_blank">#2910</a>,
  76. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2923" target="_blank">#2923</a>
  77. </li>
  78. <li class="li" id="v304__2917">When generating HTML output with DITA-OT 3.0.2, images referenced indirectly via keys were not
  79. copied to the output folder. Processing has been corrected to ensure that the list of images in the job
  80. configuration includes those referenced via keys.
  81. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2917" target="_blank">#2917</a>,
  82. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2921" target="_blank">#2921</a>
  83. </li>
  84. <li class="li" id="v304__2926">In earlier releases, <code class="keyword markupname xmlatt">@scale</code> attributes on the <code class="keyword markupname xmlelement">&lt;fig&gt;</code>
  85. element were ignored for PDF output. The <code class="keyword markupname xmlatt">@scale</code> attribute is now respected for PDF figures,
  86. which may include text content (such as code blocks), inline images inside the text, or block images.
  87. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2926" target="_blank">#2926</a>
  88. </li>
  89. <li class="li" id="v304__2927">In earlier releases, topic references to peer DITA content reported “missing navigation title”
  90. errors even when the reference included <code class="keyword markupname xmlelement">&lt;linktext&gt;</code>. As with all other peer, external,
  91. and non-DITA references, the <code class="keyword markupname xmlelement">&lt;linktext&gt;</code> for peer topics will now be used as a
  92. fallback title when no navigation title is available.
  93. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2927" target="_blank">#2927</a>
  94. </li>
  95. <li class="li" id="v304__2929">The Lightweight DITA plug-in has been updated to the latest version (2.0.3) to prevent errors
  96. when processing Markdown input that contains typographic quotation marks with the <code class="keyword markupname xmlatt">@format</code>
  97. attribute set to <code class="ph codeph">markdown</code>
  98. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2929" target="_blank">#2929</a>,
  99. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2956" target="_blank">#2956</a>
  100. </li>
  101. <li class="li" id="v304__2942">When generating PDF output for tables that specified row headers, DITA-OT failed to honor
  102. vertical spans defined via the <code class="keyword markupname xmlatt">@morerows</code> attribute on an <code class="keyword markupname xmlelement">&lt;entry&gt;</code>
  103. (cell). Row headers are now properly applied when cells span additional rows.
  104. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2942" target="_blank">#2942</a>,
  105. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2946" target="_blank">#2946</a>
  106. </li>
  107. <li class="li" id="v304__2945">When <code class="keyword markupname xmlelement">&lt;fragref&gt;</code> elements were used to reference a syntax diagram fragment,
  108. earlier versions of DITA-OT displayed an error. Processing has been updated to use the latest designs from
  109. the topicpull module and fix the error.
  110. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2945" target="_blank">#2945</a>
  111. </li>
  112. </ul>
  113. <p class="p">For the complete list of changes since the previous release, see the
  114. <a class="xref" href="https://github.com/dita-ot/dita-ot/compare/3.0.3...3.0.4" target="_blank">
  115. changelog</a> on GitHub.</p>
  116. </section>
  117. </div>
  118. </article>
  119. <article class="topic reference nested1" aria-labelledby="ariaid-title4" id="v303">
  120. <h2 class="title topictitle2" id="ariaid-title4">DITA-OT 3.0.3 <span class="ph small">released March 10, 2018</span></h2>
  121. <div class="body refbody">
  122. <section class="section">
  123. <p class="p">DITA Open Toolkit 3.0.3 is a maintenance release that includes the following bug fixes.</p>
  124. <ul class="ul">
  125. <li class="li" id="v303__2892">In some scenarios on Windows, the version of Saxon shipped in DITA-OT 3.0 caches one copy of the
  126. toolkit module <span class="ph filepath">functions.xsl</span> and then uses that copy in place of a second (different)
  127. module with the same name. This causes problems when using the <span class="keyword cmdname">ant</span> command to run HTML5
  128. builds. Adding an explicit path to one of the imports works around the problem.
  129. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2892" target="_blank">#2892</a>
  130. </li>
  131. <li class="li" id="v303__2894">If an XSLT message is declared to be fatal, throwing that message should halt the build. This
  132. stopped working with a refactored message process several releases ago, but was missed because the default
  133. toolkit does not declare any fatal messages for XSLT modules.
  134. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2894" target="_blank">#2894</a>
  135. </li>
  136. <li class="li" id="v303__2896">When a DITAVAL document contains a typo in the <code class="keyword markupname xmlatt">@action</code> attribute (which should
  137. be set to one of <code class="ph codeph">include</code>, <code class="ph codeph">exclude</code>, <code class="ph codeph">flag</code>, or
  138. <code class="ph codeph">passthrough</code>), the build ends with a message that is difficult to diagnose. The message
  139. has been updated to be more explicit and to use the toolkit’s standard message format.
  140. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2896" target="_blank">#2896</a></li>
  141. <li class="li" id="v303__2897">When the <code class="keyword markupname xmlelement">&lt;navtitle&gt;</code> element is used in a map, it should be ignored by
  142. default (for the purposes of TOC titles, PDF bookmarks or generated links), except in cases where the
  143. <code class="keyword markupname xmlatt">@locktitle</code> attribute on the containing topic reference is set to <code class="ph codeph">yes</code>.
  144. This has always worked when using the <code class="keyword markupname xmlatt">@navtitle</code> attribute on topic references, but
  145. previously the <code class="keyword markupname xmlelement">&lt;navtitle&gt;</code> element in maps was used even if it was not locked.
  146. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2897" target="_blank">#2897</a>
  147. </li>
  148. <li class="li" id="v303__2900">When a DITA document contains more than one <code class="keyword markupname xmlelement">&lt;glossentry&gt;</code> element, and
  149. keys are defined for those entries using the file name but <em class="ph i">without</em> including the entry ID, XHTML and
  150. HTML5 builds would fail to process topics that reference the key. This error has been corrected so that
  151. terms linking to glossary entries will go to the correct file, and no error will be generated.
  152. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2900" target="_blank">#2900</a>
  153. </li>
  154. <li class="li" id="v303__2904">In PDF builds, the <code class="keyword markupname xmlelement">&lt;navtitle&gt;</code> element inside of a topic was ignored when
  155. creating bookmarks and the table of contents. The <code class="keyword markupname xmlelement">&lt;navtitle&gt;</code> element in topics is now
  156. used for each of those cases except when a map overrides the navigation title.
  157. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2904" target="_blank">#2904</a>,
  158. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2906" target="_blank">#2906</a>
  159. </li>
  160. <li class="li" id="v303__2908"> When the <code class="keyword markupname xmlelement">&lt;choicetable&gt;</code> element does not specify a table header, it
  161. should generate default values for the "Option" and "Description" fields. In PDF, the "Description" column
  162. was not generating the correct header. This has been fixed so that each column gets the proper header.
  163. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2908" target="_blank">#2908</a>,
  164. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2909" target="_blank">#2909</a></li>
  165. <li class="li" id="v303__2912">In HTML5, the default output process generates a Dublin Core metadata tag that specifies the
  166. content format as XHTML. This is left over from earlier releases when the two formats shared the same code.
  167. The format value is now correctly set to HTML5.
  168. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2912" target="_blank">#2912</a></li>
  169. </ul>
  170. <p class="p">For the complete list of changes since the previous release, see the
  171. <a class="xref" href="https://github.com/dita-ot/dita-ot/compare/3.0.2...3.0.3" target="_blank">
  172. changelog</a> on GitHub.</p>
  173. </section>
  174. </div>
  175. </article>
  176. <article class="topic reference nested1" aria-labelledby="ariaid-title5" id="v302">
  177. <h2 class="title topictitle2" id="ariaid-title5">DITA-OT 3.0.2 <span class="ph small">released February 5, 2018</span></h2>
  178. <div class="body refbody">
  179. <section class="section">
  180. <p class="p">DITA Open Toolkit 3.0.2 is a maintenance release that includes the following bug fixes.</p>
  181. <ul class="ul">
  182. <li class="li" id="v302__1550">If a map or branch of a map was chunked to create a single document, but that portion of the map
  183. also contained a <code class="keyword markupname xmlelement">&lt;topicref&gt;</code> reference to a non-DITA resource, earlier versions of
  184. DITA-OT attempted to read and chunk the non-DITA file. This resulted in build errors and a broken reference.
  185. The non-DITA references are no longer read or renamed when chunking.
  186. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/1550" target="_blank">#1550</a>,
  187. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2883" target="_blank">#2883</a></li>
  188. <li class="li" id="v302__2432">Several issues related to relationship table column headings have been resolved:
  189. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2432" target="_blank">#2432</a>,
  190. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2873" target="_blank">#2873</a>.
  191. <ul class="ul">
  192. <li class="li">If a relationship table heading uses a <code class="keyword markupname xmlatt">@navtitle</code> without a topic, earlier versions of
  193. DITA-OT would fail with an XSLT error. If the <code class="keyword markupname xmlatt">@href</code> attribute is not present, the
  194. navigation title will now be used as expected. </li>
  195. <li class="li">You can now set a heading on any relationship table column to apply that heading to the group of links
  196. generated by cells in that column. For example, if you create a column for
  197. <code class="keyword markupname xmlelement">&lt;glossentry&gt;</code> topics and set a title of “Related terms”, the generated links
  198. will appear in a group titled “Related terms” (rather than the default “Related concepts”). In earlier
  199. releases, these headings were ignored unless every column specified its own heading.</li>
  200. </ul>
  201. </li>
  202. <li class="li" id="v302__2596">If a bookmap is referenced from within another map or topic reference, earlier versions of
  203. DITA-OT generated an invalid <code class="keyword markupname xmlelement">&lt;fo:page-sequence&gt;</code> within an
  204. <code class="keyword markupname xmlelement">&lt;fo:block&gt;</code>, which caused FO processing to fail. DITA-OT now checks the bookmap
  205. elements at the root level to determine whether page sequences and static content should be generated. This
  206. allows processing to complete without errors.
  207. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2596" target="_blank">#2596</a>,
  208. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2859" target="_blank">#2859</a>
  209. </li>
  210. <li class="li" id="v302__2725">The bundled DITA grammar files have been updated to reflect the latest changes from the OASIS
  211. DITA Technical Committee (Errata 02, 16 January 2018). These changes allow XML Schema-based validators like
  212. Saxon EE to resolve schema references based on URI mappings, and replace declarations of the
  213. <code class="keyword markupname xmlatt">@domains</code> attribute in modules with <code class="ph codeph">domains-att</code> references to facilitate
  214. domain attribute substitution.
  215. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2725" target="_blank">#2725</a>,
  216. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2818" target="_blank">#2818</a>,
  217. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2860" target="_blank">#2860</a>
  218. </li>
  219. <li class="li" id="v302__2828">In DITA-OT 3.0, image references in bookmap bookmeta data caused builds to fail. Processing has
  220. been corrected to ignore images when reading topics from the map, allowing builds to complete successfully.
  221. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2828" target="_blank">#2828</a>
  222. </li>
  223. <li class="li" id="v302__2829">Earlier versions of DITA-OT failed to process resources where the filename includes the percent
  224. <code class="ph codeph">%</code> character. The URI parser has been corrected to escape these characters correctly and
  225. rewrite references in valid URI syntax.
  226. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2829" target="_blank">#2829</a>
  227. </li>
  228. <li class="li" id="v302__2837">The Lightweight DITA plug-in has been updated to the latest version (2.0.2) to prevent errors
  229. when processing Markdown input that contains typographic quotation marks.
  230. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2837" target="_blank">#2837</a>,
  231. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2866" target="_blank">#2866</a>
  232. </li>
  233. <li class="li" id="v302__2862">In DITA-OT 3.0, cross-references to external resources caused problems if the
  234. <code class="keyword markupname xmlatt">@scope</code> attribute was not explicitly set to <code class="ph codeph">external</code>. The preprocess
  235. validation filter has been revised to implicitly treat such references as external in lax processing mode
  236. per the DITA specification and issue a warning.
  237. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2862" target="_blank">#2862</a>,
  238. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2877" target="_blank">#2877</a>
  239. </li>
  240. <li class="li" id="v302__2864">The German translation for <code class="ph codeph">danger</code> note labels has been changed from <cite lang="de" class="cite">VORSICHT</cite> to <cite lang="de" class="cite">GEFAHR</cite> to align with recommendations in ANSI
  241. Z535.4 Annex D.
  242. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2864" target="_blank">#2864</a>,
  243. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2871" target="_blank">#2871</a>
  244. </li>
  245. <li class="li" id="v302__2867">DITA-OT 3.0 would fail with an error when generating HTML output with non-DITA resource
  246. references such as MathML, which were treated as <code class="ph codeph">html</code>. The <code class="keyword markupname xmlatt">@format</code> tracking
  247. has been corrected to use the correct format in the job configuration instead of <code class="ph codeph">html</code>.
  248. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2867" target="_blank">#2867</a>,
  249. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2889" target="_blank">#2889</a>
  250. </li>
  251. <li class="li" id="v302__2874">The DITA 1.2 schemas have been corrected to use DITA 1.2 version-specific identifiers in all
  252. <code class="keyword markupname xmlatt">@schemaLocation</code> references. Previously one module was referenced with an unversioned
  253. identifier, causing DITA 1.3 rules to be pulled into the DITA 1.2 task schema.
  254. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2874" target="_blank">#2874</a>,
  255. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2878" target="_blank">#2878</a>
  256. </li>
  257. <li class="li" id="v302__2887">The bundled Saxon-HE library was updated to version 9.8.0.7, which restores the ability to run
  258. XSLT 1.0–based stylesheets. This change will allow existing plug-ins that still use XSLT 1.0 syntax to work
  259. in DITA-OT 3.0.2 without migration.
  260. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2887" target="_blank">#2887</a>,
  261. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2888" target="_blank">#2888</a>
  262. </li>
  263. </ul>
  264. <p class="p">For the complete list of changes since the previous release, see the
  265. <a class="xref" href="https://github.com/dita-ot/dita-ot/compare/3.0.1...3.0.2" target="_blank">
  266. changelog</a> on GitHub.</p>
  267. </section>
  268. </div>
  269. </article>
  270. <article class="topic reference nested1" aria-labelledby="ariaid-title6" id="v301">
  271. <h2 class="title topictitle2" id="ariaid-title6">DITA-OT 3.0.1 <span class="ph small">released November 30, 2017</span></h2>
  272. <div class="body refbody">
  273. <section class="section">
  274. <p class="p">DITA Open Toolkit 3.0.1 is a maintenance release that includes the following bug fixes.</p>
  275. <ul class="ul">
  276. <li class="li" id="v301__1151">Microsoft Compiled HTML Help requires a Windows codepage rather than UTF-8, so many characters
  277. are converted to HTML entities to ensure they are preserved during the codepage conversion. In earlier
  278. versions of DITA-OT, these entities were not rendered correctly in index terms or in topic titles on the
  279. <span class="ph uicontrol">Contents</span> tab of the .chm file. This is now fixed; characters that exist in the
  280. target codepage are not converted to entities, so they will appear properly in the compiled help file.
  281. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/1151" target="_blank">#1151</a>,
  282. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/1271" target="_blank">#1271</a>,
  283. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2852" target="_blank">#2852</a>
  284. </li>
  285. <li class="li" id="v301__2824">When unordered lists nest greater than 4 levels, PDF processing generates a warning about a
  286. missing variable, and deeply nested lists use text such as <code class="ph codeph">Unordered List bullet 5</code> instead
  287. of a bullet character. Characters for levels 1 through 4 now repeat in deeply nested lists.
  288. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2824" target="_blank">#2824</a>,
  289. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2853" target="_blank">#2853</a>
  290. </li>
  291. <li class="li" id="v301__2830">Map-first processing in 3.0 uses generated file names in the temp directory for HTML Help, but
  292. this breaks any existing context-sensitive help projects that call topics directly by file name rather than
  293. by aliased constants (topic IDs) or help context numbers. Topics in the compiled help file are now restored
  294. to their original names to support external applications that to link to topics within a CHM by file name.
  295. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2830" target="_blank">#2830</a>
  296. </li>
  297. <li class="li" id="v301__2833">Simplified common variable definitions in 3.0 could not be overridden using the traditional
  298. customization approach; the override process now checks for common variables to ensure those in the
  299. configuration directory are used.
  300. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2833" target="_blank">#2833</a>,
  301. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2838" target="_blank">#2838</a>
  302. </li>
  303. <li class="li" id="v301__2836">Generating Markdown output with DITA-OT 3.0 failed with references to a missing stylesheet. The
  304. Lightweight DITA plug-in has been updated to the latest version (2.0.1), which corrects the plug-in
  305. directory path in the stylesheet reference, so Markdown output is now generated as expected.
  306. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2836" target="_blank">#2836</a>,
  307. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2846" target="_blank">#2846</a>
  308. </li>
  309. <li class="li" id="v301__2851">In 3.0, HTML Help project files would not compile to CHM files because a property definition was
  310. not properly initialized. This has been fixed and CHM files are generated using the original map name.
  311. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2851" target="_blank">#2851</a>
  312. </li>
  313. <li class="li" id="v301__2854">In 3.0, the <span class="keyword parmname">args.output.base</span> property to name output files does not work
  314. properly for HTML Help. The property is now used to produce a CHM file with the correct name and contents.
  315. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2854" target="_blank">#2854</a>
  316. </li>
  317. <li class="li" id="v301__2856">In 3.0, content references to warehouse topics that contain unresolved cross-references would
  318. cause PDF builds to fail, even if the invalid reference was not explicitly included in the content
  319. reference. DITA-OT now checks to make sure such files exist and only parses them if available.
  320. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2856" target="_blank">#2856</a>
  321. </li>
  322. <li class="li">
  323. <p class="p">The documentation includes minor
  324. <a class="xref" href="https://github.com/dita-ot/docs/compare/3.0...3.0.1" target="_blank">
  325. changes</a> with
  326. <a class="xref" href="https://github.com/dita-ot/docs/milestone/30?closed=1" target="_blank">corrections and improvements</a> to existing topics.</p>
  327. </li>
  328. </ul>
  329. <p class="p">For the complete list of changes since the previous release, see the
  330. <a class="xref" href="https://github.com/dita-ot/dita-ot/compare/3.0...3.0.1" target="_blank">
  331. changelog</a> on GitHub.</p>
  332. </section>
  333. </div>
  334. </article>
  335. <article class="topic reference nested1" aria-labelledby="ariaid-title7" id="highlights">
  336. <h2 class="title topictitle2" id="ariaid-title7">DITA-OT 3.0 <span class="ph small">released October 28, 2017</span></h2>
  337. <div class="body refbody">
  338. <section class="section">
  339. <p class="p">DITA-OT <span class="keyword">3.0</span>
  340. <span class="ph" id="highlights__summary">adds support for Markdown, normalized DITA output, and the alternative authoring formats
  341. proposed for Lightweight DITA. The map-first preprocessing approach provides a modern alternative to the
  342. default <code class="ph codeph">preprocess</code> operation.</span></p>
  343. </section>
  344. <section class="section" id="highlights__markdown"><h3 class="title sectiontitle">Markdown support</h3>
  345. <p class="p">The
  346. <a class="xref" href="https://daringfireball.net/projects/markdown/" target="_blank">Markdown</a> implementation previously provided by the external <code class="ph codeph">dita-ot-markdown</code>
  347. plug-in has been updated to support additional edge cases and bundled into the DITA-OT 3.0 release.
  348. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2774" target="_blank">#2774</a></p>
  349. <p class="p">Markdown topics can be added to DITA publications by setting the <code class="keyword markupname xmlatt">@format</code> attribute to
  350. <code class="ph codeph">markdown</code> so the toolkit will recognize the source file as Markdown and convert it to
  351. DITA:</p>
  352. <div class="p">
  353. <pre class="pre codeblock"><code>&lt;map&gt;
  354. &lt;topicref href="markdown-dita-topic.md" <strong class="ph b">format="markdown"</strong>/&gt;
  355. &lt;/map&gt;</code></pre>
  356. </div>
  357. <p class="p">Along with Markdown input, DITA-OT now provides three new output formats to convert DITA content to Markdown,
  358. including the original <code class="ph codeph">markdown</code> syntax, <code class="ph codeph">markdown_github</code> for
  359. <a class="xref" href="https://github.github.com/gfm/" target="_blank">GitHub-Flavored Markdown</a>, and <code class="ph codeph">markdown_gitbook</code> for publishing via GitBook.</p>
  360. <p class="p">Markdown output can be generated by passing one of these keywords to the <span class="keyword cmdname">dita</span> command with
  361. the <span class="keyword option">--format</span> option:</p>
  362. <div class="p">
  363. <pre class="pre codeblock"><code>dita --input=userguide.ditamap --format=markdown</code></pre></div>
  364. <p class="p">The new output formats can be used to feed DITA content into Markdown-based publishing systems or other
  365. workflows that lack the ability to process DITA XML.</p>
  366. <div class="note note note_note"><span class="note__title">Note:</span> The Markdown support is based on
  367. <a class="xref" href="http://commonmark.org" target="_blank">CommonMark</a>, a strongly defined, highly compatible specification of Markdown and implemented
  368. via the <code class="ph codeph">flexmark-java</code> parser.</div>
  369. </section>
  370. <section class="section" id="highlights__lwdita"><h3 class="title sectiontitle">Preview support for Lightweight DITA</h3>
  371. <p class="p">The new <code class="ph codeph">org.lwdita</code> plug-in replaces the earlier <code class="ph codeph">dita-ot-markdown</code> plug-in
  372. and provides preview support for the MDITA and HDITA authoring formats proposed for
  373. <a class="xref" href="http://docs.oasis-open.org/dita/LwDITA/v1.0/cnprd01/LwDITA-v1.0-cnprd01.pdf" target="_blank">Lightweight DITA</a>.</p>
  374. <p class="p">The <code class="keyword markupname xmlatt">@format</code> attribute can be set to <code class="ph codeph">mdita</code> to apply LwDITA-specific
  375. processing to Markdown topics:</p>
  376. <div class="p">
  377. <pre class="pre codeblock"><code>&lt;map&gt;
  378. &lt;topicref href="mdita-topic.md" <strong class="ph b">format="mdita"</strong>/&gt;
  379. &lt;/map&gt;</code></pre>
  380. </div>
  381. <p class="p">In this case, the first paragraph in the topic will be treated as a short description, for example, and
  382. additional metadata can be specified for the topic via a YAML front matter block.</p>
  383. <div class="note attention note_attention"><span class="note__title">Attention:</span> Since
  384. <a class="xref" href="http://docs.oasis-open.org/dita/LwDITA/v1.0/cnprd01/LwDITA-v1.0-cnprd01.pdf" target="_blank">Lightweight DITA</a> has not yet been released as a formal specification, the implementation for MDITA and
  385. HDITA authoring formats is subject to change. Future versions of DITA Open Toolkit will be updated as LwDITA
  386. proposals evolve.</div>
  387. </section>
  388. <section class="section" id="highlights__norm-dita"><h3 class="title sectiontitle">Normalized DITA output</h3>
  389. <p class="p">The new <code class="ph codeph">dita</code> transformation generates normalized topics and maps from DITA input. The
  390. normalized output includes the results of the DITA Open Toolkit pre-processing operations, which resolve map
  391. references, keys, content references, code references and push metadata back and forth between maps and
  392. topics.</p>
  393. <p class="p">In comparison to the source DITA files, the normalized DITA files are modified in the following ways:</p>
  394. <ul class="ul">
  395. <li class="li">References from one DITA map to another are resolved</li>
  396. <li class="li">Map-based links, such as those generated by map hierarchy and relationship tables, are added to the
  397. topics.</li>
  398. <li class="li">Link text is resolved.</li>
  399. <li class="li">Map attributes that cascade are made explicit on child elements.</li>
  400. <li class="li">Map metadata such as index entries and copyrights are pushed into topics.</li>
  401. <li class="li">Topic metadata such as navigation titles, link text and short descriptions are pulled from topics into the
  402. map.</li>
  403. <li class="li">XML comments are removed.</li>
  404. </ul>
  405. <p class="p">Normalized output can be used during plug-in development to troubleshoot the results of preprocessing
  406. routines, or in situations where post-processing of DITA content is required, but the downstream systems are
  407. limited in their ability to resolve DITA references.
  408. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2775" target="_blank">#2775</a></p>
  409. <div class="note tip note_tip"><span class="note__title">Tip:</span> The <code class="ph codeph">dita</code> transformation can also be used to convert Markdown topics or the
  410. alternative input formats supported by the <code class="ph codeph">org.lwdita</code> plug-in to standard DITA XML.</div>
  411. </section>
  412. <section class="section" id="highlights__map-first"><h3 class="title sectiontitle">Map-first preprocessing</h3>
  413. <p class="p"><span class="ph">DITA-OT 3.0 provides a map-first preprocessing option as an alternative to
  414. the default <code class="ph codeph">preprocess</code> operation. The method, which was introduced in DITA-OT 2.5 as an
  415. experimental feature, has been improved and is ready for use in many production scenarios. Map-first-preprocessing
  416. provides the same functionality as the default <code class="ph codeph">preprocess</code>, but takes a different
  417. approach.</span>
  418. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2763" target="_blank">#2763</a></p>
  419. <p class="p">Whereas the default preprocessing routine handles both maps and topics at the same
  420. time, often switching back and forth between map operations and topic operations, the map-first approach only
  421. begins processing topics after nearly all map processing is complete. This simplifies the processing logic and
  422. creates cleaner module responsibilities, which makes it easier to process only those topics that are actually
  423. referenced after filtering, for example, or to only process the map to validate the map structure.</p>
  424. <div class="note note note_note"><span class="note__title">Note:</span> The map-first preprocessing option is enabled by default in DITA-OT 3.0 for PDF,
  425. HTML Help, and Java Help. These three formats were chosen because they all generate a compiled result file, so
  426. temporarily hashed file names should all be invisible to the build. After further testing and feedback, the new
  427. option will most likely become the default for other output formats in future versions. Because the DITA-OT
  428. development team cannot have access to all varieties of DITA, all edge cases, or even all the ways DITA-OT itself
  429. is extended, the switch to default map-first preprocessing for other output formats will be smoother for
  430. everyone if more people can test and provide feedback.</div>
  431. </section>
  432. </div>
  433. </article>
  434. <article class="topic reference nested1" aria-labelledby="ariaid-title8" id="issues">
  435. <h2 class="title topictitle2" id="ariaid-title8">Resolved issues</h2>
  436. <div class="body refbody">
  437. <section class="section">
  438. <p class="p">In addition to the highlights mentioned above, DITA Open Toolkit Release <span class="keyword">3.0</span> includes
  439. the following changes.</p>
  440. </section>
  441. <section class="section" id="issues__features"><h3 class="title sectiontitle">Features</h3>
  442. <p class="p">DITA Open Toolkit Release <span class="keyword">3.0</span> includes the following new features:</p>
  443. <ul class="ul">
  444. <li class="li" id="issues__1200">A new property named <span class="keyword parmname">args.output.base</span> can be used to control the name of
  445. the output file for transformation types that produce a single output file. The value of the property is the
  446. base file name of the output file, without file extension. The file extension is defined by the
  447. transformation type.
  448. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/1200" target="_blank">#1200</a>
  449. </li>
  450. <li class="li" id="issues__1471">The custom logging implementation used by earlier toolkit versions has been replaced with the
  451. Simple Logging Facade for Java (SLF4J) and the Logback logging framework to better support parameterized log
  452. messages and reduce dependencies on the underlying logging mechanisms.
  453. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/1471" target="_blank">#1471</a>
  454. </li>
  455. <li class="li" id="issues__1551">HTML Help project files are now generated in a temporary directory, so that only the Compiled
  456. HTML Help (.chm) file is returned.
  457. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/1551" target="_blank">#1551</a>
  458. </li>
  459. <li class="li" id="issues__2626">The
  460. <a class="xref" href="../reference/map-first-preprocessing.html" title="DITA-OT 3.0 provides a map-first preprocessing option as an alternative to the default preprocess operation. The method, which was introduced in DITA-OT 2.5 as an experimental feature, has been improved and is ready for use in many production scenarios. Map-first-preprocessing provides the same functionality as the default preprocess, but takes a different approach.">Map-first preprocessing</a> routine has been extended to support subject schemes
  461. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2626" target="_blank">#2626</a>
  462. </li>
  463. <li class="li" id="issues__2766">A new <code class="ph codeph">ant.import</code> extension point has been added to make it easier to add new
  464. targets to the Ant processing pipeline.
  465. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2766" target="_blank">#2766</a>
  466. <div class="note tip note_tip"><span class="note__title">Tip:</span> See
  467. <a class="xref" href="../topics/plugin-anttarget.html" title="As of DITA-OT 3.0, the ant.import extension point can be used to make new targets available to the Ant processing pipeline. This can be done as part of creating a new transformation, extending pre-processing, or simply to make new Ant targets available to other plug-ins.">Adding a new target to the Ant build process</a> for details.</div>
  468. </li>
  469. </ul>
  470. </section>
  471. <section class="section" id="issues__enhancements"><h3 class="title sectiontitle">Enhancements and changes</h3>
  472. <p class="p">DITA Open Toolkit Release <span class="keyword">3.0</span> includes the following enhancements and changes to
  473. existing features:</p>
  474. <ul class="ul">
  475. <li class="li" id="issues__2121">Legacy plug-ins that were removed from the distribution package in earlier releases have been
  476. moved to their own repositories. The following plug-ins have been moved: DocBook, Eclipse Content, Eclipse
  477. map specialization, RTF, ODT, and support for pre-OASIS DITA document types.
  478. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2121" target="_blank">#2121</a>
  479. </li>
  480. <li class="li" id="issues__2232">Use XMLUnit 2
  481. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2232" target="_blank">#2232</a>,
  482. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2723" target="_blank">#2723</a>
  483. </li>
  484. <li class="li" id="issues__2447">Generated link groups in XHTML and HTML5 now use list markup rather than
  485. <code class="keyword markupname xmlelement">&lt;div&gt;</code>, as required to comply with WCAG 2.0 accessibility guidelines.
  486. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2447" target="_blank">#2447</a>
  487. </li>
  488. <li class="li" id="issues__2713">Upgrade Gradle to version 3.5
  489. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2713" target="_blank">#2713</a>
  490. </li>
  491. <li class="li" id="issues__2718">When building PDF from files that do not use <span class="ph filepath">.dita</span> or
  492. <span class="ph filepath">.ditamap</span> extensions, the input file extension (such as <span class="ph filepath">.xml</span>) is
  493. no longer included in the generated PDF file name.
  494. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2718" target="_blank">#2718</a>
  495. </li>
  496. <li class="li" id="issues__2721">Upgrade Saxon-HE to version 9.8
  497. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2721" target="_blank">#2721</a>,
  498. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2727" target="_blank">#2727</a>,
  499. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2822" target="_blank">#2822</a>
  500. </li>
  501. <li class="li" id="issues__2736">Upgrade Apache™ FOP to version 2.2
  502. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2736" target="_blank">#2736</a>
  503. </li>
  504. <li class="li" id="issues__2739">When merging submaps for processing, preserve titles and metadata from the referenced submap so
  505. that they may be used in later processing stages.
  506. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2739" target="_blank">#2739</a>
  507. </li>
  508. <li class="li" id="issues__2748">Add flagging information from DITAVAL during the same step that handles DITAVAL filtering.
  509. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2748" target="_blank">#2748</a>
  510. </li>
  511. <li class="li" id="issues__2755">Allow plug-ins to specify custom parameters of type <code class="ph codeph">url</code>
  512. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2755" target="_blank">#2755</a>
  513. </li>
  514. <li class="li" id="issues__2765">Move or rename Java classes
  515. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2765" target="_blank">#2765</a>
  516. </li>
  517. <li class="li" id="issues__2770">Make it easier for PDF plug-ins or overrides to customize how processing handles the DITA
  518. <code class="keyword markupname xmlatt">@outputclass</code> attribute, such as by mapping it to corresponding XSL:FO attributes.
  519. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2770" target="_blank">#2770</a>
  520. </li>
  521. <li class="li" id="issues__2780">Topics exploded by chunk should be written to the topic folder
  522. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2780" target="_blank">#2780</a>
  523. </li>
  524. <li class="li" id="issues__2781">Move configuration files to a dedicated <span class="ph filepath">config/</span> directory, which ensures
  525. that configuration files and generated files like <span class="ph filepath">messages.xml</span> will not be bundled into
  526. the compiled <span class="ph filepath">dost.jar</span>
  527. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2781" target="_blank">#2781</a>,
  528. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2783" target="_blank">#2783</a>
  529. </li>
  530. <li class="li" id="issues__2784">Allow any attribute to be used for profiling
  531. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2784" target="_blank">#2784</a>
  532. </li>
  533. <li class="li" id="issues__2789">Support language-independent variable files. For variables common to all (or nearly all)
  534. languages, this means we no longer need to maintain an individual copy of the variable for every language.
  535. Plugins may also now define variables that are used by all languages.
  536. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2789" target="_blank">#2789</a>
  537. </li>
  538. <li class="li" id="issues__2808">Use double-hyphen syntax for CLI options in error messages
  539. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2808" target="_blank">#2808</a>
  540. </li>
  541. <li class="li" id="issues__2811">Refactor HTML5 <code class="keyword markupname xmlelement">&lt;simpletable&gt;</code> accessibility to use more modern attributes
  542. to associate table entries with header cells.
  543. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2811" target="_blank">#2811</a>,
  544. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2448" target="_blank">#2448</a>
  545. </li>
  546. </ul>
  547. </section>
  548. <section class="section" id="issues__bugs"><h3 class="title sectiontitle">Bugs</h3>
  549. <p class="p">DITA Open Toolkit Release <span class="keyword">3.0</span> provides fixes for the following bugs:</p>
  550. <ul class="ul">
  551. <li class="li" id="issues__2654">Email links without a scope or format previously generated a NullPointerException. The
  552. <code class="ph codeph">mailto:</code> syntax is now recognized as an email link and will not be read as a file
  553. reference.
  554. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2654" target="_blank">#2654</a>
  555. </li>
  556. <li class="li" id="issues__2742">The wrong language code was previously set when documents set <code class="keyword markupname xmlatt">@xml:lang</code> to the
  557. value <code class="ph codeph">zh-Hans</code>
  558. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2742" target="_blank">#2742</a>
  559. </li>
  560. <li class="li" id="issues__2752">According to the DITA 1.3 specification, when key definitions refer to images, text that would
  561. otherwise become link text should be placed in the images <code class="keyword markupname xmlatt">@alt</code> element as alternative text.
  562. Previously the text was placed directly into the <code class="keyword markupname xmlelement">&lt;image&gt;</code>, which was not valid and
  563. ignored by later processing.
  564. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2752" target="_blank">#2752</a>,
  565. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2814" target="_blank">#2814</a>
  566. </li>
  567. <li class="li" id="issues__2782">In earlier releases, when a <code class="keyword markupname xmlelement">&lt;table&gt;</code> element included too many entries in
  568. a row, FOP would crash during PDF processing. The extra entries are now ignored with an error message.
  569. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2782" target="_blank">#2782</a>
  570. </li>
  571. <li class="li" id="issues__2797">A Java method for generating relative paths failed on Windows when comparing two paths from
  572. different drives. The method has been fixed so that it does not try to construct a relative path between
  573. drives.
  574. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2797" target="_blank">#2797</a>
  575. </li>
  576. <li class="li" id="issues__2807">In HTML5, a DITA <code class="keyword markupname xmlelement">&lt;stepsction&gt;</code> that contained paragraphs resulted in HTML5
  577. <code class="keyword markupname xmlelement">&lt;p&gt;</code> elements that contained <code class="keyword markupname xmlelement">&lt;p&gt;</code>. The
  578. <code class="keyword markupname xmlelement">&lt;stepsection&gt;</code> now generates a <code class="keyword markupname xmlelement">&lt;div&gt;</code> to ensure valid HTML5
  579. output regardless of what it contains.
  580. <a class="xref" href="https://github.com/dita-ot/dita-ot/issues/2807" target="_blank">#2807</a>
  581. </li>
  582. <li class="li" id="issues__2810">An updated errata has been approved for DITA 1.3 that removes default values for
  583. <code class="keyword markupname xmlatt">@rowheader</code> on <code class="keyword markupname xmlelement">&lt;colspec&gt;</code>. The relevant grammar file modules from
  584. OASIS have been updated to include this errata.
  585. <a class="xref" href="https://github.com/dita-ot/dita-ot/pull/2810" target="_blank">#2810</a>
  586. </li>
  587. </ul>
  588. </section>
  589. <section class="section" id="issues__contrib"><h3 class="title sectiontitle">Contributors</h3>
  590. <p class="p">DITA Open Toolkit Release <span class="keyword">3.0</span> includes
  591. <a class="xref" href="https://github.com/dita-ot/dita-ot/graphs/contributors" target="_blank">code contributions</a> by the following people:</p>
  592. <ol class="ol">
  593. <li class="li">Jarno Elovirta</li>
  594. <li class="li">Robert D. Anderson</li>
  595. <li class="li">Roger Sheen</li>
  596. <li class="li">Alexey Mironov</li>
  597. </ol>
  598. <p class="p">For the complete list of changes since the previous release, see the
  599. <a class="xref" href="https://github.com/dita-ot/dita-ot/compare/2.5...3.0" target="_blank">
  600. changelog</a> on GitHub.</p>
  601. </section>
  602. <section class="section" id="issues__docs"><h3 class="title sectiontitle">Documentation updates</h3>
  603. <p class="p">The documentation for DITA Open Toolkit Release <span class="keyword">3.0</span> provides corrections and
  604. improvements to existing topics, along with new information:</p>
  605. <ul class="ul">
  606. <li class="li">The top-level documentation structure has been revised to replace book-based paradigms (<cite class="cite">User
  607. Guide</cite>, <cite class="cite">Developer Reference</cite>) with more task-oriented groupings
  608. <a class="xref" href="https://github.com/dita-ot/docs/issues/121" target="_blank">#121</a>
  609. <ul class="ul">
  610. <li class="li">
  611. <a class="xref" href="../topics/installing-client.html" title="The DITA-OT distribution package can be installed on Linux, macOS, and Windows. It contains everything that you need to run the toolkit except for Java.">Installing the DITA Open Toolkit</a></li>
  612. <li class="li">
  613. <a class="xref" href="../topics/building-output.html" title="You can use either the dita command-line tool or Ant to transform DITA content to the various output formats that are supported by the DITA Open Toolkit.">Building output</a></li>
  614. <li class="li">
  615. <a class="xref" href="../topics/extending-the-ot.html" title="There are several ways to customize and extend the toolkit. You can adjust various aspects of the default output by setting parameters or using custom stylesheets. For more complex customizations, use custom DITA-OT plug-ins to override other parts of processing.">Customizing the DITA Open Toolkit</a></li>
  616. <li class="li">
  617. <a class="xref" href="../topics/troubleshooting-overview.html" title="This section contains information about problems that you might encounter and how to resolve them.">Error messages and troubleshooting</a></li>
  618. </ul>
  619. </li>
  620. <li class="li">New input formats
  621. <a class="xref" href="https://github.com/dita-ot/docs/issues/150" target="_blank">#150</a>
  622. <a class="xref" href="https://github.com/dita-ot/docs/issues/151" target="_blank">#151</a>
  623. <ul class="ul">
  624. <li class="li">
  625. <a class="xref" href="../topics/markdown-input.html" title="Markdown is a lightweight markup language that allows you to write using an easy-to-read plain text format and convert to structurally valid markup as necessary.">Markdown content</a></li>
  626. <li class="li">
  627. <a class="xref" href="../topics/lwdita-input.html" title="DITA-OT provides preview support for the MDITA and HDITA authoring formats proposed for Lightweight DITA, or “LwDITA”. These proposed formats are alternative representations of DITA content in Markdown or HTML.">Preview support for Lightweight DITA</a></li>
  628. </ul></li>
  629. <li class="li">New output formats
  630. <a class="xref" href="https://github.com/dita-ot/docs/issues/152" target="_blank">#152</a>
  631. <ul class="ul">
  632. <li class="li">
  633. <a class="xref" href="../topics/dita2markdown.html" title="Along with Markdown input, DITA-OT now provides three new transformation types to convert DITA content to Markdown, including the original syntax, GitHub-Flavored Markdown, and GitBook.">Markdown</a></li>
  634. <li class="li">
  635. <a class="xref" href="../topics/dita2dita.html" title="The dita transformation generates normalized topics and maps from DITA input. The normalized output includes the results of the DITA Open Toolkit pre-processing operations, which resolve map references, keys, content references, code references and push metadata back and forth between maps and topics.">Normalized DITA</a></li>
  636. </ul>
  637. </li>
  638. <li class="li">
  639. <a class="xref" href="../reference/map-first-preprocessing.html" title="DITA-OT 3.0 provides a map-first preprocessing option as an alternative to the default preprocess operation. The method, which was introduced in DITA-OT 2.5 as an experimental feature, has been improved and is ready for use in many production scenarios. Map-first-preprocessing provides the same functionality as the default preprocess, but takes a different approach.">Map-first preprocessing</a></li>
  640. <li class="li">
  641. <a class="xref" href="../topics/migrating-to-3.0.html" title="DITA-OT 3.0 adds support for Markdown, normalized DITA output, and the alternative authoring formats proposed for Lightweight DITA. The map-first preprocessing approach provides a modern alternative to the default preprocess operation.">Migrating to release 3.0</a></li>
  642. </ul>
  643. <p class="p">For additional information on documentation issues resolved in DITA Open Toolkit Release <span class="keyword">3.0</span>, see the
  644. <a class="xref" href="https://github.com/dita-ot/docs/issues?q=milestone%3A3.0+is%3Aclosed" target="_blank">
  645. <span class="keyword">3.0</span> milestone</a> in the documentation repository.</p>
  646. <p class="p">DITA Open Toolkit Release <span class="keyword">3.0</span> includes
  647. <a class="xref" href="https://github.com/dita-ot/docs/graphs/contributors" target="_blank">documentation contributions</a> by the following people:</p>
  648. <ol class="ol">
  649. <li class="li">Roger Sheen</li>
  650. <li class="li">Robert D. Anderson</li>
  651. <li class="li">Jarno Elovirta</li>
  652. <li class="li">Shane Taylor</li>
  653. <li class="li">Misti Pinter</li>
  654. <li class="li">Garrett Guillotte</li>
  655. <li class="li">Lionel Moizeau</li>
  656. <li class="li">Stefan Eike</li>
  657. </ol>
  658. <p class="p">For the complete list of documentation changes since the previous release, see the
  659. <a class="xref" href="https://github.com/dita-ot/docs/compare/2.5...3.0" target="_blank">
  660. changelog</a>.</p>
  661. </section>
  662. </div>
  663. </article>
  664. </article></main></body></html>