plugin-extension-points-pre-processing.dita 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  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="plugin-extension-points-pre-processing">
  5. <title>Pre-processing extension points</title>
  6. <shortdesc>You can use these extension points to run an Ant target before or after the pre-processing stage. If
  7. necessary, you can also run an Ant target before a specific pre-processing step — but this approach is not
  8. recommended.</shortdesc>
  9. <refbody>
  10. <section>
  11. <note conref="../resources/conref-task.dita#ID/tip-extend-before-after-preprocessing"/>
  12. <dl>
  13. <dlentry>
  14. <dt><parmname>depend.preprocess.pre</parmname></dt>
  15. <dd conaction="pushreplace"
  16. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.pre.desc">Runs an Ant
  17. target before the pre-processing stage.</dd>
  18. </dlentry>
  19. <dlentry>
  20. <dt><parmname>depend.preprocess.post</parmname></dt>
  21. <dd conaction="pushreplace"
  22. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.post.desc">Runs an Ant
  23. target after the pre-processing stage.</dd>
  24. </dlentry>
  25. </dl>
  26. </section>
  27. <section>
  28. <title>Legacy pre-processing extensions</title>
  29. <p>The following extension points are available in the original <codeph>preprocess</codeph> pipeline that was used
  30. by default for all transformations prior to DITA-OT 3.0. These extensions are not available in the newer <xref
  31. keyref="map-first-preproc">map-first preprocessing</xref> pipeline (<codeph>preprocess2</codeph>), which is
  32. used in the PDF and HTML Help transformations as of DITA-OT 3.0.</p>
  33. <note conref="../resources/conref-task.dita#ID/caution-extend-within-preprocessing"/>
  34. <dl>
  35. <dlentry>
  36. <dt><parmname>depend.preprocess.chunk.pre</parmname></dt>
  37. <dd conaction="pushreplace"
  38. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.chunk.pre.desc">Runs an
  39. Ant target before the <codeph>chunk</codeph> step in the pre-processing stage.</dd>
  40. </dlentry>
  41. <dlentry>
  42. <dt><parmname>depend.preprocess.coderef.pre</parmname></dt>
  43. <dd conaction="pushreplace"
  44. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.coderef.pre.desc">Runs an
  45. Ant target before the <codeph>coderef</codeph> step in the pre-processing stage.</dd>
  46. </dlentry>
  47. <dlentry>
  48. <dt><parmname>depend.preprocess.conref.pre</parmname></dt>
  49. <dd conaction="pushreplace"
  50. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.conref.pre.desc">Runs an
  51. Ant target before the <codeph>conref</codeph> step in the pre-processing stage.</dd>
  52. </dlentry>
  53. <dlentry>
  54. <dt><parmname>depend.preprocess.conrefpush.pre</parmname></dt>
  55. <dd conaction="pushreplace"
  56. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.conrefpush.pre.desc">Runs
  57. an Ant target before the <codeph>conrefpush</codeph> step in the pre-processing stage.</dd>
  58. </dlentry>
  59. <dlentry>
  60. <dt><parmname>depend.preprocess.clean-temp.pre</parmname></dt>
  61. <dd conaction="pushreplace"
  62. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.clean-temp.pre.desc">Runs
  63. an Ant target before the <codeph>clean-temp</codeph> step in the pre-processing stage.</dd>
  64. </dlentry>
  65. <dlentry>
  66. <dt><parmname>depend.preprocess.copy-files.pre</parmname></dt>
  67. <dd conaction="pushreplace"
  68. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.copy-files.pre.desc">Runs
  69. an Ant target before the <codeph>copy-files</codeph> step in the pre-processing stage.</dd>
  70. </dlentry>
  71. <dlentry>
  72. <dt><parmname>depend.preprocess.copy-flag.pre</parmname></dt>
  73. <dd conaction="pushreplace"
  74. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.copy-flag.pre.desc">Runs
  75. an Ant target before the <codeph>copy-flag</codeph> step in the pre-processing stage.</dd>
  76. </dlentry>
  77. <dlentry>
  78. <dt><parmname>depend.preprocess.copy-html.pre</parmname></dt>
  79. <dd conaction="pushreplace"
  80. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.copy-html.pre.desc">Runs
  81. an Ant target before the <codeph>copy-html</codeph> step in the pre-processing stage.</dd>
  82. </dlentry>
  83. <dlentry>
  84. <dt><parmname>depend.preprocess.copy-image.pre</parmname></dt>
  85. <dd conaction="pushreplace"
  86. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.copy-image.pre.desc">Runs
  87. an Ant target before the <codeph>copy-image</codeph> step in the pre-processing stage.</dd>
  88. </dlentry>
  89. <dlentry>
  90. <dt><parmname>depend.preprocess.copy-subsidiary.pre</parmname></dt>
  91. <dd conaction="pushreplace"
  92. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.copy-subsidiary.pre.desc"
  93. >Runs an Ant target before the <codeph>copy-subsidiary</codeph> step in the pre-processing stage.</dd>
  94. </dlentry>
  95. <dlentry>
  96. <dt><parmname>depend.preprocess.debug-filter.pre</parmname></dt>
  97. <dd conaction="pushreplace"
  98. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.debug-filter.pre.desc"
  99. >Runs an Ant target before the <codeph>debug-filter</codeph> step in the pre-processing stage.</dd>
  100. </dlentry>
  101. <dlentry>
  102. <dt><parmname>depend.preprocess.gen-list.pre</parmname></dt>
  103. <dd conaction="pushreplace"
  104. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.gen-list.pre.desc">Runs
  105. an Ant target before the <codeph>gen-list</codeph> step in the pre-processing stage.</dd>
  106. </dlentry>
  107. <dlentry>
  108. <dt><parmname>depend.preprocess.keyref.pre</parmname></dt>
  109. <dd conaction="pushreplace"
  110. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.keyref.pre.desc">Runs an
  111. Ant target before the <codeph>keyref</codeph> step in the pre-processing stage.</dd>
  112. </dlentry>
  113. <dlentry>
  114. <dt><parmname>depend.preprocess.maplink.pre</parmname></dt>
  115. <dd conaction="pushreplace"
  116. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.maplink.pre.desc">Runs an
  117. Ant target before the <codeph>maplink</codeph> step in the pre-processing stage.</dd>
  118. </dlentry>
  119. <dlentry>
  120. <dt><parmname>depend.preprocess.mappull.pre</parmname></dt>
  121. <dd conaction="pushreplace"
  122. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.mappull.pre.desc">Runs an
  123. Ant target before the <codeph>mappull</codeph> step in the pre-processing stage.</dd>
  124. </dlentry>
  125. <dlentry>
  126. <dt><parmname>depend.preprocess.mapref.pre</parmname></dt>
  127. <dd conaction="pushreplace"
  128. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.mapref.pre.desc">Runs an
  129. Ant target before the <codeph>mapref</codeph> step in the pre-processing stage.</dd>
  130. </dlentry>
  131. <dlentry>
  132. <dt><parmname>depend.preprocess.move-meta-entries.pre</parmname></dt>
  133. <dd conaction="pushreplace"
  134. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.move-meta-entries.pre.desc"
  135. >Runs an Ant target before the <codeph>move-meta-entries</codeph> step in the pre-processing stage.</dd>
  136. </dlentry>
  137. <dlentry>
  138. <dt><parmname>depend.preprocess.topicpull.pre</parmname></dt>
  139. <dd conaction="pushreplace"
  140. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.topicpull.pre.desc">Runs
  141. an Ant target before the <codeph>topicpull</codeph> step in the pre-processing stage.</dd>
  142. </dlentry>
  143. </dl>
  144. </section>
  145. </refbody>
  146. </reference>