1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
2 | <!--Arbortext, Inc., 1988-2011, v.4002-->
|
---|
3 | <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
|
---|
4 | "reference.dtd">
|
---|
5 | <?Pub Inc?>
|
---|
6 | <reference id="plugin-antpreprocess" xml:lang="en-us">
|
---|
7 | <title>Adding Ant targets to the pre-process pipeline</title>
|
---|
8 | <shortdesc>Every step in the pre-process pipeline defines an extension
|
---|
9 | point before and after the step, to allow plug-ins to integrate additional
|
---|
10 | processing. This allows a plug-in to insert a new step before any
|
---|
11 | pre-processing step, as well as before or after the entire preprocess
|
---|
12 | pipeline.</shortdesc>
|
---|
13 | <refbody>
|
---|
14 | <section><p>The group of preprocessing steps defines extension points
|
---|
15 | before and after the full preprocessing chain.</p><dl><dlentry>
|
---|
16 | <dt><codeph>depend.preprocess.pre</codeph></dt>
|
---|
17 | <dd>Preprocessing pre-target; extending this target runs your Ant
|
---|
18 | target before the full preprocess routine begins.</dd>
|
---|
19 | </dlentry><dlentry>
|
---|
20 | <dt><codeph>depend.preprocess.post</codeph></dt>
|
---|
21 | <dd>Preprocessing post-target; extending this target runs your Ant
|
---|
22 | target after the full preprocess routine completes.</dd>
|
---|
23 | </dlentry></dl><p>In addition, there are extension points to execute
|
---|
24 | an Ant target before individual preprocessing steps.</p><dl><dlentry>
|
---|
25 | <dt><codeph>depend.preprocess.clean-temp.pre</codeph></dt>
|
---|
26 | <dd>Clean temp pre-target</dd>
|
---|
27 | </dlentry><dlentry>
|
---|
28 | <dt><codeph>depend.preprocess.gen-list.pre</codeph></dt>
|
---|
29 | <dd>Generate list pre-target</dd>
|
---|
30 | </dlentry><dlentry>
|
---|
31 | <dt><codeph>depend.preprocess.debug-filter.pre</codeph></dt>
|
---|
32 | <dd>Debug and filter pre-target</dd>
|
---|
33 | </dlentry><dlentry>
|
---|
34 | <dt><codeph>depend.preprocess.conrefpush.pre</codeph></dt>
|
---|
35 | <dd>Content reference push pre-target</dd>
|
---|
36 | </dlentry><dlentry>
|
---|
37 | <dt><codeph>depend.preprocess.move-meta-entries.pre</codeph></dt>
|
---|
38 | <dd>Move meta entries pre-target</dd>
|
---|
39 | </dlentry><dlentry>
|
---|
40 | <dt><codeph>depend.preprocess.conref.pre</codeph></dt>
|
---|
41 | <dd>Content reference pre-target</dd>
|
---|
42 | </dlentry><dlentry>
|
---|
43 | <dt><codeph>depend.preprocess.coderef.pre</codeph></dt>
|
---|
44 | <dd>Code reference pre-target</dd>
|
---|
45 | </dlentry><dlentry>
|
---|
46 | <dt><codeph>depend.preprocess.mapref.pre</codeph></dt>
|
---|
47 | <dd>Map reference pre-target</dd>
|
---|
48 | </dlentry><dlentry>
|
---|
49 | <dt><codeph>depend.preprocess.keyref.pre</codeph></dt>
|
---|
50 | <dd>Resolve key reference pre-target</dd>
|
---|
51 | </dlentry><dlentry>
|
---|
52 | <dt><codeph>depend.preprocess.mappull.pre</codeph></dt>
|
---|
53 | <dd>Map pull pre-target</dd>
|
---|
54 | </dlentry><dlentry>
|
---|
55 | <dt><codeph>depend.preprocess.chunk.pre</codeph></dt>
|
---|
56 | <dd>Chunking pre-target</dd>
|
---|
57 | </dlentry><dlentry>
|
---|
58 | <dt><codeph>depend.preprocess.maplink.pre</codeph></dt>
|
---|
59 | <dd>Map link pre-target</dd>
|
---|
60 | </dlentry><dlentry>
|
---|
61 | <dt><codeph>depend.preprocess.move-links.pre</codeph></dt>
|
---|
62 | <dd>Move links pre-target</dd>
|
---|
63 | </dlentry><dlentry>
|
---|
64 | <dt><codeph>depend.preprocess.topicpull.pre</codeph></dt>
|
---|
65 | <dd>Topic pull pre-target</dd>
|
---|
66 | </dlentry><dlentry>
|
---|
67 | <dt><codeph>depend.preprocess.copy-files.pre</codeph></dt>
|
---|
68 | <dd>Copy files pre-target</dd>
|
---|
69 | </dlentry><dlentry>
|
---|
70 | <dt><codeph>depend.preprocess.copy-image.pre</codeph></dt>
|
---|
71 | <dd>Copy images pre-target</dd>
|
---|
72 | </dlentry><dlentry>
|
---|
73 | <dt><codeph>depend.preprocess.copy-html.pre</codeph></dt>
|
---|
74 | <dd>Copy HTML pre-target</dd>
|
---|
75 | </dlentry><dlentry>
|
---|
76 | <dt><codeph>depend.preprocess.copy-flag.pre</codeph></dt>
|
---|
77 | <dd>Copy flag pre-target</dd>
|
---|
78 | </dlentry><dlentry>
|
---|
79 | <dt><codeph>depend.preprocess.copy-subsidiary.pre</codeph></dt>
|
---|
80 | <dd>Copy subsidiary pre-target</dd>
|
---|
81 | </dlentry><dlentry>
|
---|
82 | <dt><codeph>depend.preprocess.copy-generated-files.pre</codeph></dt>
|
---|
83 | <dd>Copy generated files pre-target</dd>
|
---|
84 | </dlentry></dl></section>
|
---|
85 | <example><title>Example</title><p>The following feature adds "myAntTargetBeforeChunk"
|
---|
86 | Ant target to be executed before the chunk step in preprocessing.
|
---|
87 | It assumes that an Ant file defining that target has already been
|
---|
88 | integrated.</p><codeblock><plugin id="com.example.extendchunk">
|
---|
89 | <feature extension="depend.preprocess.chunk.pre" value="myAntTargetBeforeChunk"/>
|
---|
90 | </plugin></codeblock><p>When integrated, the Ant target "myAntTargetBeforeChunk"
|
---|
91 | will be added to the Ant dependency list so that it always runs immediately
|
---|
92 | before the Chunk step.</p><?Pub Caret -1?></example>
|
---|
93 | </refbody>
|
---|
94 | </reference>
|
---|
95 | <?Pub *0000004128?>
|
---|