ant-parameters-details.dita 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
  3. <!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
  4. <reference id="ant-parameters-details">
  5. <title>Ant parameter details</title>
  6. <reference id="base">
  7. <title>All transformations</title>
  8. <titlealts>
  9. <navtitle>All transformations</navtitle>
  10. </titlealts>
  11. <shortdesc conaction="pushreplace" conref="parameters-base.dita#base/shortdesc">Certain parameters apply to all
  12. transformations that DITA Open Toolkit supports.</shortdesc>
  13. <prolog>
  14. <metadata>
  15. <keywords>
  16. <!-- This is a resource-only topic. Place index entries in the content below. -->
  17. </keywords>
  18. </metadata>
  19. </prolog>
  20. <refbody>
  21. <section>
  22. <parml>
  23. <plentry id="args.draft">
  24. <pt>
  25. <parmname>args.draft</parmname>
  26. </pt>
  27. <pd conaction="mark" conref="parameters-base.dita#base/args.draft.desc"/>
  28. <pd conaction="pushafter" audience="xslt-customizer">Corresponds to the XSLT parameter
  29. <parmname>DRAFT</parmname> in most XSLT modules.<note type="tip">For PDF output, setting the
  30. <parmname>args.draft</parmname> parameter to <option>yes</option> causes the contents of the
  31. <xmlelement>titlealts</xmlelement> element to be rendered below the title.
  32. <indexterm><xmlelement>titlealts</xmlelement></indexterm>
  33. <indexterm start="ant-xslt-params">XSLT</indexterm>
  34. <indexterm>draft<indexterm>args.draft</indexterm><indexterm>PDF</indexterm></indexterm>
  35. <indexterm>PDF<indexterm>draft</indexterm></indexterm>
  36. <indexterm>parameters<indexterm>args.draft</indexterm></indexterm>
  37. </note>
  38. </pd>
  39. </plentry>
  40. <plentry id="args.figurelink.style">
  41. <pt>
  42. <parmname>args.figurelink.style</parmname>
  43. </pt>
  44. <pd conaction="mark" conref="parameters-base.dita#base/args.figurelink.style.desc"/>
  45. <pd conaction="pushafter">Specifying <option>NUMBER</option> results in "Figure 5"; specifying
  46. <option>TITLE</option> results in the title of the figure. <ph audience="xslt-customizer">Corresponds to
  47. the XSLT parameter <parmname>FIGURELINK</parmname>.</ph><note rev="2.0">Support for PDF was added in
  48. DITA-OT 2.0. By default PDF uses the value <option>NUMTITLE</option>, which is not supported for other
  49. transformation types; this results in "Figure 5. Title".</note></pd>
  50. </plentry>
  51. <plentry id="args.filter">
  52. <pt>
  53. <parmname>args.filter</parmname>
  54. </pt>
  55. <pd conaction="pushreplace" conref="parameters-base.dita#base/args.filter.desc">
  56. <p>Specifies filter file(s) used to include, exclude, or flag content. Relative paths are resolved against
  57. the DITA-OT base directory (for backwards compatibility) and internally converted to absolute paths.</p>
  58. <note>
  59. <p>To specify multiple filter files, use the system path separator character to delimit individual file
  60. paths (semicolon ‘<codeph>;</codeph>’ on Windows, and colon ‘<codeph>:</codeph>’ on macOS and Linux)
  61. and wrap the value in quotes:</p>
  62. <p><codeph>--args.filter="filter1.ditaval;filter2.ditaval;filter3.ditaval"</codeph></p>
  63. <p>DITAVAL files are evaluated in the order specified, so conditions specified in the first file take
  64. precedence over matching conditions specified in later files, just as conditions at the start of a
  65. DITAVAL document take precedence over matching conditions later in the same document.</p>
  66. <indexterm>DITAVAL<indexterm><parmname>args.filter</parmname></indexterm></indexterm>
  67. <indexterm>DITAVAL<index-see-also>filters</index-see-also></indexterm> <!-- https://github.com/dita-ot/dita-ot/issues/3319 -->
  68. <indexterm>DITAVAL<index-see-also>profiling</index-see-also></indexterm>
  69. <indexterm>OSX<index-see>macOS</index-see></indexterm>
  70. <indexterm>macOS<indexterm>delimiter</indexterm></indexterm>
  71. <indexterm>Linux<indexterm>delimiter</indexterm></indexterm>
  72. <indexterm>Windows<indexterm>delimiter</indexterm></indexterm>
  73. </note>
  74. </pd>
  75. </plentry>
  76. <plentry id="args.gen.task.lbl">
  77. <pt>
  78. <parmname>args.gen.task.lbl</parmname>
  79. </pt>
  80. <pd conaction="mark" conref="parameters-base.dita#base/args.gen.task.lbl.desc"/>
  81. <pd conaction="pushafter">
  82. <ph audience="xslt-customizer">Corresponds to the XSLT parameter
  83. <parmname>GENERATE-TASK-LABELS</parmname>.</ph></pd>
  84. </plentry>
  85. <plentry id="args.grammar.cache">
  86. <pt>
  87. <parmname>args.grammar.cache</parmname>
  88. </pt>
  89. <pd conaction="mark" conref="parameters-base.dita#base/args.grammar.cache.desc"/>
  90. <pd conaction="pushafter">
  91. <note>This option dramatically speeds up processing time. However, there is a known problem with using
  92. this feature for documents that use XML entities. If your build fails with parser errors about entity
  93. resolution, set this parameter to <option>no</option>.
  94. <indexterm>processing time</indexterm></note>
  95. </pd>
  96. </plentry>
  97. <plentry id="args.input">
  98. <pt>
  99. <parmname>args.input</parmname>
  100. </pt>
  101. <pd conaction="mark" conref="parameters-base.dita#base/args.input.desc"/>
  102. <pd conaction="pushafter">Typically this is a DITA map, however it also can be a DITA topic if you want to
  103. transform a single DITA file. The path can be absolute, relative to <parmname>args.input.dir</parmname>,
  104. or relative to the directory where your project’s Ant build script resides if
  105. <parmname>args.input.dir</parmname> is not defined. </pd>
  106. </plentry>
  107. <plentry id="args.input.dir">
  108. <pt>
  109. <parmname>args.input.dir</parmname>
  110. </pt>
  111. <pd conaction="mark" conref="parameters-base.dita#base/args.input.dir.desc"/>
  112. <pd conaction="pushafter">The default value is the parent directory of the file specified by
  113. <parmname>args.input</parmname>.</pd>
  114. </plentry>
  115. <plentry id="args.logdir">
  116. <pt><parmname>args.logdir</parmname></pt>
  117. <pd conaction="mark" conref="parameters-base.dita#base/args.logdir.desc"/>
  118. <pd conaction="pushafter">
  119. <note type="attention">The <parmname>args.logdir</parmname> parameter is obsolete and will be removed in
  120. an upcoming version of DITA-OT. To write the log to a file, use <cmdname>dita</cmdname>
  121. <parmname>--logfile</parmname>=<varname>file</varname> or <cmdname>ant</cmdname>
  122. <parmname>-l</parmname>
  123. <varname>file</varname> to set the path to the log. Unless an absolute path is specified, the value will
  124. be interpreted relative to the current directory.</note></pd>
  125. </plentry>
  126. <plentry id="args.rellinks">
  127. <pt><parmname>args.rellinks</parmname></pt>
  128. <pd conaction="mark" conref="parameters-base.dita#base/args.rellinks.desc"/>
  129. <pd conaction="pushafter">
  130. <p>For PDF output, the default value is <option>nofamily</option>. For all other formats, the default
  131. value is <option>all</option>.
  132. <indexterm>args.rellinks</indexterm>
  133. <indexterm>PDF<indexterm>related links</indexterm><indexterm>args.rellinks</indexterm></indexterm>
  134. <indexterm>HTML5<indexterm>related links</indexterm><indexterm>args.rellinks</indexterm></indexterm>
  135. </p></pd>
  136. </plentry>
  137. <plentry id="args.tablelink.style">
  138. <pt>
  139. <parmname>args.tablelink.style</parmname>
  140. </pt>
  141. <pd conaction="mark" conref="parameters-base.dita#base/args.tablelink.style.desc"/>
  142. <pd conaction="pushafter">Specifying <option>NUMBER</option> results in "Table 5"; specifying
  143. <option>TITLE</option> results in the title of the table. <ph audience="xslt-customizer">Corresponds to
  144. the XSLT parameter <parmname>TABLELINK</parmname>.</ph><note rev="2.0">Support for PDF was added in
  145. DITA-OT 2.0. By default PDF uses the value <option>NUMTITLE</option>, which is not supported for other
  146. transformation types; this results in "Table 5. Title".
  147. <indexterm>tables<indexterm>args.tablelink.style</indexterm></indexterm>
  148. </note></pd>
  149. </plentry>
  150. <plentry id="cleantemp">
  151. <pt>
  152. <parmname>clean.temp</parmname>
  153. </pt>
  154. <pd conaction="mark" conref="parameters-base.dita#base/clean.temp.desc"/>
  155. <pd conaction="pushafter"/>
  156. </plentry>
  157. <plentry id="default.language">
  158. <pt>
  159. <parmname>default.language</parmname>
  160. </pt>
  161. <pd conaction="pushreplace" conref="parameters-base.dita#base/default.language.desc">Specifies the language
  162. that is used if the input file does not have the <xmlatt>xml:lang</xmlatt> attribute set on the root
  163. element. By default, this is set to <option>en</option>. The allowed values are those that are defined in
  164. IETF BCP 47, <xref href="https://tools.ietf.org/html/bcp47" format="html" scope="external">Tags for
  165. Identifying Languages</xref>.
  166. <indexterm><xmlatt>xml:lang</xmlatt></indexterm>
  167. <indexterm>IETF BCP 47</indexterm>
  168. <indexterm>languages<indexterm>default</indexterm></indexterm>
  169. </pd>
  170. </plentry>
  171. <plentry id="dita.temp.dir">
  172. <pt>
  173. <parmname>dita.temp.dir</parmname>
  174. </pt>
  175. <pd conaction="mark" conref="parameters-base.dita#base/dita.temp.dir.desc"/>
  176. <pd conaction="pushafter">The temporary directory is where DITA-OT writes temporary files that are generated
  177. during the transformation process.</pd>
  178. </plentry>
  179. <plentry id="dita.input.valfile" importance="deprecated">
  180. <pt>
  181. <parmname>dita.input.valfile</parmname>
  182. </pt>
  183. <pd conaction="mark" conref="parameters-base.dita#base/dita.input.valfile.desc"/>
  184. <pd conaction="pushafter">
  185. <note type="notice">Deprecated in favor of the <parmname>args.filter</parmname> parameter.</note>
  186. </pd>
  187. </plentry>
  188. <plentry id="filter-stage">
  189. <pt>
  190. <parmname>filter-stage</parmname>
  191. </pt>
  192. <pd conaction="mark" conref="parameters-base.dita#base/filter-stage.desc"/>
  193. <pd conaction="pushafter">
  194. <note>Changing the filtering stage may produce different results for the same initial data set and
  195. filtering conditions.</note>
  196. </pd>
  197. </plentry>
  198. <plentry id="force-unique">
  199. <pt>
  200. <parmname>force-unique</parmname>
  201. </pt>
  202. <pd conaction="mark" conref="parameters-base.dita#base/force-unique.desc"/>
  203. <pd conaction="pushafter">
  204. <p>Setting this to <option>true</option> ensures that unique output files are created for each instance of
  205. a resource when a map contains multiple references to a single topic.</p></pd>
  206. </plentry>
  207. <plentry id="generate-debug-attributes">
  208. <pt>
  209. <parmname>generate-debug-attributes</parmname>
  210. </pt>
  211. <pd conaction="mark" conref="parameters-base.dita#base/generate-debug-attributes.desc"/>
  212. <pd conaction="pushafter">
  213. <note>Disabling debugging attributes reduces the size of temporary files and thus reduces memory
  214. consumption. However, the log messages no longer have the source information available and thus the
  215. ability to debug problems might deteriorate.
  216. <indexterm>debugging<indexterm>generate-debug-attributes</indexterm></indexterm>
  217. <indexterm>memory</indexterm>
  218. </note>
  219. </pd>
  220. </plentry>
  221. <plentry id="generate.copy.outer">
  222. <pt>
  223. <parmname>generate.copy.outer</parmname>
  224. <ph><indexterm><parmname>generate.copy.outer</parmname></indexterm></ph>
  225. </pt>
  226. <pd conaction="mark" conref="parameters-base.dita#base/generate.copy.outer.desc"/>
  227. <pd conaction="pushafter">
  228. <p>See <xref keyref="generate-copy-outer"/> for more information.</p>
  229. </pd>
  230. </plentry>
  231. <plentry id="onlytopic.in.map">
  232. <pt>
  233. <parmname>onlytopic.in.map</parmname>
  234. </pt>
  235. <pd conaction="mark" conref="parameters-base.dita#base/onlytopic.in.map.desc"/>
  236. <pd conaction="pushafter">If set to <option>true</option>, only files that are referenced directly from the
  237. map will generate output.</pd>
  238. </plentry>
  239. <plentry id="outer.control">
  240. <pt>
  241. <parmname>outer.control</parmname>
  242. </pt>
  243. <pd conaction="mark" conref="parameters-base.dita#base/outer.control.desc"/>
  244. <pd conaction="pushafter">
  245. <note type="warning" platform="windows">Microsoft HTML Help Compiler cannot produce HTML Help for
  246. documentation projects that use outer content. The content files must reside in or below the directory
  247. containing the master DITA map file, and the map file cannot specify ".." at the start of the
  248. <xmlatt>href</xmlatt> attributes for <xmlelement>topicref</xmlelement> elements.
  249. <indexterm><xmlelement>topicref</xmlelement></indexterm>
  250. <indexterm><xmlatt>href</xmlatt></indexterm>
  251. </note>
  252. </pd>
  253. </plentry>
  254. <plentry id="output.dir">
  255. <pt>
  256. <parmname>output.dir</parmname>
  257. </pt>
  258. <pd conaction="mark" conref="parameters-base.dita#base/output.dir.desc"/>
  259. <pd conaction="pushafter">By default, the output is written to
  260. <filepath><varname>DITA-dir</varname>/out</filepath>.</pd>
  261. </plentry>
  262. <plentry id="root-chunk-override">
  263. <pt>
  264. <parmname>root-chunk-override</parmname>
  265. </pt>
  266. <pd conaction="mark" conref="parameters-base.dita#base/root-chunk-override.desc"/>
  267. <pd conaction="pushafter">Acceptable values include any value normally allowed on the <xmlatt>chunk</xmlatt>
  268. attribute. If the map does not have a <xmlatt>chunk</xmlatt> attribute, this value will be used; if the
  269. map already has a <xmlatt>chunk</xmlatt> attribute specified, this value will be used instead.
  270. <indexterm><xmlatt>chunk</xmlatt><indexterm><parmname>root-chunk-override</parmname></indexterm></indexterm>
  271. </pd>
  272. </plentry>
  273. <plentry id="transtype">
  274. <pt>
  275. <parmname>transtype</parmname>
  276. </pt>
  277. <pd conaction="mark" conref="parameters-base.dita#base/transtype.desc"/>
  278. <pd conaction="pushafter">
  279. <p conref="../resources/conref-task.dita#ID/transtypes"/>
  280. </pd>
  281. </plentry>
  282. </parml>
  283. </section>
  284. </refbody>
  285. </reference>
  286. <reference id="base-html">
  287. <title>HTML-based output parameters</title>
  288. <titlealts>
  289. <navtitle>HTML-based output</navtitle>
  290. </titlealts>
  291. <shortdesc conaction="pushreplace" conref="parameters-base-html.dita#base-html/shortdesc">Certain parameters apply
  292. to all HTML-based transformation types: HTML5, XHTML, HTML&#xA0;Help, Eclipse help, and TocJS.
  293. <ph>
  294. <indexterm>HTML5<indexterm>parameters</indexterm></indexterm>
  295. </ph>
  296. </shortdesc>
  297. <refbody>
  298. <section>
  299. <parml>
  300. <plentry id="args.copycss">
  301. <pt><parmname>args.copycss</parmname></pt>
  302. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.copycss.desc"/>
  303. <pd conaction="pushafter">
  304. <div id="args.copycss.details">If an external process will copy your custom .css file to the output
  305. directory, leave this parameter unset (or set it to <option>no</option>). If DITA-OT should copy the
  306. file when generating output, set it to <option>yes</option>.</div></pd>
  307. </plentry>
  308. <plentry id="args.css">
  309. <pt><parmname>args.css</parmname></pt>
  310. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.css.desc"/>
  311. <pd conaction="pushafter">
  312. <div id="args.css.details">The value of this parameter should be only the file name (or an absolute path
  313. to the file). A relative path can be specified with <parmname>args.cssroot</parmname>.</div></pd>
  314. </plentry>
  315. <plentry id="args.csspath">
  316. <pt>
  317. <parmname>args.csspath</parmname>
  318. </pt>
  319. <pd conaction="pushreplace" conref="parameters-base-html.dita#base-html/args.csspath.desc">
  320. <div id="args.csspath.desc">Specifies the <b>destination</b> directory to which .css files are copied
  321. (relative to the output directory).</div></pd>
  322. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.csspath.desc"/>
  323. <pd conaction="pushafter">
  324. <div id="args.csspath.details">
  325. <p audience="xslt-customizer">Corresponds to the XSLT parameter <parmname>CSSPATH</parmname>.</p>
  326. <p>DITA-OT will copy the file <b>to</b> this location.</p>
  327. <note type="tip">If <parmname>args.csspath</parmname> is not set, the custom CSS file (and the default
  328. CSS files) will be copied to the root level of the output folder. To copy CSS files to an output
  329. subfolder named <filepath>css</filepath>, set <parmname>args.csspath</parmname> to
  330. <option>css</option>.
  331. <indexterm>CSS<indexterm>copy to specific location</indexterm></indexterm>
  332. </note></div>
  333. </pd>
  334. </plentry>
  335. <plentry id="args.cssroot">
  336. <pt>
  337. <parmname>args.cssroot</parmname>
  338. </pt>
  339. <pd conaction="pushreplace" conref="parameters-base-html.dita#base-html/args.cssroot.desc">
  340. <div id="args.cssroot.desc">Specifies the <b>source</b> directory that contains the custom .css
  341. file.</div></pd>
  342. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.cssroot.desc"/>
  343. <pd conaction="pushafter">
  344. <div id="args.cssroot.details">
  345. <p>DITA-OT will copy the file <b>from</b> this location.</p>
  346. <note type="tip">The value you enter here will be interpreted relative to the location of the input map
  347. file. If your map is stored at the root level of your project folder and the CSS file is stored in a
  348. subfolder named <filepath>resources</filepath>, set <parmname>args.cssroot</parmname> to
  349. <option>resources</option>.</note>
  350. </div></pd>
  351. </plentry>
  352. <plentry id="args.dita.locale">
  353. <pt>
  354. <parmname>args.dita.locale</parmname>
  355. </pt>
  356. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.dita.locale.desc"/>
  357. <pd conaction="pushafter">
  358. <note>This parameter is not available for the XHTML transformation.</note>
  359. </pd>
  360. </plentry>
  361. <plentry id="args.ftr">
  362. <pt>
  363. <parmname>args.ftr</parmname>
  364. </pt>
  365. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.ftr.desc"/>
  366. <pd conaction="pushafter">
  367. <div id="args.ftr.details">
  368. <ph audience="xslt-customizer">Corresponds to the XSLT parameter <parmname>FTR</parmname>.</ph>
  369. <note>The footer file should be specified using an absolute path and must contain valid XML. A common
  370. practice is to place all content into a <xmlelement>div</xmlelement> element. In HTML5 output, the
  371. footer file contents will be wrapped in an HTML5 <xmlelement>footer</xmlelement> element with the
  372. <xmlatt>role</xmlatt> attribute set to <option>contentinfo</option>.
  373. <indexterm><xmlelement>div</xmlelement><indexterm>HTML footer</indexterm><indexterm><parmname>args.ftr</parmname></indexterm></indexterm>
  374. <indexterm><xmlatt>role</xmlatt></indexterm>
  375. <indexterm>HTML5<indexterm>footers</indexterm></indexterm>
  376. </note>
  377. </div></pd>
  378. </plentry>
  379. <plentry id="args.gen.default.meta">
  380. <pt>
  381. <parmname>args.gen.default.meta</parmname>
  382. </pt>
  383. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.gen.default.meta.desc"/>
  384. <pd conaction="pushafter" audience="xslt-customizer">
  385. <div id="args.gen.default.meta.details">Corresponds to the XSLT parameter <parmname>genDefMeta</parmname>.
  386. </div>
  387. </pd>
  388. </plentry>
  389. <plentry id="args.hdf">
  390. <pt><parmname>args.hdf</parmname></pt>
  391. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.hdf.desc"/>
  392. <pd conaction="pushafter">
  393. <div id="args.hdf.details">
  394. <p>The contents of the header file will be inserted in the <xmlelement>head</xmlelement> element of the
  395. generated HTML files.</p>
  396. <note type="tip">The header file should be specified using an absolute path and must contain valid XML.
  397. If you need to insert more than one element into the HTML page head, wrap the content in a
  398. <xmlelement>div</xmlelement> element. The division wrapper in the header file will be discarded when
  399. generating HTML files, and the contents will be inserted into each page head.
  400. <indexterm><xmlelement>div</xmlelement><indexterm>HTML <xmlelement>head</xmlelement></indexterm><indexterm><parmname>args.hdf</parmname></indexterm></indexterm>
  401. </note></div></pd>
  402. </plentry>
  403. <plentry id="args.hdr">
  404. <pt>
  405. <parmname>args.hdr</parmname>
  406. </pt>
  407. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.hdr.desc"/>
  408. <pd conaction="pushafter">
  409. <div id="args.hdr.details">
  410. <ph audience="xslt-customizer">Corresponds to the XSLT parameter <parmname>HDR</parmname>.</ph>
  411. <note>The header file should be specified using an absolute path and must contain valid XML. A common
  412. practice is to place all content into a <xmlelement>div</xmlelement> element. In HTML5 output, the
  413. contents of the header file will be wrapped in an HTML5 <xmlelement>header</xmlelement> element with
  414. the <xmlatt>role</xmlatt> attribute set to <option>banner</option>.
  415. <indexterm><xmlelement>div</xmlelement><indexterm>HTML header</indexterm><indexterm><parmname>args.hdr</parmname></indexterm></indexterm>
  416. <indexterm><xmlelement>header</xmlelement></indexterm>
  417. <indexterm><xmlatt>role</xmlatt></indexterm>
  418. <indexterm>HTML5<indexterm>headers</indexterm></indexterm>
  419. </note>
  420. </div></pd>
  421. </plentry>
  422. <plentry id="args.hide.parent.link" importance="deprecated">
  423. <pt>
  424. <parmname>args.hide.parent.link</parmname>
  425. <ph><indexterm>deprecated features<indexterm><parmname>args.hide.parent.link</parmname></indexterm></indexterm></ph>
  426. </pt>
  427. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.hide.parent.link.desc"/>
  428. <pd conaction="pushafter">
  429. <div id="args.hide.parent.link.details">
  430. <ph audience="xslt-customizer">Corresponds to the XSLT parameter <parmname>NOPARENTLINK</parmname>.</ph>
  431. <note type="notice">This parameter is deprecated in favor of the <parmname>args.rellinks</parmname>
  432. parameter.</note>
  433. </div></pd>
  434. </plentry>
  435. <plentry id="args.outext">
  436. <pt>
  437. <parmname>args.outext</parmname>
  438. </pt>
  439. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.outext.desc"/>
  440. <pd conaction="pushafter">
  441. <div id="args.outext.details">
  442. <ph audience="xslt-customizer">Corresponds to the XSLT parameter <parmname>OUTEXT</parmname>.</ph>
  443. </div></pd>
  444. </plentry>
  445. <plentry id="args.xhtml.classattr">
  446. <pt>
  447. <parmname>args.xhtml.classattr</parmname>
  448. </pt>
  449. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.xhtml.classattr.desc"/>
  450. <pd conaction="pushafter">For example, the <xmlelement>prereq</xmlelement> element (which is specialized
  451. from <xmlelement>section</xmlelement>) would generate <codeph>class="section prereq"</codeph>. <ph
  452. audience="xslt-customizer">Corresponds to the XSLT parameter
  453. <parmname>PRESERVE-DITA-CLASS</parmname>.</ph><note>Beginning with DITA-OT release 1.5.2, the default
  454. value is <option>yes</option>. For release 1.5 and 1.5.1, the default value was <option>no</option>.
  455. </note>
  456. <indexterm><xmlelement>prereq</xmlelement></indexterm>
  457. <indexterm><xmlelement>section</xmlelement></indexterm>
  458. </pd>
  459. </plentry>
  460. <plentry id="args.xsl">
  461. <pt>
  462. <parmname>args.xsl</parmname>
  463. </pt>
  464. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.xsl.desc"/>
  465. <pd conaction="pushafter">
  466. <div id="args.xsl.details">The parameter must specify a fully qualified file name.</div></pd>
  467. </plentry>
  468. </parml>
  469. </section>
  470. </refbody>
  471. </reference>
  472. <reference id="eclipsehelp">
  473. <title>Eclipse help</title>
  474. <titlealts>
  475. <navtitle>Eclipse help</navtitle>
  476. </titlealts>
  477. <shortdesc conaction="pushreplace" conref="parameters-eclipsehelp.dita#eclipsehelp/shortdesc">Certain parameters are
  478. specific to the Eclipse help transformation.</shortdesc>
  479. <refbody>
  480. <section>
  481. <parml>
  482. <plentry id="args.eclipsehelp.country">
  483. <pt>
  484. <parmname>args.eclipsehelp.country</parmname>
  485. </pt>
  486. <pd conaction="mark" conref="parameters-eclipsehelp.dita#eclipsehelp/args.eclipsehelp.country.desc"/>
  487. <pd conaction="pushafter">For example, <option>us</option>, <option>ca</option>, and <option>gb</option>
  488. would clarify a value of <option>en</option> set for the <parmname>args.eclipsehelp.language</parmname>
  489. parameter. The content will be moved into the appropriate directory structure for an Eclipse
  490. fragment.<draft-comment author="Kristen James Eberlein" time="11 August 2012">What does "The content
  491. will be moved into the appropriate directory structure for an Eclipse fragment"
  492. mean?</draft-comment></pd>
  493. </plentry>
  494. <plentry id="args.eclipsehelp.language">
  495. <pt>
  496. <parmname>args.eclipsehelp.language</parmname>
  497. </pt>
  498. <pd conaction="mark" conref="parameters-eclipsehelp.dita#eclipsehelp/args.eclipsehelp.language.desc"/>
  499. <pd conaction="pushafter">This parameter is a prerequisite for the
  500. <parmname>args.eclipsehelp.country</parmname> parameter. The content will be moved into the appropriate
  501. directory structure for an Eclipse fragment.</pd>
  502. </plentry>
  503. <plentry id="args.eclipse.provider">
  504. <pt>
  505. <parmname>args.eclipse.provider</parmname>
  506. </pt>
  507. <pd conaction="mark" conref="parameters-eclipsehelp.dita#eclipsehelp/args.eclipse.provider.desc"/>
  508. <pd conaction="pushafter">The default value is <option>DITA</option>. <note type="tip">The toolkit ignores
  509. the value of this parameter when it processes an Eclipse map.</note>
  510. </pd>
  511. </plentry>
  512. <plentry id="args.eclipse.version">
  513. <pt>
  514. <parmname>args.eclipse.version</parmname>
  515. </pt>
  516. <pd conaction="mark" conref="parameters-eclipsehelp.dita#eclipsehelp/args.eclipse.version.desc"/>
  517. <pd conaction="pushafter">The default value is <option>0.0.0</option>.<note type="tip">The toolkit ignores
  518. the value of this parameter when it processes an Eclipse map.</note></pd>
  519. </plentry>
  520. <plentry id="args.eclipse.symbolic.name">
  521. <pt>
  522. <parmname>args.eclipse.symbolic.name</parmname>
  523. </pt>
  524. <pd conaction="mark" conref="parameters-eclipsehelp.dita#eclipsehelp/args.eclipse.symbolic.name.desc"/>
  525. <pd conaction="pushafter">
  526. <!-- Specifies the symbolic name (aka plugin ID) in the output for an Eclipse Help project. -->The
  527. <xmlatt>id</xmlatt> value from the DITA map or the Eclipse map collection (Eclipse help specialization)
  528. is the symbolic name for the plugin in Eclipse. The default value is
  529. <option>org.sample.help.doc</option>.<note type="tip">The toolkit ignores the value of this parameter
  530. when it processes an Eclipse map.
  531. <indexterm><xmlatt>id</xmlatt><indexterm><parmname>args.eclipse.symbolic.name</parmname></indexterm></indexterm>
  532. </note><draft-comment author="Kristen James Eberlein"
  533. time="11 August 2012">I'm not clear what this means. Is the default value for the
  534. <parmname>args.eclipse.symbolic.name</parmname> parameter the value of the <xmlatt>id</xmlatt>
  535. attribute on the <xmlelement>map</xmlelement> or <xmlelement>plugin</xmlelement> element, if provided,
  536. and the <option>org.sample.help.doc</option> if there is not a value for the <xmlatt>id</xmlatt>
  537. attribute or the <parmname>args.eclipse.symbolic.name</parmname> parameter?</draft-comment></pd>
  538. </plentry>
  539. </parml>
  540. </section>
  541. </refbody>
  542. </reference>
  543. <reference id="htmlhelp">
  544. <title>HTML Help</title>
  545. <titlealts>
  546. <navtitle>HTML Help</navtitle>
  547. </titlealts>
  548. <shortdesc conaction="pushreplace" conref="parameters-htmlhelp.dita#htmlhelp/shortdesc">Certain parameters are
  549. specific to the Microsoft Compiled HTML Help (.chm) transformation.</shortdesc>
  550. <refbody/>
  551. </reference>
  552. <reference id="pdf">
  553. <title>PDF</title>
  554. <titlealts>
  555. <navtitle>PDF</navtitle>
  556. </titlealts>
  557. <shortdesc conaction="pushreplace" conref="parameters-pdf.dita#pdf/shortdesc">Certain parameters are specific to the
  558. PDF transformation.</shortdesc>
  559. <refbody>
  560. <section>
  561. <parml>
  562. <plentry id="args.xsl.pdf">
  563. <pt>
  564. <parmname>args.xsl.pdf</parmname>
  565. </pt>
  566. <pd conaction="mark" conref="parameters-pdf.dita#pdf/args.xsl.pdf.desc"/>
  567. <pd conaction="pushafter">You must specify the fully qualified file name.</pd>
  568. </plentry>
  569. <plentry id="org.dita.pdf2.i18n.enabled">
  570. <pt><parmname>org.dita.pdf2.i18n.enabled</parmname></pt>
  571. <pd conaction="pushreplace" conref="parameters-pdf.dita#pdf/org.dita.pdf2.i18n.enabled.desc">
  572. <p>Enables internationalization (I18N) font processing to provide per-character font selection for FO
  573. renderers that do not support the <codeph>font-selection-strategy</codeph> property (such as Apache
  574. FOP).
  575. <indexterm>Apache FOP<indexterm>I18N</indexterm></indexterm>
  576. <indexterm>FOP<index-see>Apache FOP</index-see></indexterm>
  577. <indexterm>I18N<indexterm><parmname>org.dita.pdf2.i18n.enabled</parmname></indexterm></indexterm>
  578. <indexterm>fonts<indexterm>PDF</indexterm></indexterm>
  579. </p>
  580. <p>When this feature is enabled, DITA-OT uses a font mapping process that takes the content language into
  581. consideration. The mapping process uses configuration files for each language to define characters that
  582. should be rendered with certain logical fonts, and font mappings that associate each logical font to
  583. physical font files.</p>
  584. <p>The following values are allowed:</p>
  585. <ul>
  586. <li><option>true</option> (default) — Enables font mapping</li>
  587. <li><option>false</option> — Disables font mapping</li>
  588. </ul>
  589. <note type="tip">If you don’t use custom character mappings, turning off font mapping makes it easier to
  590. define custom fonts simply by changing font names in the XSL attributes files of your custom PDF
  591. plug-in. For details, see <xref keyref="jelovirt-on-pdf2-i18n"/>.</note>
  592. </pd>
  593. </plentry>
  594. <plentry id="outputFile.base">
  595. <pt>
  596. <parmname>outputFile.base</parmname>
  597. </pt>
  598. <pd conaction="mark" conref="parameters-pdf.dita#pdf/outputFile.base.desc"/>
  599. <pd conaction="pushafter">By default, the PDF file uses the base filename of the input
  600. <filepath>.ditamap</filepath> file.
  601. <indexterm>DITA maps<indexterm>PDF file name</indexterm></indexterm></pd>
  602. </plentry>
  603. <plentry id="pdf.formatter">
  604. <pt>
  605. <parmname>pdf.formatter</parmname>
  606. </pt>
  607. <pd>The client package comes with Apache FOP; other XSL processors must be separately installed.</pd>
  608. <!-- Added to inject index entries into the right location. -->
  609. <pd conaction="mark" conref="parameters-pdf.dita#pdf/pdf.formatter.desc"/>
  610. <pd conaction="pushafter">
  611. <indexterm>Apache FOP<indexterm><parmname>pdf.formatter</parmname></indexterm></indexterm>
  612. <indexterm>formatter</indexterm>
  613. <indexterm>PDF<indexterm>formatter</indexterm></indexterm>
  614. </pd>
  615. </plentry>
  616. <plentry id="publish.required.cleanup" importance="deprecated">
  617. <pt>
  618. <parmname>publish.required.cleanup</parmname>
  619. <ph><indexterm>deprecated features<indexterm><parmname>publish.required.cleanup</parmname></indexterm></indexterm></ph>
  620. </pt>
  621. <pd conaction="mark" conref="parameters-pdf.dita#pdf/publish.required.cleanup.desc"/>
  622. <pd conaction="pushafter">The default value is the value of the <parmname>args.draft</parmname> parameter.
  623. <ph audience="xslt-customizer">Corresponds to the XSLT parameter
  624. <parmname>publishRequiredCleanup</parmname>.</ph><note type="notice">This parameter is deprecated in
  625. favor of the <parmname>args.draft</parmname> parameter.
  626. <indexterm end="ant-xslt-params"/></note></pd>
  627. </plentry>
  628. </parml>
  629. </section>
  630. </refbody>
  631. </reference>
  632. <reference id="xhtml">
  633. <title>XHTML</title>
  634. <shortdesc conaction="pushreplace" conref="parameters-xhtml.dita#xhtml/shortdesc">Certain parameters are specific to
  635. the XHTML transformation.</shortdesc>
  636. <refbody>
  637. <section>
  638. <parml>
  639. <plentry id="args.xhtml.contenttarget">
  640. <pt>
  641. <parmname>args.xhtml.contenttarget</parmname>
  642. </pt>
  643. <pd conaction="mark" conref="parameters-xhtml.dita#xhtml/args.xhtml.contenttarget.desc"/>
  644. <pd conaction="pushafter">The default value is <option>contentwin</option>. Change this value to use a
  645. different target name for the table of contents.
  646. <indexterm>table of contents<indexterm>XHTML</indexterm></indexterm>
  647. </pd>
  648. </plentry>
  649. </parml>
  650. </section>
  651. </refbody>
  652. </reference>
  653. <reference id="html5">
  654. <title>HTML5 parameters</title>
  655. <titlealts>
  656. <navtitle>HTML5</navtitle>
  657. </titlealts>
  658. <shortdesc conaction="pushreplace" conref="parameters-html5.dita#html5/shortdesc">The HTML5 transformation shares
  659. common parameters with other HTML-based transformations and provides additional parameters that are specific to
  660. HTML5 output.
  661. <ph><indexterm>HTML5</indexterm></ph>
  662. </shortdesc>
  663. <refbody>
  664. <!-- args.html5.contenttarget is listed in generated topic, but does not appear in default HTML5 output files. -->
  665. <section>
  666. <!-- Re-use extended base-html parameter descriptions for #132 -->
  667. <parml>
  668. <plentry id="args.copycss">
  669. <pt><parmname>args.copycss</parmname></pt>
  670. <pd conaction="mark" conref="parameters-html5.dita#html5/args.copycss.desc"/>
  671. <pd conaction="pushafter">
  672. <div conref="./ant-parameters-details.dita#base-html/args.copycss.details"/></pd>
  673. </plentry>
  674. <plentry id="args.css">
  675. <pt><parmname>args.css</parmname></pt>
  676. <pd conaction="mark" conref="parameters-html5.dita#html5/args.css.desc"/>
  677. <pd conaction="pushafter">
  678. <div conref="./ant-parameters-details.dita#base-html/args.css.details"/></pd>
  679. </plentry>
  680. <!-- ↓ excerpt-csspath ↓ -->
  681. <plentry id="args.csspath">
  682. <pt>
  683. <parmname>args.csspath</parmname>
  684. </pt>
  685. <pd conaction="pushreplace"
  686. conref="parameters-html5.dita#html5/args.csspath.desc">
  687. <div conref="./ant-parameters-details.dita#base-html/args.csspath.desc"/>
  688. </pd>
  689. <pd conaction="mark" conref="parameters-html5.dita#html5/args.csspath.desc"/>
  690. <pd conaction="pushafter">
  691. <div conref="./ant-parameters-details.dita#base-html/args.csspath.details"/>
  692. </pd>
  693. </plentry>
  694. <!-- ↑ end-excerpt ↑ -->
  695. <plentry id="args.cssroot">
  696. <pt>
  697. <parmname>args.cssroot</parmname>
  698. </pt>
  699. <pd conaction="pushreplace" conref="parameters-html5.dita#html5/args.cssroot.desc">
  700. <div conref="./ant-parameters-details.dita#base-html/args.cssroot.desc"/></pd>
  701. <pd conaction="mark" conref="parameters-html5.dita#html5/args.cssroot.desc"/>
  702. <pd conaction="pushafter">
  703. <div conref="./ant-parameters-details.dita#base-html/args.cssroot.details"/></pd>
  704. </plentry>
  705. <plentry id="args.ftr">
  706. <pt>
  707. <parmname>args.ftr</parmname>
  708. </pt>
  709. <pd conaction="mark" conref="parameters-html5.dita#html5/args.ftr.desc"/>
  710. <pd conaction="pushafter">
  711. <div conref="./ant-parameters-details.dita#base-html/args.ftr.details"/></pd>
  712. </plentry>
  713. <plentry id="args.gen.default.meta">
  714. <pt>
  715. <parmname>args.gen.default.meta</parmname>
  716. </pt>
  717. <pd conaction="mark" conref="parameters-html5.dita#html5/args.gen.default.meta.desc"/>
  718. <pd conaction="pushafter" audience="xslt-customizer">
  719. <div conref="./ant-parameters-details.dita#base-html/args.gen.default.meta.details"/>
  720. </pd>
  721. </plentry>
  722. <plentry id="args.hdf">
  723. <pt><parmname>args.hdf</parmname></pt>
  724. <pd conaction="mark" conref="parameters-html5.dita#html5/args.hdf.desc"/>
  725. <pd conaction="pushafter">
  726. <div conref="./ant-parameters-details.dita#base-html/args.hdf.details"/></pd>
  727. </plentry>
  728. <plentry id="args.hdr">
  729. <pt>
  730. <parmname>args.hdr</parmname>
  731. </pt>
  732. <pd conaction="mark" conref="parameters-html5.dita#html5/args.hdr.desc"/>
  733. <pd conaction="pushafter">
  734. <div conref="./ant-parameters-details.dita#base-html/args.hdr.details"/></pd>
  735. </plentry>
  736. <plentry id="args.hide.parent.link" importance="deprecated">
  737. <pt>
  738. <parmname>args.hide.parent.link</parmname>
  739. <ph><indexterm>deprecated features<indexterm><parmname>args.hide.parent.link</parmname></indexterm></indexterm></ph>
  740. </pt>
  741. <pd conaction="mark" conref="parameters-html5.dita#html5/args.hide.parent.link.desc"/>
  742. <pd conaction="pushafter">
  743. <div conref="./ant-parameters-details.dita#base-html/args.hide.parent.link.details"/></pd>
  744. </plentry>
  745. <plentry id="args.outext">
  746. <pt>
  747. <parmname>args.outext</parmname>
  748. </pt>
  749. <pd conaction="mark" conref="parameters-html5.dita#html5/args.outext.desc"/>
  750. <pd conaction="pushafter">
  751. <div conref="./ant-parameters-details.dita#base-html/args.outext.details"/></pd>
  752. </plentry>
  753. <plentry id="args.xsl">
  754. <pt>
  755. <parmname>args.xsl</parmname>
  756. </pt>
  757. <pd conaction="mark" conref="parameters-html5.dita#html5/args.xsl.desc"/>
  758. <pd conaction="pushafter">
  759. <div conref="./ant-parameters-details.dita#base-html/args.xsl.details"/></pd>
  760. </plentry>
  761. <!-- End shared base-html parameter descriptions -->
  762. <plentry id="nav-toc">
  763. <pt><parmname>nav-toc</parmname></pt>
  764. <pd conaction="pushreplace" conref="parameters-html5.dita#html5/nav-toc.desc">
  765. <p>Specifies whether to generate a table of contents (ToC) in the HTML5 <xmlelement>nav</xmlelement>
  766. element of each page. The navigation can then be rendered in a sidebar or menu via CSS.
  767. <indexterm>HTML5<indexterm>nav-toc</indexterm></indexterm>
  768. </p>
  769. <p>The following values are supported:
  770. <ul>
  771. <li><option>none</option> (default) – No table of contents will be generated</li>
  772. <li><option>partial</option> – Include the current topic in the ToC along with its parents, siblings
  773. and children</li>
  774. <li><option>full</option> – Generate a complete ToC for the entire map</li>
  775. </ul>
  776. <div outputclass="div-index">
  777. <indexterm>table of contents<indexterm>HTML5</indexterm></indexterm>
  778. <indexterm>table of contents<indexterm>nav-toc</indexterm></indexterm>
  779. </div>
  780. </p>
  781. </pd>
  782. </plentry>
  783. </parml>
  784. </section>
  785. </refbody>
  786. </reference>
  787. </reference>