migrating-to-3.4.dita 4.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  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="migrating-to-3.4">
  5. <title>Migrating to release 3.4</title>
  6. <titlealts>
  7. <navtitle>To 3.4</navtitle>
  8. </titlealts>
  9. <shortdesc>DITA-OT 3.4 includes <ph id="summary">an official Docker container image, a separate plug-in for PDF
  10. indexing, a new option to skip HTML5 cover pages, and initial support for project files that allow you to define
  11. multiple deliverables in advance, and publish them all at once</ph>.</shortdesc>
  12. <refbody>
  13. <section>
  14. <note>This topic provides a summary of changes in DITA-OT 3.4 that may require modifications to custom stylesheets
  15. or plug-ins. For more information on changes in this release, see the
  16. <xref keyref="3.4-release-notes"/>.</note>
  17. </section>
  18. <section>
  19. <title>New indexing plug-in</title>
  20. <sectiondiv id="indexing-plugin">
  21. <p>DITA-OT 3.4 extracts the PDF indexing code to a separate <filepath>org.dita.index</filepath> plug-in, and
  22. adds a new <codeph>depend.org.dita.pdf2.index</codeph> extension point that can be used to add custom index
  23. processing targets to PDF output.</p>
  24. <p>The built-in index processing has been disabled and deprecated. If you have overridden index processing via
  25. the <codeph>transform.topic2fo</codeph> target in the past, you can set the new
  26. <parmname>org.dita.index.skip</parmname> property to <option>yes</option> and re-enable the
  27. <codeph>transform.topic2fo.index</codeph> target with <xmlelement>feature
  28. extension="depend.org.dita.pdf2.index" value="transform.topic2fo.index"/</xmlelement> in your plug-in
  29. configuration.</p>
  30. </sectiondiv>
  31. <table outputclass="table-hover" frame="none" colsep="0" rowsep="1">
  32. <title>New plug-ins</title>
  33. <tgroup cols="2">
  34. <colspec colwidth="1*"/>
  35. <colspec colwidth="1*"/>
  36. <thead>
  37. <row>
  38. <entry>Plug-in </entry>
  39. <entry>Source code location</entry>
  40. </row>
  41. </thead>
  42. <tbody>
  43. <row>
  44. <entry>org.dita.index</entry>
  45. <entry>
  46. <xref href="https://github.com/dita-ot/org.dita.index" format="html" scope="external"/></entry>
  47. </row>
  48. </tbody>
  49. </tgroup>
  50. </table>
  51. </section>
  52. <section id="34-legacy-plugin-removal">
  53. <title>Legacy plug-ins removed</title>
  54. <indexterm>TocJS</indexterm>
  55. <indexterm>deprecated features
  56. <indexterm>TocJS plug-in</indexterm></indexterm>
  57. <indexterm>plug-ins
  58. <indexterm>TocJS</indexterm></indexterm>
  59. <p>DITA-OT 3.4 no longer includes the following legacy transformation plug-ins in the default distribution:</p>
  60. <table outputclass="table-hover" frame="none" colsep="0" rowsep="1">
  61. <title>Legacy plug-ins</title>
  62. <tgroup cols="2">
  63. <colspec colwidth="1*"/>
  64. <colspec colwidth="1*"/>
  65. <thead>
  66. <row>
  67. <entry>Plug-in </entry>
  68. <entry>Source code location</entry>
  69. </row>
  70. </thead>
  71. <tbody>
  72. <row>
  73. <entry>TocJS</entry>
  74. <entry>
  75. <xref href="https://github.com/dita-ot/com.sophos.tocjs" format="html" scope="external"/></entry>
  76. </row>
  77. <row>
  78. <entry>troff</entry>
  79. <entry>
  80. <xref href="https://github.com/dita-ot/org.dita.troff" format="html" scope="external"/></entry>
  81. </row>
  82. </tbody>
  83. </tgroup>
  84. </table>
  85. <note conkeyref="reusable-components/legacy-plugins-note"/>
  86. <p>To re-install the plug-in(s) from the plug-in registry at
  87. <xref keyref="site-plugin-registry"/>, run the following command(s):</p>
  88. <codeblock><cmdname>dita</cmdname> <parmname>--install</parmname>=<filepath>com.sophos.tocjs</filepath>
  89. <cmdname>dita</cmdname> <parmname>--install</parmname>=<filepath>org.dita.troff</filepath></codeblock>
  90. </section>
  91. </refbody>
  92. </reference>