extension-points-details.dita 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153
  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="extension-points-details">
  5. <title>Extension points details</title>
  6. <shortdesc>This file provides additional details that are pushed to the generated topics to replace the navigation
  7. titles and short descriptions embedded in the plug-in source code. Descriptions for individual extension points are
  8. pushed from the manually authored topics as necessary.</shortdesc>
  9. <prolog>
  10. <metadata>
  11. <keywords>
  12. <!-- This is a resource-only topic. Place index entries in the content below. -->
  13. </keywords>
  14. </metadata>
  15. </prolog>
  16. <reference id="base">
  17. <title>All transformations</title>
  18. <titlealts>
  19. <navtitle conaction="pushreplace"
  20. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/navtitle">Common processing</navtitle>
  21. </titlealts>
  22. <shortdesc conaction="pushreplace"
  23. conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/shortdesc">The
  24. <codeph>org.dita.base</codeph> plug-in provides common extension points that are available to extend processing
  25. in all transformations that DITA Open Toolkit supports.
  26. <ph>
  27. <indexterm><codeph>org.dita.base</codeph></indexterm>
  28. <indexterm>extension points<indexterm>common</indexterm></indexterm>
  29. </ph>
  30. </shortdesc>
  31. <refbody/>
  32. </reference>
  33. <reference id="xhtml">
  34. <title>HTML-based output formats</title>
  35. <titlealts>
  36. <navtitle>HTML-based output</navtitle>
  37. </titlealts>
  38. <shortdesc conaction="pushreplace"
  39. conref="extension-points-in-org.dita.xhtml.dita#org.dita.xhtml-ext/shortdesc">The
  40. <codeph>org.dita.xhtml</codeph> plug-in provides shared extension points that can be used to modify processing
  41. in HTML-based transformation types such as Eclipse help, HTML Help, TocJS, and XHTML.
  42. <ph>
  43. <indexterm><codeph>org.dita.xhtml</codeph></indexterm>
  44. <indexterm>extension points<indexterm>HTML</indexterm></indexterm>
  45. <indexterm>extension points<indexterm>HTML5</indexterm></indexterm>
  46. <indexterm>extension points<indexterm>HTML Help</indexterm></indexterm>
  47. <indexterm>extension points<indexterm>Eclipse Help</indexterm></indexterm>
  48. <indexterm>extension points<indexterm>TocJS</indexterm></indexterm>
  49. <indexterm>extension points<indexterm>XHTML</indexterm></indexterm>
  50. <indexterm>HTML</indexterm>
  51. <indexterm>HTML5<indexterm>extension points</indexterm></indexterm>
  52. <indexterm>HTML Help</indexterm>
  53. <indexterm>Eclipse Help</indexterm>
  54. <indexterm>TocJS</indexterm>
  55. <indexterm>XHTML</indexterm>
  56. </ph>
  57. </shortdesc>
  58. <refbody/>
  59. </reference>
  60. <reference id="html5">
  61. <title>HTML5 extension points </title>
  62. <titlealts>
  63. <navtitle>HTML5</navtitle>
  64. </titlealts>
  65. <shortdesc conaction="pushreplace"
  66. conref="extension-points-in-org.dita.html5.dita#org.dita.html5-ext/shortdesc">In addition to the
  67. extension points provided by common processing and those shared by with other HTML-based transformations, the
  68. <codeph>org.dita.html5</codeph> plug-in provides extension points that are specific to the HTML5
  69. transformation.
  70. <ph>
  71. <indexterm><codeph>org.dita.html5</codeph></indexterm>
  72. <indexterm>extension points<indexterm><codeph>org.dita.html5</codeph></indexterm></indexterm>
  73. </ph>
  74. </shortdesc>
  75. <refbody/>
  76. </reference>
  77. <reference id="eclipsehelp">
  78. <title>Eclipse Help</title>
  79. <titlealts>
  80. <navtitle>Eclipse Help (<codeph>org.dita.eclipsehelp</codeph>) </navtitle>
  81. </titlealts>
  82. <shortdesc conaction="pushreplace"
  83. conref="extension-points-in-org.dita.eclipsehelp.dita#org.dita.eclipsehelp-ext/shortdesc">Certain
  84. extension points are specific to the Eclipse Help transformation.
  85. <ph>
  86. <indexterm><codeph>org.dita.eclipsehelp</codeph></indexterm>
  87. <indexterm>extension points<indexterm><codeph>org.dita.eclipsehelp</codeph></indexterm></indexterm>
  88. <indexterm>Eclipse Help</indexterm>
  89. </ph>
  90. </shortdesc>
  91. <refbody/>
  92. </reference>
  93. <reference id="htmlhelp">
  94. <title>HTML Help</title>
  95. <titlealts>
  96. <navtitle conaction="pushreplace"
  97. conref="extension-points-in-org.dita.htmlhelp.dita#org.dita.htmlhelp-ext/navtitle">HTML Help</navtitle>
  98. </titlealts>
  99. <shortdesc conaction="pushreplace"
  100. conref="extension-points-in-org.dita.htmlhelp.dita#org.dita.htmlhelp-ext/shortdesc">Certain extension
  101. points are specific to the HTML Help transformation.
  102. <ph>
  103. <indexterm><codeph>org.dita.htmlhelp</codeph></indexterm>
  104. <indexterm>extension points<indexterm><codeph>org.dita.htmlhelp</codeph></indexterm></indexterm>
  105. <indexterm>HTML Help</indexterm>
  106. </ph>
  107. </shortdesc>
  108. <refbody/>
  109. </reference>
  110. <reference id="pdf">
  111. <title>PDF</title>
  112. <titlealts>
  113. <navtitle>PDF (<codeph>org.dita.pdf2</codeph>) </navtitle>
  114. </titlealts>
  115. <shortdesc conaction="pushreplace"
  116. conref="extension-points-in-org.dita.pdf2.dita#org.dita.pdf2-ext/shortdesc">Certain extension points are
  117. specific to the PDF transformation (formerly known as “PDF2”).
  118. <ph>
  119. <indexterm>PDF<indexterm><codeph>org.dita.pdf2</codeph></indexterm></indexterm>
  120. <indexterm><codeph>org.dita.pdf2</codeph></indexterm>
  121. <indexterm>extension points<indexterm><codeph>org.dita.pdf2</codeph></indexterm></indexterm>
  122. </ph>
  123. </shortdesc>
  124. <refbody/>
  125. </reference>
  126. <reference id="troff">
  127. <title>troff</title>
  128. <titlealts>
  129. <navtitle conaction="pushreplace"
  130. conref="extension-points-in-org.dita.troff.dita#org.dita.troff-ext/navtitle">troff</navtitle>
  131. </titlealts>
  132. <shortdesc conaction="pushreplace"
  133. conref="extension-points-in-org.dita.troff.dita#org.dita.troff-ext/shortdesc">Certain extension points
  134. are specific to the troff transformation, which produces output for use with the troff viewer on Unix-style
  135. platforms, particularly for programs such as the man page viewer.
  136. <ph>
  137. <indexterm>UNIX<index-see-also>Linux</index-see-also></indexterm>
  138. <indexterm><codeph>org.dita.troff</codeph></indexterm>
  139. <indexterm>extension points<indexterm><codeph>org.dita.troff</codeph></indexterm></indexterm>
  140. </ph>
  141. </shortdesc>
  142. <refbody/>
  143. </reference>
  144. </reference>