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="Generate lists (gen-list)"/>
|
---|
11 | <meta name="abstract" content="The gen-list step examines the input files and creates lists of topics, images, document properties, or other content. These lists are used by later steps in the pipeline. For example, one list includes all topics that make use of the conref attribute; only those files are processed during the conref stage of the build. This step is implemented in Ant and Java."/>
|
---|
12 | <meta name="description" content="The gen-list step examines the input files and creates lists of topics, images, document properties, or other content. These lists are used by later steps in the pipeline. For example, one list includes all topics that make use of the conref attribute; only those files are processed during the conref stage of the build. This step is implemented in Ant and Java."/>
|
---|
13 | <meta name="DC.Relation" scheme="URI" content="../dev_ref/DITA-OTPreprocess.html"/>
|
---|
14 | <meta name="DC.Relation" scheme="URI" content="../dev_ref/preprocess-debugfilter.html"/>
|
---|
15 | <meta name="DC.Format" content="XHTML"/>
|
---|
16 | <meta name="DC.Identifier" content="preprocess-genlist"/>
|
---|
17 | <meta name="DC.Language" content="en-us"/>
|
---|
18 | <link rel="stylesheet" type="text/css" href="../commonltr.css"/>
|
---|
19 | <link rel="stylesheet" type="text/css" href="../dita-ot-doc.css"/>
|
---|
20 | <title>Generate lists (gen-list)</title>
|
---|
21 | </head>
|
---|
22 | <body id="preprocess-genlist">
|
---|
23 |
|
---|
24 |
|
---|
25 | <h1 class="title topictitle1">Generate lists (gen-list)</h1>
|
---|
26 |
|
---|
27 |
|
---|
28 | <div class="body refbody"><p class="shortdesc">The <samp class="ph codeph">gen-list</samp> step examines the input files
|
---|
29 | and creates lists of topics, images, document properties, or other
|
---|
30 | content. These lists are used by later steps in the pipeline. For
|
---|
31 | example, one list includes all topics that make use of the conref
|
---|
32 | attribute; only those files are processed during the conref
|
---|
33 | stage of the build. This step is implemented in Ant and Java.</p>
|
---|
34 |
|
---|
35 | <div class="section"><p class="p">The result of this list is a set of several list files
|
---|
36 | in the temporary directory, including <span class="ph filepath">dita.list</span> and <span class="ph filepath">dita.xml.properties</span>.</p>
|
---|
37 |
|
---|
38 | <div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" class="table" frame="border" border="1" rules="all">
|
---|
39 |
|
---|
40 | <thead class="thead" align="left">
|
---|
41 | <tr class="row">
|
---|
42 | <th class="entry" valign="top" id="d10247e40">List file property</th>
|
---|
43 |
|
---|
44 | <th class="entry" valign="top" id="d10247e43">List file</th>
|
---|
45 |
|
---|
46 | <th class="entry" valign="top" id="d10247e46">List property</th>
|
---|
47 |
|
---|
48 | <th class="entry" valign="top" id="d10247e49">Usage</th>
|
---|
49 |
|
---|
50 | </tr>
|
---|
51 |
|
---|
52 | </thead>
|
---|
53 |
|
---|
54 | <tbody class="tbody">
|
---|
55 | <tr class="row">
|
---|
56 | <td class="entry" valign="top" headers="d10247e40 ">canditopicsfile</td>
|
---|
57 |
|
---|
58 | <td class="entry" valign="top" headers="d10247e43 "><samp class="ph codeph">canditopics.list</samp></td>
|
---|
59 |
|
---|
60 | <td class="entry" valign="top" headers="d10247e46 ">canditopicslist</td>
|
---|
61 |
|
---|
62 | <td class="entry" valign="top" headers="d10247e49 "> </td>
|
---|
63 |
|
---|
64 | </tr>
|
---|
65 |
|
---|
66 | <tr class="row">
|
---|
67 | <td class="entry" valign="top" headers="d10247e40 ">chunkedditamapfile</td>
|
---|
68 |
|
---|
69 | <td class="entry" valign="top" headers="d10247e43 "><samp class="ph codeph">chunkedditamap.list</samp></td>
|
---|
70 |
|
---|
71 | <td class="entry" valign="top" headers="d10247e46 ">chunkedditamaplist</td>
|
---|
72 |
|
---|
73 | <td class="entry" valign="top" headers="d10247e49 "> </td>
|
---|
74 |
|
---|
75 | </tr>
|
---|
76 |
|
---|
77 | <tr class="row">
|
---|
78 | <td class="entry" valign="top" headers="d10247e40 ">chunkedtopicfile</td>
|
---|
79 |
|
---|
80 | <td class="entry" valign="top" headers="d10247e43 "><samp class="ph codeph">chunkedtopic.list</samp></td>
|
---|
81 |
|
---|
82 | <td class="entry" valign="top" headers="d10247e46 ">chunkedtopiclist</td>
|
---|
83 |
|
---|
84 | <td class="entry" valign="top" headers="d10247e49 "> </td>
|
---|
85 |
|
---|
86 | </tr>
|
---|
87 |
|
---|
88 | <tr class="row">
|
---|
89 | <td class="entry" valign="top" headers="d10247e40 ">codereffile</td>
|
---|
90 |
|
---|
91 | <td class="entry" valign="top" headers="d10247e43 "><samp class="ph codeph">coderef.list</samp></td>
|
---|
92 |
|
---|
93 | <td class="entry" valign="top" headers="d10247e46 ">codereflist</td>
|
---|
94 |
|
---|
95 | <td class="entry" valign="top" headers="d10247e49 ">topics with coderef</td>
|
---|
96 |
|
---|
97 | </tr>
|
---|
98 |
|
---|
99 | <tr class="row">
|
---|
100 | <td class="entry" valign="top" headers="d10247e40 ">conreffile</td>
|
---|
101 |
|
---|
102 | <td class="entry" valign="top" headers="d10247e43 "><samp class="ph codeph">conref.list</samp></td>
|
---|
103 |
|
---|
104 | <td class="entry" valign="top" headers="d10247e46 ">conreflist</td>
|
---|
105 |
|
---|
106 | <td class="entry" valign="top" headers="d10247e49 ">Documents that contains conref attribute that
|
---|
107 | need to be resolved in preprocess.</td>
|
---|
108 |
|
---|
109 | </tr>
|
---|
110 |
|
---|
111 | <tr class="row">
|
---|
112 | <td class="entry" valign="top" headers="d10247e40 ">conrefpushfile</td>
|
---|
113 |
|
---|
114 | <td class="entry" valign="top" headers="d10247e43 "><samp class="ph codeph">conrefpush.list</samp></td>
|
---|
115 |
|
---|
116 | <td class="entry" valign="top" headers="d10247e46 ">conrefpushlist</td>
|
---|
117 |
|
---|
118 | <td class="entry" valign="top" headers="d10247e49 "> </td>
|
---|
119 |
|
---|
120 | </tr>
|
---|
121 |
|
---|
122 | <tr class="row">
|
---|
123 | <td class="entry" valign="top" headers="d10247e40 ">conreftargetsfile</td>
|
---|
124 |
|
---|
125 | <td class="entry" valign="top" headers="d10247e43 "><samp class="ph codeph">conreftargets.list</samp></td>
|
---|
126 |
|
---|
127 | <td class="entry" valign="top" headers="d10247e46 ">conreftargetslist</td>
|
---|
128 |
|
---|
129 | <td class="entry" valign="top" headers="d10247e49 "> </td>
|
---|
130 |
|
---|
131 | </tr>
|
---|
132 |
|
---|
133 | <tr class="row">
|
---|
134 | <td class="entry" valign="top" headers="d10247e40 ">copytosourcefile</td>
|
---|
135 |
|
---|
136 | <td class="entry" valign="top" headers="d10247e43 "><samp class="ph codeph">copytosource.list</samp></td>
|
---|
137 |
|
---|
138 | <td class="entry" valign="top" headers="d10247e46 ">copytosourcelist</td>
|
---|
139 |
|
---|
140 | <td class="entry" valign="top" headers="d10247e49 "> </td>
|
---|
141 |
|
---|
142 | </tr>
|
---|
143 |
|
---|
144 | <tr class="row">
|
---|
145 | <td class="entry" valign="top" headers="d10247e40 ">copytotarget2sourcemapfile</td>
|
---|
146 |
|
---|
147 | <td class="entry" valign="top" headers="d10247e43 "><samp class="ph codeph">copytotarget2sourcemap.list</samp></td>
|
---|
148 |
|
---|
149 | <td class="entry" valign="top" headers="d10247e46 ">copytotarget2sourcemaplist</td>
|
---|
150 |
|
---|
151 | <td class="entry" valign="top" headers="d10247e49 "> </td>
|
---|
152 |
|
---|
153 | </tr>
|
---|
154 |
|
---|
155 | <tr class="row">
|
---|
156 | <td class="entry" valign="top" headers="d10247e40 ">flagimagefile</td>
|
---|
157 |
|
---|
158 | <td class="entry" valign="top" headers="d10247e43 "><samp class="ph codeph">flagimage.list</samp></td>
|
---|
159 |
|
---|
160 | <td class="entry" valign="top" headers="d10247e46 ">flagimagelist</td>
|
---|
161 |
|
---|
162 | <td class="entry" valign="top" headers="d10247e49 "> </td>
|
---|
163 |
|
---|
164 | </tr>
|
---|
165 |
|
---|
166 | <tr class="row">
|
---|
167 | <td class="entry" valign="top" headers="d10247e40 ">fullditamapandtopicfile</td>
|
---|
168 |
|
---|
169 | <td class="entry" valign="top" headers="d10247e43 "><samp class="ph codeph">fullditamapandtopic.list</samp></td>
|
---|
170 |
|
---|
171 | <td class="entry" valign="top" headers="d10247e46 ">fullditamapandtopiclist</td>
|
---|
172 |
|
---|
173 | <td class="entry" valign="top" headers="d10247e49 ">All of the ditamap and topic files that are
|
---|
174 | referenced during the transformation. These may be
|
---|
175 | referenced by href or conref attributes.</td>
|
---|
176 |
|
---|
177 | </tr>
|
---|
178 |
|
---|
179 | <tr class="row">
|
---|
180 | <td class="entry" valign="top" headers="d10247e40 ">fullditamapfile</td>
|
---|
181 |
|
---|
182 | <td class="entry" valign="top" headers="d10247e43 "><samp class="ph codeph">fullditamap.list</samp></td>
|
---|
183 |
|
---|
184 | <td class="entry" valign="top" headers="d10247e46 ">fullditamaplist</td>
|
---|
185 |
|
---|
186 | <td class="entry" valign="top" headers="d10247e49 ">All of the ditamap files in dita.list</td>
|
---|
187 |
|
---|
188 | </tr>
|
---|
189 |
|
---|
190 | <tr class="row">
|
---|
191 | <td class="entry" valign="top" headers="d10247e40 ">fullditatopicfile</td>
|
---|
192 |
|
---|
193 | <td class="entry" valign="top" headers="d10247e43 "><samp class="ph codeph">fullditatopic.list</samp></td>
|
---|
194 |
|
---|
195 | <td class="entry" valign="top" headers="d10247e46 ">fullditatopiclist</td>
|
---|
196 |
|
---|
197 | <td class="entry" valign="top" headers="d10247e49 ">All of the topic files in dita.list</td>
|
---|
198 |
|
---|
199 | </tr>
|
---|
200 |
|
---|
201 | <tr class="row">
|
---|
202 | <td class="entry" valign="top" headers="d10247e40 ">hrefditatopicfile</td>
|
---|
203 |
|
---|
204 | <td class="entry" valign="top" headers="d10247e43 "><samp class="ph codeph">hrefditatopic.list</samp></td>
|
---|
205 |
|
---|
206 | <td class="entry" valign="top" headers="d10247e46 ">hrefditatopiclist</td>
|
---|
207 |
|
---|
208 | <td class="entry" valign="top" headers="d10247e49 ">All of the topic files that are referenced with
|
---|
209 | an href attribute</td>
|
---|
210 |
|
---|
211 | </tr>
|
---|
212 |
|
---|
213 | <tr class="row">
|
---|
214 | <td class="entry" valign="top" headers="d10247e40 ">hreftargetsfile</td>
|
---|
215 |
|
---|
216 | <td class="entry" valign="top" headers="d10247e43 "><samp class="ph codeph">hreftargets.list</samp></td>
|
---|
217 |
|
---|
218 | <td class="entry" valign="top" headers="d10247e46 ">hreftargetslist</td>
|
---|
219 |
|
---|
220 | <td class="entry" valign="top" headers="d10247e49 ">link targets</td>
|
---|
221 |
|
---|
222 | </tr>
|
---|
223 |
|
---|
224 | <tr class="row">
|
---|
225 | <td class="entry" valign="top" headers="d10247e40 ">htmlfile</td>
|
---|
226 |
|
---|
227 | <td class="entry" valign="top" headers="d10247e43 "><samp class="ph codeph">html.list</samp></td>
|
---|
228 |
|
---|
229 | <td class="entry" valign="top" headers="d10247e46 ">htmllist</td>
|
---|
230 |
|
---|
231 | <td class="entry" valign="top" headers="d10247e49 ">resource files</td>
|
---|
232 |
|
---|
233 | </tr>
|
---|
234 |
|
---|
235 | <tr class="row">
|
---|
236 | <td class="entry" valign="top" headers="d10247e40 ">imagefile</td>
|
---|
237 |
|
---|
238 | <td class="entry" valign="top" headers="d10247e43 "><samp class="ph codeph">image.list</samp></td>
|
---|
239 |
|
---|
240 | <td class="entry" valign="top" headers="d10247e46 ">imagelist</td>
|
---|
241 |
|
---|
242 | <td class="entry" valign="top" headers="d10247e49 ">Images files that are referenced in the content</td>
|
---|
243 |
|
---|
244 | </tr>
|
---|
245 |
|
---|
246 | <tr class="row">
|
---|
247 | <td class="entry" valign="top" headers="d10247e40 ">keyreffile</td>
|
---|
248 |
|
---|
249 | <td class="entry" valign="top" headers="d10247e43 "><samp class="ph codeph">keyref.list</samp></td>
|
---|
250 |
|
---|
251 | <td class="entry" valign="top" headers="d10247e46 ">keyreflist</td>
|
---|
252 |
|
---|
253 | <td class="entry" valign="top" headers="d10247e49 ">Topics and maps which have key references.</td>
|
---|
254 |
|
---|
255 | </tr>
|
---|
256 |
|
---|
257 | <tr class="row">
|
---|
258 | <td class="entry" valign="top" headers="d10247e40 ">outditafilesfile</td>
|
---|
259 |
|
---|
260 | <td class="entry" valign="top" headers="d10247e43 "><samp class="ph codeph">outditafiles.list</samp></td>
|
---|
261 |
|
---|
262 | <td class="entry" valign="top" headers="d10247e46 ">outditafileslist</td>
|
---|
263 |
|
---|
264 | <td class="entry" valign="top" headers="d10247e49 "> </td>
|
---|
265 |
|
---|
266 | </tr>
|
---|
267 |
|
---|
268 | <tr class="row">
|
---|
269 | <td class="entry" valign="top" headers="d10247e40 ">relflagimagefile</td>
|
---|
270 |
|
---|
271 | <td class="entry" valign="top" headers="d10247e43 "><samp class="ph codeph">relflagimage.list</samp></td>
|
---|
272 |
|
---|
273 | <td class="entry" valign="top" headers="d10247e46 ">relflagimagelist</td>
|
---|
274 |
|
---|
275 | <td class="entry" valign="top" headers="d10247e49 "> </td>
|
---|
276 |
|
---|
277 | </tr>
|
---|
278 |
|
---|
279 | <tr class="row">
|
---|
280 | <td class="entry" valign="top" headers="d10247e40 ">resourceonlyfile</td>
|
---|
281 |
|
---|
282 | <td class="entry" valign="top" headers="d10247e43 "><samp class="ph codeph">resourceonly.list</samp></td>
|
---|
283 |
|
---|
284 | <td class="entry" valign="top" headers="d10247e46 ">resourceonlylist</td>
|
---|
285 |
|
---|
286 | <td class="entry" valign="top" headers="d10247e49 "> </td>
|
---|
287 |
|
---|
288 | </tr>
|
---|
289 |
|
---|
290 | <tr class="row">
|
---|
291 | <td class="entry" valign="top" headers="d10247e40 ">skipchunkfile</td>
|
---|
292 |
|
---|
293 | <td class="entry" valign="top" headers="d10247e43 "><samp class="ph codeph">skipchunk.list</samp></td>
|
---|
294 |
|
---|
295 | <td class="entry" valign="top" headers="d10247e46 ">skipchunklist</td>
|
---|
296 |
|
---|
297 | <td class="entry" valign="top" headers="d10247e49 "> </td>
|
---|
298 |
|
---|
299 | </tr>
|
---|
300 |
|
---|
301 | <tr class="row">
|
---|
302 | <td class="entry" valign="top" headers="d10247e40 ">subjectschemefile</td>
|
---|
303 |
|
---|
304 | <td class="entry" valign="top" headers="d10247e43 "><samp class="ph codeph">subjectscheme.list</samp></td>
|
---|
305 |
|
---|
306 | <td class="entry" valign="top" headers="d10247e46 ">subjectschemelist</td>
|
---|
307 |
|
---|
308 | <td class="entry" valign="top" headers="d10247e49 "> </td>
|
---|
309 |
|
---|
310 | </tr>
|
---|
311 |
|
---|
312 | <tr class="row">
|
---|
313 | <td class="entry" valign="top" headers="d10247e40 ">subtargetsfile</td>
|
---|
314 |
|
---|
315 | <td class="entry" valign="top" headers="d10247e43 "><samp class="ph codeph">subtargets.list</samp></td>
|
---|
316 |
|
---|
317 | <td class="entry" valign="top" headers="d10247e46 ">subtargetslist</td>
|
---|
318 |
|
---|
319 | <td class="entry" valign="top" headers="d10247e49 "> </td>
|
---|
320 |
|
---|
321 | </tr>
|
---|
322 |
|
---|
323 | <tr class="row">
|
---|
324 | <td class="entry" valign="top" headers="d10247e40 ">tempdirToinputmapdir.relative.value</td>
|
---|
325 |
|
---|
326 | <td class="entry" valign="top" headers="d10247e43 "> </td>
|
---|
327 |
|
---|
328 | <td class="entry" valign="top" headers="d10247e46 "> </td>
|
---|
329 |
|
---|
330 | <td class="entry" valign="top" headers="d10247e49 "> </td>
|
---|
331 |
|
---|
332 | </tr>
|
---|
333 |
|
---|
334 | <tr class="row">
|
---|
335 | <td class="entry" valign="top" headers="d10247e40 ">uplevels</td>
|
---|
336 |
|
---|
337 | <td class="entry" valign="top" headers="d10247e43 "> </td>
|
---|
338 |
|
---|
339 | <td class="entry" valign="top" headers="d10247e46 "> </td>
|
---|
340 |
|
---|
341 | <td class="entry" valign="top" headers="d10247e49 "> </td>
|
---|
342 |
|
---|
343 | </tr>
|
---|
344 |
|
---|
345 | <tr class="row">
|
---|
346 | <td class="entry" valign="top" headers="d10247e40 ">user.input.dir</td>
|
---|
347 |
|
---|
348 | <td class="entry" valign="top" headers="d10247e43 "> </td>
|
---|
349 |
|
---|
350 | <td class="entry" valign="top" headers="d10247e46 "> </td>
|
---|
351 |
|
---|
352 | <td class="entry" valign="top" headers="d10247e49 ">Absolute input directory path</td>
|
---|
353 |
|
---|
354 | </tr>
|
---|
355 |
|
---|
356 | <tr class="row">
|
---|
357 | <td class="entry" valign="top" headers="d10247e40 ">user.input.file.listfile</td>
|
---|
358 |
|
---|
359 | <td class="entry" valign="top" headers="d10247e43 "> </td>
|
---|
360 |
|
---|
361 | <td class="entry" valign="top" headers="d10247e46 "> </td>
|
---|
362 |
|
---|
363 | <td class="entry" valign="top" headers="d10247e49 ">Input file list file</td>
|
---|
364 |
|
---|
365 | </tr>
|
---|
366 |
|
---|
367 | <tr class="row">
|
---|
368 | <td class="entry" valign="top" headers="d10247e40 ">user.input.file</td>
|
---|
369 |
|
---|
370 | <td class="entry" valign="top" headers="d10247e43 "> </td>
|
---|
371 |
|
---|
372 | <td class="entry" valign="top" headers="d10247e46 "> </td>
|
---|
373 |
|
---|
374 | <td class="entry" valign="top" headers="d10247e49 ">Input file path, relative to input directory</td>
|
---|
375 |
|
---|
376 | </tr>
|
---|
377 |
|
---|
378 | </tbody>
|
---|
379 |
|
---|
380 | </table>
|
---|
381 | </div>
|
---|
382 | </div>
|
---|
383 |
|
---|
384 | </div>
|
---|
385 |
|
---|
386 | <div class="related-links">
|
---|
387 | <div class="familylinks">
|
---|
388 | <div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../dev_ref/DITA-OTPreprocess.html" title="The pre-processing operation is a set of steps that typically runs at the beginning of every DITA-OT transformation. Each step or stage corresponds to an Ant target in the build pipeline; the preprocess target calls the entire set of steps.">Pre-processing modules</a></div>
|
---|
389 | <div class="nextlink"><strong>Next topic:</strong> <a class="link" href="../dev_ref/preprocess-debugfilter.html" title="The debug-filter step processes all referenced DITA content and creates copies in a temporary directory. As the DITA content is copied, filtering is performed, debugging information is inserted, and table column names are adjusted. This step is implemented in Java.">Debug and filter (debug-filter)</a></div>
|
---|
390 | </div>
|
---|
391 | </div>
|
---|
392 |
|
---|
393 | </body>
|
---|
394 | </html>
|
---|