| 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="reference"/>
|
|---|
| 10 | <meta name="DC.Title" content="Command-line tool parameters: All transformations"/>
|
|---|
| 11 | <meta name="abstract" content="Certain parameters apply to all transformations that are supported by the DITA Open Toolkit."/>
|
|---|
| 12 | <meta name="description" content="Certain parameters apply to all transformations that are supported by the DITA Open Toolkit."/>
|
|---|
| 13 | <meta name="DC.subject" content="command-line tool, parameters, basedir, cleantemp, debug, ditadir, ditaext, ditalocale, draft, filter, grammarcache, i, logdir, outdir, outext, tempdir, transtype, validate"/>
|
|---|
| 14 | <meta name="keywords" content="command-line tool, parameters, basedir, cleantemp, debug, ditadir, ditaext, ditalocale, draft, filter, grammarcache, i, logdir, outdir, outext, tempdir, transtype, validate"/>
|
|---|
| 15 | <meta name="DC.Relation" scheme="URI" content="../readme/dita-ot_java_properties.html"/>
|
|---|
| 16 | <meta name="DC.Format" content="XHTML"/>
|
|---|
| 17 | <meta name="DC.Identifier" content="tool-parameters-all-transformation"/>
|
|---|
| 18 | <link rel="stylesheet" type="text/css" href="../commonltr.css"/>
|
|---|
| 19 | <link rel="stylesheet" type="text/css" href="../dita-ot-doc.css"/>
|
|---|
| 20 | <title>Command-line tool parameters: All transformations</title>
|
|---|
| 21 | </head>
|
|---|
| 22 | <body id="tool-parameters-all-transformation">
|
|---|
| 23 |
|
|---|
| 24 |
|
|---|
| 25 | <h1 class="title topictitle1">Command-line tool parameters: All transformations</h1>
|
|---|
| 26 |
|
|---|
| 27 |
|
|---|
| 28 |
|
|---|
| 29 |
|
|---|
| 30 | <div class="body refbody"><p class="shortdesc">Certain parameters apply to all transformations that are supported by the DITA Open
|
|---|
| 31 | Toolkit.</p>
|
|---|
| 32 |
|
|---|
| 33 |
|
|---|
| 34 | <div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" class="table" frame="border" border="1" rules="all"><caption><span class="tablecap">Table 1. Command-line tool parameters: All transformations</span></caption>
|
|---|
| 35 |
|
|---|
| 36 |
|
|---|
| 37 | <thead class="thead" align="left">
|
|---|
| 38 | <tr class="row">
|
|---|
| 39 | <th class="entry" valign="top" width="27.27272727272727%" id="d35605e83">Parameters</th>
|
|---|
| 40 |
|
|---|
| 41 | <th class="entry" valign="top" width="72.72727272727273%" id="d35605e86">Description</th>
|
|---|
| 42 |
|
|---|
| 43 | </tr>
|
|---|
| 44 |
|
|---|
| 45 | </thead>
|
|---|
| 46 |
|
|---|
| 47 | <tbody class="tbody">
|
|---|
| 48 | <tr class="row">
|
|---|
| 49 | <td class="entry" valign="top" width="27.27272727272727%" headers="d35605e83 "><span class="keyword parmname">basedir</span></td>
|
|---|
| 50 |
|
|---|
| 51 | <td class="entry" id="tool-parameters-all-transformation__basedir.desc" valign="top" width="72.72727272727273%" headers="d35605e86 ">The directory where your project's ant build script resides.
|
|---|
| 52 | The DITA-OT will look for your .dita files relative to this directory. DITA-OT's
|
|---|
| 53 | default build script sets this as an attribute of the project, but you can also define
|
|---|
| 54 | it as a project property.</td>
|
|---|
| 55 |
|
|---|
| 56 | </tr>
|
|---|
| 57 |
|
|---|
| 58 | <tr class="row">
|
|---|
| 59 | <td class="entry" valign="top" width="27.27272727272727%" headers="d35605e83 "><span class="keyword parmname">cleantemp</span></td>
|
|---|
| 60 |
|
|---|
| 61 | <td class="entry" valign="top" width="72.72727272727273%" headers="d35605e86 ">Specifies whether the DITA-OT deletes the files in the
|
|---|
| 62 | temporary directory after it finishes a build. The allowed values are
|
|---|
| 63 | <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is
|
|---|
| 64 | <span class="keyword option">yes</span>.</td>
|
|---|
| 65 |
|
|---|
| 66 | </tr>
|
|---|
| 67 |
|
|---|
| 68 | <tr class="row">
|
|---|
| 69 | <td class="entry" valign="top" width="27.27272727272727%" headers="d35605e83 "><span class="keyword parmname">debug</span></td>
|
|---|
| 70 |
|
|---|
| 71 | <td class="entry" valign="top" width="72.72727272727273%" headers="d35605e86 ">Specifies whether debugging information is included in the
|
|---|
| 72 | log. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default
|
|---|
| 73 | value is <span class="keyword option">no</span>.</td>
|
|---|
| 74 |
|
|---|
| 75 | </tr>
|
|---|
| 76 |
|
|---|
| 77 | <tr class="row">
|
|---|
| 78 | <td class="entry" valign="top" width="27.27272727272727%" headers="d35605e83 "><span class="keyword parmname">ditadir</span></td>
|
|---|
| 79 |
|
|---|
| 80 | <td class="entry" valign="top" width="72.72727272727273%" headers="d35605e86 ">Specifies where the DITA-OT is installed.</td>
|
|---|
| 81 |
|
|---|
| 82 | </tr>
|
|---|
| 83 |
|
|---|
| 84 | <tr class="row">
|
|---|
| 85 | <td class="entry" valign="top" width="27.27272727272727%" headers="d35605e83 "><span class="keyword parmname">ditaext</span></td>
|
|---|
| 86 |
|
|---|
| 87 | <td class="entry" valign="top" width="72.72727272727273%" headers="d35605e86 ">Specifies the file extension that the DITA-OT uses for
|
|---|
| 88 | files in the temporary directory. The allowed values are <span class="keyword option">xml</span> and
|
|---|
| 89 | <span class="keyword option">dita</span>; the default value is <span class="keyword option">xml</span>.<div class="note note"><span class="notetitle">Note:</span> This
|
|---|
| 90 | parameter is deprecated in favor of the <span class="keyword parmname">dita.ext</span>
|
|---|
| 91 | parameter.</div>
|
|---|
| 92 | </td>
|
|---|
| 93 |
|
|---|
| 94 | </tr>
|
|---|
| 95 |
|
|---|
| 96 | <tr class="row">
|
|---|
| 97 | <td class="entry" valign="top" width="27.27272727272727%" headers="d35605e83 "><span class="keyword parmname">ditalocale</span></td>
|
|---|
| 98 |
|
|---|
| 99 | <td class="entry" valign="top" width="72.72727272727273%" headers="d35605e86 ">Specifies the language locale file to use for sorting
|
|---|
| 100 | index entries.<div class="note note"><span class="notetitle">Note:</span> This parameter is not available for the XHTML
|
|---|
| 101 | transformation.</div>
|
|---|
| 102 | </td>
|
|---|
| 103 |
|
|---|
| 104 | </tr>
|
|---|
| 105 |
|
|---|
| 106 | <tr class="row">
|
|---|
| 107 | <td class="entry" valign="top" width="27.27272727272727%" headers="d35605e83 "><span class="keyword parmname">draft</span></td>
|
|---|
| 108 |
|
|---|
| 109 | <td class="entry" valign="top" width="72.72727272727273%" headers="d35605e86 ">Specifies whether the content of <draft-comment> and
|
|---|
| 110 | <required-cleanup> elements is included in the output. The allowed values are
|
|---|
| 111 | <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is
|
|---|
| 112 | <span class="keyword option">no</span>. <span class="ph">Corresponds to XSLT parameter
|
|---|
| 113 | <span class="keyword parmname">DRAFT</span> in most XSLT modules.</span><div class="note tip"><span class="tiptitle">Tip:</span> For PDF
|
|---|
| 114 | output, setting the <span class="keyword parmname">args.draft</span> parameter to
|
|---|
| 115 | <span class="keyword option">yes</span> causes the contents of the <titlealts> element to be
|
|---|
| 116 | rendered below the title.</div>
|
|---|
| 117 |
|
|---|
| 118 | </td>
|
|---|
| 119 |
|
|---|
| 120 | </tr>
|
|---|
| 121 |
|
|---|
| 122 | <tr class="row">
|
|---|
| 123 | <td class="entry" valign="top" width="27.27272727272727%" headers="d35605e83 "><span class="keyword parmname">filter</span></td>
|
|---|
| 124 |
|
|---|
| 125 | <td class="entry" valign="top" width="72.72727272727273%" headers="d35605e86 ">Specifies a filter file to be
|
|---|
| 126 | used to include, exclude, or flag content. Filter files must have a .ditaval or
|
|---|
| 127 | .DITAVAL extension.<div class="note note"><span class="notetitle">Note:</span> Deprecated in favor of the
|
|---|
| 128 | <span class="keyword parmname">args.filter</span> parameter.</div>
|
|---|
| 129 | </td>
|
|---|
| 130 |
|
|---|
| 131 | </tr>
|
|---|
| 132 |
|
|---|
| 133 | <tr class="row">
|
|---|
| 134 | <td class="entry" valign="top" width="27.27272727272727%" headers="d35605e83 "><span class="keyword parmname">grammarcache</span></td>
|
|---|
| 135 |
|
|---|
| 136 | <td class="entry" valign="top" width="72.72727272727273%" headers="d35605e86 ">Specifies whether the
|
|---|
| 137 | grammar-caching feature of the XML parser is used. The allowed values are
|
|---|
| 138 | <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is
|
|---|
| 139 | <span class="keyword option">no</span>.<div class="note note"><span class="notetitle">Note:</span> This option dramatically speeds up processing time.
|
|---|
| 140 | However, there is a known problem with using this feature for documents that use XML
|
|---|
| 141 | entities. If your build fails with parser errors about entity resolution, set this
|
|---|
| 142 | parameter to <span class="keyword option">no</span>.</div>
|
|---|
| 143 | </td>
|
|---|
| 144 |
|
|---|
| 145 | </tr>
|
|---|
| 146 |
|
|---|
| 147 | <tr class="row">
|
|---|
| 148 | <td class="entry" valign="top" width="27.27272727272727%" headers="d35605e83 "><span class="keyword parmname">i</span></td>
|
|---|
| 149 |
|
|---|
| 150 | <td class="entry" valign="top" width="72.72727272727273%" headers="d35605e86 ">Specifies the master file for your documentation project.
|
|---|
| 151 | Typically this is a DITA map, however it also can be a DITA topic if you want to
|
|---|
| 152 | transform a single DITA file. The path can be absolute, relative to <span class="keyword parmname">args.input.dir</span>,
|
|---|
| 153 | or relative to the directory where your project's ant build script resides
|
|---|
| 154 | if <span class="keyword parmname">args.input.dir</span> is not defined.
|
|---|
| 155 | </td>
|
|---|
| 156 |
|
|---|
| 157 | </tr>
|
|---|
| 158 |
|
|---|
| 159 | <tr class="row">
|
|---|
| 160 | <td class="entry" valign="top" width="27.27272727272727%" headers="d35605e83 "><span class="keyword parmname">logdir</span></td>
|
|---|
| 161 |
|
|---|
| 162 | <td class="entry" valign="top" width="72.72727272727273%" headers="d35605e86 ">Specifies the location where the DITA-OT places log files
|
|---|
| 163 | for your project.</td>
|
|---|
| 164 |
|
|---|
| 165 | </tr>
|
|---|
| 166 |
|
|---|
| 167 | <tr class="row">
|
|---|
| 168 | <td class="entry" valign="top" width="27.27272727272727%" headers="d35605e83 "><span class="keyword parmname">outdir</span></td>
|
|---|
| 169 |
|
|---|
| 170 | <td class="entry" valign="top" width="72.72727272727273%" headers="d35605e86 ">Specifies the name and location of the output directory. By
|
|---|
| 171 | default, the output is written to
|
|---|
| 172 | <span class="ph filepath"><var class="keyword varname">DITA-dir</var>\out</span>.</td>
|
|---|
| 173 |
|
|---|
| 174 | </tr>
|
|---|
| 175 |
|
|---|
| 176 | <tr class="row">
|
|---|
| 177 | <td class="entry" valign="top" width="27.27272727272727%" headers="d35605e83 "><span class="keyword parmname">outext</span></td>
|
|---|
| 178 |
|
|---|
| 179 | <td class="entry" valign="top" width="72.72727272727273%" headers="d35605e86 ">Specifies an extension to use for DITA topics; All DITA topics
|
|---|
| 180 | will use this single extension in the temp directory. The default value is .xml. <span class="ph">Corresponds to XSLT parameter
|
|---|
| 181 | <span class="keyword parmname">DITAEXT</span>.</span>
|
|---|
| 182 | </td>
|
|---|
| 183 |
|
|---|
| 184 | </tr>
|
|---|
| 185 |
|
|---|
| 186 | <tr class="row">
|
|---|
| 187 | <td class="entry" valign="top" width="27.27272727272727%" headers="d35605e83 "><span class="keyword parmname">tempdir</span></td>
|
|---|
| 188 |
|
|---|
| 189 | <td class="entry" valign="top" width="72.72727272727273%" headers="d35605e86 ">Specifies the location of the temporary directory. The
|
|---|
| 190 | temporary directory is where the DITA-OT writes temporary files that are generated
|
|---|
| 191 | during the transformation process.</td>
|
|---|
| 192 |
|
|---|
| 193 | </tr>
|
|---|
| 194 |
|
|---|
| 195 |
|
|---|
| 196 |
|
|---|
| 197 | <tr class="row">
|
|---|
| 198 | <td class="entry" valign="top" width="27.27272727272727%" headers="d35605e83 "><span class="keyword parmname">transtype</span></td>
|
|---|
| 199 |
|
|---|
| 200 | <td class="entry" valign="top" width="72.72727272727273%" headers="d35605e86 ">Specifies the output format. You can create plug-ins to add
|
|---|
| 201 | new values for this parameter; by default, the following values are available:<ul class="ul">
|
|---|
| 202 | <li class="li">docbook</li>
|
|---|
| 203 |
|
|---|
| 204 | <li class="li">eclipsehelp</li>
|
|---|
| 205 |
|
|---|
| 206 | <li class="li">eclipsecontent</li>
|
|---|
| 207 |
|
|---|
| 208 | <li class="li">htmlhelp</li>
|
|---|
| 209 |
|
|---|
| 210 | <li class="li">javahelp</li>
|
|---|
| 211 |
|
|---|
| 212 | <li class="li">legacypdf</li>
|
|---|
| 213 |
|
|---|
| 214 | <li class="li">odt</li>
|
|---|
| 215 |
|
|---|
| 216 | <li class="li">pdf</li>
|
|---|
| 217 |
|
|---|
| 218 | <li class="li">wordrtf</li>
|
|---|
| 219 |
|
|---|
| 220 | <li class="li">troff</li>
|
|---|
| 221 |
|
|---|
| 222 | <li class="li">xhtml</li>
|
|---|
| 223 |
|
|---|
| 224 | </ul>
|
|---|
| 225 |
|
|---|
| 226 | </td>
|
|---|
| 227 |
|
|---|
| 228 | </tr>
|
|---|
| 229 |
|
|---|
| 230 | <tr class="row">
|
|---|
| 231 | <td class="entry" valign="top" width="27.27272727272727%" headers="d35605e83 "><span class="keyword parmname">validate</span></td>
|
|---|
| 232 |
|
|---|
| 233 | <td class="entry" valign="top" width="72.72727272727273%" headers="d35605e86 ">Specifies whether the DITA-OT validates the content. The
|
|---|
| 234 | allowed values are <span class="keyword option">true</span> and <span class="keyword option">false</span>; the default value is
|
|---|
| 235 | <span class="keyword option">true</span>.</td>
|
|---|
| 236 |
|
|---|
| 237 | </tr>
|
|---|
| 238 |
|
|---|
| 239 | </tbody>
|
|---|
| 240 |
|
|---|
| 241 | </table>
|
|---|
| 242 | </div>
|
|---|
| 243 |
|
|---|
| 244 | </div>
|
|---|
| 245 |
|
|---|
| 246 | <div class="related-links">
|
|---|
| 247 | <div class="familylinks">
|
|---|
| 248 | <div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../readme/dita-ot_java_properties.html" title="Certain parameters apply to all DITA-OT transformations. Other parameters are common to the HTML-based transformations. Finally, some parameters apply only to the specific transformation types.">Command-line tool parameters</a></div>
|
|---|
| 249 | </div>
|
|---|
| 250 | </div>
|
|---|
| 251 |
|
|---|
| 252 | </body>
|
|---|
| 253 | </html>
|
|---|
