Inicio Explorar Axuda
Iniciar sesión
bn
/
se
2
0
Fork 0
Ficheiros Incidencias 0 Pull Requests 0 Wiki
Árbore: c8927bb461
Ramas Etiquetas
se
/
SE
/
schema
/
WPS_Functions
/
dita-ot
/
dita-ot-3.5
/
doc
/
topics
/
plugin-configfile.html

plugin-configfile.html 30 KB
Histórico Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342 
  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 2020"><meta name="DC.rights.owner" content="(C) Copyright 2020"><meta name="DC.type" content="reference"><meta name="description" content="The plug-in descriptor file (plugin.xml) controls all aspects of a plug-in, making each extension visible to the rest of the toolkit. The file uses pre-defined extension points to locate changes, and then integrates those changes into the core DITA-OT code."><meta name="DC.subject" content="plug-ins, identfiers, plugin.xml, metadata, plug-in"><meta name="keywords" content="plug-ins, identfiers, plugin.xml, metadata, plug-in"><meta name="DC.relation" scheme="URI" content="../topics/custom-plugins.html"><meta name="DC.relation" scheme="URI" content="../topics/plugin-newextensions.html"><meta name="DC.relation" scheme="URI" content="../topics/plugin-newtranstype.html"><meta name="DC.format" content="HTML5"><meta name="DC.identifier" content="plugin-configfile"><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>Plug-in descriptor file</title></head><body id="plugin-configfile"><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 3.5</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a><ul><li><a href="../topics/plugin-benefits.html">Plug-in benefits</a></li><li class="active"><a href="../topics/plugin-configfile.html">Plug-in descriptor file</a></li><li><a href="../topics/plugin-coding-conventions.html">Coding conventions</a></li><li><a href="../topics/plugin-dependencies.html">Plug-in dependencies</a></li><li><a href="../topics/plugin-use-cases.html">Plug-in use cases</a></li><li><a href="../topics/html-customization-plugins.html">Custom HTML plug-ins</a></li><li><a href="../topics/pdf-customization-plugins.html">Custom PDF plug-ins</a></li><li><a href="../topics/globalization.html">Globalizing DITA content</a></li><li><a href="../topics/migration.html">Migrating customizations</a></li></ul></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
    7. 

  7.   <h1 class="title topictitle1" id="ariaid-title1">Plug-in descriptor file</h1>
    8. 

  8.   
    9. 

  9.   
    10. 

  10.   <div class="body refbody"><p class="shortdesc">The plug-in descriptor file (<span class="ph filepath">plugin.xml</span>) controls all aspects of a plug-in, making
    11. 

  11.     each extension visible to the rest of the toolkit. The file uses pre-defined extension points to locate changes, and
    12. 

  12.     then integrates those changes into the core DITA-OT code.</p>
    13. 

  13.     <section class="section"><h2 class="title sectiontitle">Validating plug-ins</h2>
    14. 

  14.       
    15. 

  15.       <div class="div" id="plugin-configfile__d650e92">
    16. 

  16.         <p class="p">DITA-OT includes a RELAX NG schema file that can be used to validate the <span class="ph filepath">plugin.xml</span>
    17. 

  17.           files that define the capabilities of each plug-in.
    18. 

  18.           
    19. 

  19.           
    20. 

  20.         </p>
    21. 

  21.         <p class="p">To ensure the syntax of your custom plug-in is correct, include an <code class="keyword markupname xmlpi">&lt;?xml-model?&gt;</code> processing
    22. 

  22.           instruction at the beginning of the <span class="ph filepath">plugin.xml</span> file, immediately after the XML
    23. 

  23.           prolog:</p>
    24. 

  24.         <p class="p"><code class="keyword markupname xmlpi">&lt;?xml-model href="dita-ot/plugin.rnc" type="application/relax-ng-compact-syntax"?&gt;</code></p>
    25. 

  25.         <p class="p">If your authoring environment does not apply this schema automatically, point your editor to <span class="ph filepath" id="plugin-configfile__d650e123"><var class="keyword varname">dita-ot-dir</var>/resources/plugin.rnc</span> to associate the schema with
    26. 

  26.           your plug-in file.</p>
    27. 

  27.       </div>
    28. 

  28.     </section>
    29. 

  29.     <section class="section"><h2 class="title sectiontitle">Plug-in identifiers</h2>
    30. 

  30.       
    31. 

  31.       
    32. 

  32.       <p class="p">Every DITA-OT plug-in must have a unique identifier composed of one or more dot-delimited tokens, for example,
    33. 

  33.           <code class="ph codeph">com.example.rss</code>. This identifier is used to identify the plug-in to the toolkit for
    34. 

  34.         installation, processing, and when determining plug-in dependencies.</p>
    35. 

  35.       <div class="note note note_note"><span class="note__title">Note:</span> The default DITA-OT plug-ins use a reverse domain naming convention, as in <code class="ph codeph">org.dita.html5</code>;
    36. 

  36.         this is strongly recommended to avoid plug-in naming conflicts.</div>
    37. 

  37.       <div class="p" id="plugin-configfile__tokendef">Each token can include only the following characters:
    38. 

  38.         <ul class="ul">
    39. 

  39.           <li class="li">Lower-case letters (a-z)</li>
    40. 

  40.           <li class="li">Upper-case letters (A-Z)</li>
    41. 

  41.           <li class="li">Numerals (0-9)</li>
    42. 

  42.           <li class="li">Underscores (_)</li>
    43. 

  43.           <li class="li">Hyphens (-)</li>
    44. 

  44.         </ul></div>
    45. 

  45.     </section>
    46. 

  46.     <section class="section"><h2 class="title sectiontitle"><code class="keyword markupname xmlelement">&lt;plugin&gt;</code></h2>
    47. 

  47.       
    48. 

  48.       <p class="p">The root element of the <span class="ph filepath">plugin.xml</span> file is <code class="keyword markupname xmlelement">&lt;plugin&gt;</code>, which has a
    49. 

  49.         required <code class="keyword markupname xmlatt">@id</code> attribute set to the unique plug-in identifier.</p>
    50. 

  50.       <figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 1. </span>Sample <code class="keyword markupname xmlelement">&lt;plugin&gt;</code> element</figcaption>
    51. 

  51.         
    52. 

  52.         <pre class="pre codeblock language-xml"><code>&lt;plugin id="com.example.html5-javascript"&gt;</code></pre>
    53. 

  53.       </figure>
    54. 

  54.     </section>
    55. 

  55.     <section class="section"><h2 class="title sectiontitle">Plug-in elements</h2>
    56. 

  56.       
    57. 

  57.       
    58. 

  58.       
    59. 

  59.       <p class="p">The <code class="keyword markupname xmlelement">&lt;plugin&gt;</code> element can contain the following child elements: </p>
    60. 

  60.       <dl class="dl parml">
    61. 

  61.         
    62. 

  62.           <dt class="dt pt dlterm"><code class="keyword markupname xmlelement">&lt;extension-point&gt;</code></dt>
    63. 

  63.           <dd class="dd pd">
    64. 

  64.             
    65. 

  65.             <p class="p">An optional element that defines a new extension point that can be used by other DITA-OT plug-ins.</p>
    66. 

  66.             <p class="p">The following attributes are supported:</p>
    67. 

  67.             <table class="simpletable"><colgroup><col style="width:33.33333333333333%"><col style="width:33.33333333333333%"><col style="width:33.33333333333333%"></colgroup><thead><tr class="sthead">
    68. 

  68.                 <th class="stentry" scope="col" id="plugin-configfile__stentry__1">Attribute</th>
    69. 

  69.                 <th class="stentry" scope="col" id="plugin-configfile__stentry__2">Description</th>
    70. 

  70.                 <th class="stentry" scope="col" id="plugin-configfile__stentry__3">Required?</th>
    71. 

  71.               </tr></thead><tbody><tr class="strow">
    72. 

  72.                 <th class="stentry" scope="row" headers="plugin-configfile__stentry__1">id</th>
    73. 

  73.                 <td class="stentry" headers="plugin-configfile__stentry__2">Extension point identifier</td>
    74. 

  74.                 <td class="stentry" headers="plugin-configfile__stentry__3">Yes</td>
    75. 

  75.               </tr><tr class="strow">
    76. 

  76.                 <th class="stentry" scope="row" headers="plugin-configfile__stentry__1">name</th>
    77. 

  77.                 <td class="stentry" headers="plugin-configfile__stentry__2">Extension point description</td>
    78. 

  78.                 <td class="stentry" headers="plugin-configfile__stentry__3">No</td>
    79. 

  79.               </tr></tbody></table>
    80. 

  80.             <p class="p" id="plugin-configfile__extension-point-ids">Like plug-in identifiers, extension point identifiers are composed of one or
    81. 

  81.               more dot-delimited tokens.</p>
    82. 

  82.             <div class="note note note_note" id="plugin-configfile__entension-point-ids-note"><span class="note__title">Note:</span> Extension point identifiers should begin with the identifier of the
    83. 

  83.               defining plug-in and append one or more tokens, for example, <code class="ph codeph">org.dita.example.pre</code>.</div>
    84. 

  84.             <figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 2. </span>Sample <code class="keyword markupname xmlelement">&lt;extension-point&gt;</code> element</figcaption>
    85. 

  85.               
    86. 

  86.               <pre class="pre codeblock language-xml"><code>&lt;extension-point id="dita.xsl.html5" name="HTML5 XSLT import"/&gt;</code></pre>
    87. 

  87.             </figure>
    88. 

  88.           </dd>
    89. 

  89.         
    90. 

  90.         
    91. 

  91.           <dt class="dt pt dlterm"><code class="keyword markupname xmlelement">&lt;feature&gt;</code></dt>
    92. 

  92.           <dd class="dd pd">
    93. 

  93.             
    94. 

  94.             
    95. 

  95.             
    96. 

  96.             <p class="p">An optional element that supplies values to a DITA-OT extension point.</p>
    97. 

  97.             <p class="p">The following attributes are supported:</p>
    98. 

  98.             <table class="simpletable"><colgroup><col style="width:33.33333333333333%"><col style="width:33.33333333333333%"><col style="width:33.33333333333333%"></colgroup><thead><tr class="sthead">
    99. 

  99.                 <th class="stentry" scope="col" id="plugin-configfile__stentry__10">Attribute</th>
    100. 

  100.                 <th class="stentry" scope="col" id="plugin-configfile__stentry__11">Description</th>
    101. 

  101.                 <th class="stentry" scope="col" id="plugin-configfile__stentry__12">Required?</th>
    102. 

  102.               </tr></thead><tbody><tr class="strow">
    103. 

  103.                 <th class="stentry" scope="row" headers="plugin-configfile__stentry__10">extension</th>
    104. 

  104.                 <td class="stentry" headers="plugin-configfile__stentry__11">Identifier of the DITA-OT extension point</td>
    105. 

  105.                 <td class="stentry" headers="plugin-configfile__stentry__12">Yes</td>
    106. 

  106.               </tr><tr class="strow">
    107. 

  107.                 <th class="stentry" scope="row" headers="plugin-configfile__stentry__10">value</th>
    108. 

  108.                 <td class="stentry" headers="plugin-configfile__stentry__11">Comma separated string value of the extension</td>
    109. 

  109.                 <td class="stentry" headers="plugin-configfile__stentry__12">Either the <code class="keyword markupname xmlatt">@value</code> or <code class="keyword markupname xmlatt">@file</code> attribute must be
    110. 

  110.                   specified</td>
    111. 

  111.               </tr><tr class="strow">
    112. 

  112.                 <th class="stentry" scope="row" headers="plugin-configfile__stentry__10">file</th>
    113. 

  113.                 <td class="stentry" headers="plugin-configfile__stentry__11">Name and path of a file containing data for the extension point.
    114. 

  114.                   <p class="p">Depending on the extension point, this might be specified as an absolute path, a path relative to
    115. 

  115.                     the <span class="ph filepath">plugin.xml</span> file, or a path relative to the DITA-OT root.</p></td>
    116. 

  116.                 <td class="stentry" headers="plugin-configfile__stentry__12">Either the <code class="keyword markupname xmlatt">@value</code> or <code class="keyword markupname xmlatt">@file</code> attribute must be
    117. 

  117.                   specified</td>
    118. 

  118.               </tr><tr class="strow">
    119. 

  119.                 <th class="stentry" scope="row" headers="plugin-configfile__stentry__10">type</th>
    120. 

  120.                 <td class="stentry" headers="plugin-configfile__stentry__11">Type of the <code class="keyword markupname xmlatt">@value</code> attribute</td>
    121. 

  121.                 <td class="stentry" headers="plugin-configfile__stentry__12">No</td>
    122. 

  122.               </tr></tbody></table>
    123. 

  123.             <figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 3. </span>Sample <code class="keyword markupname xmlelement">&lt;feature&gt;</code> elements</figcaption>
    124. 

  124.               
    125. 

  125.               <p class="p">If more than one <code class="keyword markupname xmlelement">&lt;feature&gt;</code> element supplies values to the same extension point,
    126. 

  126.                 the values are additive. For example, the following are equivalent:</p>
    127. 

  127.               <pre class="pre codeblock language-xml"><code>&lt;feature extension="org.dita.example.extension-point" value="a,b,c"/&gt;</code></pre>
    128. 

  128.               <pre class="pre codeblock language-xml"><code>&lt;feature extension="org.dita.example.extension-point" value="a"/&gt;
    129. 

  129. &lt;feature extension="org.dita.example.extension-point" value="b"/&gt;
    130. 

  130. &lt;feature extension="org.dita.example.extension-point" value="c"/&gt;</code></pre>
    131. 

  131.             </figure>
    132. 

  132.           </dd>
    133. 

  133.         
    134. 

  134.         
    135. 

  135.           <dt class="dt pt dlterm"><code class="keyword markupname xmlelement">&lt;meta&gt;</code></dt>
    136. 

  136.           <dd class="dd pd">
    137. 

  137.             
    138. 

  138.             <p class="p">An optional element that defines metadata.</p>
    139. 

  139.             <p class="p">The following attributes are supported:</p>
    140. 

  140.             <table class="simpletable"><colgroup><col style="width:33.33333333333333%"><col style="width:33.33333333333333%"><col style="width:33.33333333333333%"></colgroup><thead><tr class="sthead">
    141. 

  141.                 <th class="stentry" scope="col" id="plugin-configfile__stentry__25">Attribute</th>
    142. 

  142.                 <th class="stentry" scope="col" id="plugin-configfile__stentry__26">Description</th>
    143. 

  143.                 <th class="stentry" scope="col" id="plugin-configfile__stentry__27">Required?</th>
    144. 

  144.               </tr></thead><tbody><tr class="strow">
    145. 

  145.                 <th class="stentry" scope="row" headers="plugin-configfile__stentry__25">type</th>
    146. 

  146.                 <td class="stentry" headers="plugin-configfile__stentry__26">Metadata name </td>
    147. 

  147.                 <td class="stentry" headers="plugin-configfile__stentry__27">Yes</td>
    148. 

  148.               </tr><tr class="strow">
    149. 

  149.                 <th class="stentry" scope="row" headers="plugin-configfile__stentry__25">value</th>
    150. 

  150.                 <td class="stentry" headers="plugin-configfile__stentry__26">Metadata value</td>
    151. 

  151.                 <td class="stentry" headers="plugin-configfile__stentry__27">Yes</td>
    152. 

  152.               </tr></tbody></table>
    153. 

  153.             <figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 4. </span>Sample <code class="keyword markupname xmlelement">&lt;meta&gt;</code> element</figcaption>
    154. 

  154.               
    155. 

  155.               <pre class="pre codeblock language-xml"><code>&lt;meta type="foo" value="bar"/&gt;</code></pre>
    156. 

  156.             </figure>
    157. 

  157.           </dd>
    158. 

  158.         
    159. 

  159.         
    160. 

  160.           <dt class="dt pt dlterm"><code class="keyword markupname xmlelement">&lt;require&gt;</code></dt>
    161. 

  161.           <dd class="dd pd">
    162. 

  162.             
    163. 

  163.             <p class="p">An optional element that defines plug-in dependencies.</p>
    164. 

  164.             <p class="p">The following attributes are supported:</p>
    165. 

  165.             <table class="simpletable"><colgroup><col style="width:33.33333333333333%"><col style="width:33.33333333333333%"><col style="width:33.33333333333333%"></colgroup><thead><tr class="sthead">
    166. 

  166.                 <th class="stentry" scope="col" id="plugin-configfile__stentry__34">Attribute</th>
    167. 

  167.                 <th class="stentry" scope="col" id="plugin-configfile__stentry__35">Description</th>
    168. 

  168.                 <th class="stentry" scope="col" id="plugin-configfile__stentry__36">Required?</th>
    169. 

  169.               </tr></thead><tbody><tr class="strow">
    170. 

  170.                 <th class="stentry" scope="row" headers="plugin-configfile__stentry__34">plugin</th>
    171. 

  171.                 <td class="stentry" headers="plugin-configfile__stentry__35">The identifier of the required plug-in.
    172. 

  172.                   <p class="p">To specify alternative requirements, separate plug-in identifiers with a vertical
    173. 

  173.                   bar.</p></td>
    174. 

  174.                 <td class="stentry" headers="plugin-configfile__stentry__36">Yes</td>
    175. 

  175.               </tr><tr class="strow">
    176. 

  176.                 <th class="stentry" scope="row" headers="plugin-configfile__stentry__34">importance</th>
    177. 

  177.                 <td class="stentry" headers="plugin-configfile__stentry__35">Identifies whether the plug-in is <code class="ph codeph">required</code> (default) or
    178. 

  178.                     <code class="ph codeph">optional</code>. DITA-OT provides a warning if a required plug-in is not
    179. 

  179.                   available.</td>
    180. 

  180.                 <td class="stentry" headers="plugin-configfile__stentry__36">No</td>
    181. 

  181.               </tr></tbody></table>
    182. 

  182.             <figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 5. </span>Sample <code class="keyword markupname xmlelement">&lt;require&gt;</code> element</figcaption>
    183. 

  183.               
    184. 

  184.               <pre class="pre codeblock language-xml normalize-space"><code>&lt;require plugin="org.dita.html5"/&gt;</code></pre>
    185. 

  185.             </figure>
    186. 

  186.           </dd>
    187. 

  187.         
    188. 

  188.         
    189. 

  189.           <dt class="dt pt dlterm"><code class="keyword markupname xmlelement">&lt;template&gt;</code></dt>
    190. 

  190.           <dd class="dd pd">
    191. 

  191.             
    192. 

  192.             
    193. 

  193.             <p class="p">An optional element that defines files that should be treated as templates.</p>
    194. 

  194.             <p class="p">Template files can be used to integrate DITA-OT extensions. Templates typically extend the default
    195. 

  195.               transformation-type-specific build files via <code class="keyword markupname xmlelement">&lt;dita:extension&gt;</code> elements. When the
    196. 

  196.               plug-in installation process runs, template files are used to recreate build files, and the specified
    197. 

  197.               extension points are replaced with references to the appropriate plug-ins.</p>
    198. 

  198.             <p class="p">The following attributes are supported:</p>
    199. 

  199.             <table class="simpletable"><colgroup><col style="width:33.33333333333333%"><col style="width:33.33333333333333%"><col style="width:33.33333333333333%"></colgroup><thead><tr class="sthead">
    200. 

  200.                 <th class="stentry" scope="col" id="plugin-configfile__stentry__43">Attribute</th>
    201. 

  201.                 <th class="stentry" scope="col" id="plugin-configfile__stentry__44">Description</th>
    202. 

  202.                 <th class="stentry" scope="col" id="plugin-configfile__stentry__45">Required?</th>
    203. 

  203.               </tr></thead><tbody><tr class="strow">
    204. 

  204.                 <th class="stentry" scope="row" headers="plugin-configfile__stentry__43">file</th>
    205. 

  205.                 <td class="stentry" headers="plugin-configfile__stentry__44">Name and path to the template file, relative to the <span class="ph filepath">plugin.xml</span>
    206. 

  206.                   file</td>
    207. 

  207.                 <td class="stentry" headers="plugin-configfile__stentry__45">Yes</td>
    208. 

  208.               </tr></tbody></table>
    209. 

  209.             <figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 6. </span>Sample <code class="keyword markupname xmlelement">&lt;template&gt;</code> element</figcaption>
    210. 

  210.               
    211. 

  211.               <pre class="pre codeblock language-xml"><code>&lt;template file="build_dita2html5_template.xml"/&gt;</code></pre>
    212. 

  212.             </figure>
    213. 

  213.           </dd>
    214. 

  214.         
    215. 

  215.         
    216. 

  216.           <dt class="dt pt dlterm"><code class="keyword markupname xmlelement">&lt;transtype&gt;</code></dt>
    217. 

  217.           <dd class="dd pd">
    218. 

  218.             
    219. 

  219.             <p class="p">An optional element that defines a new output format (transformation type).</p>
    220. 

  220.             <p class="p">The following attributes are supported:</p>
    221. 

  221.             <table class="simpletable"><colgroup><col style="width:33.33333333333333%"><col style="width:33.33333333333333%"><col style="width:33.33333333333333%"></colgroup><thead><tr class="sthead">
    222. 

  222.                 <th class="stentry" scope="col" id="plugin-configfile__stentry__49">Attribute</th>
    223. 

  223.                 <th class="stentry" scope="col" id="plugin-configfile__stentry__50">Description</th>
    224. 

  224.                 <th class="stentry" scope="col" id="plugin-configfile__stentry__51">Required?</th>
    225. 

  225.               </tr></thead><tbody><tr class="strow">
    226. 

  226.                 <th class="stentry" scope="row" headers="plugin-configfile__stentry__49">name</th>
    227. 

  227.                 <td class="stentry" headers="plugin-configfile__stentry__50">Transformation name</td>
    228. 

  228.                 <td class="stentry" headers="plugin-configfile__stentry__51">Yes</td>
    229. 

  229.               </tr><tr class="strow">
    230. 

  230.                 <th class="stentry" scope="row" headers="plugin-configfile__stentry__49">desc</th>
    231. 

  231.                 <td class="stentry" headers="plugin-configfile__stentry__50">Transformation type description</td>
    232. 

  232.                 <td class="stentry" headers="plugin-configfile__stentry__51">No</td>
    233. 

  233.               </tr><tr class="strow">
    234. 

  234.                 <th class="stentry" scope="row" headers="plugin-configfile__stentry__49">abstract</th>
    235. 

  235.                 <td class="stentry" headers="plugin-configfile__stentry__50">When <span class="keyword option">true</span>, sets the transformation type as <q class="q">abstract</q>, meaning it can be
    236. 

  236.                   extended by other plug-ins, but cannot be used directly.
    237. 

  237.                   <p class="p">For example, the <code class="ph codeph">org.dita.base</code> plug-in defines an abstract <q class="q">base</q>
    238. 

  238.                     transformation type that is extended by other DITA-OT plug-ins.</p></td>
    239. 

  239.                 <td class="stentry" headers="plugin-configfile__stentry__51">No</td>
    240. 

  240.               </tr><tr class="strow">
    241. 

  241.                 <th class="stentry" scope="row" headers="plugin-configfile__stentry__49">extends</th>
    242. 

  242.                 <td class="stentry" headers="plugin-configfile__stentry__50">Specifies the name of the transformation type being extended</td>
    243. 

  243.                 <td class="stentry" headers="plugin-configfile__stentry__51">No</td>
    244. 

  244.               </tr></tbody></table>
    245. 

  245.             <figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 7. </span>Sample <code class="keyword markupname xmlelement">&lt;transtype&gt;</code> element</figcaption>
    246. 

  246.               
    247. 

  247.               <pre class="pre codeblock language-xml"><code>&lt;transtype name="base" abstract="true" desc="Common"&gt;
    248. 

  248.   &lt;!-- ⋮ --&gt;
    249. 

  249.   &lt;param name="link-crawl"
    250. 

  250.          desc="Specifies whether to crawl only topic links found in maps, or all discovered topic links."
    251. 

  251.          type="enum"&gt;
    252. 

  252.     &lt;val&gt;map&lt;/val&gt;
    253. 

  253.     &lt;val default="true"&gt;topic&lt;/val&gt;
    254. 

  254.   &lt;/param&gt;
    255. 

  255.   &lt;!-- ⋮ --&gt;
    256. 

  256. &lt;/transtype&gt;
    257. 

  257. </code></pre>
    258. 

  258.             </figure>
    259. 

  259.             <p class="p">The <code class="keyword markupname xmlelement">&lt;transtype&gt;</code> element may define additional parameters for the transformation
    260. 

  260.               type using the following child elements.</p>
    261. 

  261.             <dl class="dl parml">
    262. 

  262.               
    263. 

  263.                 <dt class="dt pt dlterm"><code class="keyword markupname xmlelement">&lt;param&gt;</code></dt>
    264. 

  264.                 <dd class="dd pd">
    265. 

  265.                   
    266. 

  266.                   <p class="p">An optional element that specifies a parameter for the transformation type.</p>
    267. 

  267.                   <p class="p">The following parameter attributes are supported:</p>
    268. 

  268.                   <table class="simpletable"><colgroup><col style="width:33.33333333333333%"><col style="width:33.33333333333333%"><col style="width:33.33333333333333%"></colgroup><thead><tr class="sthead">
    269. 

  269.                       <th class="stentry" scope="col" id="plugin-configfile__stentry__64">Attribute</th>
    270. 

  270.                       <th class="stentry" scope="col" id="plugin-configfile__stentry__65">Description</th>
    271. 

  271.                       <th class="stentry" scope="col" id="plugin-configfile__stentry__66">Required?</th>
    272. 

  272.                     </tr></thead><tbody><tr class="strow">
    273. 

  273.                       <th class="stentry" scope="row" headers="plugin-configfile__stentry__64">name</th>
    274. 

  274.                       <td class="stentry" headers="plugin-configfile__stentry__65">Parameter name</td>
    275. 

  275.                       <td class="stentry" headers="plugin-configfile__stentry__66">Yes</td>
    276. 

  276.                     </tr><tr class="strow">
    277. 

  277.                       <th class="stentry" scope="row" headers="plugin-configfile__stentry__64">desc</th>
    278. 

  278.                       <td class="stentry" headers="plugin-configfile__stentry__65">Parameter description</td>
    279. 

  279.                       <td class="stentry" headers="plugin-configfile__stentry__66">No</td>
    280. 

  280.                     </tr><tr class="strow">
    281. 

  281.                       <th class="stentry" scope="row" headers="plugin-configfile__stentry__64">type</th>
    282. 

  282.                       <td class="stentry" headers="plugin-configfile__stentry__65">Parameter type (<span class="keyword option">enum</span>, <span class="keyword option">file</span>,
    283. 

  283.                         <span class="keyword option">string</span>)</td>
    284. 

  284.                       <td class="stentry" headers="plugin-configfile__stentry__66">Yes</td>
    285. 

  285.                     </tr><tr class="strow">
    286. 

  286.                       <th class="stentry" scope="row" headers="plugin-configfile__stentry__64">deprecated</th>
    287. 

  287.                       <td class="stentry" headers="plugin-configfile__stentry__65">When <span class="keyword option">true</span>, identifies this parameter as deprecated</td>
    288. 

  288.                       <td class="stentry" headers="plugin-configfile__stentry__66">No</td>
    289. 

  289.                     </tr><tr class="strow">
    290. 

  290.                       <th class="stentry" scope="row" headers="plugin-configfile__stentry__64">required</th>
    291. 

  291.                       <td class="stentry" headers="plugin-configfile__stentry__65">When <span class="keyword option">true</span>, identifies this parameter as required</td>
    292. 

  292.                       <td class="stentry" headers="plugin-configfile__stentry__66">No</td>
    293. 

  293.                     </tr></tbody></table></dd>
    294. 

  294.               
    295. 

  295.               
    296. 

  296.                 <dt class="dt pt dlterm"><code class="keyword markupname xmlelement">&lt;val&gt;</code></dt>
    297. 

  297.                 <dd class="dd pd">
    298. 

  298.                   
    299. 

  299.                   <p class="p">A child of <code class="keyword markupname xmlelement">&lt;param&gt;</code> (when <code class="keyword markupname xmlatt">@type</code>=<span class="keyword option">enum</span>) that
    300. 

  300.                     specifies an enumeration value.</p>
    301. 

  301.                   <p class="p">The following attributes are supported:</p>
    302. 

  302.                   <table class="simpletable"><colgroup><col style="width:33.33333333333333%"><col style="width:33.33333333333333%"><col style="width:33.33333333333333%"></colgroup><thead><tr class="sthead">
    303. 

  303.                       <th class="stentry" scope="col" id="plugin-configfile__stentry__82">Attribute</th>
    304. 

  304.                       <th class="stentry" scope="col" id="plugin-configfile__stentry__83">Description</th>
    305. 

  305.                       <th class="stentry" scope="col" id="plugin-configfile__stentry__84">Required?</th>
    306. 

  306.                     </tr></thead><tbody><tr class="strow">
    307. 

  307.                       <th class="stentry" scope="row" headers="plugin-configfile__stentry__82">default</th>
    308. 

  308.                       <td class="stentry" headers="plugin-configfile__stentry__83">When <span class="keyword option">true</span>, sets the enumeration value as the default value of the parent
    309. 

  309.                           <code class="keyword markupname xmlelement">&lt;param&gt;</code></td>
    310. 

  310.                       <td class="stentry" headers="plugin-configfile__stentry__84">Only for the default <code class="keyword markupname xmlelement">&lt;val&gt;</code></td>
    311. 

  311.                     </tr></tbody></table></dd>
    312. 

  312.               
    313. 

  313.             </dl>
    314. 

  314.           </dd>
    315. 

  315.         
    316. 

  316.       </dl>
    317. 

  317.       <p class="p">Any extension that is not recognized by DITA-OT is ignored. Since DITA-OT version 1.5.3, you can combine
    318. 

  318.         multiple extension definitions within a single <span class="ph filepath">plugin.xml</span> file; in older versions, only the
    319. 

  319.         last extension definition was used.</p>
    320. 

  320.     </section>
    321. 

  321.     <div class="example" id="plugin-configfile__plugin-sample"><h2 class="title sectiontitle">Example <span class="ph filepath">plugin.xml</span> file</h2>
    322. 

  322.       
    323. 

  323.       
    324. 

  324.       
    325. 

  325.       
    326. 

  326.       
    327. 

  327.       
    328. 

  328.       
    329. 

  329.       <p class="p">The following is a sample of a <span class="ph filepath">plugin.xml</span> file. This file adds support for a new set of
    330. 

  330.         specialized DTDs, and includes an override for the XHTML output processor.</p>
    331. 

  331.       <p class="p">This <span class="ph filepath">plugin.xml</span> file would go into a directory such as
    332. 

  332.           <span class="ph filepath">DITA-OT/plugins/music/</span> and referenced supporting files would also exist in that
    333. 

  333.         directory. A more extensive sample using these values is available in the actual music plug-in, available on
    334. 

  334.         <a class="xref" href="https://sourceforge.net/projects/dita-ot/files/Plug-in_%20Music/" target="_blank" rel="external noopener">SourceForge</a>.</p>
    335. 

  335.       <pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;plugin id="org.metadita.specialization.music"&gt;
    336. 

  336.   &lt;feature extension="dita.specialization.catalog.relative" 
    337. 

  337.            file="catalog-dita.xml"/&gt;
    338. 

  338.   &lt;feature extension="dita.xsl.xhtml" file="xsl/music2xhtml.xsl"/&gt;
    339. 

  339. &lt;/plugin&gt;</code></pre>
    340. 

  340.     </div>
    341. 

  341.   </div>
    342. 

  342. <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../topics/custom-plugins.html" title="In addition to adding plug-ins from the plug-in registry at dita-ot.org/plugins, you can create custom DITA-OT plug-ins of your own to modify the default output, add new output formats, support new languages, or implement DITA topic specializations.">Creating custom plug-ins</a></div></div><div class="linklist reltasks"><strong>Related tasks</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/plugin-newtranstype.html" title="Plug-ins can add an entirely new transformation type. The new transformation type can be very simple, such as an HTML build that creates an additional control file; it also can be very complex, adding any number of new processing steps.">Adding a new transformation type</a></li></ul></div><div class="linklist relref"><strong>Related reference</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/plugin-newextensions.html" title="If your plug-in needs to define its own extension point in an XML file, add the string &#34;_template&#34; to the filename before the file suffix. When the plug-in is installed, this file will be processed like the built-in DITA-OT templates.">Creating a new plug-in extension point</a></li></ul></div></nav></article></main></body></html>
    343.