migrating-to-3.5.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  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="DITA-OT 3.5 includes support for additional input resources, an alternative subcommand syntax for the dita command, and an initial preview of features for the latest draft of the upcoming DITA 2.0 standard."><meta name="DC.relation" scheme="URI" content="../topics/migration.html"><meta name="DC.format" content="HTML5"><meta name="DC.identifier" content="migrating-to-3.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 3.5</title></head><body id="migrating-to-3.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 class="active"><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><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 3.5</h1>
  8. <div class="body refbody"><p class="shortdesc">DITA-OT 3.5 includes <span class="ph" id="migrating-to-3.5__summary">support for additional input resources, an alternative subcommand
  9. syntax for the <span class="keyword cmdname">dita</span> command, and an initial preview of features for the latest draft of the
  10. upcoming DITA 2.0 standard</span>.</p>
  11. <section class="section">
  12. <div class="note note note_note"><span class="note__title">Note:</span> This topic provides a summary of changes in DITA-OT 3.5 that may require modifications to custom stylesheets
  13. or plug-ins. For more information on changes in this release, see the
  14. <a class="xref" href="https://www.dita-ot.org/3.5/release-notes/" target="_blank" rel="external noopener">DITA-OT 3.5 Release Notes</a>.</div>
  15. </section>
  16. <section class="section" id="migrating-to-3.5__subcommands"><h2 class="title sectiontitle">New subcommands</h2>
  17. <p class="p">The <span class="keyword cmdname">dita</span> command line interface has been refactored to support subcommands for common
  18. operations.</p>
  19. <div class="note important note_important"><span class="note__title">Important:</span> The new subcommands supersede the deprecated X-Toolkit–style single-hyphen keyword variants
  20. (such as <span class="keyword option">-install</span>), and the corresponding GNU-style option keywords preceded by two hyphens
  21. (such as <span class="keyword option">--install</span>).</div>
  22. <dl class="dl">
  23. <dt class="dt dlterm"><span class="keyword cmdname">dita install</span></dt>
  24. <dd class="dd">Installs or reloads plug-ins (replaces <span class="keyword cmdname">dita</span>
  25. <span class="keyword parmname">--install</span>)</dd>
  26. <dt class="dt dlterm"><span class="keyword cmdname">dita plugins</span></dt>
  27. <dd class="dd">Prints a list of installed plug-ins (replaces <span class="keyword cmdname">dita</span>
  28. <span class="keyword parmname">--plugins</span>)</dd>
  29. <dt class="dt dlterm"><span class="keyword cmdname">dita transtypes</span></dt>
  30. <dd class="dd">Prints a list of installed transformation types, or <em class="ph i">output formats</em> (replaces
  31. <span class="keyword cmdname">dita</span>
  32. <span class="keyword parmname">--transtypes</span>)</dd>
  33. <dt class="dt dlterm"><span class="keyword cmdname">dita uninstall</span></dt>
  34. <dd class="dd">Removes and deletes a plug-in (replaces <span class="keyword cmdname">dita</span>
  35. <span class="keyword parmname">--uninstall</span>)</dd>
  36. <dt class="dt dlterm"><span class="keyword cmdname">dita version</span></dt>
  37. <dd class="dd">Prints version information and exits (replaces <span class="keyword cmdname">dita</span>
  38. <span class="keyword parmname">--version</span>)</dd>
  39. </dl>
  40. <div class="note tip note_tip"><span class="note__title">Tip:</span> The double-hyphen option syntax has been retained for backwards compatibility, so if you use
  41. commands like <span class="keyword cmdname">dita</span>
  42. <span class="keyword parmname">--install</span> in scripts, they will still work, but you may want to migrate your scripts to the
  43. new subcommand syntax.</div>
  44. </section>
  45. <section class="section" id="migrating-to-3.5__3.5-legacy-target-removal"><h2 class="title sectiontitle">Legacy constructs removed</h2>
  46. <p class="p">DITA-OT 3.5 no longer includes the following legacy properties, list files, and targets, which were deprecated
  47. in previous releases. These constructs were no longer used in recent releases, and have now been removed
  48. entirely.</p>
  49. <p class="p">The following Ant targets have been removed from the pre-processing pipeline:</p>
  50. <ul class="ul">
  51. <li class="li"><code class="ph codeph">mappull</code> and <code class="ph codeph">mappull-check</code>, which were used to pull metadata (such as
  52. navtitle) into the map from referenced topics prior to DITA-OT 2.2 (merged with
  53. <code class="ph codeph">move-meta-entries</code>)</li>
  54. <li class="li"><code class="ph codeph">conref-check</code>, deprecated since 2.3</li>
  55. <li class="li"><code class="ph codeph">coderef</code>, which was used to resolve code references in input files prior to 2.3 (merged with
  56. <code class="ph codeph">topic-fragment</code>)</li>
  57. <li class="li"><code class="ph codeph">copy-subsidiary</code> and <code class="ph codeph">copy-subsidiary-check</code>, which were used to copy files
  58. to the temporary directory prior to 2.1</li>
  59. </ul>
  60. <p class="p">Recent DITA-OT versions provide alternative mechanisms to achieve the same results, such as the
  61. <code class="keyword markupname xmlelement">&lt;ditafileset&gt;</code> element to select resources in the temporary directory.</p>
  62. <p class="p">Along with the obsolete targets, the following Ant properties have been removed:</p>
  63. <ul class="ul">
  64. <li class="li"><code class="ph codeph">canditopicsfile</code></li>
  65. <li class="li"><code class="ph codeph">canditopicslist</code></li>
  66. <li class="li"><code class="ph codeph">conreffile</code></li>
  67. <li class="li"><code class="ph codeph">conreflist</code></li>
  68. <li class="li"><code class="ph codeph">conreftargetsfile</code></li>
  69. <li class="li"><code class="ph codeph">conreftargetslist</code></li>
  70. <li class="li"><code class="ph codeph">copytosourcefile</code></li>
  71. <li class="li"><code class="ph codeph">copytosourcelist</code></li>
  72. <li class="li"><code class="ph codeph">fullditamapandtopicfile</code></li>
  73. <li class="li"><code class="ph codeph">fullditamapandtopiclist</code></li>
  74. <li class="li"><code class="ph codeph">fullditamapfile</code></li>
  75. <li class="li"><code class="ph codeph">fullditamaplist</code></li>
  76. <li class="li"><code class="ph codeph">fullditatopicfile</code></li>
  77. <li class="li"><code class="ph codeph">fullditatopiclist</code></li>
  78. <li class="li"><code class="ph codeph">hrefditatopicfile</code></li>
  79. <li class="li"><code class="ph codeph">hrefditatopiclist</code></li>
  80. <li class="li"><code class="ph codeph">hreftargetsfile</code></li>
  81. <li class="li"><code class="ph codeph">hreftargetslist</code></li>
  82. <li class="li"><code class="ph codeph">htmlfile</code></li>
  83. <li class="li"><code class="ph codeph">htmllist</code></li>
  84. <li class="li"><code class="ph codeph">imagefile</code></li>
  85. <li class="li"><code class="ph codeph">imagelist</code></li>
  86. <li class="li"><code class="ph codeph">outditafilesfile</code></li>
  87. <li class="li"><code class="ph codeph">outditafileslist</code></li>
  88. <li class="li"><code class="ph codeph">resourceonlyfile</code></li>
  89. <li class="li"><code class="ph codeph">resourceonlylist</code></li>
  90. <li class="li"><code class="ph codeph">subjectschemefile</code></li>
  91. <li class="li"><code class="ph codeph">subjectschemelist</code></li>
  92. <li class="li"><code class="ph codeph">subtargetsfile</code></li>
  93. <li class="li"><code class="ph codeph">subtargetslist</code></li>
  94. <li class="li"><code class="ph codeph">user.input.file.listfile</code></li>
  95. <li class="li"><code class="ph codeph">user.input.file</code></li>
  96. </ul>
  97. <p class="p">The following obsolete list files are no longer generated in the temporary directory:</p>
  98. <ul class="ul">
  99. <li class="li"><span class="ph filepath">canditopics.list</span></li>
  100. <li class="li"><span class="ph filepath">conref.list</span></li>
  101. <li class="li"><span class="ph filepath">conreftargets.list</span></li>
  102. <li class="li"><span class="ph filepath">copytosource.list</span></li>
  103. <li class="li"><span class="ph filepath">fullditamap.list</span></li>
  104. <li class="li"><span class="ph filepath">fullditamapandtopic.list</span></li>
  105. <li class="li"><span class="ph filepath">fullditatopic.list</span></li>
  106. <li class="li"><span class="ph filepath">hrefditatopic.list</span></li>
  107. <li class="li"><span class="ph filepath">hreftargets.list</span></li>
  108. <li class="li"><span class="ph filepath">html.list</span></li>
  109. <li class="li"><span class="ph filepath">image.list</span></li>
  110. <li class="li"><span class="ph filepath">outditafiles.list</span></li>
  111. <li class="li"><span class="ph filepath">resourceonly.list</span></li>
  112. <li class="li"><span class="ph filepath">subjectscheme.list</span></li>
  113. <li class="li"><span class="ph filepath">subtargets.list</span></li>
  114. <li class="li"><span class="ph filepath">user.input.file.list</span></li>
  115. <li class="li"><span class="ph filepath">usr.input.file.list</span></li>
  116. </ul>
  117. </section>
  118. </div>
  119. <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>