migrating-to-2.4.dita 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  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. <prolog>
  12. <metadata>
  13. <keywords>
  14. <indexterm>deprecated features
  15. <indexterm><codeph>.notetitle</codeph> classes</indexterm></indexterm>
  16. <indexterm>GitHub</indexterm>
  17. </keywords>
  18. </metadata>
  19. </prolog>
  20. <refbody>
  21. <section>
  22. <note>This topic provides a summary of changes in DITA-OT 2.4 that may require modifications to custom stylesheets
  23. or plug-ins. For more information on changes in this release, see the
  24. <xref keyref="2.4-release-notes"/>.</note>
  25. </section>
  26. <section>
  27. <title>HTML5</title>
  28. <ul>
  29. <li>
  30. <div id="24-html5-split">
  31. <p>The <option>HTML5</option> transformation introduced in release 2.0 as part of the <option>XHTML</option>
  32. plug-in was moved to a separate <option>HTML5</option> plug-in in release 2.2, but that version of the
  33. <option>HTML5</option> transformation still depended on the <option>XHTML</option> plug-in for certain
  34. common processing.</p>
  35. <p>In release 2.4, all dependencies between <option>HTML5</option> and <option>XHTML</option> have been
  36. removed to ensure that HTML5 processing can be further refactored in the future without affecting XHTML
  37. output, or other HTML-based transformations such as <option>eclipsehelp</option>,
  38. <option>htmlhelp</option> or <option>javahelp</option>.</p>
  39. </div>
  40. <p>Customizations that extended the previous HTML5 output under the <option>XHTML</option> plug-in (as
  41. provided in releases 2.0 and 2.1) or the <option>HTML5</option> plug-in that shipped with release 2.2 will
  42. need to be refactored to build on the new HTML5 plug-in.</p></li>
  43. <li>
  44. <p>Note title processing was revised in release 2.2 to include a common <codeph>note__title</codeph> class for
  45. note elements of all types. The legacy <codeph><varname>{$type}</varname>title</codeph> classes (such as
  46. <codeph>.notetitle</codeph>, <codeph>.cautiontitle</codeph>, <codeph>.tiptitle</codeph>, etc.) were
  47. included in release 2.2 for backwards compatibility, but have now been removed in release 2.4.</p>
  48. <p>Stylesheets that apply formatting overrides to note titles should be revised to replace the deprecated
  49. class selectors with the equivalent descendant selectors, for example:</p>
  50. <ul>
  51. <li><codeph>.note_note .note__title</codeph></li>
  52. <li><codeph>.note_caution .note__title</codeph></li>
  53. <li><codeph>.note_tip .note__title</codeph></li>
  54. </ul>
  55. </li>
  56. </ul>
  57. </section>
  58. <section id="24-legacy-plugin-removal">
  59. <title>Legacy plug-ins removed</title>
  60. <indexterm>DocBook</indexterm>
  61. <indexterm>Eclipse Content</indexterm>
  62. <indexterm>OpenDocument Text</indexterm>
  63. <indexterm>RTF</indexterm>
  64. <indexterm>plug-ins
  65. <indexterm>DocBook</indexterm></indexterm>
  66. <indexterm>plug-ins
  67. <indexterm>Eclipse Content</indexterm></indexterm>
  68. <indexterm>plug-ins
  69. <indexterm>OpenDocument Text</indexterm></indexterm>
  70. <indexterm>plug-ins
  71. <indexterm>RTF</indexterm></indexterm>
  72. <p>DITA-OT 2.4 no longer includes the following legacy transformation plug-ins in the default distribution:</p>
  73. <table outputclass="table-hover" frame="none" colsep="0" rowsep="1">
  74. <title>Legacy plug-ins</title>
  75. <tgroup cols="2">
  76. <colspec colwidth="1*"/>
  77. <colspec colwidth="1*"/>
  78. <thead>
  79. <row>
  80. <entry>Plug-in </entry>
  81. <entry>Source code location</entry>
  82. </row>
  83. </thead>
  84. <tbody>
  85. <row>
  86. <entry>DocBook</entry>
  87. <entry>
  88. <xref href="https://github.com/dita-ot/org.dita.docbook" format="html" scope="external"/></entry>
  89. </row>
  90. <row>
  91. <entry>Eclipse Content</entry>
  92. <entry>
  93. <xref href="https://github.com/dita-ot/org.dita.eclipsecontent" format="html" scope="external"/></entry>
  94. </row>
  95. <row>
  96. <entry>OpenDocument Text</entry>
  97. <entry>
  98. <xref href="https://github.com/dita-ot/org.dita.odt" format="odt" scope="external"/></entry>
  99. </row>
  100. <row>
  101. <entry>Word RTF</entry>
  102. <entry>
  103. <xref href="https://github.com/dita-ot/org.dita.wordrtf" format="html" scope="external"/></entry>
  104. </row>
  105. </tbody>
  106. </tgroup>
  107. </table>
  108. <note conkeyref="reusable-components/legacy-plugins-note"/>
  109. </section>
  110. </refbody>
  111. </reference>