migrating-to-3.3.dita 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  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.3">
  5. <title>Migrating to release 3.3</title>
  6. <titlealts>
  7. <navtitle>To 3.3</navtitle>
  8. </titlealts>
  9. <shortdesc>DITA-OT 3.3 includes <ph id="summary">new attribute sets for HTML5 customization, support for custom
  10. integration processing, rotated table cells in PDF output, and hazard statements in HTML output</ph>.</shortdesc>
  11. <prolog>
  12. <metadata>
  13. <keywords>
  14. <indexterm>security</indexterm>
  15. <indexterm>TLS</indexterm>
  16. <indexterm>registry</indexterm>
  17. <indexterm>tables<indexterm>PDF</indexterm></indexterm>
  18. </keywords>
  19. </metadata>
  20. </prolog>
  21. <refbody>
  22. <section>
  23. <note>This topic provides a summary of changes in DITA-OT 3.3 that may require modifications to custom stylesheets
  24. or plug-ins. For more information on changes in this release, see the
  25. <xref keyref="3.3-release-notes"/>.</note>
  26. </section>
  27. <section>
  28. <title>Secure connections to the plug-in registry</title>
  29. <note type="attention">To ensure data integrity during the plug-in installation process, Transport Layer Security
  30. (TLS) will soon be required to access the plug-in registry. If you are using DITA-OT 3.3, 3.2, or 3.2.1 and are
  31. unable to upgrade to the latest version, modify the <codeph>registry</codeph> key in the
  32. <filepath>config/configuration.properties</filepath> file to switch the URI schema to
  33. <codeph>http<b>s</b>://</codeph>, so the entry reads <codeph>https://plugins.dita-ot.org/</codeph>.</note>
  34. <p>For more information, see
  35. <xref keyref="plugins-registry"/>.</p>
  36. </section>
  37. <section>
  38. <title>Base plug-in files moved to <filepath>plugins</filepath> directory</title>
  39. <div outputclass="div-index">
  40. <indexterm><xmlelement>xsl:include</xmlelement></indexterm>
  41. <indexterm><xmlelement>xsl:import</xmlelement></indexterm>
  42. </div>
  43. <p>Various XSLT files and other resources have been moved from the root of the DITA-OT installation directory to
  44. the base plug-in directory <filepath>plugins/org.dita.base</filepath>.</p>
  45. <note type="attention">There is no longer an <filepath>xsl/</filepath> directory in the installation root.</note>
  46. <p>If your plug-ins use the <codeph>plugin</codeph> URI scheme as recommended in the
  47. <xref keyref="plugin-coding-conventions"/>, this change should not require any modifications to custom plug-in
  48. code:</p>
  49. <lq>
  50. <p>In XSLT, use the <codeph>plugin</codeph> URI scheme in <xmlelement>xsl:import</xmlelement> and
  51. <xmlelement>xsl:include</xmlelement> to reference files in other plug-ins.</p>
  52. <p>Instead of:</p>
  53. <p><codeblock outputclass="language-xml">&lt;xsl:import href="../../org.dita.base/xsl/common/output-message.xsl"/></codeblock></p>
  54. <p>use:</p>
  55. <p><codeblock outputclass="language-xml">&lt;xsl:import href="plugin:org.dita.base:xsl/common/output-message.xsl"/></codeblock></p>
  56. <p>As with the plug-in directory property in Ant, this allows plug-ins to resolve to the correct directory even
  57. when a plug-in moves to a new location. The plug-in is referenced using the syntax
  58. <codeph>plugin:<varname>plugin-id</varname>:<varname>path/within/plugin/file.xsl</varname></codeph>.</p>
  59. </lq>
  60. </section>
  61. <section>
  62. <title>Relocated catalog</title>
  63. <div outputclass="div-index">
  64. <indexterm><xmlelement>nextCatalog</xmlelement></indexterm>
  65. <indexterm>catalog<indexterm>location</indexterm></indexterm>
  66. </div>
  67. <p>
  68. <ph id="catalog">Along with the other base plug-in files, the <filepath>catalog-dita.xml</filepath> file has
  69. been moved from the root of the DITA-OT installation directory to <filepath>plugins/org.dita.base</filepath>.
  70. External systems that rely on this catalog should be updated with the new location. Ant scripts and DITA-OT
  71. plug-ins should use the plug-in directory property to refer to the file as
  72. <codeph>${dita.plugin.org.dita.base.dir}/catalog-dita.xml</codeph>. A placeholder with a
  73. <xmlelement>nextCatalog</xmlelement> entry is provided in the original location for backwards compatibility,
  74. but this file may be removed in an upcoming release.</ph></p>
  75. <fig>
  76. <title>Legacy catalog placeholder content</title>
  77. <codeblock outputclass="language-xml">&lt;nextCatalog catalog="plugins/org.dita.base/catalog-dita.xml"/></codeblock>
  78. </fig>
  79. </section>
  80. <section>
  81. <title>Deprecated properties</title>
  82. <div outputclass="div-index">
  83. <indexterm><xmlelement>template</xmlelement></indexterm>
  84. <indexterm>deprecated features<indexterm><filepath>plugin.xml</filepath>, <codeph>templates</codeph>
  85. key</indexterm></indexterm>
  86. </div>
  87. <p><ph id="templates">The <codeph>templates</codeph> key in configuration properties has been deprecated in favor
  88. of the <xmlelement>template</xmlelement> element in <filepath>plugin.xml</filepath>.</ph></p>
  89. </section>
  90. <section>
  91. <title>New attribute sets for HTML5 customization</title>
  92. <div outputclass="div-index">
  93. <indexterm>Bootstrap</indexterm>
  94. <indexterm>CSS<indexterm>HTML5</indexterm></indexterm>
  95. <indexterm>HTML5<indexterm>CSS</indexterm></indexterm>
  96. </div>
  97. <p id="html5-att-sets">A series of new attribute sets has been added to the default HTML5 transformation to
  98. facilitate customization with additional ARIA roles, attributes, or CSS classes. Attribute sets are provided
  99. for:
  100. <ul>
  101. <li><codeph>article</codeph></li>
  102. <li><codeph>banner</codeph></li>
  103. <li><codeph>footer</codeph></li>
  104. <li><codeph>main</codeph></li>
  105. <li><codeph>navigation</codeph></li>
  106. <li><codeph>toc</codeph></li>
  107. </ul>If you have previously copied XSL templates (or template modes) to custom plug-ins only to add classes
  108. required by web frameworks such as Bootstrap or Foundation (or your company CSS), you may be able to simplify
  109. your customizations by using the new attribute sets instead of overriding the default templates.</p>
  110. </section>
  111. </refbody>
  112. </reference>