migrating-to-2.4.dita 4.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  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-2.4">
  5. <title>Migrating to release 2.4</title>
  6. <titlealts>
  7. <navtitle>To 2.4</navtitle>
  8. </titlealts>
  9. <shortdesc>In DITA-OT 2.4, the <option>HTML5</option> transformation was refactored as an independent plug-in that no
  10. longer depends on the <option>XHTML</option> plug-in. </shortdesc>
  11. <refbody>
  12. <section>
  13. <note>This topic provides a summary of changes in DITA-OT 2.4 that may require modifications to custom stylesheets
  14. or plug-ins. For more information on changes in this release, see the
  15. <xref keyref="2.4-release-notes"/>.</note>
  16. </section>
  17. <section>
  18. <title>HTML5</title>
  19. <ul>
  20. <li>
  21. <div id="24-html5-split">
  22. <p>The <option>HTML5</option> transformation introduced in release 2.0 as part of the <option>XHTML</option>
  23. plug-in was moved to a separate <option>HTML5</option> plug-in in release 2.2, but that version of the
  24. <option>HTML5</option> transformation still depended on the <option>XHTML</option> plug-in for certain
  25. common processing.</p>
  26. <p>In release 2.4, all dependencies between <option>HTML5</option> and <option>XHTML</option> have been
  27. removed to ensure that HTML5 processing can be further refactored in the future without affecting XHTML
  28. output, or other HTML-based transformations such as <option>eclipsehelp</option>,
  29. <option>htmlhelp</option> or <option>javahelp</option>.</p>
  30. </div>
  31. <p>Customizations that extended the previous HTML5 output under the <option>XHTML</option> plug-in (as
  32. provided in releases 2.0 and 2.1) or the <option>HTML5</option> plug-in that shipped with release 2.2 will
  33. need to be refactored to build on the new HTML5 plug-in.</p></li>
  34. <li>
  35. <p>Note title processing was revised in release 2.2 to include a common <codeph>note__title</codeph> class for
  36. note elements of all types. The legacy <codeph><varname>{$type}</varname>title</codeph> classes (such as
  37. <codeph>.notetitle</codeph>, <codeph>.cautiontitle</codeph>, <codeph>.tiptitle</codeph>, etc.) were
  38. included in release 2.2 for backwards compatibility, but have now been removed in release 2.4.</p>
  39. <p>Stylesheets that apply formatting overrides to note titles should be revised to replace the deprecated
  40. class selectors with the equivalent descendant selectors, for example:</p>
  41. <ul>
  42. <li><codeph>.note_note .note__title</codeph></li>
  43. <li><codeph>.note_caution .note__title</codeph></li>
  44. <li><codeph>.note_tip .note__title</codeph></li>
  45. </ul>
  46. </li>
  47. </ul>
  48. </section>
  49. <section id="24-legacy-plugin-removal">
  50. <title>Legacy plug-ins removed</title>
  51. <p>DITA-OT 2.4 no longer includes the following legacy transformation plug-ins in the default distribution:</p>
  52. <table frame="none" rowsep="1" colsep="0">
  53. <title>Legacy plug-ins</title>
  54. <tgroup cols="2">
  55. <colspec colname="c1" colnum="1" colwidth="1.0*"/>
  56. <colspec colname="c2" colnum="2" colwidth="1.0*"/>
  57. <thead>
  58. <row>
  59. <entry>Plug-in </entry>
  60. <entry>Source code location</entry>
  61. </row>
  62. </thead>
  63. <tbody>
  64. <row>
  65. <entry>DocBook</entry>
  66. <entry>
  67. <xref href="https://github.com/dita-ot/org.dita.docbook" format="html" scope="external"/></entry>
  68. </row>
  69. <row>
  70. <entry>Eclipse Content</entry>
  71. <entry>
  72. <xref href="https://github.com/dita-ot/org.dita.eclipsecontent" format="html" scope="external"/></entry>
  73. </row>
  74. <row>
  75. <entry>OpenDocument Text</entry>
  76. <entry>
  77. <xref href="https://github.com/dita-ot/org.dita.odt" format="odt" scope="external"/></entry>
  78. </row>
  79. <row>
  80. <entry>Word RTF</entry>
  81. <entry>
  82. <xref href="https://github.com/dita-ot/org.dita.wordrtf" format="html" scope="external"/></entry>
  83. </row>
  84. </tbody>
  85. </tgroup>
  86. </table>
  87. <note>If necessary, legacy plug-ins may be re-installed from earlier DITA-OT distributions, but they are no longer
  88. actively maintained or supported by the core toolkit committers. The source code is available on GitHub for
  89. anyone interested in maintaining the plug-ins for use with future toolkit versions.</note>
  90. </section>
  91. </refbody>
  92. </reference>