source: vbox/trunk/src/libs/dita-ot-1.8.5/docsrc/dev_ref/preprocess-genlist.dita@ 98600

<?xml version="1.0" encoding="UTF-8"?>
<!-- This file is part of the DITA Open Toolkit project hosted on 
 Sourceforge.net. See the accompanying license.txt file for 
 applicable licenses.-->
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
 "reference.dtd">
<reference id="preprocess-genlist" xml:lang="en-us">
<title>Generate lists (gen-list)</title>
<shortdesc>The <codeph>gen-list</codeph> 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.</shortdesc>
<refbody>
<section><p>The result of this list is a set of several list files
in the temporary directory, including <filepath>dita.list</filepath> and <filepath>dita.xml.properties</filepath>.</p><table>
<tgroup cols="4"><colspec colname="col1"/><colspec colname="col2"/>
<colspec colname="col3"/><colspec colname="col4"/>
<thead>
<row>
<entry colname="col1">List file property</entry>
<entry colname="col2">List file</entry>
<entry colname="col3">List property</entry>
<entry colname="col4">Usage</entry>
</row>
</thead>
<tbody>
<row>
<entry colname="col1">canditopicsfile</entry>
<entry colname="col2"><codeph>canditopics.list</codeph></entry>
<entry colname="col3">canditopicslist</entry>
<entry colname="col4"></entry>
</row>
<row>
<entry colname="col1">chunkedditamapfile</entry>
<entry colname="col2"><codeph>chunkedditamap.list</codeph></entry>
<entry colname="col3">chunkedditamaplist</entry>
<entry colname="col4"></entry>
</row>
<row>
<entry colname="col1">chunkedtopicfile</entry>
<entry colname="col2"><codeph>chunkedtopic.list</codeph></entry>
<entry colname="col3">chunkedtopiclist</entry>
<entry colname="col4"></entry>
</row>
<row>
<entry colname="col1">codereffile</entry>
<entry colname="col2"><codeph>coderef.list</codeph></entry>
<entry colname="col3">codereflist</entry>
<entry colname="col4">topics with coderef</entry>
</row>
<row>
<entry colname="col1">conreffile</entry>
<entry colname="col2"><codeph>conref.list</codeph></entry>
<entry colname="col3">conreflist</entry>
<entry colname="col4">Documents that contains conref attribute that
need to be resolved in preprocess.</entry>
</row>
<row>
<entry colname="col1">conrefpushfile</entry>
<entry colname="col2"><codeph>conrefpush.list</codeph></entry>
<entry colname="col3">conrefpushlist</entry>
<entry colname="col4"></entry>
</row>
<row>
<entry colname="col1">conreftargetsfile</entry>
<entry colname="col2"><codeph>conreftargets.list</codeph></entry>
<entry colname="col3">conreftargetslist</entry>
<entry colname="col4"></entry>
</row>
<row>
<entry colname="col1">copytosourcefile</entry>
<entry colname="col2"><codeph>copytosource.list</codeph></entry>
<entry colname="col3">copytosourcelist</entry>
<entry colname="col4"></entry>
</row>
<row>
<entry colname="col1">copytotarget2sourcemapfile</entry>
<entry colname="col2"><codeph>copytotarget2sourcemap.list</codeph></entry>
<entry colname="col3">copytotarget2sourcemaplist</entry>
<entry colname="col4"></entry>
</row>
<row>
<entry colname="col1">flagimagefile</entry>
<entry colname="col2"><codeph>flagimage.list</codeph></entry>
<entry colname="col3">flagimagelist</entry>
<entry colname="col4"></entry>
</row>
<row>
<entry colname="col1">fullditamapandtopicfile</entry>
<entry colname="col2"><codeph>fullditamapandtopic.list</codeph></entry>
<entry colname="col3">fullditamapandtopiclist</entry>
<entry colname="col4">All of the ditamap and topic files that are
referenced during the transformation. These                 may be
referenced by href or conref attributes.</entry>
</row>
<row>
<entry colname="col1">fullditamapfile</entry>
<entry colname="col2"><codeph>fullditamap.list</codeph></entry>
<entry colname="col3">fullditamaplist</entry>
<entry colname="col4">All of the ditamap files in dita.list</entry>
</row>
<row>
<entry colname="col1">fullditatopicfile</entry>
<entry colname="col2"><codeph>fullditatopic.list</codeph></entry>
<entry colname="col3">fullditatopiclist</entry>
<entry colname="col4">All of the topic files in dita.list</entry>
</row>
<row>
<entry colname="col1">hrefditatopicfile</entry>
<entry colname="col2"><codeph>hrefditatopic.list</codeph></entry>
<entry colname="col3">hrefditatopiclist</entry>
<entry colname="col4">All of the topic files that are referenced with
an href attribute</entry>
</row>
<row>
<entry colname="col1">hreftargetsfile</entry>
<entry colname="col2"><codeph>hreftargets.list</codeph></entry>
<entry colname="col3">hreftargetslist</entry>
<entry colname="col4">link targets</entry>
</row>
<row>
<entry colname="col1">htmlfile</entry>
<entry colname="col2"><codeph>html.list</codeph></entry>
<entry colname="col3">htmllist</entry>
<entry colname="col4">resource files</entry>
</row>
<row>
<entry colname="col1">imagefile</entry>
<entry colname="col2"><codeph>image.list</codeph></entry>
<entry colname="col3">imagelist</entry>
<entry colname="col4">Images files that are referenced in the content</entry>
</row>
<row>
<entry colname="col1">keyreffile</entry>
<entry colname="col2"><codeph>keyref.list</codeph></entry>
<entry colname="col3">keyreflist</entry>
<entry colname="col4">Topics and maps which have key references.</entry>
</row>
<row>
<entry colname="col1">outditafilesfile</entry>
<entry colname="col2"><codeph>outditafiles.list</codeph></entry>
<entry colname="col3">outditafileslist</entry>
<entry colname="col4"></entry>
</row>
<row>
<entry colname="col1">relflagimagefile</entry>
<entry colname="col2"><codeph>relflagimage.list</codeph></entry>
<entry colname="col3">relflagimagelist</entry>
<entry colname="col4"></entry>
</row>
<row>
<entry colname="col1">resourceonlyfile</entry>
<entry colname="col2"><codeph>resourceonly.list</codeph></entry>
<entry colname="col3">resourceonlylist</entry>
<entry colname="col4"></entry>
</row>
<row>
<entry colname="col1">skipchunkfile</entry>
<entry colname="col2"><codeph>skipchunk.list</codeph></entry>
<entry colname="col3">skipchunklist</entry>
<entry colname="col4"></entry>
</row>
<row>
<entry colname="col1">subjectschemefile</entry>
<entry colname="col2"><codeph>subjectscheme.list</codeph></entry>
<entry colname="col3">subjectschemelist</entry>
<entry colname="col4"></entry>
</row>
<row>
<entry colname="col1">subtargetsfile</entry>
<entry colname="col2"><codeph>subtargets.list</codeph></entry>
<entry colname="col3">subtargetslist</entry>
<entry colname="col4"></entry>
</row>
<row>
<entry colname="col1">tempdirToinputmapdir.relative.value</entry>
<entry colname="col2"></entry>
<entry colname="col3"></entry>
<entry colname="col4"></entry>
</row>
<row>
<entry colname="col1">uplevels</entry>
<entry colname="col2"></entry>
<entry colname="col3"></entry>
<entry colname="col4"></entry>
</row>
<row>
<entry colname="col1">user.input.dir</entry>
<entry colname="col2"></entry>
<entry colname="col3"></entry>
<entry colname="col4">Absolute input directory path</entry>
</row>
<row>
<entry colname="col1">user.input.file.listfile</entry>
<entry colname="col2"></entry>
<entry colname="col3"></entry>
<entry colname="col4">Input file list file</entry>
</row>
<row>
<entry colname="col1">user.input.file</entry>
<entry colname="col2"></entry>
<entry colname="col3"></entry>
<entry colname="col4">Input file path, relative to input directory</entry>
</row>
</tbody>
</tgroup>
</table></section>
</refbody>
</reference>