plugin.xml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!--
  3. This file is part of the DITA Open Toolkit project.
  4. See the accompanying license.txt file for applicable licenses.
  5. -->
  6. <plugin id="org.dita.base">
  7. <!-- base extension points -->
  8. <extension-point id="package.version" name="Plug-in version"/>
  9. <extension-point id="package.support.email" name="Plug-in support email"/>
  10. <extension-point id="package.support.name" name="Plug-in support name"/>
  11. <extension-point id="dita.conductor.plugin" name="Ant conductor plug-in information"/>
  12. <extension-point id="dita.catalog.plugin-info" name="Plug-in XML catalog information"/>
  13. <extension-point id="dita.image.extensions" name="Image file extension"/>
  14. <extension-point id="dita.html.extensions" name="HTML file extension"/>
  15. <extension-point id="dita.resource.extensions" name="Resource file extension"/>
  16. <!-- deprecated -->
  17. <extension-point id="dita.conductor.transtype.check" name="Transtype check"/>
  18. <extension-point id="dita.transtype.print" name="Print transtype"/>
  19. <extension-point id="dita.conductor.target" name="Ant conductor"/>
  20. <extension-point id="dita.conductor.target.relative" name="Ant conductor"/>
  21. <extension-point id="dita.specialization.catalog" name="XML catalog"/>
  22. <extension-point id="dita.specialization.catalog.relative" name="XML catalog"/>
  23. <extension-point id="dita.xsl.strings" name="Generated text"/>
  24. <extension-point id="dita.conductor.lib.import" name="Java library import"/>
  25. <extension-point id="dita.xsl.messages" name="Diagnostic messages"/>
  26. <!-- legacy support -->
  27. <extension-point id="dita.basedir-resource-directory" name="Flag to use basedir as resource directory"/>
  28. <!-- preprocessing extension points -->
  29. <extension-point id="depend.preprocess.pre" name="Preprocessing pre-target"/>
  30. <extension-point id="depend.preprocess.clean-temp.pre" name="Clean temp pre-target"/>
  31. <extension-point id="depend.preprocess.gen-list.pre" name="Generate list pre-target"/>
  32. <extension-point id="depend.preprocess.debug-filter.pre" name="Debug and filter pre-target"/>
  33. <extension-point id="depend.preprocess.conrefpush.pre" name="Content reference push pre-target"/>
  34. <extension-point id="depend.preprocess.move-meta-entries.pre" name="Move meta entries pre-target"/>
  35. <extension-point id="depend.preprocess.conref.pre" name="Content reference pre-target"/>
  36. <extension-point id="depend.preprocess.coderef.pre" name="Code reference pre-target"/>
  37. <extension-point id="depend.preprocess.mapref.pre" name="Map reference pre-target"/>
  38. <extension-point id="depend.preprocess.keyref.pre" name="Key reference pre-target"/>
  39. <extension-point id="depend.preprocess.mappull.pre" name="Map pull pre-target"/>
  40. <extension-point id="depend.preprocess.chunk.pre" name="Chunking pre-target"/>
  41. <extension-point id="depend.preprocess.maplink.pre" name="Map link pre-target"/>
  42. <extension-point id="depend.preprocess.topicpull.pre" name="Topic pull pre-target"/>
  43. <extension-point id="depend.preprocess.flag-module.pre" name="Flag module pre-target"/>
  44. <extension-point id="depend.preprocess.copy-files.pre" name="Copy files pre-target"/>
  45. <extension-point id="depend.preprocess.copy-image.pre" name="Copy images pre-target"/>
  46. <extension-point id="depend.preprocess.copy-html.pre" name="Copy HTML pre-target"/>
  47. <extension-point id="depend.preprocess.copy-flag.pre" name="Copy flag pre-target"/>
  48. <!-- Deprecated since 2.1 -->
  49. <extension-point id="depend.preprocess.copy-subsidiary.pre" name="Copy subsidiary pre-target"/>
  50. <extension-point id="depend.preprocess.post" name="Preprocessing post-target"/>
  51. <extension-point id="dita.preprocess.conref.param" name="Content reference XSLT parameters"/>
  52. <extension-point id="dita.preprocess.mapref.param" name="Map reference XSLT parameters"/>
  53. <extension-point id="dita.preprocess.mappull.param" name="Map pull XSLT parameters"/>
  54. <!--extension-point id="dita.preprocess.maplink.param" name="Map link XSLT parameters"/-->
  55. <extension-point id="dita.preprocess.topicpull.param" name="Topic pull XSLT parameters"/>
  56. <extension-point id="dita.preprocess.flag-module.param" name="Flag module XSLT parameters"/>
  57. <extension-point id="dita.xsl.conref" name="Content reference XSLT import"/>
  58. <extension-point id="dita.xsl.topicpull" name="Topic pull XSLT import"/>
  59. <extension-point id="dita.xsl.flag-module" name="Flag module XSLT import"/>
  60. <extension-point id="dita.xsl.mapref" name="Map reference XSLT import"/>
  61. <extension-point id="dita.xsl.mappull" name="Map pull XSLT import"/>
  62. <extension-point id="dita.xsl.maplink" name="Map link XSLT import"/>
  63. <extension-point id="dita.parser" name="Custom DITA parser"/>
  64. <!-- extensions -->
  65. <transtype name="base" abstract="true" desc="Common">
  66. <param name="dita.preprocess.reloadstylesheet.topicpull" desc="Specifies whether the DITA-OT reloads the XSL style sheets that are used for the transformation." type="enum">
  67. <val>true</val>
  68. <val default="true">false</val>
  69. </param>
  70. <param name="args.gen.task.lbl" desc="Specifies whether to generate headings for sections within task topics." type="enum">
  71. <val>YES</val>
  72. <val>NO</val>
  73. </param>
  74. <param name="args.rellinks" desc="Specifies which links to include in the output." type="enum">
  75. <val desc="No links are included.">none</val>
  76. <val desc="All links are included.">all</val>
  77. <val desc="Parent links are not included.">noparent</val>
  78. <val desc="Parent, child, next, and previous links are not included.">nofamily</val>
  79. </param>
  80. <param name="args.debug" desc="Specifies whether debugging information is included in the log." type="enum">
  81. <val>yes</val>
  82. <val default="true">no</val>
  83. </param>
  84. <param name="args.draft" desc="Specifies whether the content of &lt;draft-comment&gt; and &lt;required-cleanup&gt; elements is included in the output." type="enum">
  85. <val>yes</val>
  86. <val default="true">no</val>
  87. </param>
  88. <param name="args.figurelink.style" desc="Specifies how cross references to figures are styled in output." type="enum">
  89. <val>NUMBER</val>
  90. <val>TITLE</val>
  91. <val>NUMTITLE</val>
  92. </param>
  93. <param name="args.filter" desc="Specifies a filter file to be used to include, exclude, or flag content." type="file"/>
  94. <param name="args.grammar.cache" desc="Specifies whether the grammar-caching feature of the XML parser is used." type="enum">
  95. <val default="true">yes</val>
  96. <val>no</val>
  97. </param>
  98. <param name="args.input" desc="Specifies the master file for your documentation project." type="file" required="true"/>
  99. <param name="args.input.dir" desc="Specifies the base directory for your documentation project." type="dir"/>
  100. <param name="args.logdir" desc="Specifies the location where the DITA-OT places log files for your project." type="dir"/>
  101. <param name="args.tablelink.style" desc="Specifies how cross references to tables are styled." type="enum">
  102. <val>NUMBER</val>
  103. <val>TITLE</val>
  104. <val>NUMTITLE</val>
  105. </param>
  106. <param name="clean.temp" desc="Specifies whether the DITA-OT deletes the files in the temporary directory after it finishes a build." type="enum">
  107. <val default="true">yes</val>
  108. <val>no</val>
  109. </param>
  110. <param name="dita.dir" desc="Specifies where the DITA-OT is installed." type="dir"/>
  111. <param name="dita.temp.dir" desc="Specifies the location of the temporary directory." type="dir"/>
  112. <param name="dita.input.valfile" deprecated="true" desc="Specifies a filter file to be used to include, exclude, or flag content." type="file"/>
  113. <param name="filter-stage" desc="Specifies whether filtering is done before all other processing, or after key and conref processing." type="enum">
  114. <val default="true">early</val>
  115. <val>late</val>
  116. </param>
  117. <param name="force-unique" desc="Generate copy-to attributes to duplicate topicref elements." type="enum">
  118. <val>true</val>
  119. <val default="true">false</val>
  120. </param>
  121. <param name="generate.copy.outer" desc="Specifies whether to generate output files for content that is not located in or beneath the directory containing the DITA map file." type="enum">
  122. <val desc="Do not generate output for content that is located outside the DITA map directory." default="true">1</val>
  123. <val desc="Shift the output directory so that it contains all output for the publication.">3</val>
  124. </param>
  125. <param name="onlytopic.in.map" desc="Specifies whether files that are linked to, or referenced with a @conref attribute, generate output." type="enum">
  126. <val>true</val>
  127. <val default="true">false</val>
  128. </param>
  129. <param name="outer.control" desc="Specifies how the DITA-OT handles content files that are not located in or below the directory containing the master DITA map." type="enum">
  130. <val desc="Fail quickly if files are going to be generated or copied outside of the directory.">fail</val>
  131. <val desc="Complete the operation if files will be generated or copied outside of the directory, but log a warning." default="true">warn</val>
  132. <val desc="Quietly finish without generating warnings or errors.">quiet</val>
  133. </param>
  134. <param name="output.dir" desc="Specifies the name and location of the output directory." type="dir"/>
  135. <param name="root-chunk-override" desc="Override for map chunk attribute value." type="string"/>
  136. <param name="transtype" desc="Specifies the output format (transformation type)." type="file" required="true"/>
  137. <param name="validate" desc="Specifies whether the DITA-OT validates the content." type="enum">
  138. <val default="true">true</val>
  139. <val>false</val>
  140. </param>
  141. <param name="generate-debug-attributes" desc="Specifies whether the @xtrf and @xtrc debugging attributes are generated in the temporary files." type="enum">
  142. <val desc="Enables generation of debugging attributes" default="true">true</val>
  143. <val desc="Disables generation of debugging attributes">false</val>
  144. </param>
  145. <param name="processing-mode" desc="Specifies how the DITA-OT handles errors and error recovery." type="enum">
  146. <val desc="When an error is encountered, the DITA-OT stops processing">strict</val>
  147. <val desc="When an error is encountered, the DITA-OT attempts to recover from it" default="true">lax</val>
  148. <val desc="When an error is encountered, the DITA-OT continues processing but does not attempt error recovery">skip</val>
  149. </param>
  150. <param name="conserve-memory" desc="Conserve memory at the expense of processing speed" type="enum">
  151. <val>true</val>
  152. <val default="true">false</val>
  153. </param>
  154. </transtype>
  155. <feature extension="dita.image.extensions" value=".gif"/>
  156. <feature extension="dita.image.extensions" value=".eps"/>
  157. <feature extension="dita.image.extensions" value=".jpg"/>
  158. <feature extension="dita.image.extensions" value=".jpeg"/>
  159. <feature extension="dita.image.extensions" value=".png"/>
  160. <feature extension="dita.image.extensions" value=".svg"/>
  161. <feature extension="dita.image.extensions" value=".tif"/>
  162. <feature extension="dita.image.extensions" value=".tiff"/>
  163. <feature extension="dita.image.extensions" value=".bmp"/>
  164. <feature extension="dita.html.extensions" value=".html"/>
  165. <feature extension="dita.html.extensions" value=".htm"/>
  166. <feature extension="dita.resource.extensions" value=".pdf"/>
  167. <feature extension="dita.resource.extensions" value=".swf"/>
  168. <feature extension="dita.basedir-resource-directory" value="true"/>
  169. <feature extension="dita.conductor.target.relative" file="conductor.xml"/>
  170. <feature extension="dita.xsl.strings" file="../../xsl/common/common-strings.xml"/>
  171. <template file="../../catalog-dita_template.xml"/>
  172. <template file="../../build_template.xml"/>
  173. <template file="build_preprocess_template.xml"/>
  174. <template file="../../resources/messages_template.xml"/>
  175. <template file="../../xsl/common/allstrings_template.xml"/>
  176. <template file="../../xsl/common/strings_template.xml"/>
  177. <template file="../../xsl/preprocess/maplink_template.xsl"/>
  178. <template file="../../xsl/preprocess/mapref_template.xsl"/>
  179. <template file="../../xsl/preprocess/mappull_template.xsl"/>
  180. <template file="../../xsl/preprocess/conref_template.xsl"/>
  181. <template file="../../xsl/preprocess/topicpull_template.xsl"/>
  182. <template file="../../xsl/preprocess/flag_template.xsl"/>
  183. </plugin>