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

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  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 2016"><meta name="DC.rights.owner" content="(C) Copyright 2016"><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; you also run an Ant target before or after a specific step in the pre-processing operation."><meta name="DC.Relation" scheme="URI" content="../dev_ref/plugin-extension-points.html"><meta name="DC.Format" content="XHTML"><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 2.3</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../getting-started/index.html">Getting Started</a></li><li><a href="../user-guide/index.html">User Guide</a></li><li><a href="../parameters/index.html">Parameter Reference</a></li><li><a href="../dev_ref/index.html">Developer Reference</a><ul><li><a href="../dev_ref/DITA-OTArchitecture.html">DITA-OT Architecture</a></li><li><a href="../dev_ref/extending-the-ot.html">Extending the DITA-OT</a></li><li><a href="../dev_ref/plugin-creating.html">Creating plug-ins</a></li><li><a href="../dev_ref/plugin-extension-points.html">Extension points</a><ul><li><a href="../dev_ref/plugin-extension-points-general.html">General extension points</a></li><li class="active"><a href="../dev_ref/plugin-extension-points-pre-processing.html">Pre-processing extension points</a></li><li><a href="../dev_ref/plugin-extension-points-xslt-import.html">XSLT-import extension points</a></li><li><a href="../dev_ref/plugin-extension-points-xslt-parameters.html">XSLT-parameter extension points</a></li><li><a href="../dev_ref/plugin-extension-points-support.html">Version and support information</a></li><li><a href="../extension-points/all-extension-points.html">All extension points</a></li></ul></li><li><a href="../dev_ref/pdf-customization.html">Customizing PDF output</a></li><li><a href="../dev_ref/migration.html">Migrating customizations</a></li></ul></li><li><a href="../user-guide/dita-and-dita-ot-resources.html">DITA 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; you
  9. also run an Ant target before or after a specific step in the pre-processing operation.</p>
  10. <section class="section">
  11. <div class="note tip note_tip"><span class="note__title tiptitle">Tip:</span> For maximum compatibility with future versions of DITA-OT, most plug-ins should use the extension
  12. points that run before or after pre-processing.</div>
  13. <dl class="dl">
  14. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.pre</span></dt>
  15. <dd class="dd">Runs an Ant target before the pre-processing stage.</dd>
  16. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.post</span></dt>
  17. <dd class="dd">Runs an Ant target after the pre-processing stage.</dd>
  18. </dl>
  19. </section>
  20. <section class="section">
  21. <div class="note caution note_caution"><span class="note__title cautiontitle">CAUTION:</span> The internal order of preprocessing steps is subject to change between versions of DITA-OT.
  22. New versions may remove, combine, or add steps to the process, so the following extension points within the
  23. preprocessing stage should only be used if absolutely necessary.</div>
  24. <dl class="dl">
  25. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.chunk.pre</span></dt>
  26. <dd class="dd">Runs an Ant target before the <code class="ph codeph">chunk</code> step in the pre-processing stage.</dd>
  27. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.coderef.pre</span></dt>
  28. <dd class="dd">Runs an Ant target before the <code class="ph codeph">coderef</code> step in the pre-processing stage.</dd>
  29. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.conref.pre</span></dt>
  30. <dd class="dd">Runs an Ant target before the <code class="ph codeph">conref</code> step in the pre-processing stage.</dd>
  31. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.conrefpush.pre</span></dt>
  32. <dd class="dd">Runs an Ant target before the <code class="ph codeph">conrefpush</code> step in the pre-processing stage.</dd>
  33. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.clean-temp.pre</span></dt>
  34. <dd class="dd">Runs an Ant target before the <code class="ph codeph">clean-temp</code> step in the pre-processing stage.</dd>
  35. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.copy-files.pre</span></dt>
  36. <dd class="dd">Runs an Ant target before the <code class="ph codeph">copy-files</code> step in the pre-processing stage.</dd>
  37. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.copy-flag.pre</span></dt>
  38. <dd class="dd">Runs an Ant target before the <code class="ph codeph">copy-flag</code> step in the pre-processing stage.</dd>
  39. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.copy-generated-files.pre</span></dt>
  40. <dd class="dd">Runs an Ant target before the <code class="ph codeph">copy-generated-files</code> step in the pre-processing stage.</dd>
  41. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.copy-html.pre</span></dt>
  42. <dd class="dd">Runs an Ant target before the <code class="ph codeph">copy-html</code> step in the pre-processing stage.</dd>
  43. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.copy-image.pre</span></dt>
  44. <dd class="dd">Runs an Ant target before the <code class="ph codeph">copy-image</code> step in the pre-processing stage.</dd>
  45. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.copy-subsidiary.pre</span></dt>
  46. <dd class="dd">Runs an Ant target before the <code class="ph codeph">copy-subsidiary</code> step in the pre-processing stage.</dd>
  47. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.debug-filter.pre</span></dt>
  48. <dd class="dd">Runs an Ant target before the <code class="ph codeph">debug-filter</code> step in the pre-processing stage.</dd>
  49. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.gen-list.pre</span></dt>
  50. <dd class="dd">Runs an Ant target before the <code class="ph codeph">gen-list</code> step in the pre-processing stage.</dd>
  51. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.keyref.pre</span></dt>
  52. <dd class="dd">Runs an Ant target before the <code class="ph codeph">keyref</code> step in the pre-processing stage.</dd>
  53. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.maplink.pre</span></dt>
  54. <dd class="dd">Runs an Ant target before the <code class="ph codeph">maplink</code> step in the pre-processing stage.</dd>
  55. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.mappull.pre</span></dt>
  56. <dd class="dd">Runs an Ant target before the <code class="ph codeph">mappull</code> step in the pre-processing stage.</dd>
  57. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.mapref.pre</span></dt>
  58. <dd class="dd">Runs an Ant target before the <code class="ph codeph">mapref</code> step in the pre-processing stage.</dd>
  59. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.move-links.pre</span></dt>
  60. <dd class="dd">Runs an Ant target before the <code class="ph codeph">move-links</code> step in the pre-processing stage.</dd>
  61. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.move-meta-entries.pre</span></dt>
  62. <dd class="dd">Runs an Ant target before the <code class="ph codeph">move-meta-entries</code> step in the pre-processing stage.</dd>
  63. <dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.topicpull.pre</span></dt>
  64. <dd class="dd">Runs an Ant target before the <code class="ph codeph">topicpull</code> step in the pre-processing stage.</dd>
  65. </dl>
  66. </section>
  67. </div>
  68. <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../dev_ref/plugin-extension-points.html" title="The 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, the DITA-OT makes each extension visible to the rest of the toolkit.">Extension points</a></div></div></nav></article></main></body></html>