ant-parameters-details.dita 37 KB

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