migrating-to-2.4.dita 5.5 KB

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