migrating-to-2.5.dita 3.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  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. <refbody>
  12. <section>
  13. <note>This topic provides a summary of changes in DITA-OT 2.5 that may require modifications to custom stylesheets
  14. or plug-ins. For more information on changes in this release, see the
  15. <xref keyref="2.5-release-notes"/>.</note>
  16. </section>
  17. <!--<section>
  18. <title>HTML5</title>
  19. <ul>
  20. <li/>
  21. </ul>
  22. </section>-->
  23. <section id="25-pdf-changes">
  24. <title>Default PDF style improvements</title>
  25. <p>Several legacy styles have been modified or removed in the default PDF plug-in <codeph>org.dita.pdf2</codeph>,
  26. including the following:</p>
  27. <p>
  28. <ul>
  29. <li>In task topics with only a single step, the step is now rendered as a simple block (rather than as a list
  30. item without a label).</li>
  31. <li>Table containers now inherit the initial indentation (<codeph>start-indent</codeph>) from the parent
  32. elements.</li>
  33. <li>Borders and indentation have been removed from <xmlelement>example</xmlelement> elements.</li>
  34. <li>Links are no longer italicized.</li>
  35. <li>Titles for related link lists have been standardized to use the <codeph>common.title</codeph> attribute
  36. set (which applies the <codeph>sans-serif</codeph> font-family) and bold font weight.</li>
  37. <li>Several remaining occurrences of left/right borders, margins, padding, and text alignment now use the
  38. corresponding start/end equivalents to better support right-to-left languages.</li>
  39. </ul>
  40. </p></section>
  41. <section id="25-legacy-pdf-plugin">
  42. <title>External plug-in for legacy PDF styling</title>
  43. <p>If you have a custom PDF plug-in that explicitly depends on the previous default settings for the
  44. aforementioned styles, the <codeph>org.dita.pdf2.legacy</codeph> plug-in can be used to restore the pre–2.5
  45. styles.</p>
  46. <table frame="none" rowsep="1" colsep="0">
  47. <tgroup cols="2">
  48. <colspec colname="c1" colnum="1" colwidth="1.0*"/>
  49. <colspec colname="c2" colnum="2" colwidth="1.0*"/>
  50. <thead>
  51. <row>
  52. <entry>Plug-in </entry>
  53. <entry>Source code location</entry>
  54. </row>
  55. </thead>
  56. <tbody>
  57. <row>
  58. <entry><codeph>org.dita.pdf2.legacy</codeph></entry>
  59. <entry>
  60. <xref href="https://github.com/dita-ot/org.dita.pdf2.legacy" format="html" scope="external"/></entry>
  61. </row>
  62. </tbody>
  63. </tgroup>
  64. </table>
  65. <p>To install the legacy PDF plug-in, run the following command:</p>
  66. <codeblock><cmdname>dita</cmdname> <parmname>--install</parmname> <filepath>https://github.com/dita-ot/org.dita.pdf2.legacy/archive/2.5.zip</filepath></codeblock>
  67. <note type="attention">Only install the legacy PDF plug-in if you have a custom PDF plug-in that requires the
  68. pre–2.5 styles. If your plug-in was designed for DITA-OT 2.4 and does not override these settings, there is no
  69. need to install the legacy PDF plug-in.</note>
  70. </section>
  71. </refbody>
  72. </reference>