plugin-extension-points-general.dita 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  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-general-extension-points">
  5. <title>General extension points</title>
  6. <shortdesc>These extension points enable you to extend DITA-OT. You can add Ant targets or imports; add a Java library
  7. to the <parmname>classpath</parmname> parameter; add a new transformation type; extend a catalog file; add new
  8. diagnostic messages, and more.</shortdesc>
  9. <prolog>
  10. <metadata>
  11. <keywords>
  12. <indexterm>deprecated features
  13. <indexterm><parmname>dita.conductor.target</parmname></indexterm></indexterm>
  14. <indexterm>deprecated features
  15. <indexterm><parmname>dita.specialization.catalog</parmname></indexterm></indexterm>
  16. </keywords>
  17. </metadata>
  18. </prolog>
  19. <refbody>
  20. <section>
  21. <dl>
  22. <dlentry id="ant.import">
  23. <dt><parmname>ant.import</parmname></dt>
  24. <dd conaction="pushreplace" conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/ant.import.desc"
  25. >Adds an Ant import to the main Ant build file.</dd>
  26. </dlentry>
  27. <dlentry>
  28. <dt><parmname>dita.conductor.lib.import</parmname></dt>
  29. <dd conaction="pushreplace"
  30. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/dita.conductor.lib.import.desc">Adds a Java
  31. library to the DITA-OT classpath.</dd>
  32. </dlentry>
  33. <dlentry>
  34. <dt importance="deprecated"><parmname>dita.conductor.target</parmname></dt>
  35. <dd conaction="pushreplace"
  36. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/dita.conductor.target.desc">Adds an Ant
  37. import to the main Ant build file.
  38. <p>
  39. <note type="attention">This extension point is deprecated; use <codeph>ant.import</codeph> instead.</note>
  40. </p>
  41. </dd>
  42. </dlentry>
  43. <dlentry>
  44. <dt><parmname>dita.conductor.target.relative</parmname></dt>
  45. <dd conaction="pushreplace"
  46. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/dita.conductor.target.relative.desc">Adds
  47. an Ant import to the main Ant build file.
  48. <p>
  49. <note type="tip">As of DITA-OT 3.0, the <codeph>ant.import</codeph> extension point can be used
  50. instead.</note>
  51. </p>
  52. </dd>
  53. </dlentry>
  54. <dlentry>
  55. <dt><parmname>dita.conductor.transtype.check</parmname></dt>
  56. <dd conaction="pushreplace"
  57. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/dita.conductor.transtype.check.desc">
  58. <p>Adds a new value to the list of valid transformation types.</p>
  59. <note type="tip">This extension point is still supported for backwards compatibility, but since DITA-OT 2.1,
  60. any new customizations should instead use the <xmlelement>transtype</xmlelement> element in the
  61. <xref keyref="plugin-configfile"/> to define a new transformation.</note>
  62. </dd>
  63. </dlentry>
  64. <dlentry importance="deprecated">
  65. <dt><parmname>dita.specialization.catalog</parmname></dt>
  66. <dd conaction="pushreplace"
  67. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/dita.specialization.catalog.desc">Adds the
  68. content of a catalog file to the main DITA-OT catalog file. <note type="attention">This extension point is
  69. deprecated; use <codeph>dita.specialization.catalog.relative</codeph> instead.</note></dd>
  70. </dlentry>
  71. <dlentry>
  72. <dt><parmname>dita.specialization.catalog.relative</parmname></dt>
  73. <dd conaction="pushreplace"
  74. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/dita.specialization.catalog.relative.desc"
  75. >Adds the content of a catalog file to the main DITA-OT catalog file.</dd>
  76. </dlentry>
  77. <dlentry>
  78. <dt><parmname>dita.transtype.print</parmname></dt>
  79. <dd conaction="pushreplace"
  80. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/dita.transtype.print.desc">Defines a
  81. transformation as a print type.<draft-comment author="Kristen Eberlein" time="31 March 2013">What does this
  82. actually do? Does this interact with using the deprecated <xmlatt>print</xmlatt>
  83. attribute?</draft-comment></dd>
  84. </dlentry>
  85. <dlentry>
  86. <dt><parmname>dita.xsl.messages</parmname></dt>
  87. <dd conaction="pushreplace"
  88. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/dita.xsl.messages.desc">Adds new diagnostic
  89. messages to DITA-OT.</dd>
  90. </dlentry>
  91. <dlentry>
  92. <dt><parmname>org.dita.pdf2.catalog.relative</parmname></dt>
  93. <dd conaction="pushreplace"
  94. conref="extension-points-in-org.dita.pdf2.dita#org.dita.pdf2-ext/org.dita.pdf2.catalog.relative.desc">Adds
  95. the content of a catalog file to the main catalog file for the PDF plug-in.</dd>
  96. </dlentry>
  97. </dl>
  98. </section>
  99. </refbody>
  100. </reference>