ant-parameters-details.dita 43 KB

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