migrating-to-1.5.4.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  1. <!DOCTYPE html
  2. SYSTEM "about:legacy-compat">
  3. <html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2019"><meta name="DC.rights.owner" content="(C) Copyright 2019"><meta name="DC.type" content="reference"><meta name="description" content="DITA-OT 1.5.4 adds new extension points to configure behavior based on file extensions, declare print transformation types and add mappings to the PDF configuration catalog file. PDF output supports mirrored page layout and uses new font family definitions. Support for several new languages was added for PDF and XHTML output."><meta name="DC.subject" content="deprecated features, print_transtypes, page-margin-left, page-margin-right, languages, supported, Finnish, Hebrew, Indonesian, Kazakh, Malay, Romanian, Russian, Swedish, I18N, org.dita.pdf2.i18n.enabled"><meta name="keywords" content="deprecated features, print_transtypes, page-margin-left, page-margin-right, languages, supported, Finnish, Hebrew, Indonesian, Kazakh, Malay, Romanian, Russian, Swedish, I18N, org.dita.pdf2.i18n.enabled"><meta name="DC.relation" scheme="URI" content="../topics/migration.html"><meta name="DC.format" content="HTML5"><meta name="DC.identifier" content="ID"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Migrating to release 1.5.4</title></head><body id="ID"><header role="banner"><div class="header">
  4. <p>DITA Open Toolkit</p>
  5. <hr>
  6. </div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.3</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/alternative-input-formats.html">Authoring formats</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../parameters/index.html">Setting parameters</a></li><li><a href="../topics/customizing.html">Customizing DITA-OT</a><ul><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/custom-plugins.html">Working with plug-ins</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../topics/migration.html">Migrating customizations</a><ul><li><a href="../topics/migrating-to-3.3.html">To 3.3</a></li><li><a href="../topics/migrating-to-3.2.html">To 3.2</a></li><li><a href="../topics/migrating-to-3.1.html">To 3.1</a></li><li><a href="../topics/migrating-to-3.0.html">To 3.0</a></li><li><a href="../topics/migrating-to-2.5.html">To 2.5</a></li><li><a href="../topics/migrating-to-2.4.html">To 2.4</a></li><li><a href="../topics/migrating-to-2.3.html">To 2.3</a></li><li><a href="../topics/migrating-to-2.2.html">To 2.2</a></li><li><a href="../topics/migrating-to-2.1.html">To 2.1</a></li><li><a href="../topics/migrating-to-2.0.html">To 2.0</a></li><li><a href="../topics/migrating-to-1.8.html">To 1.8</a></li><li><a href="../topics/migrating-to-1.7.html">To 1.7</a></li><li><a href="../topics/migrating-to-1.6.html">To 1.6</a></li><li class="active"><a href="../topics/migrating-to-1.5.4.html">To 1.5.4</a></li></ul></li><li><a href="../topics/globalization.html">Globalizing DITA content</a></li><li><a href="../topics/rebuilding-docs.html">Rebuilding documentation</a></li></ul></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
  7. <h1 class="title topictitle1" id="ariaid-title1">Migrating to release 1.5.4</h1>
  8. <div class="body refbody"><p class="shortdesc">DITA-OT 1.5.4 adds new extension points to configure behavior based on file extensions, declare print
  9. transformation types and add mappings to the PDF configuration catalog file. PDF output supports mirrored page
  10. layout and uses new font family definitions. Support for several new languages was added for PDF and XHTML
  11. output.</p>
  12. <section class="section" id="ID__section_vc5_gld_g2"><h2 class="title sectiontitle">Configuration properties file changes</h2>
  13. <p class="p">In previous versions, the <span class="ph filepath">lib/configuration.properties</span> file was generated by the
  14. integration process. Integration has been changed to generate
  15. <span class="ph filepath">lib/org.dita.dost.platform/plugin.properties</span> and the role of the old
  16. <span class="ph filepath">lib/configuration.properties</span> has been changed to contain defaults and configuration
  17. options, such as default language.</p>
  18. <p class="p">The <code class="ph codeph">dita.plugin.org.dita.*.dir</code> properties have been changed to point to the DITA-OT base
  19. directory.</p>
  20. <p class="p">To allow access to configuration files, the <span class="ph filepath">lib</span> directory needs to be added to the Java
  21. classpath.</p>
  22. </section>
  23. <section class="section"><h2 class="title sectiontitle">New plug-in extension points </h2>
  24. <p class="p">New plug-in extension points have been added allow configuring DITA-OT behavior based on file extensions.</p>
  25. <table class="table table-hover frame-none"><caption></caption><colgroup><col style="width:33.33333333333333%"><col style="width:33.33333333333333%"><col style="width:33.33333333333333%"></colgroup><thead class="thead">
  26. <tr class="row">
  27. <th class="entry colsep-0 rowsep-1" id="ID__entry__1">Extension point</th>
  28. <th class="entry colsep-0 rowsep-1" id="ID__entry__2">Description</th>
  29. <th class="entry colsep-0 rowsep-1" id="ID__entry__3">Default values</th>
  30. </tr>
  31. </thead><tbody class="tbody">
  32. <tr class="row">
  33. <td class="entry colsep-0 rowsep-1" headers="ID__entry__1"><span class="keyword parmname">dita.topic.extension</span></td>
  34. <td class="entry colsep-0 rowsep-1" headers="ID__entry__2">DITA topic</td>
  35. <td class="entry colsep-0 rowsep-1" headers="ID__entry__3"><span class="ph filepath">.dita</span>, <span class="ph filepath">.xml</span></td>
  36. </tr>
  37. <tr class="row">
  38. <td class="entry colsep-0 rowsep-1" headers="ID__entry__1"><span class="keyword parmname">dita.map.extensions</span></td>
  39. <td class="entry colsep-0 rowsep-1" headers="ID__entry__2">DITA map</td>
  40. <td class="entry colsep-0 rowsep-1" headers="ID__entry__3"><span class="ph filepath">.ditamap</span></td>
  41. </tr>
  42. <tr class="row">
  43. <td class="entry colsep-0 rowsep-1" headers="ID__entry__1"><span class="keyword parmname">dita.html.extensions</span></td>
  44. <td class="entry colsep-0 rowsep-1" headers="ID__entry__2">HTML file</td>
  45. <td class="entry colsep-0 rowsep-1" headers="ID__entry__3"><span class="ph filepath">.html</span>, <span class="ph filepath">.htm</span></td>
  46. </tr>
  47. <tr class="row">
  48. <td class="entry colsep-0 rowsep-1" headers="ID__entry__1"><span class="keyword parmname">dita.resource.extensions</span></td>
  49. <td class="entry colsep-0 rowsep-1" headers="ID__entry__2">Resource file</td>
  50. <td class="entry colsep-0 rowsep-1" headers="ID__entry__3"><span class="ph filepath">.pdf</span>, <span class="ph filepath">.swf</span></td>
  51. </tr>
  52. </tbody></table>
  53. <p class="p">Both HTML and resource file extensions are used to determine if a file in source is copied to output.</p>
  54. <p class="p">A new plug-in extension point has been added to declare transformation types as print types.</p>
  55. <table class="table table-hover frame-none"><caption></caption><colgroup><col style="width:50%"><col style="width:50%"></colgroup><thead class="thead">
  56. <tr class="row">
  57. <th class="entry colsep-0 rowsep-1" id="ID__entry__16">Extension point</th>
  58. <th class="entry colsep-0 rowsep-1" id="ID__entry__17">Description</th>
  59. </tr>
  60. </thead><tbody class="tbody">
  61. <tr class="row">
  62. <td class="entry colsep-0 rowsep-1" headers="ID__entry__16"><span class="keyword parmname">dita.transtype.print</span></td>
  63. <td class="entry colsep-0 rowsep-1" headers="ID__entry__17">Declare transformation type as a print type.</td>
  64. </tr>
  65. </tbody></table>
  66. <p class="p">The <code class="ph codeph">print_transtypes</code> property in <span class="ph filepath">integrator.properties</span> has been
  67. deprecated in favor of <span class="keyword parmname">dita.transtype.print</span>.</p>
  68. </section>
  69. <section class="section"><h2 class="title sectiontitle">Plugin URI scheme</h2>
  70. <p class="p">Support for the <span class="keyword">plugin</span> URI scheme has been added to XSLT stylesheets. Plug-ins can refer to
  71. files in other plug-ins without hard-coding relative paths, for example: </p>
  72. <pre class="pre codeblock language-xml"><code>&lt;xsl:import href="plugin:org.dita.pdf2:xsl/fo/topic2fo_1.0.xsl"/&gt;</code></pre>
  73. </section>
  74. <section class="section"><h2 class="title sectiontitle">XHTML</h2>
  75. <p class="p">Support for the following languages has been added:</p>
  76. <ul class="ul">
  77. <li class="li">Indonesian</li>
  78. <li class="li">Kazakh</li>
  79. <li class="li">Malay</li>
  80. </ul>
  81. </section>
  82. <section class="section"><h2 class="title sectiontitle">PDF</h2>
  83. <p class="p">Support for mirrored page layout was added. The default is the unmirrored layout. The following XSLT
  84. configuration variables have been deprecated:</p>
  85. <ul class="ul" id="ID__ul_hkv_oyj_bd">
  86. <li class="li"><code class="ph codeph">page-margin-left</code></li>
  87. <li class="li"><code class="ph codeph">page-margin-right</code></li>
  88. </ul>
  89. <p class="p">The following variables should be used instead to control page margins:</p>
  90. <ul class="ul" id="ID__ul_yda_wyj_bd">
  91. <li class="li"><code class="ph codeph">page-margin-outside</code></li>
  92. <li class="li"><code class="ph codeph">page-margin-inside</code></li>
  93. </ul>
  94. <p class="p">The <span class="keyword parmname">args.bookmap-order</span> property has been added to control how front and back matter are
  95. processed in bookmaps. The default is to reorder the frontmatter content as in previous releases.</p>
  96. <p class="p">A new extension point has been added to add mappings to the PDF configuration catalog file.</p>
  97. <table class="table table-hover frame-none"><caption></caption><colgroup><col style="width:50%"><col style="width:50%"></colgroup><thead class="thead">
  98. <tr class="row">
  99. <th class="entry colsep-0 rowsep-1" id="ID__entry__20">Extension point</th>
  100. <th class="entry colsep-0 rowsep-1" id="ID__entry__21">Description</th>
  101. </tr>
  102. </thead><tbody class="tbody">
  103. <tr class="row">
  104. <td class="entry colsep-0 rowsep-1" headers="ID__entry__20"><span class="keyword parmname">org.dita.pdf2.catalog.relative</span></td>
  105. <td class="entry colsep-0 rowsep-1" headers="ID__entry__21">Configuration catalog includes.</td>
  106. </tr>
  107. </tbody></table>
  108. <p class="p">Support for the following languages has been added:</p>
  109. <ul class="ul">
  110. <li class="li">Finnish</li>
  111. <li class="li">Hebrew</li>
  112. <li class="li">Romanian</li>
  113. <li class="li">Russian</li>
  114. <li class="li">Swedish</li>
  115. </ul>
  116. <p class="p">PDF processing no longer copies images or generates XSL FO to output directory. Instead, the temporary
  117. directory is used for all temporary files and source images are read directly from source directory. The legacy
  118. processing model can be enabled by setting <span class="keyword parmname">org.dita.pdf2.use-out-temp</span> to
  119. <span class="keyword option">true</span> in configuration properties; support for the legacy processing model may be removed in
  120. future releases.</p>
  121. <p class="p">Support for FrameMaker index syntax has been disabled by default. To enable FrameMaker index syntax, set
  122. <span class="keyword parmname">org.dita.pdf2.index.frame-markup</span> to <span class="keyword option">true</span> in configuration
  123. properties.</p>
  124. <p class="p">A configuration option has been added to disable internationalization (I18N) font processing and use
  125. stylesheet-defined fonts. To disable I18N font processing, set <span class="keyword parmname">org.dita.pdf2.i18n.enabled</span>
  126. to <code class="ph codeph">false</code> in configuration properties.</p>
  127. <p class="p">The XSLT parameters <span class="keyword parmname">customizationDir</span> and <span class="keyword parmname">fileProfilePrefix</span> have been
  128. removed in favor of the <span class="keyword parmname">customizationDir.url</span> parameter.</p>
  129. <p class="p">A new shell stylesheet has been added for FOP and other shell stylesheets have also been revised. Plug-ins
  130. which have their own shell stylesheets for PDF processing should make sure all required stylesheets are
  131. imported.</p>
  132. <p class="p">Font family definitions in stylesheets have been changed from Sans, Serif, and Monospaced to sans-serif, serif,
  133. and monospace, respectively. The I18N font processing still uses the old logical names and aliases are used to
  134. map the new names to old ones. </p>
  135. </section>
  136. </div>
  137. <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../topics/migration.html" title="If you have XSL transformation overrides, plug-ins or other customizations written prior to DITA-OT 3.3, you may need to make changes to ensure your overrides work properly with the latest toolkit versions.">Migrating customizations</a></div></div></nav></article></main></body></html>