Página Principal Explorar Ajuda
Iniciar Sessão
bn
/
se
2
0
Fork 0
Ficheiros Problemas 0 Pull Requests 0 Wiki
Árvore: e89bfafc3a
Ramos Etiquetas
se
/
SE
/
stuff
/
dita-ot-2.3.3
/
doc
/
dev_ref
/
preprocess-genlist.html

preprocess-genlist.html 15 KB
Histórico Em bruto

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135 
  1. <!DOCTYPE html
    2. 

  2.   SYSTEM "about:legacy-compat">
    3. 

  3. <html lang="en-us"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2016"><meta name="DC.rights.owner" content="(C) Copyright 2016"><meta name="DC.Type" content="reference"><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. This step is implemented in Java."><meta name="DC.Relation" scheme="URI" content="../dev_ref/DITA-OTPreprocess.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/preprocess-debugfilter.html"><meta name="DC.Format" content="XHTML"><meta name="DC.Identifier" content="preprocess-genlist"><meta name="DC.Language" content="en-US"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Generate lists (gen-list)</title></head><body id="preprocess-genlist"><header role="banner"><div class="header">
    4. 

  4.   <p>DITA Open Toolkit</p>
    5. 

  5.   <hr>
    6. 

  6. </div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 2.3</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../getting-started/index.html">Getting Started</a></li><li><a href="../user-guide/index.html">User Guide</a></li><li><a href="../parameters/index.html">Parameter Reference</a></li><li><a href="../dev_ref/index.html">Developer Reference</a><ul><li><a href="../dev_ref/DITA-OTArchitecture.html">DITA-OT Architecture</a><ul><li><a href="../dev_ref/processing-structure.html">Processing structure</a></li><li><a href="../dev_ref/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../dev_ref/processing-order.html">Processing order</a></li><li><a href="../dev_ref/DITA-OTPreprocess.html">Pre-processing modules</a><ul><li class="active"><a href="../dev_ref/preprocess-genlist.html">Generate lists (gen-list)</a></li><li><a href="../dev_ref/preprocess-debugfilter.html">Debug and filter (debug-filter)</a></li><li><a href="../dev_ref/preprocess-mapref.html">Resolve map references (mapref)</a></li><li><a href="../dev_ref/preprocess-copyfiles.html">Copy related files (copy-files)</a></li><li><a href="../dev_ref/preprocess-keyref.html">Resolve keyref (keyref)</a></li><li><a href="../dev_ref/preprocess-conrefpush.html">Conref push (conrefpush)</a></li><li><a href="../dev_ref/preprocess-conref.html">Conref (conref)</a></li><li><a href="../dev_ref/preprocess-coderef.html">Resolve code references (coderef)</a></li><li><a href="../dev_ref/preprocess-chunk.html">Chunk topics (chunk)</a></li><li><a href="../dev_ref/preprocess-metadata.html">Move metadata (move-meta-entries) and pull content into maps (mappull) </a></li><li><a href="../dev_ref/preprocess-maplink.html">Map based linking (maplink)</a></li><li><a href="../dev_ref/preprocess-topicpull.html">Pull content into topics (topicpull)</a></li><li><a href="../dev_ref/preprocess-flagging.html">Flagging in the toolkit</a></li></ul></li><li><a href="../dev_ref/XhtmlWithNavigation.html">HTML-based processing modules</a></li><li><a href="../dev_ref/PdfDefault.html">PDF processing modules</a></li><li><a href="../dev_ref/OdtDefault.html">Open Document Format processing modules</a></li></ul></li><li><a href="../dev_ref/extending-the-ot.html">Extending the DITA-OT</a></li><li><a href="../dev_ref/plugin-creating.html">Creating plug-ins</a></li><li><a href="../dev_ref/plugin-extension-points.html">Extension points</a></li><li><a href="../dev_ref/pdf-customization.html">Customizing PDF output</a></li><li><a href="../dev_ref/migration.html">Migrating customizations</a></li></ul></li><li><a href="../user-guide/dita-and-dita-ot-resources.html">DITA Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
    7. 

  7.   <h1 class="title topictitle1" id="ariaid-title1">Generate lists (gen-list)</h1>
    8. 

  8.   
    9. 

  9.   <div class="body refbody"><p class="shortdesc">The <code class="ph codeph">gen-list</code> step examines the input files and creates lists of topics, images, document
    10. 

  10.     properties, or other content. These lists are used by later steps in the pipeline. This step is implemented in
    11. 

  11.     Java.</p>
    12. 

  12.     <section class="section">
    13. 

  13.       <p class="p">For example, one list includes all topics that make use of the conref attribute; only those files are processed
    14. 

  14.         during the conref stage of the build. The list file name name is derived from the list file property. For
    15. 

  15.         example, the <code class="ph codeph">conref.list</code> file is generated for “conreffile” and a corresponding list property
    16. 

  16.         is provided for each generated list, in this case “conreflist”.</p>
    17. 

  17.       <p class="p">The result of this step is a set of several list files in the temporary directory, including
    18. 

  18.           <span class="ph filepath">dita.list</span> and <span class="ph filepath">dita.xml.properties</span>.</p><table class="table"><caption></caption><colgroup><col style="width:25%"><col style="width:37.5%"><col style="width:37.5%"></colgroup><thead class="thead">
    19. 

  19.             <tr class="row">
    20. 

  20.               <th class="entry nocellnorowborder" id="preprocess-genlist__entry__1">List file property</th>
    21. 

  21.               <th class="entry nocellnorowborder" id="preprocess-genlist__entry__2">List file</th>
    22. 

  22.               <th class="entry nocellnorowborder" id="preprocess-genlist__entry__3">Usage</th>
    23. 

  23.             </tr>
    24. 

  24.           </thead><tbody class="tbody">
    25. 

  25.             <tr class="row">
    26. 

  26.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__1 ">canditopicsfile</td>
    27. 

  27.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__2 "><code class="ph codeph">canditopics.list</code></td>
    28. 

  28.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__3 "></td>
    29. 

  29.             </tr>
    30. 

  30.             <tr class="row">
    31. 

  31.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__1 ">conreffile</td>
    32. 

  32.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__2 "><code class="ph codeph">conref.list</code></td>
    33. 

  33.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__3 ">Documents that contain conref attributes that need to be resolved in
    34. 

  34.                 preprocess.</td>
    35. 

  35.             </tr>
    36. 

  36.             <tr class="row">
    37. 

  37.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__1 ">conreftargetsfile</td>
    38. 

  38.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__2 "><code class="ph codeph">conreftargets.list</code></td>
    39. 

  39.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__3 "></td>
    40. 

  40.             </tr>
    41. 

  41.             <tr class="row">
    42. 

  42.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__1 ">copytosourcefile</td>
    43. 

  43.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__2 "><code class="ph codeph">copytosource.list</code></td>
    44. 

  44.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__3 "></td>
    45. 

  45.             </tr>
    46. 

  46.             <tr class="row">
    47. 

  47.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__1 ">flagimagefile</td>
    48. 

  48.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__2 "><code class="ph codeph">flagimage.list</code></td>
    49. 

  49.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__3 "></td>
    50. 

  50.             </tr>
    51. 

  51.             <tr class="row">
    52. 

  52.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__1 ">fullditamapandtopicfile</td>
    53. 

  53.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__2 "><code class="ph codeph">fullditamapandtopic.list</code></td>
    54. 

  54.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__3 ">All of the ditamap and topic files that are referenced during the transformation.
    55. 

  55.                 These may be referenced by href or conref attributes.</td>
    56. 

  56.             </tr>
    57. 

  57.             <tr class="row">
    58. 

  58.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__1 ">fullditamapfile</td>
    59. 

  59.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__2 "><code class="ph codeph">fullditamap.list</code></td>
    60. 

  60.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__3 ">All of the ditamap files in dita.list</td>
    61. 

  61.             </tr>
    62. 

  62.             <tr class="row">
    63. 

  63.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__1 ">fullditatopicfile</td>
    64. 

  64.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__2 "><code class="ph codeph">fullditatopic.list</code></td>
    65. 

  65.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__3 ">All of the topic files in dita.list</td>
    66. 

  66.             </tr>
    67. 

  67.             <tr class="row">
    68. 

  68.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__1 ">hrefditatopicfile</td>
    69. 

  69.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__2 "><code class="ph codeph">hrefditatopic.list</code></td>
    70. 

  70.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__3 ">All of the topic files that are referenced with an href attribute</td>
    71. 

  71.             </tr>
    72. 

  72.             <tr class="row">
    73. 

  73.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__1 ">hreftargetsfile</td>
    74. 

  74.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__2 "><code class="ph codeph">hreftargets.list</code></td>
    75. 

  75.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__3 ">Link targets</td>
    76. 

  76.             </tr>
    77. 

  77.             <tr class="row">
    78. 

  78.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__1 ">htmlfile</td>
    79. 

  79.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__2 "><code class="ph codeph">html.list</code></td>
    80. 

  80.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__3 ">Resource files</td>
    81. 

  81.             </tr>
    82. 

  82.             <tr class="row">
    83. 

  83.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__1 ">imagefile</td>
    84. 

  84.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__2 "><code class="ph codeph">image.list</code></td>
    85. 

  85.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__3 ">Image files that are referenced in the content</td>
    86. 

  86.             </tr>
    87. 

  87.             <tr class="row">
    88. 

  88.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__1 ">outditafilesfile</td>
    89. 

  89.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__2 "><code class="ph codeph">outditafiles.list</code></td>
    90. 

  90.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__3 "></td>
    91. 

  91.             </tr>
    92. 

  92.             <tr class="row">
    93. 

  93.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__1 ">resourceonlyfile</td>
    94. 

  94.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__2 "><code class="ph codeph">resourceonly.list</code></td>
    95. 

  95.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__3 "></td>
    96. 

  96.             </tr>
    97. 

  97.             <tr class="row">
    98. 

  98.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__1 ">subjectschemefile</td>
    99. 

  99.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__2 "><code class="ph codeph">subjectscheme.list</code></td>
    100. 

  100.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__3 "></td>
    101. 

  101.             </tr>
    102. 

  102.             <tr class="row">
    103. 

  103.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__1 ">subtargetsfile</td>
    104. 

  104.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__2 "><code class="ph codeph">subtargets.list</code></td>
    105. 

  105.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__3 "></td>
    106. 

  106.             </tr>
    107. 

  107.             <tr class="row">
    108. 

  108.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__1 ">tempdirToinputmapdir.relative.value</td>
    109. 

  109.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__2 "></td>
    110. 

  110.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__3 "></td>
    111. 

  111.             </tr>
    112. 

  112.             <tr class="row">
    113. 

  113.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__1 ">uplevels</td>
    114. 

  114.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__2 "></td>
    115. 

  115.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__3 "></td>
    116. 

  116.             </tr>
    117. 

  117.             <tr class="row">
    118. 

  118.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__1 ">user.input.dir</td>
    119. 

  119.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__2 "></td>
    120. 

  120.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__3 ">Absolute input directory path</td>
    121. 

  121.             </tr>
    122. 

  122.             <tr class="row">
    123. 

  123.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__1 ">user.input.file.listfile</td>
    124. 

  124.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__2 "></td>
    125. 

  125.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__3 ">Input file list file</td>
    126. 

  126.             </tr>
    127. 

  127.             <tr class="row">
    128. 

  128.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__1 ">user.input.file</td>
    129. 

  129.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__2 "></td>
    130. 

  130.               <td class="entry nocellnorowborder" headers="preprocess-genlist__entry__3 ">Input file path, relative to the input directory</td>
    131. 

  131.             </tr>
    132. 

  132.           </tbody></table>
    133. 

  133.     </section>
    134. 

  134.   </div>
    135. 

  135. <nav role="navigation" class="related-links"><div class="familylinks"><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><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></div></nav></article></main></body></html>
    136.