| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 2 | <!DOCTYPE html
|
|---|
| 3 | PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|---|
| 4 | <html xml:lang="en-us" lang="en-us">
|
|---|
| 5 | <head>
|
|---|
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
|
|---|
| 7 | <meta name="copyright" content="(C) Copyright 2005"/>
|
|---|
| 8 | <meta name="DC.rights.owner" content="(C) Copyright 2005"/>
|
|---|
| 9 | <meta name="DC.Type" content="reference"/>
|
|---|
| 10 | <meta name="DC.Title" content="Adding Ant targets to the pre-process pipeline"/>
|
|---|
| 11 | <meta name="abstract" content="Every step in the pre-process pipeline defines an extension point before and after the step, to allow plug-ins to integrate additional processing. This allows a plug-in to insert a new step before any pre-processing step, as well as before or after the entire preprocess pipeline."/>
|
|---|
| 12 | <meta name="description" content="Every step in the pre-process pipeline defines an extension point before and after the step, to allow plug-ins to integrate additional processing. This allows a plug-in to insert a new step before any pre-processing step, as well as before or after the entire preprocess pipeline."/>
|
|---|
| 13 | <meta name="DC.Relation" scheme="URI" content="../dev_ref/plugins-overview.html"/>
|
|---|
| 14 | <meta name="DC.Format" content="XHTML"/>
|
|---|
| 15 | <meta name="DC.Identifier" content="plugin-antpreprocess"/>
|
|---|
| 16 | <meta name="DC.Language" content="en-us"/>
|
|---|
| 17 | <link rel="stylesheet" type="text/css" href="../commonltr.css"/>
|
|---|
| 18 | <link rel="stylesheet" type="text/css" href="../dita-ot-doc.css"/>
|
|---|
| 19 | <title>Adding Ant targets to the pre-process pipeline</title>
|
|---|
| 20 | </head>
|
|---|
| 21 | <body id="plugin-antpreprocess">
|
|---|
| 22 |
|
|---|
| 23 |
|
|---|
| 24 | <h1 class="title topictitle1">Adding Ant targets to the pre-process pipeline</h1>
|
|---|
| 25 |
|
|---|
| 26 |
|
|---|
| 27 | <div class="body refbody"><p class="shortdesc">Every step in the pre-process pipeline defines an extension
|
|---|
| 28 | point before and after the step, to allow plug-ins to integrate additional
|
|---|
| 29 | processing. This allows a plug-in to insert a new step before any
|
|---|
| 30 | pre-processing step, as well as before or after the entire preprocess
|
|---|
| 31 | pipeline.</p>
|
|---|
| 32 |
|
|---|
| 33 | <div class="section"><p class="p">The group of preprocessing steps defines extension points
|
|---|
| 34 | before and after the full preprocessing chain.</p>
|
|---|
| 35 | <dl class="dl">
|
|---|
| 36 | <dt class="dt dlterm"><samp class="ph codeph">depend.preprocess.pre</samp></dt>
|
|---|
| 37 |
|
|---|
| 38 | <dd class="dd">Preprocessing pre-target; extending this target runs your Ant
|
|---|
| 39 | target before the full preprocess routine begins.</dd>
|
|---|
| 40 |
|
|---|
| 41 |
|
|---|
| 42 | <dt class="dt dlterm"><samp class="ph codeph">depend.preprocess.post</samp></dt>
|
|---|
| 43 |
|
|---|
| 44 | <dd class="dd">Preprocessing post-target; extending this target runs your Ant
|
|---|
| 45 | target after the full preprocess routine completes.</dd>
|
|---|
| 46 |
|
|---|
| 47 | </dl>
|
|---|
| 48 | <p class="p">In addition, there are extension points to execute
|
|---|
| 49 | an Ant target before individual preprocessing steps.</p>
|
|---|
| 50 | <dl class="dl">
|
|---|
| 51 | <dt class="dt dlterm"><samp class="ph codeph">depend.preprocess.clean-temp.pre</samp></dt>
|
|---|
| 52 |
|
|---|
| 53 | <dd class="dd">Clean temp pre-target</dd>
|
|---|
| 54 |
|
|---|
| 55 |
|
|---|
| 56 | <dt class="dt dlterm"><samp class="ph codeph">depend.preprocess.gen-list.pre</samp></dt>
|
|---|
| 57 |
|
|---|
| 58 | <dd class="dd">Generate list pre-target</dd>
|
|---|
| 59 |
|
|---|
| 60 |
|
|---|
| 61 | <dt class="dt dlterm"><samp class="ph codeph">depend.preprocess.debug-filter.pre</samp></dt>
|
|---|
| 62 |
|
|---|
| 63 | <dd class="dd">Debug and filter pre-target</dd>
|
|---|
| 64 |
|
|---|
| 65 |
|
|---|
| 66 | <dt class="dt dlterm"><samp class="ph codeph">depend.preprocess.conrefpush.pre</samp></dt>
|
|---|
| 67 |
|
|---|
| 68 | <dd class="dd">Content reference push pre-target</dd>
|
|---|
| 69 |
|
|---|
| 70 |
|
|---|
| 71 | <dt class="dt dlterm"><samp class="ph codeph">depend.preprocess.move-meta-entries.pre</samp></dt>
|
|---|
| 72 |
|
|---|
| 73 | <dd class="dd">Move meta entries pre-target</dd>
|
|---|
| 74 |
|
|---|
| 75 |
|
|---|
| 76 | <dt class="dt dlterm"><samp class="ph codeph">depend.preprocess.conref.pre</samp></dt>
|
|---|
| 77 |
|
|---|
| 78 | <dd class="dd">Content reference pre-target</dd>
|
|---|
| 79 |
|
|---|
| 80 |
|
|---|
| 81 | <dt class="dt dlterm"><samp class="ph codeph">depend.preprocess.coderef.pre</samp></dt>
|
|---|
| 82 |
|
|---|
| 83 | <dd class="dd">Code reference pre-target</dd>
|
|---|
| 84 |
|
|---|
| 85 |
|
|---|
| 86 | <dt class="dt dlterm"><samp class="ph codeph">depend.preprocess.mapref.pre</samp></dt>
|
|---|
| 87 |
|
|---|
| 88 | <dd class="dd">Map reference pre-target</dd>
|
|---|
| 89 |
|
|---|
| 90 |
|
|---|
| 91 | <dt class="dt dlterm"><samp class="ph codeph">depend.preprocess.keyref.pre</samp></dt>
|
|---|
| 92 |
|
|---|
| 93 | <dd class="dd">Resolve key reference pre-target</dd>
|
|---|
| 94 |
|
|---|
| 95 |
|
|---|
| 96 | <dt class="dt dlterm"><samp class="ph codeph">depend.preprocess.mappull.pre</samp></dt>
|
|---|
| 97 |
|
|---|
| 98 | <dd class="dd">Map pull pre-target</dd>
|
|---|
| 99 |
|
|---|
| 100 |
|
|---|
| 101 | <dt class="dt dlterm"><samp class="ph codeph">depend.preprocess.chunk.pre</samp></dt>
|
|---|
| 102 |
|
|---|
| 103 | <dd class="dd">Chunking pre-target</dd>
|
|---|
| 104 |
|
|---|
| 105 |
|
|---|
| 106 | <dt class="dt dlterm"><samp class="ph codeph">depend.preprocess.maplink.pre</samp></dt>
|
|---|
| 107 |
|
|---|
| 108 | <dd class="dd">Map link pre-target</dd>
|
|---|
| 109 |
|
|---|
| 110 |
|
|---|
| 111 | <dt class="dt dlterm"><samp class="ph codeph">depend.preprocess.move-links.pre</samp></dt>
|
|---|
| 112 |
|
|---|
| 113 | <dd class="dd">Move links pre-target</dd>
|
|---|
| 114 |
|
|---|
| 115 |
|
|---|
| 116 | <dt class="dt dlterm"><samp class="ph codeph">depend.preprocess.topicpull.pre</samp></dt>
|
|---|
| 117 |
|
|---|
| 118 | <dd class="dd">Topic pull pre-target</dd>
|
|---|
| 119 |
|
|---|
| 120 |
|
|---|
| 121 | <dt class="dt dlterm"><samp class="ph codeph">depend.preprocess.copy-files.pre</samp></dt>
|
|---|
| 122 |
|
|---|
| 123 | <dd class="dd">Copy files pre-target</dd>
|
|---|
| 124 |
|
|---|
| 125 |
|
|---|
| 126 | <dt class="dt dlterm"><samp class="ph codeph">depend.preprocess.copy-image.pre</samp></dt>
|
|---|
| 127 |
|
|---|
| 128 | <dd class="dd">Copy images pre-target</dd>
|
|---|
| 129 |
|
|---|
| 130 |
|
|---|
| 131 | <dt class="dt dlterm"><samp class="ph codeph">depend.preprocess.copy-html.pre</samp></dt>
|
|---|
| 132 |
|
|---|
| 133 | <dd class="dd">Copy HTML pre-target</dd>
|
|---|
| 134 |
|
|---|
| 135 |
|
|---|
| 136 | <dt class="dt dlterm"><samp class="ph codeph">depend.preprocess.copy-flag.pre</samp></dt>
|
|---|
| 137 |
|
|---|
| 138 | <dd class="dd">Copy flag pre-target</dd>
|
|---|
| 139 |
|
|---|
| 140 |
|
|---|
| 141 | <dt class="dt dlterm"><samp class="ph codeph">depend.preprocess.copy-subsidiary.pre</samp></dt>
|
|---|
| 142 |
|
|---|
| 143 | <dd class="dd">Copy subsidiary pre-target</dd>
|
|---|
| 144 |
|
|---|
| 145 |
|
|---|
| 146 | <dt class="dt dlterm"><samp class="ph codeph">depend.preprocess.copy-generated-files.pre</samp></dt>
|
|---|
| 147 |
|
|---|
| 148 | <dd class="dd">Copy generated files pre-target</dd>
|
|---|
| 149 |
|
|---|
| 150 | </dl>
|
|---|
| 151 | </div>
|
|---|
| 152 |
|
|---|
| 153 | <div class="example"><h2 class="title sectiontitle">Example</h2><p class="p">The following feature adds "myAntTargetBeforeChunk"
|
|---|
| 154 | Ant target to be executed before the chunk step in preprocessing.
|
|---|
| 155 | It assumes that an Ant file defining that target has already been
|
|---|
| 156 | integrated.</p>
|
|---|
| 157 | <pre class="pre codeblock"><plugin id="com.example.extendchunk">
|
|---|
| 158 | <feature extension="depend.preprocess.chunk.pre" value="myAntTargetBeforeChunk"/>
|
|---|
| 159 | </plugin></pre>
|
|---|
| 160 | <p class="p">When integrated, the Ant target "myAntTargetBeforeChunk"
|
|---|
| 161 | will be added to the Ant dependency list so that it always runs immediately
|
|---|
| 162 | before the Chunk step.</p>
|
|---|
| 163 | </div>
|
|---|
| 164 |
|
|---|
| 165 | </div>
|
|---|
| 166 |
|
|---|
| 167 | <div class="related-links">
|
|---|
| 168 | <div class="familylinks">
|
|---|
| 169 | <div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../dev_ref/plugins-overview.html" title="The DITA Open Toolkit comes with a built in mechanism for adding in extensions through plug-ins. These plug-ins may do a wide variety of things, such as adding support for specialized DITA DTDs or Schemas, integrating processing overrides, or even providing entirely new output transforms. Plug-ins are the best way to extend the toolkit in a way that is consistent, easily sharable, and easy to preserve through toolkit upgrades.">Creating DITA-OT plug-ins</a></div>
|
|---|
| 170 | </div>
|
|---|
| 171 | </div>
|
|---|
| 172 |
|
|---|
| 173 | </body>
|
|---|
| 174 | </html>
|
|---|
