plugin-extension-points-pre-processing.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
  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 2019"><meta name="DC.rights.owner" content="(C) Copyright 2019"><meta name="DC.type" content="reference"><meta name="description" content="You can use these extension points to run an Ant target before or after the pre-processing stage. If necessary, you can also run an Ant target before a specific pre-processing step — but this approach is not recommended."><meta name="DC.relation" scheme="URI" content="../extension-points/plugin-extension-points.html"><meta name="DC.relation" scheme="URI" content="../extension-points/extension-points-in-org.dita.base.html"><meta name="DC.format" content="HTML5"><meta name="DC.identifier" content="plugin-extension-points-pre-processing"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Pre-processing extension points</title></head><body id="plugin-extension-points-pre-processing"><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.3</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/alternative-input-formats.html">Authoring formats</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../parameters/index.html">Setting parameters</a></li><li><a href="../topics/customizing.html">Customizing DITA-OT</a><ul><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/custom-plugins.html">Working with plug-ins</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a><ul><li><a href="../extension-points/all-extension-points.html">All extension points</a></li><li><a href="../extension-points/plugin-extension-points-general.html">General extension points</a></li><li class="active"><a href="../extension-points/plugin-extension-points-pre-processing.html">Pre-processing extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-import.html">XSLT-import extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-parameters.html">XSLT-parameter extension points</a></li><li><a href="../extension-points/plugin-extension-points-support.html">Version and support information</a></li><li><a href="../extension-points/extension-points-by-plugin.html">Plug-in extension points</a></li></ul></li><li><a href="../topics/migration.html">Migrating customizations</a></li><li><a href="../topics/globalization.html">Globalizing DITA content</a></li><li><a href="../topics/rebuilding-docs.html">Rebuilding documentation</a></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">Pre-processing extension points</h1>
  8. <div class="body refbody"><p class="shortdesc">You can use these extension points to run an Ant target before or after the pre-processing stage. If
  9. necessary, you can also run an Ant target before a specific pre-processing step — but this approach is not
  10. recommended.</p>
  11. <section class="section">
  12. <div class="note tip note_tip"><span class="note__title">Tip:</span> For maximum compatibility with future versions of
  13. DITA-OT, most plug-ins should use the extension points that run <strong class="ph b">before</strong> or <strong class="ph b">after</strong>
  14. pre-processing.</div>
  15. <dl class="dl">
  16. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.pre</span></dt>
  17. <dd class="dd">Runs an Ant
  18. target before the pre-processing stage.</dd>
  19. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.post</span></dt>
  20. <dd class="dd">Runs an Ant
  21. target after the pre-processing stage.</dd>
  22. </dl>
  23. </section>
  24. <section class="section"><h2 class="title sectiontitle">Legacy pre-processing extensions</h2>
  25. <p class="p">The following extension points are available in the original <code class="ph codeph">preprocess</code> pipeline that was used
  26. by default for all transformations prior to DITA-OT 3.0. These extensions are not available in the newer <a class="xref" href="../reference/map-first-preprocessing.html" title="DITA-OT 3.0 provides a map-first preprocessing option as an alternative to the default preprocess operation. The method, which was introduced in DITA-OT 2.5 as an experimental feature, has been improved and is ready for use in many production scenarios. Map-first-preprocessing provides the same functionality as the default preprocess, but takes a different approach.">map-first preprocessing</a> pipeline (<code class="ph codeph">preprocess2</code>), which is
  27. used in the PDF and HTML Help transformations as of DITA-OT 3.0.</p>
  28. <div class="note caution note_caution"><span class="note__title">CAUTION:</span> The internal order of preprocessing steps is
  29. subject to change between versions of DITA-OT. New versions may remove, reorder, combine, or add steps to
  30. the process, so the extension points <strong class="ph b">within</strong> the preprocessing stage should only be used if absolutely
  31. necessary.</div>
  32. <dl class="dl">
  33. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.chunk.pre</span></dt>
  34. <dd class="dd">Runs an
  35. Ant target before the <code class="ph codeph">chunk</code> step in the pre-processing stage.</dd>
  36. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.coderef.pre</span></dt>
  37. <dd class="dd">Runs an
  38. Ant target before the <code class="ph codeph">coderef</code> step in the pre-processing stage.</dd>
  39. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.conref.pre</span></dt>
  40. <dd class="dd">Runs an
  41. Ant target before the <code class="ph codeph">conref</code> step in the pre-processing stage.</dd>
  42. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.conrefpush.pre</span></dt>
  43. <dd class="dd">Runs
  44. an Ant target before the <code class="ph codeph">conrefpush</code> step in the pre-processing stage.</dd>
  45. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.clean-temp.pre</span></dt>
  46. <dd class="dd">Runs
  47. an Ant target before the <code class="ph codeph">clean-temp</code> step in the pre-processing stage.</dd>
  48. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.copy-files.pre</span></dt>
  49. <dd class="dd">Runs
  50. an Ant target before the <code class="ph codeph">copy-files</code> step in the pre-processing stage.</dd>
  51. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.copy-flag.pre</span></dt>
  52. <dd class="dd">Runs
  53. an Ant target before the <code class="ph codeph">copy-flag</code> step in the pre-processing stage.</dd>
  54. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.copy-html.pre</span></dt>
  55. <dd class="dd">Runs
  56. an Ant target before the <code class="ph codeph">copy-html</code> step in the pre-processing stage.</dd>
  57. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.copy-image.pre</span></dt>
  58. <dd class="dd">Runs
  59. an Ant target before the <code class="ph codeph">copy-image</code> step in the pre-processing stage.</dd>
  60. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.copy-subsidiary.pre</span></dt>
  61. <dd class="dd">Runs an Ant target before the <code class="ph codeph">copy-subsidiary</code> step in the pre-processing stage.</dd>
  62. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.debug-filter.pre</span></dt>
  63. <dd class="dd">Runs an Ant target before the <code class="ph codeph">debug-filter</code> step in the pre-processing stage.</dd>
  64. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.gen-list.pre</span></dt>
  65. <dd class="dd">Runs
  66. an Ant target before the <code class="ph codeph">gen-list</code> step in the pre-processing stage.</dd>
  67. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.keyref.pre</span></dt>
  68. <dd class="dd">Runs an
  69. Ant target before the <code class="ph codeph">keyref</code> step in the pre-processing stage.</dd>
  70. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.maplink.pre</span></dt>
  71. <dd class="dd">Runs an
  72. Ant target before the <code class="ph codeph">maplink</code> step in the pre-processing stage.</dd>
  73. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.mappull.pre</span></dt>
  74. <dd class="dd">Runs an
  75. Ant target before the <code class="ph codeph">mappull</code> step in the pre-processing stage.</dd>
  76. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.mapref.pre</span></dt>
  77. <dd class="dd">Runs an
  78. Ant target before the <code class="ph codeph">mapref</code> step in the pre-processing stage.</dd>
  79. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.move-meta-entries.pre</span></dt>
  80. <dd class="dd">Runs an Ant target before the <code class="ph codeph">move-meta-entries</code> step in the pre-processing stage.</dd>
  81. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.topicpull.pre</span></dt>
  82. <dd class="dd">Runs
  83. an Ant target before the <code class="ph codeph">topicpull</code> step in the pre-processing stage.</dd>
  84. </dl>
  85. </section>
  86. </div>
  87. <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../extension-points/plugin-extension-points.html" title="DITA Open Toolkit provides a series of extension points that can be used to integrate changes into the core code. Extension points are defined in the plugin.xml file for each plug-in. When plug-ins are installed, DITA-OT makes each extension visible to the rest of the toolkit.">Extension points</a></div></div><div class="linklist relinfo relref"><strong>Related reference</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../extension-points/extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports.">Extension points in org.dita.base</a></li></ul></div></nav></article></main></body></html>