migrating-to-1.7.dita 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  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="ID" rev="1.7">
  5. <title>Migrating to release 1.7</title>
  6. <titlealts>
  7. <navtitle>To 1.7</navtitle>
  8. </titlealts>
  9. <shortdesc>In DITA-OT 1.7, a new preprocessing step implements flagging for HTML-based output formats. PDF processing
  10. was corrected with regard to <codeph>shortdesc</codeph> handling, and a new XSLT template mode was introduced for
  11. HTML TOC processing. Several stylesheets were moved to plug-in specific folders and deprecated properties and XSLT
  12. variables were removed. </shortdesc>
  13. <prolog>
  14. <metadata>
  15. <keywords>
  16. <indexterm>deprecated features<indexterm><codeph>dita.input</codeph></indexterm></indexterm>
  17. <indexterm>deprecated features<indexterm><codeph>dita.input.dirname</codeph></indexterm></indexterm>
  18. <indexterm>deprecated features<indexterm><codeph>dita.extname</codeph></indexterm></indexterm>
  19. <indexterm>deprecated features<indexterm>XHTML, flagging-related templates</indexterm></indexterm>
  20. <indexterm>deprecated features<indexterm><codeph>page-margin-left</codeph></indexterm></indexterm>
  21. <indexterm>deprecated features<indexterm><codeph>page-margin-right</codeph></indexterm></indexterm>
  22. </keywords>
  23. </metadata>
  24. </prolog>
  25. <refbody>
  26. <section>
  27. <p>A new job status file <filepath>.job.xml</filepath> has been introduced and replaces
  28. <filepath>dita.list</filepath> and <filepath>dita.xml.properties</filepath> as the normative source for job
  29. status. If you have custom processing which modifies the job properties, you should change your code to modify
  30. <filepath>.job.xml</filepath> instead.</p>
  31. <p>Support for the following deprecated properties has been removed:</p>
  32. <ul>
  33. <li><codeph>dita.input</codeph></li>
  34. <li><codeph>dita.input.dirname</codeph></li>
  35. <li><codeph>dita.extname</codeph></li>
  36. </ul>
  37. <p>Stylesheets for the following transformation types have moved to plug-in specific folders:</p>
  38. <ul>
  39. <li><option>docbook</option></li>
  40. <li><option>eclipsecontent</option></li>
  41. <li><option>troff</option></li>
  42. <li><option>wordrtf</option></li>
  43. </ul>
  44. <p>If custom plug-ins have hard coded paths to these stylesheets, update references to use either
  45. <codeph>plugin</codeph> URIs in <codeph>xsl:import</codeph> instructions or use <codeph>dita.plugin.*</codeph>
  46. Ant properties.</p>
  47. <p>The integration process has been changed to use strict mode by default. For old plug-ins which are not valid,
  48. <keyword>lax</keyword> processing mode can still be used.</p>
  49. <p>Plug-ins that use the <codeph>MessageUtils</codeph> Java class must use <codeph>getInstance</codeph> method to
  50. access the <codeph>MessageUtils</codeph> instance, as <codeph>getMessage</codeph> methods have been changed to
  51. instance methods.</p>
  52. </section>
  53. <section>
  54. <title>Preprocessing</title>
  55. <p>The preprocessing Ant dependency chain has been cleaned up. Tasks no longer depend on the previous task in the
  56. default chain, but rather the whole preprocess dependency chain is defined by the <codeph>preprocess</codeph>
  57. task.</p>
  58. </section>
  59. <section>
  60. <title>HTML</title>
  61. <p>Core TOC generation has been moved to a separate XSLT stylesheet
  62. <filepath>xsl/map2htmtoc/map2htmlImpl.xsl</filepath> and the new templates use the mode <codeph>toc</codeph>.
  63. Plug-ins which override HTML TOC processing should change the map processing templates to <codeph>toc</codeph>
  64. mode.</p>
  65. </section>
  66. <section>
  67. <title>HTML and extended transformation types</title>
  68. <p>Flagging logic has been pulled out of the core X/HTML code and moved to a preprocess step. This significantly
  69. simplifies and optimizes the X/HTML code, while making flagging logic available to any other transformation
  70. type. The new preprocess step implements all flagging logic; for each active flag, it adds a DITA-OT specific
  71. hint into the intermediate topics (implemented as a specialization of the DITA &lt;foreign&gt; element). As part
  72. of this change, all flagging-related templates in the XHTML code (such as start-flagit and gen-style) are
  73. deprecated.</p>
  74. <p>If you override the X/HTML transforms, you may need to update your overrides to use the new flagging logic. In
  75. most cases this just means deleting calls to the deprecated templates; in some cases, the calls can be replaced
  76. with 2 lines to process flags in new places. You should compare your override to the updated XHTML code and
  77. update as needed. See <xref keyref="flagging-migration"/> for details.</p>
  78. <p>Plug-ins that provide support for new transforms need to ensure that they properly support the DITA
  79. &lt;foreign&gt; element, which should be ignored by default; if so, this change will have no immediate impact.
  80. Support for flagging new transformation types may be more easily added based on this update, because there is no
  81. need to re-implement flagging logic, but this is not required. See <xref keyref="preprocess-flagging"/> for
  82. details on how to add flagging support.</p>
  83. </section>
  84. <section>
  85. <title>PDF</title>
  86. <p>The following deprecated XSLT variables have been removed:</p>
  87. <ul>
  88. <li><codeph>page-margin-left</codeph></li>
  89. <li><codeph>page-margin-right</codeph></li>
  90. </ul>
  91. <p>XSLT stylesheets have been split to separate specialization topic code and new <codeph>xsl:import</codeph>
  92. instructions have been added to <filepath>topic2fo.xsl</filepath>. Plug-ins which define their own shell
  93. stylesheet should be revised to import all the required stylesheet modules.</p>
  94. <p>PDF processing used to replace topic <codeph>shortdesc</codeph> with map <codeph>shortdesc</codeph>, but this
  95. behavior was incorrect and was removed to comply with the DITA specification.</p>
  96. <p>A new <codeph>#note-separator</codeph> variable string was added to facilitate customization.</p>
  97. </section>
  98. </refbody>
  99. </reference>