migrating-to-3.4.html 10.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  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 2020"><meta name="DC.rights.owner" content="(C) Copyright 2020"><meta name="DC.type" content="reference"><meta name="description" content="DITA-OT 3.4 includes an official Docker container image, a separate plug-in for PDF indexing, a new option to skip HTML5 cover pages, and initial support for project files that allow you to define multiple deliverables in advance, and publish them all at once."><meta name="DC.relation" scheme="URI" content="../topics/migration.html"><meta name="DC.format" content="HTML5"><meta name="DC.identifier" content="migrating-to-3.4"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Migrating to release 3.4</title></head><body id="migrating-to-3.4"><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.5</a></li><li><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/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a><ul><li><a href="../topics/plugin-benefits.html">Plug-in benefits</a></li><li><a href="../topics/plugin-configfile.html">Plug-in descriptor file</a></li><li><a href="../topics/plugin-coding-conventions.html">Coding conventions</a></li><li><a href="../topics/plugin-dependencies.html">Plug-in dependencies</a></li><li><a href="../topics/plugin-use-cases.html">Plug-in use cases</a></li><li><a href="../topics/html-customization-plugins.html">Custom HTML plug-ins</a></li><li><a href="../topics/pdf-customization-plugins.html">Custom PDF plug-ins</a></li><li><a href="../topics/globalization.html">Globalizing DITA content</a></li><li><a href="../topics/migration.html">Migrating customizations</a><ul><li><a href="../topics/migrating-to-3.5.html">To 3.5</a></li><li class="active"><a href="../topics/migrating-to-3.4.html">To 3.4</a></li><li><a href="../topics/migrating-to-3.3.html">To 3.3</a></li><li><a href="../topics/migrating-to-3.2.html">To 3.2</a></li><li><a href="../topics/migrating-to-3.1.html">To 3.1</a></li><li><a href="../topics/migrating-to-3.0.html">To 3.0</a></li><li><a href="../topics/migrating-to-2.5.html">To 2.5</a></li><li><a href="../topics/migrating-to-2.4.html">To 2.4</a></li><li><a href="../topics/migrating-to-2.3.html">To 2.3</a></li><li><a href="../topics/migrating-to-2.2.html">To 2.2</a></li><li><a href="../topics/migrating-to-2.1.html">To 2.1</a></li><li><a href="../topics/migrating-to-2.0.html">To 2.0</a></li><li><a href="../topics/migrating-to-1.8.html">To 1.8</a></li><li><a href="../topics/migrating-to-1.7.html">To 1.7</a></li><li><a href="../topics/migrating-to-1.6.html">To 1.6</a></li><li><a href="../topics/migrating-to-1.5.4.html">To 1.5.4</a></li></ul></li></ul></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">Migrating to release 3.4</h1>
  8. <div class="body refbody"><p class="shortdesc">DITA-OT 3.4 includes <span class="ph" id="migrating-to-3.4__summary">an official Docker container image, a separate plug-in for PDF
  9. indexing, a new option to skip HTML5 cover pages, and initial support for project files that allow you to define
  10. multiple deliverables in advance, and publish them all at once</span>.</p>
  11. <section class="section">
  12. <div class="note note note_note"><span class="note__title">Note:</span> This topic provides a summary of changes in DITA-OT 3.4 that may require modifications to custom stylesheets
  13. or plug-ins. For more information on changes in this release, see the
  14. <a class="xref" href="https://www.dita-ot.org/3.4/release-notes/" target="_blank" rel="external noopener">DITA-OT 3.4 Release Notes</a>.</div>
  15. </section>
  16. <section class="section"><h2 class="title sectiontitle">New indexing plug-in</h2>
  17. <div class="sectiondiv" id="migrating-to-3.4__indexing-plugin">
  18. <p class="p">DITA-OT 3.4 extracts the PDF indexing code to a separate <span class="ph filepath">org.dita.index</span> plug-in, and
  19. adds a new <code class="ph codeph">depend.org.dita.pdf2.index</code> extension point that can be used to add custom index
  20. processing targets to PDF output.</p>
  21. <p class="p">The built-in index processing has been disabled and deprecated. If you have overridden index processing via
  22. the <code class="ph codeph">transform.topic2fo</code> target in the past, you can set the new
  23. <span class="keyword parmname">org.dita.index.skip</span> property to <span class="keyword option">yes</span> and re-enable the
  24. <code class="ph codeph">transform.topic2fo.index</code> target with <code class="keyword markupname xmlelement">&lt;feature
  25. extension="depend.org.dita.pdf2.index" value="transform.topic2fo.index"/&gt;</code> in your plug-in
  26. configuration.</p>
  27. </div>
  28. <table class="table table-hover frame-none"><caption><span class="table--title-label">Table 1. </span><span class="title">New plug-ins</span></caption><colgroup><col style="width:50%"><col style="width:50%"></colgroup><thead class="thead">
  29. <tr class="row">
  30. <th class="entry colsep-0 rowsep-1" id="migrating-to-3.4__entry__1">Plug-in </th>
  31. <th class="entry colsep-0 rowsep-1" id="migrating-to-3.4__entry__2">Source code location</th>
  32. </tr>
  33. </thead><tbody class="tbody">
  34. <tr class="row">
  35. <td class="entry colsep-0 rowsep-1" headers="migrating-to-3.4__entry__1">org.dita.index</td>
  36. <td class="entry colsep-0 rowsep-1" headers="migrating-to-3.4__entry__2">
  37. <a class="xref" href="https://github.com/dita-ot/org.dita.index" target="_blank" rel="external noopener">https://github.com/dita-ot/org.dita.index</a></td>
  38. </tr>
  39. </tbody></table>
  40. </section>
  41. <section class="section" id="migrating-to-3.4__34-legacy-plugin-removal"><h2 class="title sectiontitle">Legacy plug-ins removed</h2>
  42. <p class="p">DITA-OT 3.4 no longer includes the following legacy transformation plug-ins in the default distribution:</p>
  43. <table class="table table-hover frame-none"><caption><span class="table--title-label">Table 2. </span><span class="title">Legacy plug-ins</span></caption><colgroup><col style="width:50%"><col style="width:50%"></colgroup><thead class="thead">
  44. <tr class="row">
  45. <th class="entry colsep-0 rowsep-1" id="migrating-to-3.4__34-legacy-plugin-removal__entry__1">Plug-in </th>
  46. <th class="entry colsep-0 rowsep-1" id="migrating-to-3.4__34-legacy-plugin-removal__entry__2">Source code location</th>
  47. </tr>
  48. </thead><tbody class="tbody">
  49. <tr class="row">
  50. <td class="entry colsep-0 rowsep-1" headers="migrating-to-3.4__34-legacy-plugin-removal__entry__1">TocJS</td>
  51. <td class="entry colsep-0 rowsep-1" headers="migrating-to-3.4__34-legacy-plugin-removal__entry__2">
  52. <a class="xref" href="https://github.com/dita-ot/com.sophos.tocjs" target="_blank" rel="external noopener">https://github.com/dita-ot/com.sophos.tocjs</a></td>
  53. </tr>
  54. <tr class="row">
  55. <td class="entry colsep-0 rowsep-1" headers="migrating-to-3.4__34-legacy-plugin-removal__entry__1">troff</td>
  56. <td class="entry colsep-0 rowsep-1" headers="migrating-to-3.4__34-legacy-plugin-removal__entry__2">
  57. <a class="xref" href="https://github.com/dita-ot/org.dita.troff" target="_blank" rel="external noopener">https://github.com/dita-ot/org.dita.troff</a></td>
  58. </tr>
  59. </tbody></table>
  60. <div class="note note note_note"><span class="note__title">Note:</span> If necessary, legacy plug-ins may be re-installed from earlier DITA-OT
  61. distributions, but they are no longer actively maintained or supported by the core toolkit committers. The
  62. source code is available on GitHub for anyone interested in maintaining the plug-ins for use with future toolkit
  63. versions.</div>
  64. <p class="p">To re-install the plug-in(s) from the plug-in registry at
  65. <a class="xref" href="https://www.dita-ot.org/plugins" target="_blank" rel="external noopener">dita-ot.org/plugins</a>, run the following command(s):</p>
  66. <pre class="pre codeblock"><code><span class="keyword cmdname">dita</span> <span class="keyword parmname">--install</span>=<span class="ph filepath">com.sophos.tocjs</span>
  67. <span class="keyword cmdname">dita</span> <span class="keyword parmname">--install</span>=<span class="ph filepath">org.dita.troff</span></code></pre>
  68. </section>
  69. </div>
  70. <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../topics/migration.html" title="If you have XSL transformation overrides, plug-ins or other customizations written prior to DITA-OT 3.5, you may need to make changes to ensure your overrides work properly with the latest toolkit versions.">Migrating customizations</a></div></div></nav></article></main></body></html>