migrating-to-2.5.html 10.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  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 2020"><meta name="DC.rights.owner" content="(C) Copyright 2020"><meta name="DC.type" content="reference"><meta name="description" content="In DITA-OT 2.5, several frequently-overridden legacy style settings were removed from the default PDF plug-in. A separate plug-in can be used to restore the original settings."><meta name="DC.subject" content=", example, PDF, org.dita.pdf2.legacy, languages, right-to-left"><meta name="keywords" content=", example, PDF, org.dita.pdf2.legacy, languages, right-to-left"><meta name="DC.relation" scheme="URI" content="../topics/migration.html"><meta name="DC.format" content="HTML5"><meta name="DC.identifier" content="migrating-to-2.5"><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 2.5</title></head><body id="migrating-to-2.5"><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.5</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/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><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/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a><ul><li><a href="../topics/plugin-benefits.html">Plug-in benefits</a></li><li><a href="../topics/plugin-configfile.html">Plug-in descriptor file</a></li><li><a href="../topics/plugin-coding-conventions.html">Coding conventions</a></li><li><a href="../topics/plugin-dependencies.html">Plug-in dependencies</a></li><li><a href="../topics/plugin-use-cases.html">Plug-in use cases</a></li><li><a href="../topics/html-customization-plugins.html">Custom HTML plug-ins</a></li><li><a href="../topics/pdf-customization-plugins.html">Custom PDF plug-ins</a></li><li><a href="../topics/globalization.html">Globalizing DITA content</a></li><li><a href="../topics/migration.html">Migrating customizations</a><ul><li><a href="../topics/migrating-to-3.5.html">To 3.5</a></li><li><a href="../topics/migrating-to-3.4.html">To 3.4</a></li><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 class="active"><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><a href="../topics/migrating-to-1.5.4.html">To 1.5.4</a></li></ul></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 2.5</h1>
  8. <div class="body refbody"><p class="shortdesc">In DITA-OT 2.5, several frequently-overridden legacy style settings were removed from the default PDF
  9. plug-in. A separate plug-in can be used to restore the original settings.</p>
  10. <section class="section">
  11. <div class="note note note_note"><span class="note__title">Note:</span> This topic provides a summary of changes in DITA-OT 2.5 that may require modifications to custom stylesheets
  12. or plug-ins. For more information on changes in this release, see the
  13. <a class="xref" href="https://www.dita-ot.org/2.5/release-notes/" target="_blank" rel="external noopener">DITA-OT 2.5 Release Notes</a>.</div>
  14. </section>
  15. <section class="section"><h2 class="title sectiontitle">Deprecated logging parameters</h2>
  16. <p class="p">The <code class="ph codeph">args.debug</code> and <code class="ph codeph">args.logdir</code> properties have been deprecated and will be
  17. removed in an upcoming version of DITA-OT.</p>
  18. <ul class="ul">
  19. <li class="li">
  20. <p class="p">To enable debug logging, use <span class="keyword cmdname">dita</span>
  21. <span class="keyword parmname">--debug</span>.</p>
  22. <div class="note attention note_attention"><span class="note__title">Attention:</span> Debug logging requires additional resources and can slow down the build process, so it
  23. should only be enabled when further details are required to diagnose problems.</div>
  24. </li>
  25. <li class="li">
  26. <p class="p">To write the log to a file, use <span class="keyword cmdname">dita</span>
  27. <span class="keyword parmname">--logfile</span>=<var class="keyword varname">file</var> or <span class="keyword cmdname">ant</span>
  28. <span class="keyword parmname">-l</span>
  29. <var class="keyword varname">file</var> and specify the path to the log file.</p>
  30. <p class="p">Unless an absolute path is specified, the value will be interpreted relative to the current
  31. directory.</p></li>
  32. </ul>
  33. </section>
  34. <section class="section" id="migrating-to-2.5__25-pdf-changes"><h2 class="title sectiontitle">Default PDF style improvements</h2>
  35. <p class="p">Several legacy styles have been modified or removed in the default PDF plug-in <code class="ph codeph">org.dita.pdf2</code>,
  36. including the following:</p>
  37. <div class="p">
  38. <ul class="ul">
  39. <li class="li">In task topics with only a single step, the step is now rendered as a simple block (rather than as a list
  40. item without a label).</li>
  41. <li class="li">Table containers now inherit the initial indentation (<code class="ph codeph">start-indent</code>) from the parent
  42. elements.</li>
  43. <li class="li">Borders and indentation have been removed from <code class="keyword markupname xmlelement">&lt;example&gt;</code> elements.</li>
  44. <li class="li">Links are no longer italicized.</li>
  45. <li class="li">Titles for related link lists have been standardized to use the <code class="ph codeph">common.title</code> attribute
  46. set (which applies the <code class="ph codeph">sans-serif</code> font-family) and bold font weight.</li>
  47. <li class="li">Several remaining occurrences of left/right borders, margins, padding, and text alignment now use the
  48. corresponding start/end equivalents to better support right-to-left languages.</li>
  49. </ul>
  50. </div></section>
  51. <section class="section" id="migrating-to-2.5__25-legacy-pdf-plugin"><h2 class="title sectiontitle">External plug-in for legacy PDF styling</h2>
  52. <p class="p">If you have a custom PDF plug-in that explicitly depends on the previous default settings for the
  53. aforementioned styles, the <code class="ph codeph">org.dita.pdf2.legacy</code> plug-in can be used to restore the pre–2.5
  54. styles.</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="migrating-to-2.5__25-legacy-pdf-plugin__entry__1">Plug-in </th>
  58. <th class="entry colsep-0 rowsep-1" id="migrating-to-2.5__25-legacy-pdf-plugin__entry__2">Source code location</th>
  59. </tr>
  60. </thead><tbody class="tbody">
  61. <tr class="row">
  62. <td class="entry colsep-0 rowsep-1" headers="migrating-to-2.5__25-legacy-pdf-plugin__entry__1"><code class="ph codeph">org.dita.pdf2.legacy</code></td>
  63. <td class="entry colsep-0 rowsep-1" headers="migrating-to-2.5__25-legacy-pdf-plugin__entry__2">
  64. <a class="xref" href="https://github.com/dita-ot/org.dita.pdf2.legacy" target="_blank" rel="external noopener">https://github.com/dita-ot/org.dita.pdf2.legacy</a></td>
  65. </tr>
  66. </tbody></table>
  67. <p class="p">To install the legacy PDF plug-in, run the following command:</p>
  68. <pre class="pre codeblock"><code><span class="keyword cmdname">dita</span> <span class="keyword parmname">--install</span>=<span class="ph filepath">https://github.com/dita-ot/org.dita.pdf2.legacy/archive/2.5.zip</span></code></pre>
  69. <div class="note attention note_attention"><span class="note__title">Attention:</span> Only install the legacy PDF plug-in if you have a custom PDF plug-in that requires the
  70. pre–2.5 styles. If your plug-in was designed for DITA-OT 2.4 and does not override these settings, there is no
  71. need to install the legacy PDF plug-in.</div>
  72. </section>
  73. </div>
  74. <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.5, 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>