migrating-to-1.5.4.dita 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195
  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="ID" rev="1.5.4">
  5. <title>Migrating to release 1.5.4</title>
  6. <titlealts>
  7. <navtitle>To 1.5.4</navtitle>
  8. </titlealts>
  9. <shortdesc>DITA-OT 1.5.4 adds new extension points to configure behavior based on file extensions, declare print
  10. transformation types and add mappings to the PDF configuration catalog file. PDF output supports mirrored page
  11. layout and uses new font family definitions. Support for several new languages was added for PDF and XHTML
  12. output.</shortdesc>
  13. <prolog>
  14. <metadata>
  15. <keywords>
  16. <indexterm>deprecated features
  17. <indexterm><codeph>print_transtypes</codeph></indexterm></indexterm>
  18. <indexterm>deprecated features
  19. <indexterm><codeph>page-margin-left</codeph></indexterm></indexterm>
  20. <indexterm>deprecated features
  21. <indexterm><codeph>page-margin-right</codeph></indexterm></indexterm>
  22. <indexterm>languages
  23. <indexterm>supported</indexterm></indexterm>
  24. <indexterm>Finnish</indexterm>
  25. <indexterm>Hebrew</indexterm>
  26. <indexterm>Indonesian</indexterm>
  27. <indexterm>Kazakh</indexterm>
  28. <indexterm>Malay</indexterm>
  29. <indexterm>Romanian</indexterm>
  30. <indexterm>Russian</indexterm>
  31. <indexterm>Swedish</indexterm>
  32. <indexterm>I18N
  33. <indexterm><parmname>org.dita.pdf2.i18n.enabled</parmname></indexterm></indexterm>
  34. </keywords>
  35. </metadata>
  36. </prolog>
  37. <refbody>
  38. <section id="section_vc5_gld_g2">
  39. <title>Configuration properties file changes</title>
  40. <p>In previous versions, the <filepath>lib/configuration.properties</filepath> file was generated by the
  41. integration process. Integration has been changed to generate
  42. <filepath>lib/org.dita.dost.platform/plugin.properties</filepath> and the role of the old
  43. <filepath>lib/configuration.properties</filepath> has been changed to contain defaults and configuration
  44. options, such as default language.</p>
  45. <p>The <codeph>dita.plugin.org.dita.*.dir</codeph> properties have been changed to point to the DITA-OT base
  46. directory.</p>
  47. <p>To allow access to configuration files, the <filepath>lib</filepath> directory needs to be added to the Java
  48. classpath.</p>
  49. </section>
  50. <section>
  51. <title>New plug-in extension points </title>
  52. <p>New plug-in extension points have been added allow configuring DITA-OT behavior based on file extensions.</p>
  53. <table outputclass="table-hover" frame="none" colsep="0" rowsep="1">
  54. <tgroup cols="3">
  55. <colspec colwidth="1*"/>
  56. <colspec colwidth="1*"/>
  57. <colspec colwidth="1*"/>
  58. <thead>
  59. <row>
  60. <entry>Extension point</entry>
  61. <entry>Description</entry>
  62. <entry>Default values</entry>
  63. </row>
  64. </thead>
  65. <tbody>
  66. <row>
  67. <entry><parmname>dita.topic.extension</parmname></entry>
  68. <entry>DITA topic</entry>
  69. <entry><filepath>.dita</filepath>, <filepath>.xml</filepath></entry>
  70. </row>
  71. <row>
  72. <entry><parmname>dita.map.extensions</parmname></entry>
  73. <entry>DITA map</entry>
  74. <entry><filepath>.ditamap</filepath></entry>
  75. </row>
  76. <row>
  77. <entry><parmname>dita.html.extensions</parmname></entry>
  78. <entry>HTML file</entry>
  79. <entry><filepath>.html</filepath>, <filepath>.htm</filepath></entry>
  80. </row>
  81. <row>
  82. <entry><parmname>dita.resource.extensions</parmname></entry>
  83. <entry>Resource file</entry>
  84. <entry><filepath>.pdf</filepath>, <filepath>.swf</filepath></entry>
  85. </row>
  86. </tbody>
  87. </tgroup>
  88. </table>
  89. <p>Both HTML and resource file extensions are used to determine if a file in source is copied to output.</p>
  90. <p>A new plug-in extension point has been added to declare transformation types as print types.</p>
  91. <table outputclass="table-hover" frame="none" colsep="0" rowsep="1">
  92. <tgroup cols="2">
  93. <colspec colwidth="1*"/>
  94. <colspec colwidth="1*"/>
  95. <thead>
  96. <row>
  97. <entry>Extension point</entry>
  98. <entry>Description</entry>
  99. </row>
  100. </thead>
  101. <tbody>
  102. <row>
  103. <entry><parmname>dita.transtype.print</parmname></entry>
  104. <entry>Declare transformation type as a print type.</entry>
  105. </row>
  106. </tbody>
  107. </tgroup>
  108. </table>
  109. <p>The <codeph>print_transtypes</codeph> property in <filepath>integrator.properties</filepath> has been
  110. deprecated in favor of <parmname>dita.transtype.print</parmname>.</p>
  111. </section>
  112. <section>
  113. <title>Plugin URI scheme</title>
  114. <p>Support for the <keyword>plugin</keyword> URI scheme has been added to XSLT stylesheets. Plug-ins can refer to
  115. files in other plug-ins without hard-coding relative paths, for example: </p>
  116. <codeblock outputclass="language-xml" xml:space="preserve">&lt;xsl:import href="plugin:org.dita.pdf2:xsl/fo/topic2fo_1.0.xsl"/&gt;</codeblock>
  117. </section>
  118. <section>
  119. <title>XHTML</title>
  120. <p>Support for the following languages has been added:</p>
  121. <ul>
  122. <li>Indonesian</li>
  123. <li>Kazakh</li>
  124. <li>Malay</li>
  125. </ul>
  126. </section>
  127. <section>
  128. <title>PDF</title>
  129. <p>Support for mirrored page layout was added. The default is the unmirrored layout. The following XSLT
  130. configuration variables have been deprecated:</p>
  131. <ul id="ul_hkv_oyj_bd">
  132. <li><codeph>page-margin-left</codeph></li>
  133. <li><codeph>page-margin-right</codeph></li>
  134. </ul>
  135. <p>The following variables should be used instead to control page margins:</p>
  136. <ul id="ul_yda_wyj_bd">
  137. <li><codeph>page-margin-outside</codeph></li>
  138. <li><codeph>page-margin-inside</codeph></li>
  139. </ul>
  140. <p>The <parmname>args.bookmap-order</parmname> property has been added to control how front and back matter are
  141. processed in bookmaps. The default is to reorder the frontmatter content as in previous releases.</p>
  142. <p>A new extension point has been added to add mappings to the PDF configuration catalog file.</p>
  143. <table outputclass="table-hover" frame="none" colsep="0" rowsep="1">
  144. <tgroup cols="2">
  145. <colspec colwidth="1*"/>
  146. <colspec colwidth="1*"/>
  147. <thead>
  148. <row>
  149. <entry>Extension point</entry>
  150. <entry>Description</entry>
  151. </row>
  152. </thead>
  153. <tbody>
  154. <row>
  155. <entry><parmname>org.dita.pdf2.catalog.relative</parmname></entry>
  156. <entry>Configuration catalog includes.</entry>
  157. </row>
  158. </tbody>
  159. </tgroup>
  160. </table>
  161. <p>Support for the following languages has been added:</p>
  162. <ul>
  163. <li>Finnish</li>
  164. <li>Hebrew</li>
  165. <li>Romanian</li>
  166. <li>Russian</li>
  167. <li>Swedish</li>
  168. </ul>
  169. <p>PDF processing no longer copies images or generates XSL FO to output directory. Instead, the temporary
  170. directory is used for all temporary files and source images are read directly from source directory. The legacy
  171. processing model can be enabled by setting <parmname>org.dita.pdf2.use-out-temp</parmname> to
  172. <option>true</option> in configuration properties; support for the legacy processing model may be removed in
  173. future releases.</p>
  174. <p>Support for FrameMaker index syntax has been disabled by default. To enable FrameMaker index syntax, set
  175. <parmname>org.dita.pdf2.index.frame-markup</parmname> to <option>true</option> in configuration
  176. properties.</p>
  177. <p>A configuration option has been added to disable internationalization (I18N) font processing and use
  178. stylesheet-defined fonts. To disable I18N font processing, set <parmname>org.dita.pdf2.i18n.enabled</parmname>
  179. to <codeph>false</codeph> in configuration properties.</p>
  180. <p>The XSLT parameters <parmname>customizationDir</parmname> and <parmname>fileProfilePrefix</parmname> have been
  181. removed in favor of the <parmname>customizationDir.url</parmname> parameter.</p>
  182. <p>A new shell stylesheet has been added for FOP and other shell stylesheets have also been revised. Plug-ins
  183. which have their own shell stylesheets for PDF processing should make sure all required stylesheets are
  184. imported.</p>
  185. <p>Font family definitions in stylesheets have been changed from Sans, Serif, and Monospaced to sans-serif, serif,
  186. and monospace, respectively. The I18N font processing still uses the old logical names and aliases are used to
  187. map the new names to old ones. </p>
  188. </section>
  189. </refbody>
  190. </reference>