Home Explore Help
Sign In
bn
/
se
2
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: e89bfafc3a
Branches Tags
se
/
SE
/
stuff
/
dita-ot-2.3.3
/
doc
/
dev_ref
/
plugin-anttarget.html

plugin-anttarget.html 6.9 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637 
  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 2016"><meta name="DC.rights.owner" content="(C) Copyright 2016"><meta name="DC.Type" content="task"><meta name="description" content="Use the Ant conductor extension point (dita.conductor.target.relative) to make new targets available to the Ant processing pipeline. This can be done as part of creating a new transformation, extending pre-processing, or simply to make new Ant targets available to other plug-ins."><meta name="DC.Relation" scheme="URI" content="../dev_ref/plugin-creating.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/plugin-extension-points-general.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/plugins-installing.html"><meta name="DC.Format" content="XHTML"><meta name="DC.Identifier" content="plugin-anttarget"><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 new target to the Ant build process</title></head><body id="plugin-anttarget"><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 2.3</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../getting-started/index.html">Getting Started</a></li><li><a href="../user-guide/index.html">User Guide</a></li><li><a href="../parameters/index.html">Parameter Reference</a></li><li><a href="../dev_ref/index.html">Developer Reference</a><ul><li><a href="../dev_ref/DITA-OTArchitecture.html">DITA-OT Architecture</a></li><li><a href="../dev_ref/extending-the-ot.html">Extending the DITA-OT</a></li><li><a href="../dev_ref/plugin-creating.html">Creating plug-ins</a><ul><li><a href="../dev_ref/plugins-overview.html">Overview of plug-ins</a></li><li><a href="../dev_ref/plugin-xmlcatalog.html">Extending an XML catalog file</a></li><li class="active"><a href="../dev_ref/plugin-anttarget.html">Adding a new target to the Ant build process</a></li><li><a href="../dev_ref/plugin-antpreprocess.html">Adding an Ant target to the pre-processing pipeline</a></li><li><a href="../dev_ref/plugin-newtranstype.html">Adding a new transformation type</a></li><li><a href="../dev_ref/plugin-overridestyle.html">Overriding an XSLT-processing step</a></li><li><a href="../dev_ref/using-plugin-URI-extension.html">Referencing files from other plug-ins</a></li><li><a href="../dev_ref/plugin-addgeneratedtext.html">Modifying or adding generated text</a></li><li><a href="../dev_ref/plugin-xsltparams.html">Adding parameters to existing XSLT steps</a></li><li><a href="../dev_ref/plugin-javalib.html">Adding a Java library to the DITA-OT classpath parameter</a></li><li><a href="../dev_ref/plugin-messages.html">Adding new diagnostic messages</a></li><li><a href="../dev_ref/plugin-newextensions.html">Creating a new plug-in extension point</a></li><li><a href="../dev_ref/plugin-sample.html">Example plugin.xml file</a></li></ul></li><li><a href="../dev_ref/plugin-extension-points.html">Extension points</a></li><li><a href="../dev_ref/pdf-customization.html">Customizing PDF output</a></li><li><a href="../dev_ref/migration.html">Migrating customizations</a></li></ul></li><li><a href="../user-guide/dita-and-dita-ot-resources.html">DITA 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 new target to the Ant build process</h1>
    8. 

  8.   
    9. 

  9.   <div class="body taskbody"><p class="shortdesc">Use the Ant conductor extension point (<code class="ph codeph">dita.conductor.target.relative</code>) to make new targets
    10. 

  10.     available to the Ant processing pipeline. This can be done as part of creating a new transformation, extending
    11. 

  11.     pre-processing, or simply to make new Ant targets available to other plug-ins.</p>
    12. 

  12.     <div class="tasklabel"><h2 class="sectiontitle tasklabel">Procedure</h2></div><ol class="ol steps"><li class="li step stepexpand">
    13. 

  13.         <span class="ph cmd">Create an Ant project file that contains the new target.</span>
    14. 

  14.       </li><li class="li step stepexpand">
    15. 

  15.         <span class="ph cmd">In the same directory as the Ant project file, create a wrapper file that imports the Ant project file: </span>
    16. 

  16.         <div class="itemgroup info"><pre class="pre codeblock"><code>&lt;dummy&gt;
    17. 

  17.   &lt;import file="<var class="keyword varname">Ant-file</var>"/&gt;
    18. 

  18. &lt;/dummy&gt;</code></pre>where
    19. 

  19.             <var class="keyword varname">Ant-file</var> is the project file that contains the new target.</div>
    20. 

  20.       </li><li class="li step stepexpand">
    21. 

  21.         <span class="ph cmd">Create the <span class="ph filepath">plugin.xml</span> file:</span>
    22. 

  22.         <div class="itemgroup stepxmp"><pre class="pre codeblock"><code>&lt;plugin id="<var class="keyword varname">plugin-id</var>"&gt;
    23. 

  23.   &lt;feature extension="dita.conductor.target.relative" file="<var class="keyword varname">wrapper-file</var>"/&gt;
    24. 

  24. &lt;/plugin&gt;</code></pre>where:<ul class="ul">
    25. 

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

  26.               <code class="ph codeph">com.example.ant</code>.</li>
    27. 

  27.             <li class="li"><var class="keyword varname">wrapper-file</var> is the wrapper file that imports the Ant project file.</li>
    28. 

  28.           </ul></div>
    29. 

  29.       </li><li class="li step stepexpand">
    30. 

  30.         <span class="ph cmd">Install the plug-in.</span>
    31. 

  31.       </li></ol>
    32. 

  32.     <section class="section result"><div class="tasklabel"><h2 class="sectiontitle tasklabel">Results</h2></div>
    33. 

  33.       <p class="p">The imports from wrapper file are copied into the <span class="ph filepath">build.xml</span> file, using the correct path.
    34. 

  34.         This makes the new Ant targets available to other processes.</p>
    35. 

  35.     </section>
    36. 

  36.   </div>
    37. 

  37. <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../dev_ref/plugin-creating.html" title="You can use DITA-OT plug-ins to extend the DITA Open Toolkit.">Creating plug-ins</a></div></div><div class="linklist linklist relinfo reltasks"><strong>Related tasks</strong><br><div><a class="link" href="../dev_ref/plugins-installing.html" title="Use the dita command to install a plug-in.">Installing plug-ins</a></div></div><div class="linklist linklist relinfo relref"><strong>Related reference</strong><br><div><a class="link" href="../dev_ref/plugin-extension-points-general.html" title="These extension points enable you to extend the 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></div></div></nav></article></main></body></html>
    38.