| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 2 | <!DOCTYPE html
|
|---|
| 3 | PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|---|
| 4 | <html xml:lang="en" lang="en">
|
|---|
| 5 | <head>
|
|---|
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
|
|---|
| 7 | <meta name="copyright" content="(C) Copyright 2005"/>
|
|---|
| 8 | <meta name="DC.rights.owner" content="(C) Copyright 2005"/>
|
|---|
| 9 | <meta name="DC.Type" content="task"/>
|
|---|
| 10 | <meta name="DC.Title" content="Installing plug-ins"/>
|
|---|
| 11 | <meta name="abstract" content="Plug-ins are generally distributed as zip files. There are two steps to installing a plug-in: unzipping and integrating."/>
|
|---|
| 12 | <meta name="description" content="Plug-ins are generally distributed as zip files. There are two steps to installing a plug-in: unzipping and integrating."/>
|
|---|
| 13 | <meta name="DC.Relation" scheme="URI" content="../dev_ref/extending-the-ot.html"/>
|
|---|
| 14 | <meta name="DC.Format" content="XHTML"/>
|
|---|
| 15 | <meta name="DC.Identifier" content="plugins-installing"/>
|
|---|
| 16 | <meta name="DC.Language" content="en"/>
|
|---|
| 17 | <link rel="stylesheet" type="text/css" href="../commonltr.css"/>
|
|---|
| 18 | <link rel="stylesheet" type="text/css" href="../dita-ot-doc.css"/>
|
|---|
| 19 | <title>Installing plug-ins</title>
|
|---|
| 20 | </head>
|
|---|
| 21 | <body id="plugins-installing">
|
|---|
| 22 |
|
|---|
| 23 |
|
|---|
| 24 | <h1 class="title topictitle1">Installing plug-ins</h1>
|
|---|
| 25 |
|
|---|
| 26 |
|
|---|
| 27 | <div class="body taskbody"><p class="shortdesc">Plug-ins are generally distributed as zip files. There are two steps to installing a
|
|---|
| 28 | plug-in: unzipping and integrating.</p>
|
|---|
| 29 |
|
|---|
| 30 | <div class="section context"><div class="tasklabel"><h2 class="sectiontitle tasklabel">About this task</h2></div>
|
|---|
| 31 | <p class="p">It is possible to define a plug-in so that it may be installed anywhere, although most
|
|---|
| 32 | expect to be placed in <span class="ph filepath">plugins/</span> directory inside of the DITA-OT. Most
|
|---|
| 33 | plug-ins do not require a specific install directory and can go in either of the default
|
|---|
| 34 | locations, but some may come with instructions for a particular install directory.</p>
|
|---|
| 35 |
|
|---|
| 36 | </div>
|
|---|
| 37 |
|
|---|
| 38 | <div class="tasklabel"><h2 class="sectiontitle tasklabel">Procedure</h2></div><ol class="ol steps"><li class="li step stepexpand">
|
|---|
| 39 | <span class="ph cmd">The unzip the plug-in file to <span class="ph filepath">plugins</span> subdirectory.</span>
|
|---|
| 40 | <div class="itemgroup info">The plug-in directory should be named after plug-in ID and version, for example
|
|---|
| 41 | <span class="ph filepath">plugins/com.example.xhtml_1.0.0</span>.</div>
|
|---|
| 42 | </li>
|
|---|
| 43 | <li class="li step stepexpand">
|
|---|
| 44 | <span class="ph cmd">Run plug-in integration process.</span>
|
|---|
| 45 | <ul class="ul choices">
|
|---|
| 46 | <li class="li choice">From the toolkit directory, run the following command to integrate all installed
|
|---|
| 47 | plug-ins: <pre class="pre codeblock">ant -f integrator.xml </pre>
|
|---|
| 48 | </li>
|
|---|
| 49 |
|
|---|
| 50 | <li class="li choice">Any build that uses the Java command line interface automatically runs the integrator
|
|---|
| 51 | before processing begins.</li>
|
|---|
| 52 |
|
|---|
| 53 | <li class="li choice">Ant based builds may import the <samp class="ph codeph">integrator.xml</samp> file, and add
|
|---|
| 54 | <samp class="ph codeph">integrate</samp> to the start of the dependency chain for the build. <div class="note note"><span class="notetitle">Note:</span> The integration process in considered part of the installation process and
|
|---|
| 55 | running it before each conversion will incur a performance penalty.</div>
|
|---|
| 56 | </li>
|
|---|
| 57 |
|
|---|
| 58 | </ul>
|
|---|
| 59 |
|
|---|
| 60 |
|
|---|
| 61 |
|
|---|
| 62 | <div class="itemgroup info">
|
|---|
| 63 | <p class="p">The integration process has two modes, lax and strict. In the strict mode the integration process will immediately fail if it encounters errors in plug-in configurations or installation process. In the lax mode, the integration process will continue to finish regardless of errors; the lax mode does not imply error recovery and may leave the DITA-OT installation into a broken state. The default mode is lax due to backwards compatibility, to run the integration in strict mode:</p>
|
|---|
| 64 |
|
|---|
| 65 | <pre class="pre codeblock">ant -f integrator.xml strict</pre>
|
|---|
| 66 |
|
|---|
| 67 | <p class="p">To get more information about the integration process, run Ant in verbose mode:</p>
|
|---|
| 68 |
|
|---|
| 69 | <pre class="pre codeblock">ant -f integrator.xml -verbose strict</pre>
|
|---|
| 70 |
|
|---|
| 71 | </div>
|
|---|
| 72 | </li>
|
|---|
| 73 | </ol>
|
|---|
| 74 |
|
|---|
| 75 | </div>
|
|---|
| 76 |
|
|---|
| 77 | <div class="related-links">
|
|---|
| 78 | <div class="familylinks">
|
|---|
| 79 | <div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../dev_ref/extending-the-ot.html" title="There are several methods that can be used to extend the toolkit; not all of them are recommended or supported. The best way to create most extensions is with a plug-in; extended documentation for creating plug-ins is provided in the next section.">Extending the DITA Open Toolkit</a></div>
|
|---|
| 80 | </div>
|
|---|
| 81 | </div>
|
|---|
| 82 |
|
|---|
| 83 | </body>
|
|---|
| 84 | </html>
|
|---|
