Startseite Erkunden Hilfe
Anmelden
bn
/
se
2
0
Fork 0
Dateien Issues 0 Pull-Requests 0 Wiki
Struktur: c8927bb461
Branches Tags
se
/
SE
/
schema
/
WPS_Functions
/
dita-ot
/
dita-ot-3.5
/
doc
/
topics
/
plugin-javalib.html

plugin-javalib.html 11 KB
Verlauf Originalformat

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778 
  1. <!DOCTYPE html
    2. 

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

  3. <html lang="en-us"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="DC.rights.owner" content="(C) Copyright 2020"><meta name="DC.type" content="task"><meta name="description" content="You can use the dita.conductor.lib.import extension point to add an additional Java library to the DITA-OT classpath parameter."><meta name="DC.subject" content="deprecated features, property, dost.class.path, plug-ins, Java, Java, classpath, classpath, XSLT"><meta name="keywords" content="deprecated features, property, dost.class.path, plug-ins, Java, Java, classpath, classpath, XSLT"><meta name="DC.relation" scheme="URI" content="../topics/plugin-use-cases.html"><meta name="DC.relation" scheme="URI" content="../extension-points/plugin-extension-points-general.html"><meta name="DC.relation" scheme="URI" content="../topics/plugins-installing.html"><meta name="DC.format" content="HTML5"><meta name="DC.identifier" content="plugin-javalib"><meta name="DC.language" content="en-US"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Adding a Java library to the DITA-OT classpath</title></head><body id="plugin-javalib"><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.5</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/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><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/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a><ul><li><a href="../topics/plugin-benefits.html">Plug-in benefits</a></li><li><a href="../topics/plugin-configfile.html">Plug-in descriptor file</a></li><li><a href="../topics/plugin-coding-conventions.html">Coding conventions</a></li><li><a href="../topics/plugin-dependencies.html">Plug-in dependencies</a></li><li><a href="../topics/plugin-use-cases.html">Plug-in use cases</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><a href="../topics/plugin-xsltparams.html">Adding parameters to existing XSLT steps</a></li><li class="active"><a href="../topics/plugin-javalib.html">Adding a Java library to the classpath</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><li><a href="../topics/implement-saxon-customizations.html">Adding Saxon customizations</a></li></ul></li><li><a href="../topics/html-customization-plugins.html">Custom HTML plug-ins</a></li><li><a href="../topics/pdf-customization-plugins.html">Custom PDF plug-ins</a></li><li><a href="../topics/globalization.html">Globalizing DITA content</a></li><li><a href="../topics/migration.html">Migrating customizations</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">Adding a Java library to the DITA-OT <span class="keyword parmname">classpath</span></h1>
    8. 

  8.   
    9. 

  9.   
    10. 

  10.   
    11. 

  11.   <div class="body taskbody"><p class="shortdesc">You can use the <code class="ph codeph">dita.conductor.lib.import</code> extension point to add an additional Java
    12. 

  12.     library to the DITA-OT <span class="keyword parmname">classpath</span> parameter.</p>
    13. 

  13.     <section class="section context"><div class="tasklabel"><h2 class="sectiontitle tasklabel">About this task</h2></div>
    14. 

  14.       <p class="p">As of DITA-OT 3.1, the Java class path is managed automatically, meaning you do not (and should not) use
    15. 

  15.         explicit references to Java class paths in your build scripts. In particular, the old
    16. 

  16.           <code class="ph codeph">dost.class.path</code> property has been deprecated and should not be used. If you are migrating
    17. 

  17.         older plug-ins that manage their class path directly, you should remove any explicit class path configuration.
    18. 

  18.         If your plug-in was not already using the <code class="ph codeph">dita.conductor.lib.import</code> extension point to
    19. 

  19.         integrate its JAR dependencies you must add it.</p>
    20. 

  20.       <p class="p">The effective DITA-OT class path is the combination of the JAR files in the main <span class="ph filepath">lib/</span>
    21. 

  21.         directory and the plug-in-contributed JARs, which are listed in <span class="ph filepath">config/env.sh</span>. The
    22. 

  22.           <span class="ph filepath">env.sh</span> file is updated automatically when plug-ins are installed or removed.</p>
    23. 

  23.     </section>
    24. 

  24.     <section><div class="tasklabel"><h2 class="sectiontitle tasklabel">Procedure</h2></div><ol class="ol steps"><li class="li step stepexpand">
    25. 

  25.         <span class="ph cmd">If necessary, compile the Java code into a JAR file.</span>
    26. 

  26.       </li><li class="li step stepexpand">
    27. 

  27.         <span class="ph cmd">Create a <span class="ph filepath">plugin.xml</span> file that contains the following code:</span>
    28. 

  28.         <div class="itemgroup info"><pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;plugin id="<var class="keyword varname">plugin-id</var>"&gt;
    29. 

  29.   &lt;feature extension="dita.conductor.lib.import" file="<var class="keyword varname">file</var>"/&gt;
    30. 

  30. &lt;/plugin&gt;</code></pre>where:
    31. 

  31.           <ul class="ul">
    32. 

  32.             <li class="li"><var class="keyword varname">plugin-id</var> is the plug-in identifier, for example,
    33. 

  33.               <code class="ph codeph">com.example.addjar</code>.</li>
    34. 

  34.             <li class="li"><var class="keyword varname">file</var> is the name of the JAR file, for example,
    35. 

  35.               <span class="ph filepath">myJavaLibrary.jar</span>. </li>
    36. 

  36.           </ul></div>
    37. 

  37.       </li><li class="li step stepexpand">
    38. 

  38.         <span class="ph cmd">Install the plug-in.</span>
    39. 

  39.       </li></ol></section>
    40. 

  40.     <section class="section result"><div class="tasklabel"><h2 class="sectiontitle tasklabel">Results</h2></div>The Ant or XSLT code now can make use of the Java code.</section>
    41. 

  41.     <section class="example"><div class="tasklabel"><h2 class="sectiontitle tasklabel">Example</h2></div>
    42. 

  42.       <p class="p">In the following extended example, the <span class="ph filepath">myJavaLibrary.jar</span> file performs a validation step
    43. 

  43.         during processing, and you want it to run immediately before the <code class="ph codeph">conref </code>step.</p>
    44. 

  44.       <p class="p">To accomplish this, you will need to use several features:</p>
    45. 

  45.       <ul class="ul">
    46. 

  46.         <li class="li">The JAR file must be added to the classpath.</li>
    47. 

  47.         <li class="li">The Ant target must be added to the dependency chain for conref.</li>
    48. 

  48.         <li class="li">An Ant target must be created that uses this class, and integrated into the code.</li>
    49. 

  49.       </ul>
    50. 

  50.       <p class="p">The files might look like the following:</p>
    51. 

  51.       <figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 1. </span><span class="ph filepath">plugin.xml</span> file</figcaption>
    52. 

  52.         
    53. 

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

  54. &lt;plugin id="com.example.samplejava"&gt;
    55. 

  55.   <em class="ph i">&lt;!-- Add the JAR file to the DITA-OT CLASSPATH --&gt;</em>
    56. 

  56.   <strong class="ph b">&lt;feature extension="dita.conductor.lib.import" 
    57. 

  57.            file="com.example.sampleValidation.jar"/&gt;</strong>
    58. 

  58.   <em class="ph i">&lt;!-- Integrate the Ant code --&gt;</em>
    59. 

  59.   &lt;feature extension="ant.import" file="calljava-antcode.xml"/&gt;
    60. 

  60.   <em class="ph i">&lt;!-- Define the Ant target to call, and when (before conref) --&gt;</em>
    61. 

  61.   &lt;feature extension="depend.preprocess.conref.pre" 
    62. 

  62.            value="validateWithJava"/&gt;
    63. 

  63. &lt;/plugin&gt;</code></pre>
    64. 

  64.       </figure>
    65. 

  65.       <figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 2. </span><span class="ph filepath">calljava-antcode.xml</span> file</figcaption>
    66. 

  66.         
    67. 

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

  68. &lt;project default="validateWithJava"&gt;
    69. 

  69.   &lt;target name="validateWithJava"&gt;
    70. 

  70.     &lt;java classname="com.example.sampleValidation"&gt;
    71. 

  71.       &lt;!-- The class was added to the DITA-OT classpath --&gt;
    72. 

  72.     &lt;/java&gt;
    73. 

  73.   &lt;/target&gt;
    74. 

  74. &lt;/project&gt;</code></pre>
    75. 

  75.       </figure>
    76. 

  76.     </section>
    77. 

  77.   </div>
    78. 

  78. <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../topics/plugin-use-cases.html" title="Plug-ins allow you to extend the functionality of DITA-OT. This might entail adding support for specialized document types, integrating processing overrides, or defining new output transformations.">Plug-in use cases</a></div></div><div class="linklist reltasks"><strong>Related tasks</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/plugins-installing.html" title="Use the dita install subcommand to install plug-ins.">Installing plug-ins</a></li></ul></div><div class="linklist relref"><strong>Related reference</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../extension-points/plugin-extension-points-general.html" title="These extension points enable you to extend DITA-OT. You can add Ant targets or imports; add a Java library to the classpath parameter; add a new transformation type; extend a catalog file; add new diagnostic messages, and more.">General extension points</a></li></ul></div></nav></article></main></body></html>
    79.