Startseite Erkunden Hilfe
Anmelden
bn
/
se
2
0
Fork 0
Dateien Issues 0 Pull-Requests 0 Wiki
Struktur: a4b429aad5
Branches Tags
se
/
SE
/
schema
/
WPS_Functions
/
dita-ot
/
dita-ot-3.3.3
/
doc
/
extension-points
/
plugin-extension-points-xslt-import.html

plugin-extension-points-xslt-import.html 12 KB
Verlauf Originalformat

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148 
  1. <!DOCTYPE html
    2. 

  2.   SYSTEM "about:legacy-compat">
    3. 

  3. <html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2019"><meta name="DC.rights.owner" content="(C) Copyright 2019"><meta name="DC.type" content="reference"><meta name="description" content="You can use these extension points to override XSLT processing steps in pre-processing and certain transformation types. The value of the file attribute in the feature element specifies a relative path to an XSL file in the current plug-in. The plug-in installer adds a XSL import statement to the default DITA-OT code, so that the XSL override becomes part of the normal build."><meta name="DC.subject" content=", xref, file, XSLT, extension points, preprocessing, extension points, XSLT"><meta name="keywords" content=", xref, file, XSLT, extension points, preprocessing, extension points, XSLT"><meta name="DC.relation" scheme="URI" content="../extension-points/plugin-extension-points.html"><meta name="DC.format" content="HTML5"><meta name="DC.identifier" content="plugin-extension-points-xslt-import"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>XSLT-import extension points</title></head><body id="plugin-extension-points-xslt-import"><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.3</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/alternative-input-formats.html">Authoring formats</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../parameters/index.html">Setting parameters</a></li><li><a href="../topics/customizing.html">Customizing DITA-OT</a><ul><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/custom-plugins.html">Working with plug-ins</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a><ul><li><a href="../extension-points/all-extension-points.html">All extension points</a></li><li><a href="../extension-points/plugin-extension-points-general.html">General extension points</a></li><li><a href="../extension-points/plugin-extension-points-pre-processing.html">Pre-processing extension points</a></li><li class="active"><a href="../extension-points/plugin-extension-points-xslt-import.html">XSLT-import extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-parameters.html">XSLT-parameter extension points</a></li><li><a href="../extension-points/plugin-extension-points-support.html">Version and support information</a></li><li><a href="../extension-points/extension-points-by-plugin.html">Plug-in extension points</a></li></ul></li><li><a href="../topics/migration.html">Migrating customizations</a></li><li><a href="../topics/globalization.html">Globalizing DITA content</a></li><li><a href="../topics/rebuilding-docs.html">Rebuilding documentation</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">XSLT-import extension points</h1>
    8. 

  8.   
    9. 

  9.   
    10. 

  10.   <div class="body refbody"><p class="shortdesc">You can use these extension points to override XSLT processing steps in pre-processing and certain
    11. 

  11.     transformation types. The value of the <code class="keyword markupname xmlatt">@file</code> attribute in the <code class="keyword markupname xmlelement">&lt;feature&gt;</code>
    12. 

  12.     element specifies a relative path to an XSL file in the current plug-in. The plug-in installer adds a XSL import
    13. 

  13.     statement to the default DITA-OT code, so that the XSL override becomes part of the normal build.</p>
    14. 

  14.     <section class="section"><h2 class="title sectiontitle">Pre-processing</h2>
    15. 

  15.       
    16. 

  16.       <p class="p">You can use the following extension points to add XSLT processing to modules in the pre-processing
    17. 

  17.         pipeline:</p>
    18. 

  18.       <dl class="dl">
    19. 

  19.         
    20. 

  20.           <dt class="dt dlterm"><span class="keyword parmname">dita.xsl.conref</span></dt>
    21. 

  21.           <dd class="dd">Overrides the pre-processing step that resolves conref.</dd>
    22. 

  22.         
    23. 

  23.         
    24. 

  24.           <dt class="dt dlterm"><span class="keyword parmname">dita.xsl.maplink</span></dt>
    25. 

  25.           <dd class="dd">Overrides the <code class="ph codeph">maplink</code> step in the pre-processing pipeline. This is the step that
    26. 

  26.             generates map-based links.</dd>
    27. 

  27.         
    28. 

  28.         
    29. 

  29.           <dt class="dt dlterm"><span class="keyword parmname">dita.xsl.mappull</span></dt>
    30. 

  30.           <dd class="dd">Overrides the <code class="ph codeph">mappull</code> step in the pre-processing pipeline. This is the step that updates
    31. 

  31.             navigation titles in maps and causes attributes to cascade.</dd>
    32. 

  32.         
    33. 

  33.         
    34. 

  34.           <dt class="dt dlterm"><span class="keyword parmname">dita.xsl.mapref</span></dt>
    35. 

  35.           <dd class="dd">Overrides the <code class="ph codeph">mapref</code> step in the pre-processing pipeline. This is the step that resolves
    36. 

  36.             references to other maps.</dd>
    37. 

  37.         
    38. 

  38.         
    39. 

  39.           <dt class="dt dlterm"><span class="keyword parmname">dita.xsl.topicpull</span></dt>
    40. 

  40.           <dd class="dd">Overrides the <code class="ph codeph">topicpull</code> step in the pre-processing pipeline. This is the step that pulls
    41. 

  41.             text into <code class="keyword markupname xmlelement">&lt;xref&gt;</code> elements, as well as performing other tasks.</dd>
    42. 

  42.         
    43. 

  43.       </dl>
    44. 

  44.     </section>
    45. 

  45.     <section class="section"><h2 class="title sectiontitle">Transformations</h2>
    46. 

  46.       
    47. 

  47.       <p class="p">You can use the following extension points to add XSLT processing to modules in DITA-OT transformations:</p>
    48. 

  48.       <dl class="dl">
    49. 

  49.         
    50. 

  50.           <dt class="dt dlterm"><span class="keyword parmname">dita.map.eclipse.index.pre</span></dt>
    51. 

  51.           <dd class="dd">Runs an Ant target before the Eclipse index extraction process.</dd>
    52. 

  52.         
    53. 

  53.         
    54. 

  54.           <dt class="dt dlterm"><span class="keyword parmname">dita.xsl.eclipse.plugin</span></dt>
    55. 

  55.           <dd class="dd">Overrides the default XSLT step that generates the <span class="ph filepath">plugin.xml</span> file for Eclipse
    56. 

  56.             Help.</dd>
    57. 

  57.         
    58. 

  58.         
    59. 

  59.           <dt class="dt dlterm"><span class="keyword parmname">dita.xsl.eclipse.toc</span></dt>
    60. 

  60.           <dd class="dd">Overrides the default XSLT step that generates the Eclipse Help table of contents (TOC).</dd>
    61. 

  61.         
    62. 

  62.         
    63. 

  63.           <dt class="dt dlterm"><span class="keyword parmname">dita.xsl.html.cover</span></dt>
    64. 

  64.           <dd class="dd">Overrides the
    65. 

  65.             default HTML cover page generation process.</dd>
    66. 

  66.         
    67. 

  67.         
    68. 

  68.           <dt class="dt dlterm"><span class="keyword parmname">dita.xsl.htmltoc</span></dt>
    69. 

  69.           <dd class="dd">Overrides the
    70. 

  70.             default XSLT step that generates the HTML table of contents (TOC).</dd>
    71. 

  71.         
    72. 

  72.         
    73. 

  73.           <dt class="dt dlterm"><span class="keyword parmname">dita.xsl.html5</span></dt>
    74. 

  74.           <dd class="dd">Overrides the
    75. 

  75.             default HTML5 transformation. The referenced file is integrated directly into the XSLT step that generates
    76. 

  76.             HTML5.</dd>
    77. 

  77.         
    78. 

  78.         
    79. 

  79.           <dt class="dt dlterm"><span class="keyword parmname">dita.xsl.html5.cover</span></dt>
    80. 

  80.           <dd class="dd">Overrides the
    81. 

  81.             default HTML5 cover page generation process.</dd>
    82. 

  82.         
    83. 

  83.         
    84. 

  84.           <dt class="dt dlterm"><span class="keyword parmname">dita.xsl.html5.toc</span></dt>
    85. 

  85.           <dd class="dd">Overrides the
    86. 

  86.             default XSLT step that generates the HTML5 table of contents (TOC).</dd>
    87. 

  87.         
    88. 

  88.         
    89. 

  89.           <dt class="dt dlterm"><span class="keyword parmname">dita.xsl.htmlhelp.map2hhc</span></dt>
    90. 

  90.           <dd class="dd">Overrides the default XSLT step that generates the HTML Help contents (<span class="ph filepath">.hhc</span>)
    91. 

  91.             file.</dd>
    92. 

  92.         
    93. 

  93.         
    94. 

  94.           <dt class="dt dlterm"><span class="keyword parmname">dita.xsl.htmlhelp.map2hhp</span></dt>
    95. 

  95.           <dd class="dd">Overrides the default XSLT step that generates the HTML Help project (<span class="ph filepath">.hhp</span>) file.</dd>
    96. 

  96.         
    97. 

  97.         
    98. 

  98.           <dt class="dt dlterm"><span class="keyword parmname">dita.xsl.troff-ast</span></dt>
    99. 

  99.           <dd class="dd">Overrides the
    100. 

  100.             intermediate block-and-phrase format that is generated as input to troff processing.</dd>
    101. 

  101.         
    102. 

  102.         
    103. 

  103.           <dt class="dt dlterm"><span class="keyword parmname">dita.xsl.troff</span></dt>
    104. 

  104.           <dd class="dd">Overrides the XSL
    105. 

  105.             that converts block-and-phrase intermediate markup into troff.</dd>
    106. 

  106.         
    107. 

  107.         
    108. 

  108.           <dt class="dt dlterm"><span class="keyword parmname">dita.xsl.xhtml</span></dt>
    109. 

  109.           <dd class="dd">Overrides the
    110. 

  110.             default HTML or XHTML transformation, including HTML Help and Eclipse Help. The referenced file is
    111. 

  111.             integrated directly into the XSLT step that generates XHTML.</dd>
    112. 

  112.         
    113. 

  113.         
    114. 

  114.           <dt class="dt dlterm"><span class="keyword parmname">dita.xsl.xslfo</span></dt>
    115. 

  115.           <dd class="dd">Overrides the default
    116. 

  116.             PDF transformation. The referenced XSL file is integrated directly into the XSLT step that generates the
    117. 

  117.             XSL-FO.</dd>
    118. 

  118.         
    119. 

  119.       </dl>
    120. 

  120.     </section>
    121. 

  121.     <div class="example"><h2 class="title sectiontitle">Example</h2>
    122. 

  122.       
    123. 

  123.       <p class="p">The following two files represent a complete (albeit simple) plug-in that adds a company banner to the XHTML
    124. 

  124.         output. The <span class="ph filepath">plugin.xml</span> file declares an XSLT file that extends the XHTML processing; the
    125. 

  125.           <span class="ph filepath">xsl/header.xsl</span> file overrides the default header processing to provide a company
    126. 

  126.         banner.</p>
    127. 

  127.       <figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 1. </span>Contents of the <span class="ph filepath">plugin.xml</span> file</figcaption>
    128. 

  128.         
    129. 

  129.         <pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
    130. 

  130. &lt;plugin id="com.example.brandheader"&gt;
    131. 

  131.   &lt;feature extension="dita.xsl.xhtml" file="xsl/header.xsl"/&gt;
    132. 

  132. &lt;/plugin&gt;</code></pre>
    133. 

  133.       </figure>
    134. 

  134.       <figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 2. </span>Contents of the <span class="ph filepath">xsl/header.xsl</span> file</figcaption>
    135. 

  135.         
    136. 

  136.         <pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
    137. 

  137. &lt;xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"&gt;
    138. 

  138.   &lt;xsl:template name="gen-user-header"&gt;
    139. 

  139.     &lt;div&gt;
    140. 

  140.       &lt;img src="http://www.example.com/company_banner.jpg" 
    141. 

  141.            alt="Example Company Banner"/&gt;
    142. 

  142.     &lt;/div&gt;
    143. 

  143.   &lt;/xsl:template&gt;
    144. 

  144. &lt;/xsl:stylesheet&gt;</code></pre>
    145. 

  145.       </figure>
    146. 

  146.     </div>
    147. 

  147.   </div>
    148. 

  148. <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../extension-points/plugin-extension-points.html" title="DITA Open Toolkit provides a series of extension points that can be used to integrate changes into the core code. Extension points are defined in the plugin.xml file for each plug-in. When plug-ins are installed, DITA-OT makes each extension visible to the rest of the toolkit.">Extension points</a></div></div></nav></article></main></body></html>
    149.