plugin-extension-points-support.dita 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
  3. <!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
  4. <reference id="plugin-support" xml:lang="en-US">
  5. <title>Version and support information</title>
  6. <shortdesc>You can use these extension points to define version and support information for a plug-in. Currently,
  7. DITA-OT does not do anything with this information, but it might do so in the future.</shortdesc>
  8. <refbody>
  9. <section>
  10. <dl>
  11. <dlentry>
  12. <dt><parmname>package.support.name</parmname></dt>
  13. <dd conaction="pushreplace"
  14. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/package.support.name.desc">Specifies the
  15. person who provides support for the DITA-OT plug-in.</dd>
  16. </dlentry>
  17. <dlentry>
  18. <dt><parmname>package.support.email</parmname></dt>
  19. <dd conaction="pushreplace"
  20. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/package.support.email.desc">Specifies the
  21. e-mail address of the person who provides support for the DITA-OT plug-in.</dd>
  22. </dlentry>
  23. <dlentry>
  24. <dt><parmname>package.version</parmname></dt>
  25. <dd conaction="pushreplace"
  26. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/package.version.desc">Specifies the version
  27. of the DITA-OT plug-in.</dd>
  28. <dd>
  29. <p>The value uses the following syntax:</p>
  30. <codeblock><varname>major</varname>.<varname>minor</varname>.<varname>micro</varname>.<varname>qualifier</varname></codeblock>
  31. <p>where:</p>
  32. <ul>
  33. <li><varname>major</varname> is a number and is required.</li>
  34. <li><varname>minor</varname> is a number and is optional.</li>
  35. <li><varname>micro</varname> is a number and is optional.</li>
  36. <li><varname>qualifier</varname> is optional and can be composed of numerals, uppercase or lower case
  37. letters, underscores, and hyphens.</li>
  38. </ul>
  39. <p>By default, the <parmname>package.version</parmname> value is set to <codeph>0.0.0</codeph>.</p>
  40. </dd>
  41. </dlentry>
  42. </dl>
  43. </section>
  44. <example>
  45. <title>Example</title>
  46. <codeblock outputclass="language-xml normalize-space show-line-numbers show-whitespace">&lt;plugin id="com.example.WithSupportInfo">
  47. &lt;feature extension="package.support.name" value="Joe the Author"/>
  48. &lt;feature extension="package.support.email" value="joe@example.com"/>
  49. &lt;feature extension="package.version" value="1.2.3"/>
  50. &lt;/plugin></codeblock>
  51. </example>
  52. </refbody>
  53. </reference>