using-plugin-URI-extension.html 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. <!DOCTYPE html
  2. SYSTEM "about:legacy-compat">
  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 2018"><meta name="DC.rights.owner" content="(C) Copyright 2018"><meta name="DC.Type" content="task"><meta name="description" content="Starting with DITA-OT 1.5.4, you can use the plugin:plugin-id URI extension and the ${dita.plugin.plugin-id.dir} Ant variable to reference the base path of another installed DITA-OT plug-in."><meta name="DC.Relation" scheme="URI" content="../topics/plugin-applications.html"><meta name="DC.Format" content="HTML5"><meta name="DC.Identifier" content="using-plugin-URI-extension"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Referencing files from other plug-ins</title></head><body id="using-plugin-URI-extension"><header role="banner"><div class="header">
  4. <p>DITA Open Toolkit</p>
  5. <hr>
  6. </div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.0</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/extending-the-ot.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/globalization.html">Globalizing DITA content</a></li><li><a href="../topics/custom-plugins.html">Custom plug-ins</a><ul><li><a href="../topics/plugins-installing.html">Installing plug-ins</a></li><li><a href="../topics/plugins-removing.html">Removing plug-ins</a></li><li><a href="../topics/plugin-configfile.html">Plug-in descriptor file</a></li><li><a href="../topics/plugin-dependencies.html">Plug-in dependencies</a></li><li><a href="../topics/plugin-applications.html">Plug-in applications</a><ul><li><a href="../topics/plugin-xmlcatalog.html">Extending an XML catalog file</a></li><li><a href="../topics/plugin-anttarget.html">Adding a new target to the Ant build process</a></li><li><a href="../topics/plugin-antpreprocess.html">Adding an Ant target to the pre-processing pipeline</a></li><li><a href="../topics/plugin-newtranstype.html">Adding a new transformation type</a></li><li><a href="../topics/plugin-overridestyle.html">Overriding an XSLT-processing step</a></li><li class="active"><a href="../topics/using-plugin-URI-extension.html">Referencing files from other plug-ins</a></li><li><a href="../topics/plugin-xsltparams.html">Adding parameters to existing XSLT steps</a></li><li><a href="../topics/plugin-javalib.html">Adding a Java library to the DITA-OT classpath parameter</a></li><li><a href="../topics/plugin-messages.html">Adding new diagnostic messages</a></li><li><a href="../topics/plugin-newextensions.html">Creating a new plug-in extension point</a></li></ul></li><li><a href="../topics/plugin-sample.html">Example plugin.xml file</a></li><li><a href="../topics/plugin-best-practices.html">Best practices for plug-ins</a></li></ul></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../topics/migration.html">Migrating customizations</a></li><li><a href="../topics/rebuilding-the-dita-ot-documentation.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. <h1 class="title topictitle1" id="ariaid-title1">Referencing files from other plug-ins</h1>
  8. <div class="body taskbody"><p class="shortdesc">Starting with DITA-OT 1.5.4, you can use the <span class="ph filepath" id="using-plugin-URI-extension__plugin-uri-ext">plugin:<var class="keyword varname">plugin-id</var></span> URI extension and the <span class="ph filepath" id="using-plugin-URI-extension__antvar">${dita.plugin.<var class="keyword varname">plugin-id</var>.dir}</span> Ant variable to reference the
  9. base path of another installed DITA-OT plug-in.</p>
  10. <section class="section">
  11. <p class="p">Sometimes you need to reference content in another DITA-OT plug-in. However, the path to an
  12. installed plug-in is not guaranteed to be the same between different installed instances of
  13. the DITA-OT. The <span class="ph filepath">plugin:<var class="keyword varname">plugin-id</var></span> URI
  14. extension and <span class="ph filepath">${dita.plugin.<var class="keyword varname">plugin-id</var>.dir}</span> Ant variable are
  15. provided so your build and XSLT files always use the correct path to the plug-in.</p>
  16. <p class="p">Within a single plug-in, you can safely use relative path references, for example,
  17. <span class="ph filepath">xsl/my.xsl</span> without specifying the path to the plug-in itself.</p>
  18. </section>
  19. <div class="tasklabel"><h2 class="sectiontitle tasklabel">Procedure</h2></div><ul class="ul steps-unordered"><li class="li step stepexpand">
  20. <span class="ph cmd">Use <span class="ph filepath">${dita.plugin.<var class="keyword varname">plugin-id</var>.dir}</span> in Ant build files.</span>
  21. <div class="itemgroup info">
  22. <p class="p">Use the Ant variable <span class="ph filepath">${dita.plugin.<var class="keyword varname">plugin-id</var>.dir}</span> anywhere
  23. in your build file or template to point to the base path of an installed DITA-OT
  24. plug-in.</p>
  25. </div>
  26. <div class="itemgroup stepxmp">
  27. <p class="p">The following example copies CSS files from the HTML5 plug-in:</p>
  28. <pre class="pre codeblock"><code>&lt;copy todir="${dita.temp.dir}/css"&gt;
  29. &lt;fileset dir="${dita.plugin.org.dita.html5.dir}/css" includes="*.css"/&gt;
  30. &lt;/copy&gt;</code></pre>
  31. </div>
  32. </li><li class="li step stepexpand">
  33. <span class="ph cmd">Use <span class="ph filepath">plugin:<var class="keyword varname">plugin-id</var></span> in XSLT
  34. files.</span>
  35. <div class="itemgroup info">
  36. <p class="p">Use the URI extension <span class="ph filepath">plugin:<var class="keyword varname">plugin-id</var></span>
  37. at the beginning of a file reference—usually in <code class="keyword markupname xmlelement">&lt;xsl:import&gt;</code>—to
  38. point to the base path of an installed DITA-OT plug-in.</p>
  39. </div>
  40. <div class="itemgroup stepxmp">
  41. <p class="p">The following example imports the base output-message.xsl processing:</p>
  42. <pre class="pre codeblock"><code>&lt;xsl:import href="plugin:org.dita.base:xsl/common/output-message.xsl"/&gt;</code></pre>
  43. </div>
  44. <div class="itemgroup info">
  45. <p class="p">To use the URI extension, your plug-in must reference the DITA-OT catalog file. In your
  46. Ant build file, add an <code class="keyword markupname xmlelement">&lt;xmlcatalog&gt;</code> element referencing the
  47. DITA-OT catalog file as a child of the <code class="keyword markupname xmlelement">&lt;xslt&gt;</code> element.</p>
  48. </div>
  49. <div class="itemgroup stepxmp">
  50. <pre class="pre codeblock"><code>&lt;xslt style="xsl/my.xsl"
  51. in="${dita.temp.dir}/input.file" out="${dita.temp.dir}/output.file"&gt;
  52. &lt;xmlcatalog refid="dita.catalog"/&gt;
  53. &lt;/xslt&gt;</code></pre>
  54. </div>
  55. </li></ul>
  56. <section class="section tasktroubleshooting">
  57. <p class="p">For both of these methods, make sure you use the plug-in ID (defined in the
  58. <span class="ph filepath">plugin.xml</span> file) rather than the folder name of the plug-in. In many
  59. cases, the folder name is not the same as the plug-in ID.</p>
  60. </section>
  61. </div>
  62. <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../topics/plugin-applications.html" title="Plug-ins allow you to extend the functionality of the DITA-OT. This might entail adding support for specialized document types, integrating processing overrides, or defining new output transformations.">Plug-in applications</a></div></div></nav></article></main></body></html>