migrating-to-2.2.dita 5.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  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.2">
  5. <title>Migrating to release 2.2</title>
  6. <titlealts>
  7. <navtitle>To 2.2</navtitle>
  8. </titlealts>
  9. <shortdesc>In DITA-OT 2.2, the <option>HTML5</option> transformation was refactored as its own plug-in and separate
  10. plug-ins were created for each of the rendering engine-specific PDF transformations.<draft-comment author="staylor">
  11. There are likely other changes that should be noted here. </draft-comment>
  12. </shortdesc>
  13. <prolog>
  14. <metadata>
  15. <keywords>
  16. <indexterm><xmlelement>toc</xmlelement></indexterm>
  17. <indexterm><xmlelement>preface</xmlelement></indexterm>
  18. <indexterm><xmlelement>frontmatter</xmlelement></indexterm>
  19. <indexterm><xmlelement>bookmap</xmlelement></indexterm>
  20. <indexterm>deprecated features<indexterm><codeph>.notetitle</codeph> classes</indexterm></indexterm>
  21. <indexterm>deprecated features<indexterm><parmname>user.input.file</parmname></indexterm></indexterm>
  22. <indexterm>deprecated features<indexterm><parmname>user.input.dir</parmname></indexterm></indexterm>
  23. <indexterm>deprecated features<indexterm><parmname>InputMapDir</parmname></indexterm></indexterm>
  24. <indexterm>RenderX<indexterm>plug-in</indexterm></indexterm>
  25. <indexterm>Antenna House<indexterm>plug-in</indexterm></indexterm>
  26. <indexterm>Apache FOP<indexterm>plug-in</indexterm></indexterm>
  27. <indexterm>table of contents<indexterm>PDF</indexterm></indexterm>
  28. </keywords>
  29. </metadata>
  30. </prolog>
  31. <refbody>
  32. <section>
  33. <note>This topic provides a summary of changes in DITA-OT 2.2 that may require modifications to custom stylesheets
  34. or plug-ins. For more information on changes in this release, see the <xref keyref="2.2-release-notes"/>.</note>
  35. </section>
  36. <section>
  37. <title>HTML5</title>
  38. <p>The <option>HTML5</option> transformation introduced in release 2.0 as part of the <option>XHTML</option>
  39. plug-in has been moved to a separate <option>HTML5</option> plug-in. Customizations that extended the previous
  40. HTML5 output under the <option>XHTML</option> plug-in will probably need to be refactored on the new HTML5
  41. plug-in.</p>
  42. <p>Note title processing has been revised to use a common <codeph>note__title</codeph> class for note elements of
  43. all types. The legacy <codeph><varname>{$type}</varname>title</codeph> classes (such as
  44. <codeph>.notetitle</codeph>, <codeph>.cautiontitle</codeph>, <codeph>.tiptitle</codeph>, etc.) are included
  45. for backwards compatibility, but are deprecated and will be removed in an upcoming release. Stylesheets that
  46. apply formatting overrides to note titles should be revised to replace the deprecated class selectors with the
  47. equivalent descendant selectors, for example <codeph>.note_note .note__title</codeph>, <codeph>.note_caution
  48. .note__title</codeph>, <codeph>.note_tip .note__title</codeph>, etc.</p>
  49. </section>
  50. <section>
  51. <title>PDF</title>
  52. <p>Processing specific to Apache FOP, Antenna House Formatter, and RenderX XEP has been separated into separate
  53. plug-ins for each of those rendering engines. Customizations that extended this processing might need to extend
  54. the new <codeph>org.dita.pdf2.fop</codeph>, <codeph>org.dita.pdf2.axf</codeph>, or
  55. <codeph>org.dita.pdf2.xep</codeph> plug-ins.</p>
  56. <p>PDF customizations that are not specific to a rendering engine can continue to extend the
  57. <codeph>org.dita.pdf2</codeph> plug-in as before.</p>
  58. <p>The default format for page numbers in the table of contents (<xmlelement>toc</xmlelement>) was switched to
  59. roman to align with <xmlelement>preface</xmlelement> and ensure consistent numbering styles for all
  60. <xmlelement>frontmatter</xmlelement> components in <xmlelement>bookmap</xmlelement>. This prevents numbering
  61. from switching back and forth between styles in bookmaps where the Preface follows the table of contents.
  62. Earlier versions of DITA-OT produced numbering sequences like <codeph>1,2,3,4,v,vi,7,8</codeph> in this use
  63. case.</p>
  64. </section>
  65. <section>
  66. <title>Deprecated properties</title>
  67. <p>The following Ant properties have been deprecated:
  68. <ul>
  69. <li><parmname>user.input.file</parmname>, use <parmname>user.input.file.uri</parmname> instead to specify the
  70. input file system path</li>
  71. <li><parmname>user.input.dir</parmname>, use <parmname>user.input.dir.uri</parmname> instead to specify the
  72. input directory system path</li>
  73. <li><parmname>InputMapDir</parmname>, use <parmname>InputMapDir.uri</parmname> instead to specify the input
  74. map directory system path</li>
  75. </ul></p>
  76. </section>
  77. </refbody>
  78. </reference>