migrating-to-2.5.dita 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  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.5">
  5. <title>Migrating to release 2.5</title>
  6. <titlealts>
  7. <navtitle>To 2.5</navtitle>
  8. </titlealts>
  9. <shortdesc>In DITA-OT 2.5, several frequently-overridden legacy style settings were removed from the default PDF
  10. plug-in. A separate plug-in can be used to restore the original settings.</shortdesc>
  11. <prolog>
  12. <metadata>
  13. <keywords>
  14. <indexterm><xmlelement>example</xmlelement></indexterm>
  15. <indexterm>PDF
  16. <indexterm><codeph>org.dita.pdf2.legacy</codeph></indexterm></indexterm>
  17. <indexterm>languages
  18. <indexterm>right-to-left</indexterm></indexterm>
  19. </keywords>
  20. </metadata>
  21. </prolog>
  22. <refbody>
  23. <section>
  24. <note>This topic provides a summary of changes in DITA-OT 2.5 that may require modifications to custom stylesheets
  25. or plug-ins. For more information on changes in this release, see the
  26. <xref keyref="2.5-release-notes"/>.</note>
  27. </section>
  28. <section>
  29. <title>Deprecated logging parameters</title>
  30. <p>The <codeph>args.debug</codeph> and <codeph>args.logdir</codeph> properties have been deprecated and will be
  31. removed in an upcoming version of DITA-OT.</p>
  32. <ul>
  33. <li>
  34. <p>To enable debug logging, use <cmdname>dita</cmdname>
  35. <parmname>--debug</parmname>.</p>
  36. <note type="attention">Debug logging requires additional resources and can slow down the build process, so it
  37. should only be enabled when further details are required to diagnose problems.</note>
  38. </li>
  39. <li>
  40. <p>To write the log to a file, use <cmdname>dita</cmdname>
  41. <parmname>--logfile</parmname>=<varname>file</varname> or <cmdname>ant</cmdname>
  42. <parmname>-l</parmname>
  43. <varname>file</varname> and specify the path to the log file.</p>
  44. <p>Unless an absolute path is specified, the value will be interpreted relative to the current
  45. directory.</p></li>
  46. </ul>
  47. </section>
  48. <section id="25-pdf-changes">
  49. <title>Default PDF style improvements</title>
  50. <indexterm>tables
  51. <indexterm>indentation</indexterm></indexterm>
  52. <p>Several legacy styles have been modified or removed in the default PDF plug-in <codeph>org.dita.pdf2</codeph>,
  53. including the following:</p>
  54. <p>
  55. <ul>
  56. <li>In task topics with only a single step, the step is now rendered as a simple block (rather than as a list
  57. item without a label).</li>
  58. <li>Table containers now inherit the initial indentation (<codeph>start-indent</codeph>) from the parent
  59. elements.</li>
  60. <li>Borders and indentation have been removed from <xmlelement>example</xmlelement> elements.</li>
  61. <li>Links are no longer italicized.</li>
  62. <li>Titles for related link lists have been standardized to use the <codeph>common.title</codeph> attribute
  63. set (which applies the <codeph>sans-serif</codeph> font-family) and bold font weight.</li>
  64. <li>Several remaining occurrences of left/right borders, margins, padding, and text alignment now use the
  65. corresponding start/end equivalents to better support right-to-left languages.</li>
  66. </ul>
  67. </p></section>
  68. <section id="25-legacy-pdf-plugin">
  69. <title>External plug-in for legacy PDF styling</title>
  70. <p>If you have a custom PDF plug-in that explicitly depends on the previous default settings for the
  71. aforementioned styles, the <codeph>org.dita.pdf2.legacy</codeph> plug-in can be used to restore the pre–2.5
  72. styles.</p>
  73. <table outputclass="table-hover" frame="none" colsep="0" rowsep="1">
  74. <tgroup cols="2">
  75. <colspec colwidth="1*"/>
  76. <colspec colwidth="1*"/>
  77. <thead>
  78. <row>
  79. <entry>Plug-in </entry>
  80. <entry>Source code location</entry>
  81. </row>
  82. </thead>
  83. <tbody>
  84. <row>
  85. <entry><codeph>org.dita.pdf2.legacy</codeph></entry>
  86. <entry>
  87. <xref href="https://github.com/dita-ot/org.dita.pdf2.legacy" format="html" scope="external"/></entry>
  88. </row>
  89. </tbody>
  90. </tgroup>
  91. </table>
  92. <p>To install the legacy PDF plug-in, run the following command:</p>
  93. <codeblock><cmdname>dita</cmdname> <parmname>--install</parmname>=<filepath>https://github.com/dita-ot/org.dita.pdf2.legacy/archive/2.5.zip</filepath></codeblock>
  94. <note type="attention">Only install the legacy PDF plug-in if you have a custom PDF plug-in that requires the
  95. pre–2.5 styles. If your plug-in was designed for DITA-OT 2.4 and does not override these settings, there is no
  96. need to install the legacy PDF plug-in.</note>
  97. </section>
  98. </refbody>
  99. </reference>