ホーム エクスプローラ ヘルプ
サインイン
bn
/
se
2
0
フォーク 0
ファイル 課題 0 プルリクエスト 0 Wiki
ツリー: a4b429aad5
ブランチ タグ
se
/
SE
/
schema
/
WPS_Functions
/
dita-ot
/
dita-ot-3.3.3
/
doc
/
extension-points
/
plugin-extension-points-xslt-parameters.html

plugin-extension-points-xslt-parameters.html 8.8 KB
履歴 Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697 
  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 pass parameters into existing XSLT steps in both the pre-processing pipeline and DITA-OT transformation. The parameters generally will be available as global xsl:param values with XSLT overrides."><meta name="DC.subject" content="XSLT, parameters, preprocessing, extension points, parameters"><meta name="keywords" content="XSLT, parameters, preprocessing, extension points, parameters"><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-parameters"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>XSLT-parameter extension points</title></head><body id="plugin-extension-points-xslt-parameters"><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><a href="../extension-points/plugin-extension-points-xslt-import.html">XSLT-import extension points</a></li><li class="active"><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-parameter extension points</h1>
    8. 

  8.   
    9. 

  9.   
    10. 

  10.   <div class="body refbody"><p class="shortdesc">You can use these extension points to pass parameters into existing XSLT steps in both the pre-processing
    11. 

  11.     pipeline and DITA-OT transformation. The parameters generally will be available as global
    12. 

  12.       <code class="keyword markupname xmlelement">&lt;xsl:param&gt;</code> values with XSLT overrides.</p>
    13. 

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

  14.       
    15. 

  15.       <p class="p">You can use the following extension points to pass parameters to modules in the pre-processing pipeline:</p>
    16. 

  16.       <dl class="dl">
    17. 

  17.         
    18. 

  18.           <dt class="dt dlterm"><span class="keyword parmname">dita.preprocess.conref.param</span></dt>
    19. 

  19.           <dd class="dd">Pass parameters to the <code class="ph codeph">conref</code> module in the pre-processing pipeline</dd>
    20. 

  20.         
    21. 

  21.         
    22. 

  22.           <dt class="dt dlterm"><span class="keyword parmname">dita.preprocess.mappull.param</span></dt>
    23. 

  23.           <dd class="dd">Pass parameters to the <code class="ph codeph">mappull</code> module in the pre-processing pipeline</dd>
    24. 

  24.         
    25. 

  25.         
    26. 

  26.           <dt class="dt dlterm"><span class="keyword parmname">dita.preprocess.mapref.param</span></dt>
    27. 

  27.           <dd class="dd">Pass parameters to the <code class="ph codeph">mapref</code> module in the pre-processing pipeline</dd>
    28. 

  28.         
    29. 

  29.         
    30. 

  30.           <dt class="dt dlterm"><span class="keyword parmname">dita.preprocess.topicpull.param</span></dt>
    31. 

  31.           <dd class="dd">Pass parameters to the <code class="ph codeph">topicpull</code> module in the pre-processing pipeline</dd>
    32. 

  32.         
    33. 

  33.       </dl>
    34. 

  34.     </section>
    35. 

  35.     <section class="section"><h2 class="title sectiontitle">Transformations</h2>
    36. 

  36.       
    37. 

  37.       <p class="p">You can use the following extension points to pass parameters to modules in DITA-OT transformations:</p>
    38. 

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

  39.         
    40. 

  40.           <dt class="dt dlterm"><span class="keyword parmname">dita.conductor.eclipse.toc.param</span></dt>
    41. 

  41.           <dd class="dd">Pass parameters to the XSLT step that generates the Eclipse Help table of contents (TOC).</dd>
    42. 

  42.         
    43. 

  43.         
    44. 

  44.           <dt class="dt dlterm"><span class="keyword parmname">dita.conductor.html.param</span></dt>
    45. 

  45.           <dd class="dd">Pass
    46. 

  46.             parameters to the HTML and HTML Help
    47. 

  47.             transformations.</dd>
    48. 

  48.         
    49. 

  49.         
    50. 

  50.           <dt class="dt dlterm"><span class="keyword parmname">dita.conductor.html5.param</span></dt>
    51. 

  51.           <dd class="dd">Pass
    52. 

  52.             parameters to the HTML5 transformation.</dd>
    53. 

  53.         
    54. 

  54.         
    55. 

  55.           <dt class="dt dlterm"><span class="keyword parmname">dita.conductor.html5.toc.param</span></dt>
    56. 

  56.           <dd class="dd">Pass
    57. 

  57.             parameters to the XSLT step that generates the HTML5 table of contents (TOC).</dd>
    58. 

  58.         
    59. 

  59.         
    60. 

  60.           <dt class="dt dlterm"><span class="keyword parmname">dita.conductor.pdf2.param</span></dt>
    61. 

  61.           <dd class="dd">Pass
    62. 

  62.             parameters to the PDF transformation.</dd>
    63. 

  63.         
    64. 

  64.         
    65. 

  65.           <dt class="dt dlterm"><span class="keyword parmname">dita.conductor.xhtml.param</span></dt>
    66. 

  66.           <dd class="dd">Pass
    67. 

  67.             parameters to the XHTML and Eclipse Help transformations.</dd>
    68. 

  68.         
    69. 

  69.         
    70. 

  70.           <dt class="dt dlterm"><span class="keyword parmname">dita.conductor.xhtml.toc.param</span></dt>
    71. 

  71.           <dd class="dd">Pass
    72. 

  72.             parameters to the XSLT step that generates the XHTML table of contents (TOC).</dd>
    73. 

  73.         
    74. 

  74.       </dl>
    75. 

  75.     </section>
    76. 

  76.     <div class="example"><h2 class="title sectiontitle">Example</h2>
    77. 

  77.       
    78. 

  78.       <p class="p">The following two files represent a complete (albeit simple) plug-in that passes the parameters defined in the
    79. 

  79.           <span class="ph filepath">insertParameters.xml</span> file to the XHTML transformation process.</p>
    80. 

  80.       <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>
    81. 

  81.         
    82. 

  82.         <pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;plugin id="com.example.newparam"&gt;
    83. 

  83.   &lt;feature extension="dita.conductor.xhtml.param"
    84. 

  84.            file="insertParameters.xml"/&gt;
    85. 

  85. &lt;/plugin&gt;</code></pre>
    86. 

  86.       </figure>
    87. 

  87.       <figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 2. </span>Contents of the <span class="ph filepath">insertParameters.xml</span></figcaption>
    88. 

  88.         
    89. 

  89.         <pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;dummy xmlns:if="ant:if" xmlns:unless="ant:unless"&gt;
    90. 

  90.   <em class="ph i">&lt;!-- Any Ant code allowed in xslt task is possible. Example: --&gt;</em>
    91. 

  91.   &lt;param name="paramNameinXSLT" expression="${antProperty}"
    92. 

  92.          if:set="antProperty"/&gt;
    93. 

  93. &lt;/dummy&gt;</code></pre>
    94. 

  94.       </figure>
    95. 

  95.     </div>
    96. 

  96.   </div>
    97. 

  97. <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>
    98.