migrating-to-2.5.dita 4.1 KB

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