| 1234 |
- <?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
- <!DOCTYPE reference
- PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
- <reference id="parameters"><title outputclass="generated">DITA-OT parameters</title><reference id="all"><title>All DITA-OT parameters</title><refbody><section><parml><plentry id="args.artlbl" props="pdf"><pt><parmname>args.artlbl</parmname></pt><pd id="args.artlbl.desc">Specifies whether to generate a label for each image; the label will contain the image file name. The allowed values are <option>yes</option> and <option>no</option>; the default value is <option>no</option>.</pd></plentry><plentry id="args.artlbl" props="base-html"><pt><parmname>args.artlbl</parmname></pt><pd id="args.artlbl.desc">Specifies whether to generate a label for each image; the label will contain the image file name. The allowed values are <option>yes</option> and <option>no</option>; the default value is <option>no</option>.</pd></plentry><plentry id="args.bookmap-order" props="pdf"><pt><parmname>args.bookmap-order</parmname></pt><pd id="args.bookmap-order.desc">Specifies if the frontmatter and backmatter content order is retained in bookmap. The allowed values are <option>retain</option> and <option>discard</option>; the default value is <option>discard</option>.</pd></plentry><plentry id="args.bookmark.style" props="pdf"><pt><parmname>args.bookmark.style</parmname></pt><pd id="args.bookmark.style.desc">Specifies whether PDF bookmarks are by default expanded or collapsed. The allowed values are <option>EXPANDED</option> and <option>COLLAPSE</option>.</pd></plentry><plentry id="args.breadcrumbs" props="base-html"><pt><parmname>args.breadcrumbs</parmname></pt><pd id="args.breadcrumbs.desc">Specifies whether to generate breadcrumb links. The allowed values are <option>yes</option> and <option>no</option>; the default value is <option>no</option>.</pd></plentry><plentry id="args.chapter.layout" props="pdf"><pt><parmname>args.chapter.layout</parmname></pt><pd id="args.chapter.layout.desc">Specifies whether chapter level TOCs are generated. The allowed values are <option>MINITOC</option> and <option>BASIC</option>; the default value is <option>MINITOC</option>.</pd></plentry><plentry id="args.copycss" props="base-html"><pt><parmname>args.copycss</parmname></pt><pd id="args.copycss.desc">Specifies whether to copy the custom .css file to the output directory. The allowed values are <option>yes</option> and <option>no</option>; the default value is <option>no</option>.</pd></plentry><plentry id="args.css" props="base-html"><pt><parmname>args.css</parmname></pt><pd id="args.css.desc">Specifies the name of a custom .css file.</pd></plentry><plentry id="args.csspath" props="base-html"><pt><parmname>args.csspath</parmname></pt><pd id="args.csspath.desc">Specifies the location of a copied .css file relative to the output directory.</pd></plentry><plentry id="args.cssroot" props="base-html"><pt><parmname>args.cssroot</parmname></pt><pd id="args.cssroot.desc">Specifies the directory that contains the custom .css file.</pd></plentry><plentry id="args.debug"><pt><parmname>args.debug</parmname></pt><pd id="args.debug.desc">Specifies whether debugging information is included in the log. The allowed values are <option>yes</option> and <option>no</option>; the default value is <option>no</option>.</pd></plentry><plentry id="args.dita.locale" props="base-html"><pt><parmname>args.dita.locale</parmname></pt><pd id="args.dita.locale.desc">Specifies the language locale file to use for sorting index entries.</pd></plentry><plentry id="args.draft"><pt><parmname>args.draft</parmname></pt><pd id="args.draft.desc">Specifies whether the content of <draft-comment> and <required-cleanup> elements is included in the output. The allowed values are <option>yes</option> and <option>no</option>; the default value is <option>no</option>.</pd></plentry><plentry id="args.eclipse.provider" props="eclipsehelp"><pt><parmname>args.eclipse.provider</parmname></pt><pd id="args.eclipse.provider.desc">Specifies the name of the person or organization that provides the Eclipse help.</pd></plentry><plentry id="args.eclipse.provider" props="eclipsecontent"><pt><parmname>args.eclipse.provider</parmname></pt><pd id="args.eclipse.provider.desc">The provider name of the eclipse help output.</pd></plentry><plentry id="args.eclipse.symbolic.name" props="eclipsehelp"><pt><parmname>args.eclipse.symbolic.name</parmname></pt><pd id="args.eclipse.symbolic.name.desc">Specifies the symbolic name (aka plugin ID) in the output for an Eclipse Help project.</pd></plentry><plentry id="args.eclipse.version" props="eclipsehelp"><pt><parmname>args.eclipse.version</parmname></pt><pd id="args.eclipse.version.desc">Specifies the version number to include in the output.</pd></plentry><plentry id="args.eclipse.version" props="eclipsecontent"><pt><parmname>args.eclipse.version</parmname></pt><pd id="args.eclipse.version.desc">The version number of the eclipse help output. Tip: The toolkit ignores the value of this property when processing an Eclipse Collection Map, eclipse.dtd.</pd></plentry><plentry id="args.eclipsecontent.toc" props="eclipsecontent"><pt><parmname>args.eclipsecontent.toc</parmname></pt><pd id="args.eclipsecontent.toc.desc">Specifies the name of the TOC file.</pd></plentry><plentry id="args.eclipsehelp.country" props="eclipsehelp"><pt><parmname>args.eclipsehelp.country</parmname></pt><pd id="args.eclipsehelp.country.desc">Specifies the region for the language that is specified by the args.</pd></plentry><plentry id="args.eclipsehelp.language" props="eclipsehelp"><pt><parmname>args.eclipsehelp.language</parmname></pt><pd id="args.eclipsehelp.language.desc">Specifies the base language for translated content, such as en for English.</pd></plentry><plentry id="args.figurelink.style"><pt><parmname>args.figurelink.style</parmname></pt><pd id="args.figurelink.style.desc">Specifies how cross references to figures are styled in output. The allowed values are <option>NUMBER</option>, <option>TITLE</option>, and <option>NUMTITLE</option>.</pd></plentry><plentry id="args.filter"><pt><parmname>args.filter</parmname></pt><pd id="args.filter.desc">Specifies a filter file to be used to include, exclude, or flag content.</pd></plentry><plentry id="args.fo.userconfig" props="pdf"><pt><parmname>args.fo.userconfig</parmname></pt><pd id="args.fo.userconfig.desc">Specifies the user configuration file for FOP.</pd></plentry><plentry id="args.ftr" props="base-html"><pt><parmname>args.ftr</parmname></pt><pd id="args.ftr.desc">Specifies an XML file that contains content for a running footer.</pd></plentry><plentry id="args.gen.default.meta" props="base-html"><pt><parmname>args.gen.default.meta</parmname></pt><pd id="args.gen.default.meta.desc">Specifies whether to generate extra metadata that targets parental control scanners, meta elements with name="security" and name="Robots". The allowed values are <option>yes</option> and <option>no</option>; the default value is <option>no</option>.</pd></plentry><plentry id="args.gen.task.lbl"><pt><parmname>args.gen.task.lbl</parmname></pt><pd id="args.gen.task.lbl.desc">Specifies whether to generate headings for sections within task topics. The allowed values are <option>YES</option> and <option>NO</option>.</pd></plentry><plentry id="args.grammar.cache"><pt><parmname>args.grammar.cache</parmname></pt><pd id="args.grammar.cache.desc">Specifies whether the grammar-caching feature of the XML parser is used. The allowed values are <option>yes</option> and <option>no</option>; the default value is <option>yes</option>.</pd></plentry><plentry id="args.hdf" props="base-html"><pt><parmname>args.hdf</parmname></pt><pd id="args.hdf.desc">Specifies an XML file that contains content to be placed in the document head.</pd></plentry><plentry id="args.hdr" props="base-html"><pt><parmname>args.hdr</parmname></pt><pd id="args.hdr.desc">Specifies an XML file that contains content for a running header.</pd></plentry><plentry id="args.hide.parent.link" props="base-html"><pt><parmname>args.hide.parent.link</parmname></pt><pd id="args.hide.parent.link.desc">Specifies whether to hide links to parent topics in the HTML or XHTML output. The allowed values are <option>yes</option> and <option>no</option>; the default value is <option>no</option>.</pd></plentry><plentry id="args.htmlhelp.includefile" props="htmlhelp"><pt><parmname>args.htmlhelp.includefile</parmname></pt><pd id="args.htmlhelp.includefile.desc">Specifies the name of a file that you want included in the HTML Help.</pd></plentry><plentry id="args.indexshow" props="base-html"><pt><parmname>args.indexshow</parmname></pt><pd id="args.indexshow.desc">Specifies whether the content of <indexterm> elements are rendered in the output. The allowed values are <option>yes</option> and <option>no</option>; the default value is <option>no</option>.</pd></plentry><plentry id="args.input" importance="required"><pt><parmname>args.input</parmname></pt><pd id="args.input.desc">Specifies the master file for your documentation project.</pd></plentry><plentry id="args.input.dir"><pt><parmname>args.input.dir</parmname></pt><pd id="args.input.dir.desc">Specifies the base directory for your documentation project.</pd></plentry><plentry id="args.javahelp.map" props="javahelp"><pt><parmname>args.javahelp.map</parmname></pt><pd id="args.javahelp.map.desc">Specifies the name of the ditamap file for a JavaHelp project.</pd></plentry><plentry id="args.javahelp.toc" props="javahelp"><pt><parmname>args.javahelp.toc</parmname></pt><pd id="args.javahelp.toc.desc">Specifies the name of the file containing the TOC in your JavaHelp output.</pd></plentry><plentry id="args.logdir"><pt><parmname>args.logdir</parmname></pt><pd id="args.logdir.desc">Specifies the location where the DITA-OT places log files for your project.</pd></plentry><plentry id="args.odt.img.embed" props="odt"><pt><parmname>args.odt.img.embed</parmname></pt><pd id="args.odt.img.embed.desc">Determines whether images are embedded as binary objects within the ODT file. The allowed values are <option>yes</option> and <option>no</option>; the default value is <option>yes</option>.</pd></plentry><plentry id="args.outext" props="base-html"><pt><parmname>args.outext</parmname></pt><pd id="args.outext.desc">Specifies the file extension for HTML or XHTML output.</pd></plentry><plentry id="args.rellinks"><pt><parmname>args.rellinks</parmname></pt><pd id="args.rellinks.desc">Specifies which links to include in the output. The following values are supported:<ul><li><option>none</option> – No links are included.</li><li><option>all</option> – All links are included.</li><li><option>noparent</option> – Parent links are not included.</li><li><option>nofamily</option> – Parent, child, next, and previous links are not included.</li></ul></pd></plentry><plentry id="args.tablelink.style"><pt><parmname>args.tablelink.style</parmname></pt><pd id="args.tablelink.style.desc">Specifies how cross references to tables are styled. The allowed values are <option>NUMBER</option>, <option>TITLE</option>, and <option>NUMTITLE</option>.</pd></plentry><plentry id="args.xhtml.classattr" props="base-html"><pt><parmname>args.xhtml.classattr</parmname></pt><pd id="args.xhtml.classattr.desc">Specifies whether to include the DITA class ancestry inside the XHTML elements. The allowed values are <option>yes</option> and <option>no</option>; the default value is <option>yes</option>.</pd></plentry><plentry id="args.xhtml.contenttarget" props="common-html"><pt><parmname>args.xhtml.contenttarget</parmname></pt><pd id="args.xhtml.contenttarget.desc">Specifies the value of the @target attribute on the <base> element in the TOC file.</pd></plentry><plentry id="args.xhtml.toc" props="common-html"><pt><parmname>args.xhtml.toc</parmname></pt><pd id="args.xhtml.toc.desc">Specifies the base name of the TOC file.</pd></plentry><plentry id="args.xhtml.toc.class" props="common-html"><pt><parmname>args.xhtml.toc.class</parmname></pt><pd id="args.xhtml.toc.class.desc">Specifies the value of the @class attribute on the <body> element in the TOC file.</pd></plentry><plentry id="args.xhtml.toc.xsl" props="common-html"><pt><parmname>args.xhtml.toc.xsl</parmname></pt><pd id="args.xhtml.toc.xsl.desc">Specifies a custom XSL file to be used for TOC generation.</pd></plentry><plentry id="args.xsl" props="base-html"><pt><parmname>args.xsl</parmname></pt><pd id="args.xsl.desc">Specifies a custom XSL file to be used instead of the default XSL transformation.</pd></plentry><plentry id="args.xsl.pdf" props="pdf"><pt><parmname>args.xsl.pdf</parmname></pt><pd id="args.xsl.pdf.desc">Specifies an XSL file that is used to override the default XSL transformation.</pd></plentry><plentry id="axf.opt" props="pdf"><pt><parmname>axf.opt</parmname></pt><pd id="axf.opt.desc">Specifies the user configuration file for Antenna House Formatter.</pd></plentry><plentry id="clean.temp"><pt><parmname>clean.temp</parmname></pt><pd id="clean.temp.desc">Specifies whether the DITA-OT deletes the files in the temporary directory after it finishes a build. The allowed values are <option>yes</option> and <option>no</option>; the default value is <option>yes</option>.</pd></plentry><plentry id="conserve-memory"><pt><parmname>conserve-memory</parmname></pt><pd id="conserve-memory.desc">Conserve memory at the expense of processing speed The allowed values are <option>true</option> and <option>false</option>; the default value is <option>false</option>.</pd></plentry><plentry id="custom.xep.config" props="pdf"><pt><parmname>custom.xep.config</parmname></pt><pd id="custom.xep.config.desc">Specifies the user configuration file for RenderX.</pd></plentry><plentry id="customization.dir" props="pdf"><pt><parmname>customization.dir</parmname></pt><pd id="customization.dir.desc">Specifies the customization directory.</pd></plentry><plentry id="dita.dir"><pt><parmname>dita.dir</parmname></pt><pd id="dita.dir.desc">Specifies where the DITA-OT is installed.</pd></plentry><plentry id="dita.input.valfile" importance="deprecated"><pt><parmname>dita.input.valfile</parmname></pt><pd id="dita.input.valfile.desc">Specifies a filter file to be used to include, exclude, or flag content.</pd></plentry><plentry id="dita.preprocess.reloadstylesheet.topicpull"><pt><parmname>dita.preprocess.reloadstylesheet.topicpull</parmname></pt><pd id="dita.preprocess.reloadstylesheet.topicpull.desc">Specifies whether the DITA-OT reloads the XSL style sheets that are used for the transformation. The allowed values are <option>true</option> and <option>false</option>; the default value is <option>false</option>.</pd></plentry><plentry id="dita.temp.dir"><pt><parmname>dita.temp.dir</parmname></pt><pd id="dita.temp.dir.desc">Specifies the location of the temporary directory.</pd></plentry><plentry id="filter-stage"><pt><parmname>filter-stage</parmname></pt><pd id="filter-stage.desc">Specifies whether filtering is done before all other processing, or after key and conref processing. The allowed values are <option>early</option> and <option>late</option>; the default value is <option>early</option>.</pd></plentry><plentry id="force-unique"><pt><parmname>force-unique</parmname></pt><pd id="force-unique.desc">Generate copy-to attributes to duplicate topicref elements. The allowed values are <option>true</option> and <option>false</option>; the default value is <option>false</option>.</pd></plentry><plentry id="generate-debug-attributes"><pt><parmname>generate-debug-attributes</parmname></pt><pd id="generate-debug-attributes.desc">Specifies whether the @xtrf and @xtrc debugging attributes are generated in the temporary files. The following values are supported:<ul><li><option>true</option> (default) – Enables generation of debugging attributes</li><li><option>false</option> – Disables generation of debugging attributes</li></ul></pd></plentry><plentry id="generate.copy.outer"><pt><parmname>generate.copy.outer</parmname></pt><pd id="generate.copy.outer.desc">Specifies whether to generate output files for content that is not located in or beneath the directory containing the DITA map file. The following values are supported:<ul><li><option>1</option> (default) – Do not generate output for content that is located outside the DITA map directory.</li><li><option>3</option> – Shift the output directory so that it contains all output for the publication.</li></ul></pd></plentry><plentry id="nav-toc" props="html5"><pt><parmname>nav-toc</parmname></pt><pd id="nav-toc.desc">Specifies whether to generate a navigation TOC in topic pages. The following values are supported:<ul><li><option>none</option> (default) – No TOC</li><li><option>partial</option> – Partial TOC that shows the current topic</li><li><option>full</option> – Full TOC</li></ul></pd></plentry><plentry id="onlytopic.in.map"><pt><parmname>onlytopic.in.map</parmname></pt><pd id="onlytopic.in.map.desc">Specifies whether files that are linked to, or referenced with a @conref attribute, generate output. The allowed values are <option>true</option> and <option>false</option>; the default value is <option>false</option>.</pd></plentry><plentry id="org.dita.pdf2.i18n.enabled" props="pdf"><pt><parmname>org.dita.pdf2.i18n.enabled</parmname></pt><pd id="org.dita.pdf2.i18n.enabled.desc">Enables I18N font processing. The following values are supported:<ul><li><option>true</option> (default) – Enables I18N processing</li><li><option>false</option> – Disables I18N processing</li></ul></pd></plentry><plentry id="outer.control"><pt><parmname>outer.control</parmname></pt><pd id="outer.control.desc">Specifies how the DITA-OT handles content files that are not located in or below the directory containing the master DITA map. The following values are supported:<ul><li><option>fail</option> – Fail quickly if files are going to be generated or copied outside of the directory.</li><li><option>warn</option> (default) – Complete the operation if files will be generated or copied outside of the directory, but log a warning.</li><li><option>quiet</option> – Quietly finish without generating warnings or errors.</li></ul></pd></plentry><plentry id="output.dir"><pt><parmname>output.dir</parmname></pt><pd id="output.dir.desc">Specifies the name and location of the output directory.</pd></plentry><plentry id="pdf.formatter" props="pdf"><pt><parmname>pdf.formatter</parmname></pt><pd id="pdf.formatter.desc">Specifies the XSL processor. The following values are supported:<ul><li><option>xep</option> – RenderX XEP Engine</li></ul></pd></plentry><plentry id="pdf.formatter" props="pdf"><pt><parmname>pdf.formatter</parmname></pt><pd id="pdf.formatter.desc">Specifies the XSL processor.</pd></plentry><plentry id="pdf.formatter" props="pdf"><pt><parmname>pdf.formatter</parmname></pt><pd id="pdf.formatter.desc">Specifies the XSL processor. The following values are supported:<ul><li><option>ah</option> – Antenna House Formatter</li></ul></pd></plentry><plentry id="pdf.formatter" props="pdf"><pt><parmname>pdf.formatter</parmname></pt><pd id="pdf.formatter.desc">Specifies the XSL processor. The following values are supported:<ul><li><option>fop</option> (default) – Apache FOP</li></ul></pd></plentry><plentry id="processing-mode"><pt><parmname>processing-mode</parmname></pt><pd id="processing-mode.desc">Specifies how the DITA-OT handles errors and error recovery. The following values are supported:<ul><li><option>strict</option> – When an error is encountered, the DITA-OT stops processing</li><li><option>lax</option> (default) – When an error is encountered, the DITA-OT attempts to recover from it</li><li><option>skip</option> – When an error is encountered, the DITA-OT continues processing but does not attempt error recovery</li></ul></pd></plentry><plentry id="publish.required.cleanup" props="pdf"><pt><parmname>publish.required.cleanup</parmname></pt><pd id="publish.required.cleanup.desc">Specifies whether draft-comment and required-cleanup elements are included in the output. The allowed values are <option>yes</option> and <option>no</option>.</pd></plentry><plentry id="publish.required.cleanup" props="pdf"><pt><parmname>publish.required.cleanup</parmname></pt><pd id="publish.required.cleanup.desc">Specifies whether draft-comment and required-cleanup elements are included in the output. The allowed values are <option>yes</option> and <option>no</option>.</pd></plentry><plentry id="root-chunk-override"><pt><parmname>root-chunk-override</parmname></pt><pd id="root-chunk-override.desc">Override for map chunk attribute value.</pd></plentry><plentry id="transtype" importance="required"><pt><parmname>transtype</parmname></pt><pd id="transtype.desc">Specifies the output format (transformation type).</pd></plentry><plentry id="validate"><pt><parmname>validate</parmname></pt><pd id="validate.desc">Specifies whether the DITA-OT validates the content. The allowed values are <option>true</option> and <option>false</option>; the default value is <option>true</option>.</pd></plentry></parml></section></refbody></reference></reference>
|
