| 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-us" lang="en-us">
|
|---|
| 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 the minimal or standard package on Linux or Mac OSX"/>
|
|---|
| 11 | <meta name="abstract" content="If you already have locally-installed copies of Ant and the other required tools, install either the minimal or standard package."/>
|
|---|
| 12 | <meta name="description" content="If you already have locally-installed copies of Ant and the other required tools, install either the minimal or standard package."/>
|
|---|
| 13 | <meta name="DC.Relation" scheme="URI" content="../readme/DITA-installation.html"/>
|
|---|
| 14 | <meta name="DC.Format" content="XHTML"/>
|
|---|
| 15 | <meta name="DC.Identifier" content="Linuxsetup"/>
|
|---|
| 16 | <link rel="stylesheet" type="text/css" href="../commonltr.css"/>
|
|---|
| 17 | <link rel="stylesheet" type="text/css" href="../dita-ot-doc.css"/>
|
|---|
| 18 | <title>Installing the minimal or standard package on Linux or Mac OSX</title>
|
|---|
| 19 | </head>
|
|---|
| 20 | <body id="Linuxsetup">
|
|---|
| 21 |
|
|---|
| 22 |
|
|---|
| 23 | <h1 class="title topictitle1">Installing the minimal or standard package on Linux or Mac OSX</h1>
|
|---|
| 24 |
|
|---|
| 25 |
|
|---|
| 26 | <div class="body taskbody"><p class="shortdesc"> If you already have locally-installed copies of Ant and the other
|
|---|
| 27 | required tools, install either the minimal or standard package. </p>
|
|---|
| 28 |
|
|---|
| 29 | <div class="section prereq p"><div class="tasklabel"><h2 class="sectiontitle tasklabel">Before you begin</h2></div>
|
|---|
| 30 | <div class="p">Ensure that you have the following prerequisite software installed:<ul class="ul">
|
|---|
| 31 | <li class="li">Ant, version <span class="keyword">1.7.1</span> or later</li>
|
|---|
| 32 |
|
|---|
| 33 | <li class="li">Java runtime environment or development kit, version <span class="keyword">6</span> or later</li>
|
|---|
| 34 |
|
|---|
| 35 | <li class="li">XSLT processor. You can use either Saxon, version <span class="keyword">9.1</span> or later, or Xalan-J, version <span class="keyword">2.7.1</span> or later.</li>
|
|---|
| 36 |
|
|---|
| 37 | </ul>
|
|---|
| 38 | </div>
|
|---|
| 39 |
|
|---|
| 40 | <p class="p">In addition, determine the specific DITA-OT transformations that you intend to
|
|---|
| 41 | support and ensure that you have the prerequisite software installed for them.</p>
|
|---|
| 42 |
|
|---|
| 43 | <p class="p">For more information, see <a class="xref" href="prerequisite-software.html" title="The prerequisite software that the DITA-OT requires depends on the type of distribution package that you intend to install and the types of transformations that you want to use.">Prerequisite software</a> and <a class="xref" href="DITA-tested.html" title="The DITA Open Toolkit (DITA-OT) has been tested against certain versions of Ant, ICU for Java, JDK, operating systems, XML parsers, and XSLT processors.">Tested platforms and tools</a>.</p>
|
|---|
| 44 |
|
|---|
| 45 | </div>
|
|---|
| 46 |
|
|---|
| 47 | <div class="tasklabel"><h2 class="sectiontitle tasklabel">Procedure</h2></div><ol class="ol steps"><li class="li step stepexpand">
|
|---|
| 48 | <span class="ph cmd">Download the minimal or standard package from
|
|---|
| 49 | <a class="xref" href="http://sourceforge.net/projects/dita-ot/files/DITA-OT%20Stable%20Release/DITA%20Open%20Toolkit%201.8/" target="_blank">SourceForge</a>.</span>
|
|---|
| 50 |
|
|---|
| 51 | <table border="1" frame="hsides" rules="rows" cellpadding="4" cellspacing="0" summary="" class="simpletable choicetable choicetableborder">
|
|---|
| 52 | <thead><tr class="sthead chhead"><th valign="bottom" align="left" id="d33657e75-option">Package</th>
|
|---|
| 53 | <th valign="bottom" align="left" id="d33657e75-desc">File name</th></tr></thead>
|
|---|
| 54 | <tbody>
|
|---|
| 55 |
|
|---|
| 56 | <tr class="strow chrow">
|
|---|
| 57 | <td valign="top" headers="d33657e75-option" id="d33657e88" class="stentry choption" width="20%"><strong>Minimal</strong></td>
|
|---|
| 58 |
|
|---|
| 59 | <td valign="top" headers="d33657e75-desc d33657e88" class="stentry chdesc" width="80%"><span class="ph filepath">DITA-OT<span class="keyword">1.8.5</span>_minimal_bin.tar.gz</span></td>
|
|---|
| 60 |
|
|---|
| 61 | </tr>
|
|---|
| 62 |
|
|---|
| 63 | <tr class="strow chrow">
|
|---|
| 64 | <td valign="top" headers="d33657e75-option" id="d33657e101" class="stentry choption" width="20%"><strong>Standard</strong></td>
|
|---|
| 65 |
|
|---|
| 66 | <td valign="top" headers="d33657e75-desc d33657e101" class="stentry chdesc" width="80%"><span class="ph filepath">DITA-OT<span class="keyword">1.8.5</span>_standard_bin.tar.gz</span></td>
|
|---|
| 67 |
|
|---|
| 68 | </tr>
|
|---|
| 69 |
|
|---|
| 70 | </tbody></table>
|
|---|
| 71 |
|
|---|
| 72 | <div class="itemgroup info">For production use, we recommend that you use the latest stable
|
|---|
| 73 | release.</div>
|
|---|
| 74 | </li>
|
|---|
| 75 | <li class="li step stepexpand">
|
|---|
| 76 | <span class="ph cmd">Extract the contents of the package into an installation directory.</span>
|
|---|
| 77 | <div class="itemgroup info">
|
|---|
| 78 | <div class="note note"><span class="notetitle">Note:</span> You can extract the files either to your private home directory for your
|
|---|
| 79 | exclusive use or to the <span class="ph filepath">/usr/local/share/</span> directory, if
|
|---|
| 80 | you want to share the DITA-OT with other users.</div>
|
|---|
| 81 |
|
|---|
| 82 | </div>
|
|---|
| 83 | </li>
|
|---|
| 84 | <li class="li step stepexpand">
|
|---|
| 85 | <span class="ph cmd">Verify that the <var class="keyword varname">JAVA_HOME</var> environment variable is set. </span>
|
|---|
| 86 | <div class="itemgroup stepxmp">
|
|---|
| 87 | <pre class="pre codeblock">export JAVA_HOME=<JRE_dir></pre>
|
|---|
| 88 |
|
|---|
| 89 | </div>
|
|---|
| 90 | </li>
|
|---|
| 91 | <li class="li step stepexpand">
|
|---|
| 92 | <span class="ph cmd">Verify that the <var class="keyword varname">ANT_HOME</var> environment variable is been set. </span>
|
|---|
| 93 | <div class="itemgroup stepxmp">
|
|---|
| 94 | <pre class="pre codeblock">export ANT_HOME=<Ant_dir></pre>
|
|---|
| 95 |
|
|---|
| 96 | </div>
|
|---|
| 97 | </li>
|
|---|
| 98 | <li class="li step stepexpand">
|
|---|
| 99 | <span class="ph cmd">Verify that the <var class="keyword varname">PATH</var> environment variable includes the Java
|
|---|
| 100 | and Ant executable files.</span>
|
|---|
| 101 | <div class="itemgroup stepxmp">
|
|---|
| 102 | <pre class="pre codeblock">export PATH=$JAVA_HOME/bin:$ANT_HOME/bin:$PATH</pre>
|
|---|
| 103 |
|
|---|
| 104 | </div>
|
|---|
| 105 | </li>
|
|---|
| 106 | <li class="li step stepexpand">
|
|---|
| 107 | <span class="ph cmd">Set the <var class="keyword varname">DITA_HOME</var> environment variable to point to the
|
|---|
| 108 | DITA-OT installation directory.</span>
|
|---|
| 109 | <div class="itemgroup stepxmp">
|
|---|
| 110 | <pre class="pre codeblock">export DITA_HOME=<DITA-OT_dir></pre>
|
|---|
| 111 |
|
|---|
| 112 | </div>
|
|---|
| 113 | </li>
|
|---|
| 114 | <li class="li step stepexpand">
|
|---|
| 115 | <span class="ph cmd">Set up the <var class="keyword varname">CLASSPATH</var> environment variable.</span>
|
|---|
| 116 | <div class="itemgroup stepxmp">
|
|---|
| 117 | <pre class="pre codeblock">export CLASSPATH=$DITA_HOME/lib/dost.jar:$CLASSPATH
|
|---|
| 118 | export CLASSPATH=$DITA_HOME/lib:$CLASSPATH
|
|---|
| 119 | export CLASSPATH=$DITA_HOME/lib/resolver.jar:$CLASSPATH
|
|---|
| 120 | export CLASSPATH=$DITA_HOME/lib/commons-codec-<span class="keyword">1.4</span>.jar:$CLASSPATH</pre>
|
|---|
| 121 |
|
|---|
| 122 | </div>
|
|---|
| 123 | </li>
|
|---|
| 124 | <li class="li step stepexpand"><strong>Optional: </strong>
|
|---|
| 125 | <span class="ph cmd">If you use Ant, version 1.8 or later, set up the <var class="keyword varname">CLASSPATH</var>
|
|---|
| 126 | environment variable to include Apache Xerces.</span>
|
|---|
| 127 | <div class="itemgroup stepxmp">
|
|---|
| 128 | <pre class="pre codeblock">export CLASSPATH=<xerces_dir>/xercesImpl.jar:<xerces_dir>/xml-apis.jar:$CLASSPATH</pre>
|
|---|
| 129 |
|
|---|
| 130 | </div>
|
|---|
| 131 | </li>
|
|---|
| 132 | <li class="li step stepexpand">
|
|---|
| 133 | <span class="ph cmd">Set up the XSLT processor:</span>
|
|---|
| 134 |
|
|---|
| 135 | <table border="1" frame="hsides" rules="rows" cellpadding="4" cellspacing="0" summary="" class="simpletable choicetable choicetableborder">
|
|---|
| 136 | <thead><tr class="sthead chhead"><th valign="bottom" align="left" id="d33657e231-option">Processor</th>
|
|---|
| 137 | <th valign="bottom" align="left" id="d33657e231-desc">Action</th></tr></thead>
|
|---|
| 138 | <tbody>
|
|---|
| 139 |
|
|---|
| 140 | <tr class="strow chrow">
|
|---|
| 141 | <td valign="top" headers="d33657e231-option" id="d33657e244" class="stentry choption" width="20%"><strong>Saxon</strong></td>
|
|---|
| 142 |
|
|---|
| 143 | <td valign="top" headers="d33657e231-desc d33657e244" class="stentry chdesc" width="80%">
|
|---|
| 144 | <div class="p">Set up the <var class="keyword varname">CLASSPATH</var> environment variable to
|
|---|
| 145 | include the Saxon JAR files, for
|
|---|
| 146 | example:<pre class="pre codeblock">export CLASSPATH=<saxon_dir>/saxon9.jar:<saxon_dir>/saxon9-dom.jar:$CLASSPATH</pre>
|
|---|
| 147 | </div>
|
|---|
| 148 |
|
|---|
| 149 | <div class="p">Set up the <samp class="ph codeph">ANT_OPTS</samp> environment variable, for
|
|---|
| 150 | example:
|
|---|
| 151 | <pre class="pre codeblock">export ANT_OPTS=$ANT_OPTS -Djavax.xml.transform.TransformerFactory=net.sf.saxon.TransformerFactoryImpl</pre>
|
|---|
| 152 | </div>
|
|---|
| 153 |
|
|---|
| 154 | </td>
|
|---|
| 155 |
|
|---|
| 156 | </tr>
|
|---|
| 157 |
|
|---|
| 158 | <tr class="strow chrow">
|
|---|
| 159 | <td valign="top" headers="d33657e231-option" id="d33657e269" class="stentry choption" width="20%"><strong>Xalan</strong></td>
|
|---|
| 160 |
|
|---|
| 161 | <td valign="top" headers="d33657e231-desc d33657e269" class="stentry chdesc" width="80%">Set up the <var class="keyword varname">CLASSPATH</var> environment variable to
|
|---|
| 162 | include the Xalan JAR files, for example:
|
|---|
| 163 | <pre class="pre codeblock">export CLASSPATH=<xalan_dir>/xalan.jar:$CLASSPATH</pre>
|
|---|
| 164 | </td>
|
|---|
| 165 |
|
|---|
| 166 | </tr>
|
|---|
| 167 |
|
|---|
| 168 | </tbody></table>
|
|---|
| 169 |
|
|---|
| 170 | </li>
|
|---|
| 171 | <li class="li step stepexpand"><strong>Optional: </strong>
|
|---|
| 172 | <span class="ph cmd">For index processing, set up ICU for Java.</span>
|
|---|
| 173 | <div class="itemgroup stepxmp">
|
|---|
| 174 | <pre class="pre codeblock">export CLASSPATH=<icu4j_dir>/icu4j.jar:$CLASSPATH</pre>
|
|---|
| 175 |
|
|---|
| 176 | </div>
|
|---|
| 177 | </li>
|
|---|
| 178 | <li class="li step stepexpand"><strong>Optional: </strong>
|
|---|
| 179 | <span class="ph cmd">For JavaHelp, set the <var class="keyword varname">JHHOME</var> environment variable.</span>
|
|---|
| 180 | <div class="itemgroup stepxmp">
|
|---|
| 181 | <pre class="pre codeblock">export JHHOME=<javahelp_dir></pre>
|
|---|
| 182 |
|
|---|
| 183 | </div>
|
|---|
| 184 | </li>
|
|---|
| 185 | <li class="li step stepexpand"><strong>Optional: </strong>
|
|---|
| 186 | <span class="ph cmd">For PDF output, set up the XSL-FO processor:</span>
|
|---|
| 187 |
|
|---|
| 188 | <table border="1" frame="hsides" rules="rows" cellpadding="4" cellspacing="0" summary="" class="simpletable choicetable choicetableborder">
|
|---|
| 189 | <thead><tr class="sthead chhead"><th valign="bottom" align="left" id="d33657e316-option">Processor</th>
|
|---|
| 190 | <th valign="bottom" align="left" id="d33657e316-desc">Action</th></tr></thead>
|
|---|
| 191 | <tbody>
|
|---|
| 192 |
|
|---|
| 193 | <tr class="strow chrow">
|
|---|
| 194 | <td valign="top" headers="d33657e316-option" id="d33657e329" class="stentry choption" width="20%"><strong>FOP</strong></td>
|
|---|
| 195 |
|
|---|
| 196 | <td valign="top" headers="d33657e316-desc d33657e329" class="stentry chdesc" width="80%">
|
|---|
| 197 | <div class="p">Add the FOP installation directory to the
|
|---|
| 198 | <span class="ph filepath">local.properties</span> file as the
|
|---|
| 199 | <span class="keyword option">fop.home</span> property, for
|
|---|
| 200 | example:<pre class="pre codeblock">fop.home=/usr/share/java/fop</pre>
|
|---|
| 201 | </div>
|
|---|
| 202 |
|
|---|
| 203 | </td>
|
|---|
| 204 |
|
|---|
| 205 | </tr>
|
|---|
| 206 |
|
|---|
| 207 | <tr class="strow chrow">
|
|---|
| 208 | <td valign="top" headers="d33657e316-option" id="d33657e349" class="stentry choption" width="20%"><strong>RenderX</strong></td>
|
|---|
| 209 |
|
|---|
| 210 | <td valign="top" headers="d33657e316-desc d33657e349" class="stentry chdesc" width="80%">Add the RenderX installation directory to the
|
|---|
| 211 | <span class="ph filepath">local.properties</span> file as the
|
|---|
| 212 | <span class="keyword option">xep.dir</span> property, for
|
|---|
| 213 | example:<pre class="pre codeblock">xep.dir=/usr/share/java/xep</pre>
|
|---|
| 214 | </td>
|
|---|
| 215 |
|
|---|
| 216 | </tr>
|
|---|
| 217 |
|
|---|
| 218 | <tr class="strow chrow">
|
|---|
| 219 | <td valign="top" headers="d33657e316-option" id="d33657e366" class="stentry choption" width="20%"><strong>Antenna House</strong></td>
|
|---|
| 220 |
|
|---|
| 221 | <td valign="top" headers="d33657e316-desc d33657e366" class="stentry chdesc" width="80%">Add the AH Formatter installation directory to the
|
|---|
| 222 | <span class="ph filepath">local.properties</span> file as the
|
|---|
| 223 | <span class="keyword option">axf.path</span> property, for
|
|---|
| 224 | example:<pre class="pre codeblock">axf.path=/usr/share/java/AHFormatterV6</pre>
|
|---|
| 225 | </td>
|
|---|
| 226 |
|
|---|
| 227 | </tr>
|
|---|
| 228 |
|
|---|
| 229 | </tbody></table>
|
|---|
| 230 |
|
|---|
| 231 | </li>
|
|---|
| 232 | <li class="li step stepexpand">
|
|---|
| 233 | <span class="ph cmd">Test the DITA-OT installation by transforming the sample files.</span>
|
|---|
| 234 | <div class="itemgroup info">The <span class="ph filepath">samples\ant_sample directory</span> contains Ant scripts
|
|---|
| 235 | designed to build various output formats.</div>
|
|---|
| 236 | <div class="itemgroup stepxmp">
|
|---|
| 237 | <pre class="pre codeblock">/usr/local/share/DITA-OT<span class="keyword">1.8.5</span>$ ant -f samples/ant_sample/sample_all.xml</pre>
|
|---|
| 238 |
|
|---|
| 239 | </div>
|
|---|
| 240 | <div class="itemgroup stepresult">The generated output is written to the
|
|---|
| 241 | <span class="ph filepath"><var class="keyword varname">DITA-dir</var>\out\samples directory</span>.
|
|---|
| 242 | The following output formats are generated:<ul class="ul">
|
|---|
| 243 | <li class="li">Docbook</li>
|
|---|
| 244 |
|
|---|
| 245 | <li class="li">Eclipse help</li>
|
|---|
| 246 |
|
|---|
| 247 | <li class="li">HTML Help</li>
|
|---|
| 248 |
|
|---|
| 249 | <li class="li">ODT</li>
|
|---|
| 250 |
|
|---|
| 251 | <li class="li">JavaHelp</li>
|
|---|
| 252 |
|
|---|
| 253 | <li class="li">PDF</li>
|
|---|
| 254 |
|
|---|
| 255 | <li class="li">TocJS</li>
|
|---|
| 256 |
|
|---|
| 257 | <li class="li">TROFF</li>
|
|---|
| 258 |
|
|---|
| 259 | <li class="li">XHTML</li>
|
|---|
| 260 |
|
|---|
| 261 | </ul>
|
|---|
| 262 | </div>
|
|---|
| 263 | </li>
|
|---|
| 264 | </ol>
|
|---|
| 265 |
|
|---|
| 266 | </div>
|
|---|
| 267 |
|
|---|
| 268 | <div class="related-links">
|
|---|
| 269 | <div class="familylinks">
|
|---|
| 270 | <div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../readme/DITA-installation.html" title="You can install the DITA Open Toolkit (DITA-OT) on Linux, Mac OSX, and Windows. The process for installing and setting up the DITA-OT depends on the type of distribution package that you select.">Installing the DITA Open Toolkit</a></div>
|
|---|
| 271 | </div>
|
|---|
| 272 | </div>
|
|---|
| 273 |
|
|---|
| 274 | </body>
|
|---|
| 275 | </html>
|
|---|
