ant-parameters-details.dita 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757
  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.md file for applicable licenses.-->
  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.debug">
  17. <pt><parmname>args.debug</parmname></pt>
  18. <pd conaction="mark" conref="parameters-base.dita#base/args.debug.desc"/>
  19. <pd conaction="pushafter">Specifies whether debugging information is included in the log. The allowed values
  20. are <option>yes</option> and <option>no</option>; the default value is <option>no</option>.</pd>
  21. </plentry>-->
  22. <plentry id="args.draft">
  23. <pt>
  24. <parmname>args.draft</parmname>
  25. </pt>
  26. <pd conaction="mark" conref="parameters-base.dita#base/args.draft.desc"/>
  27. <pd conaction="pushafter" audience="xslt-customizer">Corresponds to the XSLT parameter
  28. <parmname>DRAFT</parmname> in most XSLT modules.<note type="tip">For PDF output, setting the
  29. <parmname>args.draft</parmname> parameter to <option>yes</option> causes the contents of the
  30. <xmlelement>titlealts</xmlelement> element to be rendered below the title.</note>
  31. </pd>
  32. </plentry>
  33. <plentry id="args.figurelink.style">
  34. <pt>
  35. <parmname>args.figurelink.style</parmname>
  36. </pt>
  37. <pd conaction="mark" conref="parameters-base.dita#base/args.figurelink.style.desc"/>
  38. <pd conaction="pushafter">Specifying <option>NUMBER</option> results in "Figure 5"; specifying
  39. <option>TITLE</option> results in the title of the figure. <ph audience="xslt-customizer">Corresponds to
  40. the XSLT parameter <parmname>FIGURELINK</parmname>.</ph><note rev="2.0">Support for PDF was added in
  41. DITA-OT 2.0. By default PDF uses the value <option>NUMTITLE</option>, which is not supported for other
  42. transformation types; this results in "Figure 5. Title".</note></pd>
  43. </plentry>
  44. <!--<plentry id="args.filter" rev="1.6">
  45. <pt><parmname>args.filter</parmname></pt>
  46. <pd conaction="mark" conref="parameters-base.dita#base/args.filter.desc"/>
  47. <pd conaction="pushafter">Specifies a filter file to be used to include, exclude, or flag content.</pd>
  48. </plentry>-->
  49. <plentry id="args.grammar.cache">
  50. <pt>
  51. <parmname>args.grammar.cache</parmname>
  52. </pt>
  53. <pd conaction="mark" conref="parameters-base.dita#base/args.grammar.cache.desc"/>
  54. <pd conaction="pushafter">
  55. <note>This option dramatically speeds up processing time. However, there is a known problem with using
  56. this feature for documents that use XML entities. If your build fails with parser errors about entity
  57. resolution, set this parameter to <option>no</option>.</note>
  58. </pd>
  59. </plentry>
  60. <plentry id="args.input">
  61. <pt>
  62. <parmname>args.input</parmname>
  63. </pt>
  64. <pd conaction="mark" conref="parameters-base.dita#base/args.input.desc"/>
  65. <pd conaction="pushafter">Typically this is a DITA map, however it also can be a DITA topic if you want to
  66. transform a single DITA file. The path can be absolute, relative to <parmname>args.input.dir</parmname>,
  67. or relative to the directory where your project's ant build script resides if
  68. <parmname>args.input.dir</parmname> is not defined. </pd>
  69. </plentry>
  70. <plentry id="args.input.dir">
  71. <pt>
  72. <parmname>args.input.dir</parmname>
  73. </pt>
  74. <pd conaction="mark" conref="parameters-base.dita#base/args.input.dir.desc"/>
  75. <pd conaction="pushafter">The default value is the parent directory of the file specified by
  76. <parmname>args.input</parmname>.</pd>
  77. </plentry>
  78. <!--<plentry id="args.logdir">
  79. <pt><parmname>args.logdir</parmname></pt>
  80. <pd conaction="mark" conref="parameters-base.dita#base/args.logdir.desc"/>
  81. <pd conaction="pushafter">Specifies the location where the DITA-OT places log files for your project.</pd>
  82. </plentry>-->
  83. <!--<plentry conref="conref-dita-ot-parameters.dita#conref-dita-ot-parameters/args.rellinks">
  84. <pt/>
  85. <pd/>
  86. </plentry>-->
  87. <plentry id="args.tablelink.style">
  88. <pt>
  89. <parmname>args.tablelink.style</parmname>
  90. </pt>
  91. <pd conaction="mark" conref="parameters-base.dita#base/args.tablelink.style.desc"/>
  92. <pd conaction="pushafter">Specifying <option>NUMBER</option> results in "Table 5"; specifying
  93. <option>TITLE</option> results in the title of the table. <ph audience="xslt-customizer">Corresponds to
  94. the XSLT parameter <parmname>TABLELINK</parmname>.</ph><note rev="2.0">Support for PDF was added in
  95. DITA-OT 2.0. By default PDF uses the value <option>NUMTITLE</option>, which is not supported for other
  96. transformation types; this results in "Table 5. Title".</note></pd>
  97. </plentry>
  98. <plentry id="cleantemp">
  99. <pt>
  100. <parmname>clean.temp</parmname>
  101. </pt>
  102. <pd conaction="mark" conref="parameters-base.dita#base/clean.temp.desc"/>
  103. <pd conaction="pushafter"/>
  104. </plentry>
  105. <!--<plentry id="dita.dir">
  106. <pt><parmname>dita.dir</parmname></pt>
  107. <pd conaction="mark" conref="parameters-base.dita#base/dita.dir.desc"/>
  108. <pd conaction="pushafter">Specifies where the DITA-OT is installed.</pd>
  109. </plentry>-->
  110. <plentry id="dita.temp.dir">
  111. <pt>
  112. <parmname>dita.temp.dir</parmname>
  113. </pt>
  114. <pd conaction="mark" conref="parameters-base.dita#base/dita.temp.dir.desc"/>
  115. <pd conaction="pushafter">The temporary directory is where the DITA-OT writes temporary files that are
  116. generated during the transformation process.</pd>
  117. </plentry>
  118. <plentry id="dita.input.valfile" importance="deprecated">
  119. <pt>
  120. <parmname>dita.input.valfile</parmname>
  121. </pt>
  122. <pd conaction="mark" conref="parameters-base.dita#base/dita.input.valfile.desc"/>
  123. <pd conaction="pushafter">
  124. <note type="notice">Deprecated in favor of the <parmname>args.filter</parmname> parameter.</note>
  125. </pd>
  126. </plentry>
  127. <plentry id="filter-stage">
  128. <pt>
  129. <parmname>filter-stage</parmname>
  130. </pt>
  131. <pd conaction="mark" conref="parameters-base.dita#base/filter-stage.desc"/>
  132. <pd conaction="pushafter">
  133. <note>Changing the filtering stage may produce different results for the same initial data set and
  134. filtering conditions.</note>
  135. </pd>
  136. </plentry>
  137. <plentry id="force-unique">
  138. <pt>
  139. <parmname>force-unique</parmname>
  140. </pt>
  141. <pd conaction="mark" conref="parameters-base.dita#base/force-unique.desc"/>
  142. <pd conaction="pushafter">
  143. <draft-comment author="jelovirt">This needs a better and longer description.</draft-comment>
  144. </pd>
  145. </plentry>
  146. <plentry id="generate-debug-attributes">
  147. <pt>
  148. <parmname>generate-debug-attributes</parmname>
  149. </pt>
  150. <pd conaction="mark" conref="parameters-base.dita#base/generate-debug-attributes.desc"/>
  151. <pd conaction="pushafter">
  152. <note>Disabling debugging attributes reduces the size of temporary files and thus reduces memory
  153. consumption. However, the log messages no longer have the source information available and thus the
  154. ability to debug problems might deteriorate.</note>
  155. </pd>
  156. </plentry>
  157. <plentry id="generate.copy.outer">
  158. <pt>
  159. <parmname>generate.copy.outer</parmname>
  160. </pt>
  161. <pd conaction="mark" conref="parameters-base.dita#base/generate.copy.outer.desc"/>
  162. <pd conaction="pushafter">
  163. <p>See <xref keyref="generate-copy-outer"/> for more information.</p>
  164. </pd>
  165. </plentry>
  166. <plentry id="onlytopic.in.map">
  167. <pt>
  168. <parmname>onlytopic.in.map</parmname>
  169. </pt>
  170. <pd conaction="mark" conref="parameters-base.dita#base/onlytopic.in.map.desc"/>
  171. <pd conaction="pushafter">If set to <option>true</option>, only files that are referenced directly from the
  172. map will generate output; the default value is <option>false</option>.</pd>
  173. </plentry>
  174. <plentry id="outer.control">
  175. <pt>
  176. <parmname>outer.control</parmname>
  177. </pt>
  178. <pd conaction="mark" conref="parameters-base.dita#base/outer.control.desc"/>
  179. <pd conaction="pushafter">
  180. <note type="warning" platform="windows">Microsoft HTML Help Compiler cannot produce HTML Help for
  181. documentation projects that use outer content. The content files must reside in or below the directory
  182. containing the master DITA map file, and the map file cannot specify ".." at the start of the
  183. <xmlatt>href</xmlatt> attributes for <xmlelement>topicref</xmlelement> elements.</note>
  184. </pd>
  185. </plentry>
  186. <plentry id="output.dir">
  187. <pt>
  188. <parmname>output.dir</parmname>
  189. </pt>
  190. <pd conaction="mark" conref="parameters-base.dita#base/output.dir.desc"/>
  191. <pd conaction="pushafter">By default, the output is written to
  192. <filepath><varname>DITA-dir</varname>/out</filepath>.</pd>
  193. </plentry>
  194. <!--<plentry id="processing-mode">
  195. <pt><parmname>processing-mode</parmname></pt>
  196. <pd conaction="mark" conref="parameters-base.dita#base/processing-mode"/>
  197. <pd conaction="pushafter"/>
  198. </plentry>-->
  199. <!--<plentry id="root-chunk-override">
  200. <pt><parmname>root-chunk-override</parmname></pt>
  201. <pd conaction="mark" conref="parameters-base.dita#base/root-chunk-override.desc"/>
  202. <pd conaction="pushafter">Override for map chunk attribute value.</pd>
  203. </plentry>-->
  204. <plentry id="transtype">
  205. <pt>
  206. <parmname>transtype</parmname>
  207. </pt>
  208. <pd conaction="mark" conref="parameters-base.dita#base/transtype.desc"/>
  209. <pd conaction="pushafter">You can create plug-ins to add new values for this parameter; by default, the
  210. following values are available:
  211. <ul>
  212. <li>docbook</li>
  213. <li>eclipsehelp</li>
  214. <li>eclipsecontent</li>
  215. <li>html5</li>
  216. <li platform="windows">htmlhelp</li>
  217. <li>javahelp</li>
  218. <li>odt</li>
  219. <li>pdf</li>
  220. <li>wordrtf</li>
  221. <li>troff</li>
  222. <li>xhtml</li>
  223. </ul>
  224. </pd>
  225. </plentry>
  226. <!--<plentry id="validate">
  227. <pt><parmname>validate</parmname></pt>
  228. <pd conaction="mark" conref="parameters-base.dita#base/validate.desc"/>
  229. <pd conaction="pushafter">Specifies whether the DITA-OT validates the content. The allowed values are
  230. <option>true</option> and <option>false</option>; the default value is <option>true</option>.</pd>
  231. </plentry>-->
  232. </parml>
  233. </section>
  234. </refbody>
  235. </reference>
  236. <reference id="base-html">
  237. <title>HTML-based output formats</title>
  238. <titlealts>
  239. <navtitle>All HTML-based transformations</navtitle>
  240. </titlealts>
  241. <shortdesc conaction="pushreplace" conref="parameters-base-html.dita#base-html/shortdesc">Certain parameters apply
  242. to all the HTML-based transformation types: Eclipse help, HTML Help, JavaHelp, TocJS, HTML5, and XHTML. </shortdesc>
  243. <refbody>
  244. <section>
  245. <parml>
  246. <!--<plentry id="args.artlbl">
  247. <pt><parmname>args.artlbl</parmname></pt>
  248. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.artlbl.desc"/>
  249. <pd conaction="pushafter">Specifies whether to generate a label for each image; the label will contain the
  250. image file name. The allowed values are <option>yes</option> and <option>no</option>; the default value is
  251. <option>no</option>.</pd>
  252. </plentry>-->
  253. <plentry id="args.breadcrumbs">
  254. <pt>
  255. <parmname>args.breadcrumbs</parmname>
  256. </pt>
  257. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.breadcrumbs.desc"/>
  258. <pd conaction="pushafter" audience="xslt-customizer">Corresponds to the XSLT parameter
  259. <parmname>BREADCRUMBS</parmname>.</pd>
  260. </plentry>
  261. <!--<plentry id="args.copycss">
  262. <pt><parmname>args.copycss</parmname></pt>
  263. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.copycss.desc"/>
  264. <pd conaction="pushafter">Specifies whether to copy the custom .css file to the output directory.</pd>
  265. </plentry>-->
  266. <!--<plentry id="args.css">
  267. <pt><parmname>args.css</parmname></pt>
  268. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.css.desc"/>
  269. <pd conaction="pushafter">Specifies the name of a custom .css file.</pd>
  270. </plentry>-->
  271. <plentry id="args.csspath">
  272. <pt>
  273. <parmname>args.csspath</parmname>
  274. </pt>
  275. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.csspath.desc"/>
  276. <pd conaction="pushafter" audience="xslt-customizer">Corresponds to the XSLT parameter
  277. <parmname>CSSPATH</parmname>. DITA-OT will copy the file to this location.</pd>
  278. </plentry>
  279. <plentry id="args.cssroot">
  280. <pt>
  281. <parmname>args.cssroot</parmname>
  282. </pt>
  283. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.cssroot.desc"/>
  284. <pd conaction="pushafter">DITA-OT will copy the file from this location.</pd>
  285. </plentry>
  286. <plentry id="args.dita.locale">
  287. <pt>
  288. <parmname>args.dita.locale</parmname>
  289. </pt>
  290. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.dita.locale.desc"/>
  291. <pd conaction="pushafter">
  292. <note>This parameter is not available for the XHTML transformation.</note>
  293. </pd>
  294. </plentry>
  295. <plentry id="args.ftr">
  296. <pt>
  297. <parmname>args.ftr</parmname>
  298. </pt>
  299. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.ftr.desc"/>
  300. <pd conaction="pushafter">
  301. <ph audience="xslt-customizer">Corresponds to the XSLT parameter <parmname>FTR</parmname>.</ph>
  302. <note>The footer file should be specified using an absolute path and must contain valid XML. A common
  303. practice is to place all content into a <xmlelement>div</xmlelement> element.</note>
  304. </pd>
  305. </plentry>
  306. <plentry id="args.gen.default.meta">
  307. <pt>
  308. <parmname>args.gen.default.meta</parmname>
  309. </pt>
  310. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.gen.default.meta.desc"/>
  311. <pd conaction="pushafter" audience="xslt-customizer">Corresponds to the XSLT parameter
  312. <parmname>genDefMeta</parmname>.</pd>
  313. </plentry>
  314. <plentry conref="conref-dita-ot-parameters.dita#conref-dita-ot-parameters/args.gen.task.lbl">
  315. <pt/>
  316. <pd/>
  317. </plentry>
  318. <plentry id="args.hdf">
  319. <pt><parmname>args.hdf</parmname></pt>
  320. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.hdf.desc"/>
  321. <pd conaction="pushafter">
  322. <p>The contents of the header file will be inserted in the <xmlelement>head</xmlelement> element of the
  323. generated HTML files.</p>
  324. <note type="tip">The header file should be specified using an absolute path and must contain valid XML. If
  325. you need to insert more than one element into the HTML page head, wrap the content in a
  326. <xmlelement>div</xmlelement> element. The division wrapper in the header file will be discarded when
  327. generating HTML files, and the contents will be inserted into each page head.</note></pd>
  328. </plentry>
  329. <plentry id="args.hdr">
  330. <pt>
  331. <parmname>args.hdr</parmname>
  332. </pt>
  333. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.hdr.desc"/>
  334. <pd conaction="pushafter">
  335. <ph audience="xslt-customizer">Corresponds to the XSLT parameter <parmname>HDR</parmname>.</ph>
  336. <note>The header file should be specified using an absolute path and must contain valid XML. A common
  337. practice is to place all content into a <xmlelement>div</xmlelement> element.</note>
  338. </pd>
  339. </plentry>
  340. <plentry id="args.hide.parent.link" importance="deprecated">
  341. <pt>
  342. <parmname>args.hide.parent.link</parmname>
  343. </pt>
  344. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.hide.parent.link.desc"/>
  345. <pd conaction="pushafter">
  346. <ph audience="xslt-customizer">Corresponds to the XSLT parameter <parmname>NOPARENTLINK</parmname>.</ph>
  347. <note type="notice">This parameter is deprecated in favor of the <parmname>args.rellinks</parmname>
  348. parameter.</note>
  349. </pd>
  350. </plentry>
  351. <!--<plentry id="args.indexshow">
  352. <pt><parmname>args.indexshow</parmname></pt>
  353. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.indexshow.desc"/>
  354. <pd conaction="pushafter">Specifies whether the content of <xmlelement>indexterm</xmlelement> elements are
  355. rendered in the output. The allowed values are <option>yes</option> and <option>no</option>; the default
  356. value is <option>no</option>.</pd>
  357. </plentry>-->
  358. <plentry id="args.outext">
  359. <pt>
  360. <parmname>args.outext</parmname>
  361. </pt>
  362. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.outext.desc"/>
  363. <pd conaction="pushafter">
  364. <ph audience="xslt-customizer">Corresponds to the XSLT parameter <parmname>OUTEXT</parmname>.</ph>
  365. </pd>
  366. </plentry>
  367. <plentry id="args.xhtml.classattr">
  368. <pt>
  369. <parmname>args.xhtml.classattr</parmname>
  370. </pt>
  371. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.xhtml.classattr.desc"/>
  372. <pd conaction="pushafter">For example, the <xmlelement>prereq</xmlelement> element (which is specialized
  373. from <xmlelement>section</xmlelement>) would generate <codeph>class="section prereq"</codeph>. <ph
  374. audience="xslt-customizer">Corresponds to the XSLT parameter
  375. <parmname>PRESERVE-DITA-CLASS</parmname>.</ph><note>Beginning with DITA OT release 1.5.2, the default
  376. value is <option>yes</option>. For release 1.5 and 1.5.1, the default value was <option>no</option>.
  377. </note></pd>
  378. </plentry>
  379. <plentry id="args.xsl">
  380. <pt>
  381. <parmname>args.xsl</parmname>
  382. </pt>
  383. <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.xsl.desc"/>
  384. <pd conaction="pushafter">The parameter must specify a fully qualified file name.</pd>
  385. </plentry>
  386. </parml>
  387. </section>
  388. </refbody>
  389. </reference>
  390. <reference id="eclipsecontent">
  391. <title>Eclipse content</title>
  392. <titlealts>
  393. <navtitle>Eclipse content</navtitle>
  394. </titlealts>
  395. <shortdesc conaction="pushreplace" conref="parameters-eclipsecontent.dita#eclipsecontent/shortdesc">Certain
  396. parameters are specific to the Eclipse content transformation.</shortdesc>
  397. <refbody>
  398. <section>
  399. <parml>
  400. <plentry id="args.eclipsecontent.toc">
  401. <pt>
  402. <parmname>args.eclipsecontent.toc</parmname>
  403. </pt>
  404. <pd conaction="mark" conref="parameters-eclipsecontent.dita#eclipsecontent/args.eclipse.version.desc"/>
  405. <pd conaction="pushafter">
  406. <note type="tip">The toolkit ignores the value of this property when processing an Eclipse Collection Map,
  407. eclipse.dtd.</note>
  408. </pd>
  409. </plentry>
  410. </parml>
  411. </section>
  412. </refbody>
  413. </reference>
  414. <reference id="eclipsehelp">
  415. <title>Eclipse help</title>
  416. <titlealts>
  417. <navtitle>Eclipse help</navtitle>
  418. </titlealts>
  419. <shortdesc conaction="pushreplace" conref="parameters-eclipsehelp.dita#eclipsehelp/shortdesc">Certain parameters are
  420. specific to the Eclipse help transformation.</shortdesc>
  421. <refbody>
  422. <section>
  423. <parml>
  424. <!--<plentry id="args.eclipsehelp.toc">
  425. <pt><parmname>args.eclipsehelp.toc</parmname></pt>
  426. <pd conaction="mark" conref="parameters-eclipsehelp.dita#eclipsehelp/args.eclipsehelp.toc.desc"/>
  427. <pd conaction="pushafter">Specifies the name of the TOC file.</pd>
  428. </plentry>-->
  429. <plentry id="args.eclipsehelp.country">
  430. <pt>
  431. <parmname>args.eclipsehelp.country</parmname>
  432. </pt>
  433. <pd conaction="mark" conref="parameters-eclipsehelp.dita#eclipsehelp/args.eclipsehelp.country.desc"/>
  434. <pd conaction="pushafter">For example, <option>us</option>, <option>ca</option>, and <option>gb</option>
  435. would clarify a value of <option>en</option> set for the <parmname>args.eclipsehelp.language</parmname>
  436. parameter. The content will be moved into the appropriate directory structure for an Eclipse
  437. fragment.<draft-comment author="Kristen James Eberlein" time="11 August 2012">What does "The content
  438. will be moved into the appropriate directory structure for an Eclipse fragment"
  439. mean?</draft-comment></pd>
  440. </plentry>
  441. <plentry id="args.eclipsehelp.language">
  442. <pt>
  443. <parmname>args.eclipsehelp.language</parmname>
  444. </pt>
  445. <pd conaction="mark" conref="parameters-eclipsehelp.dita#eclipsehelp/args.eclipsehelp.language.desc"/>
  446. <pd conaction="pushafter">This parameter is a prerequisite for the
  447. <parmname>args.eclipsehelp.country</parmname> parameter. The content will be moved into the appropriate
  448. directory structure for an Eclipse fragment.</pd>
  449. </plentry>
  450. <plentry id="args.eclipse.provider">
  451. <pt>
  452. <parmname>args.eclipse.provider</parmname>
  453. </pt>
  454. <pd conaction="mark" conref="parameters-eclipsehelp.dita#eclipsehelp/args.eclipse.provider.desc"/>
  455. <pd conaction="pushafter">The default value is <option>DITA</option>. <note type="tip">The toolkit ignores
  456. the value of this parameter when it processes an Eclipse map.</note>
  457. </pd>
  458. </plentry>
  459. <plentry id="args.eclipse.version">
  460. <pt>
  461. <parmname>args.eclipse.version</parmname>
  462. </pt>
  463. <pd conaction="mark" conref="parameters-eclipsehelp.dita#eclipsehelp/args.eclipse.version.desc"/>
  464. <pd conaction="pushafter">The default value is <option>0.0.0</option>.<note type="tip">The toolkit ignores
  465. the value of this parameter when it processes an Eclipse map.</note></pd>
  466. </plentry>
  467. <plentry id="args.eclipse.symbolic.name">
  468. <pt>
  469. <parmname>args.eclipse.symbolic.name</parmname>
  470. </pt>
  471. <pd conaction="mark" conref="parameters-eclipsehelp.dita#eclipsehelp/args.eclipse.symbolic.name.desc"/>
  472. <pd conaction="pushafter">
  473. <!-- Specifies the symbolic name (aka plugin ID) in the output for an Eclipse Help project. -->The
  474. <xmlatt>id</xmlatt> value from the DITA map or the Eclipse map collection (Eclipse help specialization)
  475. is the symbolic name for the plugin in Eclipse. The default value is
  476. <option>org.sample.help.doc</option>.<note type="tip">The toolkit ignores the value of this parameter
  477. when it processes an Eclipse map.</note><draft-comment author="Kristen James Eberlein"
  478. time="11 August 2012">I'm not clear what this means. Is the default value for the
  479. <parmname>args.eclipse.symbolic.name</parmname> parameter the value of the <xmlatt>id</xmlatt>
  480. attribute on the <xmlelement>map</xmlelement> or <xmlelement>plugin</xmlelement> element, if provided,
  481. and the <option>org.sample.help.doc</option> if there is not a value for the <xmlatt>id</xmlatt>
  482. attribute or the <parmname>args.eclipse.symbolic.name</parmname> parameter?</draft-comment></pd>
  483. </plentry>
  484. </parml>
  485. </section>
  486. </refbody>
  487. </reference>
  488. <reference id="htmlhelp">
  489. <title>HTML Help</title>
  490. <titlealts>
  491. <navtitle>HTML Help</navtitle>
  492. </titlealts>
  493. <shortdesc conaction="pushreplace" conref="parameters-htmlhelp.dita#htmlhelp/shortdesc">Certain parameters are
  494. specific to the HTML Help transformation.</shortdesc>
  495. <refbody>
  496. <section>
  497. <!--<parml>
  498. <plentry id="args.htmlhelp.includefile">
  499. <pt><parmname>args.htmlhelp.includefile</parmname></pt>
  500. <pd conaction="mark" conref="parameters-htmlhelp.dita#htmlhelp/args.htmlhelp.includefile.desc"/>
  501. <pd conaction="pushafter">Specifies the name of a file that you want included in the HTML Help.</pd>
  502. </plentry>
  503. </parml>-->
  504. </section>
  505. </refbody>
  506. </reference>
  507. <reference id="javahelp">
  508. <title>JavaHelp</title>
  509. <titlealts>
  510. <navtitle>JavaHelp</navtitle>
  511. </titlealts>
  512. <shortdesc conaction="pushreplace" conref="parameters-javahelp.dita#javahelp/shortdesc">Certain parameters are
  513. specific to the JavaHelp transformation.</shortdesc>
  514. <refbody>
  515. <section>
  516. <parml>
  517. <plentry id="args.javahelp.map">
  518. <pt>
  519. <parmname>args.javahelp.map</parmname>
  520. </pt>
  521. <pd conaction="mark" conref="parameters-javahelp.dita#javahelp/args.javahelp.map.desc"/>
  522. <pd conaction="pushafter">
  523. <draft-comment author="Kristen James Eberlein" time="11 August 2012">What does this mean? How does this
  524. differ from the <parmname>args.input</parmname> parameter? Or should this read "Specifies the name of
  525. the JavaHelp map file?</draft-comment>
  526. </pd>
  527. </plentry>
  528. <plentry id="args.javahelp.toc">
  529. <pt>
  530. <parmname>args.javahelp.toc</parmname>
  531. </pt>
  532. <pd conaction="mark" conref="parameters-javahelp.dita#javahelp/args.javahelp.toc.desc"/>
  533. <pd conaction="pushafter">Default value is the name of the ditamap file for your project. <draft-comment
  534. author="Kristen James Eberlein" time="11 August 2012">I assume that the first sentence means "Specifies
  535. the name of the JavaHelp TOC file." But what does the second sentence mean? That the default value for
  536. the <parmname>args.javahelp.toc</parmname> parameter is the name of the master DITA map? Or that the
  537. default value for the <parmname>args.javahelp.toc</parmname> parameter is the value of the
  538. <parmname>args.javahelp.map</parmname> parameter?</draft-comment></pd>
  539. </plentry>
  540. </parml>
  541. </section>
  542. </refbody>
  543. </reference>
  544. <reference id="odt">
  545. <title>ODT</title>
  546. <titlealts>
  547. <navtitle>ODT</navtitle>
  548. </titlealts>
  549. <shortdesc conaction="pushreplace" conref="parameters-odt.dita#odt/shortdesc">Certain parameters are specific to the
  550. ODT transformation.</shortdesc>
  551. <refbody>
  552. <section>
  553. <!--<parml>
  554. <plentry>
  555. <pt><parmname>args.odt.img.embed</parmname></pt>
  556. <pd conaction="mark" conref="parameters-odt.dita#odt/args.odt.img.embed.desc"/>
  557. <pd conaction="pushafter">Determines whether images are embedded as binary objects within the ODT file.
  558. </pd>
  559. </plentry>
  560. </parml>-->
  561. </section>
  562. </refbody>
  563. </reference>
  564. <reference id="ant-parameters-other">
  565. <title>Other parameters</title>
  566. <titlealts>
  567. <navtitle>Other</navtitle>
  568. </titlealts>
  569. <shortdesc>These parameters enable you to reload style sheets that the DITA-OT uses for specific pre-processing
  570. stages.</shortdesc>
  571. <refbody>
  572. <section>
  573. <draft-comment author="Kristen James Eberlein" time="11 August 2012">I've made no attempt to work with the
  574. content in the topic. Here's what I'd like to know:
  575. <ul>
  576. <li>When would someone want to use the various <parmname>dita.preprocess</parmname> parameters? (Other than
  577. if they need to reduce Java memory consumption.) The use cases are not clear from the current
  578. description.</li>
  579. </ul>
  580. </draft-comment>
  581. <!--<parml>
  582. <plentry>
  583. <pt id="dita.preprocess.reloadstylesheet"><parmname>dita.preprocess.reloadstylesheet</parmname></pt>
  584. <pt id="dita.preprocess.reloadstylesheet.conref">
  585. <parmname>dita.preprocess.reloadstylesheet.conref</parmname>
  586. </pt>
  587. <pt id="dita.preprocess.reloadstylesheet.mapref">
  588. <parmname>dita.preprocess.reloadstylesheet.mapref</parmname>
  589. </pt>
  590. <pt id="dita.preprocess.reloadstylesheet.mappull">
  591. <parmname>dita.preprocess.reloadstylesheet.mappull</parmname>
  592. </pt>
  593. <pt id="dita.preprocess.reloadstylesheet.maplink">
  594. <parmname>dita.preprocess.reloadstylesheet.maplink</parmname>
  595. </pt>
  596. <pt id="dita.preprocess.reloadstylesheet.topicpull">
  597. <parmname>dita.preprocess.reloadstylesheet.topicpull</parmname>
  598. </pt>
  599. <pd conaction="mark" conref="parameters-other.dita#other/dita.preprocess.reloadstylesheet.desc"/>
  600. <pd conaction="pushafter">Specifies whether the DITA-OT reloads the XSL style sheets that are used for the
  601. transformation. The allowed values are <option>true</option> and <option>false</option>; the default value
  602. is <option>false</option>.<note type="tip">Set the parameter to <option>true</option> if you want to use
  603. more than one set of style sheets to process a collection of topics. The parameter also is useful for
  604. large projects that generate Java out-of-memory errors during transformation. Alternatively, you can
  605. adjust the size of your Java memory heap if setting <codeph>dita.preprocess.reloadstylesheet</codeph>
  606. for this reason.</note></pd>
  607. </plentry>
  608. </parml>-->
  609. </section>
  610. </refbody>
  611. </reference>
  612. <reference id="pdf">
  613. <title>PDF</title>
  614. <titlealts>
  615. <navtitle>PDF</navtitle>
  616. </titlealts>
  617. <shortdesc conaction="pushreplace" conref="parameters-pdf.dita#pdf/shortdesc">Certain parameters are specific to the
  618. PDF transformation.</shortdesc>
  619. <refbody>
  620. <section>
  621. <parml>
  622. <!--<plentry id="args.bookmap-order" rev="1.5.4">
  623. <pt><parmname>args.bookmap-order</parmname></pt>
  624. <pd conaction="mark" conref="parameters-pdf.dita#pdf/args.bookmap-order.desc"/>
  625. <pd conaction="pushafter">Specifies if the frontmatter and backmatter content order is retained in bookmap.
  626. The allowed values are <option>retain</option> and <option>discard</option>; the default value is
  627. <option>discard</option>.</pd>
  628. </plentry>-->
  629. <!--<plentry id="args.bookmark.style">
  630. <pt><parmname>args.bookmark.style</parmname></pt>
  631. <pd conaction="mark" conref="parameters-pdf.dita#pdf/args.bookmark.style.desc"/>
  632. <pd conaction="pushafter">Specifies whether PDF bookmarks are by default expanded or collapsed. The allowed
  633. values are <option>COLLAPSED</option> and <option>EXPANDED</option>, the default value is
  634. <option>COLLAPSE</option>.</pd>
  635. </plentry>-->
  636. <!--<plentry id="args.chapter.layout">
  637. <pt><parmname>args.chapter.layout</parmname></pt>
  638. <pd conaction="mark" conref="parameters-pdf.dita#pdf/args.chapter.layout.desc"/>
  639. <pd conaction="pushafter">Specifies whether chapter level TOCs are generated. The allowed values are
  640. <option>MINITOC</option> and <option>BASIC</option>; the default value is <option>MINITOC</option>.</pd>
  641. </plentry>-->
  642. <plentry conref="conref-dita-ot-parameters.dita#conref-dita-ot-parameters/args.fo.userconfig">
  643. <pt/>
  644. <pd/>
  645. </plentry>
  646. <plentry conref="conref-dita-ot-parameters.dita#conref-dita-ot-parameters/args.gen.task.lbl">
  647. <pt/>
  648. <pd/>
  649. </plentry>
  650. <plentry conref="conref-dita-ot-parameters.dita#conref-dita-ot-parameters/args.rellinks">
  651. <pt/>
  652. <pd/>
  653. </plentry>
  654. <plentry id="args.xsl.pdf">
  655. <pt>
  656. <parmname>args.xsl.pdf</parmname>
  657. </pt>
  658. <pd conaction="mark" conref="parameters-pdf.dita#pdf/args.xsl.pdf.desc"/>
  659. <pd conaction="pushafter">You must specify the fully qualified file name.</pd>
  660. </plentry>
  661. <!--<plentry id="custom.xep.config">
  662. <pt><parmname>custom.xep.config</parmname></pt>
  663. <pd conaction="mark" conref="parameters-pdf.dita#pdf/custom.xep.config.desc"/>
  664. <pd conaction="pushafter">Specifies the user configuration file for RenderX.</pd>
  665. </plentry>-->
  666. <!--<plentry id="customization.dir" audience="xslt-customizer">
  667. <pt><parmname>customization.dir</parmname></pt>
  668. <pd>Specifies the customization directory.</pd>
  669. </plentry>-->
  670. <plentry id="pdf.formatter">
  671. <pt>
  672. <parmname>pdf.formatter</parmname>
  673. </pt>
  674. <pd>The client package comes with Apache FOP; other XSL processors must be separately installed.</pd>
  675. </plentry>
  676. <plentry id="publish.required.cleanup" importance="deprecated">
  677. <pt>
  678. <parmname>publish.required.cleanup</parmname>
  679. </pt>
  680. <pd conaction="mark" conref="parameters-pdf.dita#pdf/publish.required.cleanup.desc"/>
  681. <pd conaction="pushafter">The default value is the value of the <parmname>args.draft</parmname> parameter.
  682. <ph audience="xslt-customizer">Corresponds to the XSLT parameter
  683. <parmname>publishRequiredCleanup</parmname>.</ph><note type="notice">This parameter is deprecated in
  684. favor of the <parmname>args.draft</parmname> parameter.</note></pd>
  685. </plentry>
  686. </parml>
  687. </section>
  688. </refbody>
  689. </reference>
  690. <reference id="common-html">
  691. <title>HTML5 and XHTML</title>
  692. <titlealts>
  693. <navtitle>HTML5 and XHTML</navtitle>
  694. </titlealts>
  695. <shortdesc conaction="pushreplace" conref="parameters-common-html.dita#common-html/shortdesc">Certain parameters are
  696. specific to the HTML5 and XHTML transformations.</shortdesc>
  697. <refbody>
  698. <section>
  699. <parml>
  700. <plentry id="args.xhtml.contenttarget">
  701. <pt>
  702. <parmname>args.xhtml.contenttarget</parmname>
  703. </pt>
  704. <pd conaction="mark" conref="parameters-common-html.dita#common-html/args.xhtml.contenttarget.desc"/>
  705. <pd conaction="pushafter">The default value is <option>contentwin</option>.</pd>
  706. </plentry>
  707. <!--<plentry id="args.xhtml.toc">
  708. <pt><parmname>args.xhtml.toc</parmname></pt>
  709. <pd conaction="mark" conref="parameters-common-html.dita#common-html/args.xhtml.toc.desc"/>
  710. <pd conaction="pushafter">Specifies the base name of the TOC file. The default value is
  711. <option>index</option>.</pd>
  712. </plentry>-->
  713. <plentry id="args.xhtml.toc.class">
  714. <pt>
  715. <parmname>args.xhtml.toc.class</parmname>
  716. </pt>
  717. <pd conaction="mark" conref="parameters-common-html.dita#common-html/args.xhtml.toc.class.desc"/>
  718. <pd conaction="pushafter">
  719. <ph audience="xslt-customizer">Found in <filepath>map2htmltoc.xsl</filepath>.</ph>
  720. </pd>
  721. </plentry>
  722. </parml>
  723. </section>
  724. </refbody>
  725. </reference>
  726. <reference id="html5">
  727. <title>HTML5 parameters</title>
  728. <titlealts>
  729. <navtitle>HTML5</navtitle>
  730. </titlealts>
  731. <shortdesc conaction="pushreplace" conref="parameters-html5.dita#html5/shortdesc">Certain parameters are specific to
  732. the HTML5 transformation.</shortdesc>
  733. <refbody>
  734. <!--<section>
  735. <parml>
  736. <plentry id="args.html5.nav-toc">
  737. <pt><parmname>args.html5.nav-toc</parmname></pt>
  738. <pd conaction="mark" conref="parameters-html5.dita#html5/args.html5.nav-toc.desc"/>
  739. <pd conaction="pushafter"/>
  740. </plentry>
  741. </parml>
  742. </section>-->
  743. </refbody>
  744. </reference>
  745. </reference>