| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757 |
- <?xml version="1.0" encoding="UTF-8"?>
- <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
- <!--This file is part of the DITA Open Toolkit project. See the accompanying LICENSE.md file for applicable licenses.-->
- <reference id="ant-parameters-details">
- <title>Ant parameter details</title>
- <reference id="base">
- <title>All transformations</title>
- <titlealts>
- <navtitle>All transformations</navtitle>
- </titlealts>
- <shortdesc conaction="pushreplace" conref="parameters-base.dita#base/shortdesc">Certain parameters apply to all
- transformations that are supported by the DITA Open Toolkit.</shortdesc>
- <refbody>
- <section>
- <parml>
- <!--<plentry id="args.debug">
- <pt><parmname>args.debug</parmname></pt>
- <pd conaction="mark" conref="parameters-base.dita#base/args.debug.desc"/>
- <pd conaction="pushafter">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.draft">
- <pt>
- <parmname>args.draft</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base.dita#base/args.draft.desc"/>
- <pd conaction="pushafter" audience="xslt-customizer">Corresponds to the XSLT parameter
- <parmname>DRAFT</parmname> in most XSLT modules.<note type="tip">For PDF output, setting the
- <parmname>args.draft</parmname> parameter to <option>yes</option> causes the contents of the
- <xmlelement>titlealts</xmlelement> element to be rendered below the title.</note>
- </pd>
- </plentry>
- <plentry id="args.figurelink.style">
- <pt>
- <parmname>args.figurelink.style</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base.dita#base/args.figurelink.style.desc"/>
- <pd conaction="pushafter">Specifying <option>NUMBER</option> results in "Figure 5"; specifying
- <option>TITLE</option> results in the title of the figure. <ph audience="xslt-customizer">Corresponds to
- the XSLT parameter <parmname>FIGURELINK</parmname>.</ph><note rev="2.0">Support for PDF was added in
- DITA-OT 2.0. By default PDF uses the value <option>NUMTITLE</option>, which is not supported for other
- transformation types; this results in "Figure 5. Title".</note></pd>
- </plentry>
- <!--<plentry id="args.filter" rev="1.6">
- <pt><parmname>args.filter</parmname></pt>
- <pd conaction="mark" conref="parameters-base.dita#base/args.filter.desc"/>
- <pd conaction="pushafter">Specifies a filter file to be used to include, exclude, or flag content.</pd>
- </plentry>-->
- <plentry id="args.grammar.cache">
- <pt>
- <parmname>args.grammar.cache</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base.dita#base/args.grammar.cache.desc"/>
- <pd conaction="pushafter">
- <note>This option dramatically speeds up processing time. However, there is a known problem with using
- this feature for documents that use XML entities. If your build fails with parser errors about entity
- resolution, set this parameter to <option>no</option>.</note>
- </pd>
- </plentry>
- <plentry id="args.input">
- <pt>
- <parmname>args.input</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base.dita#base/args.input.desc"/>
- <pd conaction="pushafter">Typically this is a DITA map, however it also can be a DITA topic if you want to
- transform a single DITA file. The path can be absolute, relative to <parmname>args.input.dir</parmname>,
- or relative to the directory where your project's ant build script resides if
- <parmname>args.input.dir</parmname> is not defined. </pd>
- </plentry>
- <plentry id="args.input.dir">
- <pt>
- <parmname>args.input.dir</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base.dita#base/args.input.dir.desc"/>
- <pd conaction="pushafter">The default value is the parent directory of the file specified by
- <parmname>args.input</parmname>.</pd>
- </plentry>
- <!--<plentry id="args.logdir">
- <pt><parmname>args.logdir</parmname></pt>
- <pd conaction="mark" conref="parameters-base.dita#base/args.logdir.desc"/>
- <pd conaction="pushafter">Specifies the location where the DITA-OT places log files for your project.</pd>
- </plentry>-->
- <!--<plentry conref="conref-dita-ot-parameters.dita#conref-dita-ot-parameters/args.rellinks">
- <pt/>
- <pd/>
- </plentry>-->
- <plentry id="args.tablelink.style">
- <pt>
- <parmname>args.tablelink.style</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base.dita#base/args.tablelink.style.desc"/>
- <pd conaction="pushafter">Specifying <option>NUMBER</option> results in "Table 5"; specifying
- <option>TITLE</option> results in the title of the table. <ph audience="xslt-customizer">Corresponds to
- the XSLT parameter <parmname>TABLELINK</parmname>.</ph><note rev="2.0">Support for PDF was added in
- DITA-OT 2.0. By default PDF uses the value <option>NUMTITLE</option>, which is not supported for other
- transformation types; this results in "Table 5. Title".</note></pd>
- </plentry>
- <plentry id="cleantemp">
- <pt>
- <parmname>clean.temp</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base.dita#base/clean.temp.desc"/>
- <pd conaction="pushafter"/>
- </plentry>
- <!--<plentry id="dita.dir">
- <pt><parmname>dita.dir</parmname></pt>
- <pd conaction="mark" conref="parameters-base.dita#base/dita.dir.desc"/>
- <pd conaction="pushafter">Specifies where the DITA-OT is installed.</pd>
- </plentry>-->
- <plentry id="dita.temp.dir">
- <pt>
- <parmname>dita.temp.dir</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base.dita#base/dita.temp.dir.desc"/>
- <pd conaction="pushafter">The temporary directory is where the DITA-OT writes temporary files that are
- generated during the transformation process.</pd>
- </plentry>
- <plentry id="dita.input.valfile" importance="deprecated">
- <pt>
- <parmname>dita.input.valfile</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base.dita#base/dita.input.valfile.desc"/>
- <pd conaction="pushafter">
- <note type="notice">Deprecated in favor of the <parmname>args.filter</parmname> parameter.</note>
- </pd>
- </plentry>
- <plentry id="filter-stage">
- <pt>
- <parmname>filter-stage</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base.dita#base/filter-stage.desc"/>
- <pd conaction="pushafter">
- <note>Changing the filtering stage may produce different results for the same initial data set and
- filtering conditions.</note>
- </pd>
- </plentry>
- <plentry id="force-unique">
- <pt>
- <parmname>force-unique</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base.dita#base/force-unique.desc"/>
- <pd conaction="pushafter">
- <draft-comment author="jelovirt">This needs a better and longer description.</draft-comment>
- </pd>
- </plentry>
- <plentry id="generate-debug-attributes">
- <pt>
- <parmname>generate-debug-attributes</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base.dita#base/generate-debug-attributes.desc"/>
- <pd conaction="pushafter">
- <note>Disabling debugging attributes reduces the size of temporary files and thus reduces memory
- consumption. However, the log messages no longer have the source information available and thus the
- ability to debug problems might deteriorate.</note>
- </pd>
- </plentry>
- <plentry id="generate.copy.outer">
- <pt>
- <parmname>generate.copy.outer</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base.dita#base/generate.copy.outer.desc"/>
- <pd conaction="pushafter">
- <p>See <xref keyref="generate-copy-outer"/> for more information.</p>
- </pd>
- </plentry>
- <plentry id="onlytopic.in.map">
- <pt>
- <parmname>onlytopic.in.map</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base.dita#base/onlytopic.in.map.desc"/>
- <pd conaction="pushafter">If set to <option>true</option>, only files that are referenced directly from the
- map will generate output; the default value is <option>false</option>.</pd>
- </plentry>
- <plentry id="outer.control">
- <pt>
- <parmname>outer.control</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base.dita#base/outer.control.desc"/>
- <pd conaction="pushafter">
- <note type="warning" platform="windows">Microsoft HTML Help Compiler cannot produce HTML Help for
- documentation projects that use outer content. The content files must reside in or below the directory
- containing the master DITA map file, and the map file cannot specify ".." at the start of the
- <xmlatt>href</xmlatt> attributes for <xmlelement>topicref</xmlelement> elements.</note>
- </pd>
- </plentry>
- <plentry id="output.dir">
- <pt>
- <parmname>output.dir</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base.dita#base/output.dir.desc"/>
- <pd conaction="pushafter">By default, the output is written to
- <filepath><varname>DITA-dir</varname>/out</filepath>.</pd>
- </plentry>
- <!--<plentry id="processing-mode">
- <pt><parmname>processing-mode</parmname></pt>
- <pd conaction="mark" conref="parameters-base.dita#base/processing-mode"/>
- <pd conaction="pushafter"/>
- </plentry>-->
- <!--<plentry id="root-chunk-override">
- <pt><parmname>root-chunk-override</parmname></pt>
- <pd conaction="mark" conref="parameters-base.dita#base/root-chunk-override.desc"/>
- <pd conaction="pushafter">Override for map chunk attribute value.</pd>
- </plentry>-->
- <plentry id="transtype">
- <pt>
- <parmname>transtype</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base.dita#base/transtype.desc"/>
- <pd conaction="pushafter">You can create plug-ins to add new values for this parameter; by default, the
- following values are available:
- <ul>
- <li>docbook</li>
- <li>eclipsehelp</li>
- <li>eclipsecontent</li>
- <li>html5</li>
- <li platform="windows">htmlhelp</li>
- <li>javahelp</li>
- <li>odt</li>
- <li>pdf</li>
- <li>wordrtf</li>
- <li>troff</li>
- <li>xhtml</li>
- </ul>
- </pd>
- </plentry>
- <!--<plentry id="validate">
- <pt><parmname>validate</parmname></pt>
- <pd conaction="mark" conref="parameters-base.dita#base/validate.desc"/>
- <pd conaction="pushafter">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 id="base-html">
- <title>HTML-based output formats</title>
- <titlealts>
- <navtitle>All HTML-based transformations</navtitle>
- </titlealts>
- <shortdesc conaction="pushreplace" conref="parameters-base-html.dita#base-html/shortdesc">Certain parameters apply
- to all the HTML-based transformation types: Eclipse help, HTML Help, JavaHelp, TocJS, HTML5, and XHTML. </shortdesc>
- <refbody>
- <section>
- <parml>
- <!--<plentry id="args.artlbl">
- <pt><parmname>args.artlbl</parmname></pt>
- <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.artlbl.desc"/>
- <pd conaction="pushafter">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.breadcrumbs">
- <pt>
- <parmname>args.breadcrumbs</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.breadcrumbs.desc"/>
- <pd conaction="pushafter" audience="xslt-customizer">Corresponds to the XSLT parameter
- <parmname>BREADCRUMBS</parmname>.</pd>
- </plentry>
- <!--<plentry id="args.copycss">
- <pt><parmname>args.copycss</parmname></pt>
- <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.copycss.desc"/>
- <pd conaction="pushafter">Specifies whether to copy the custom .css file to the output directory.</pd>
- </plentry>-->
- <!--<plentry id="args.css">
- <pt><parmname>args.css</parmname></pt>
- <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.css.desc"/>
- <pd conaction="pushafter">Specifies the name of a custom .css file.</pd>
- </plentry>-->
- <plentry id="args.csspath">
- <pt>
- <parmname>args.csspath</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.csspath.desc"/>
- <pd conaction="pushafter" audience="xslt-customizer">Corresponds to the XSLT parameter
- <parmname>CSSPATH</parmname>. DITA-OT will copy the file to this location.</pd>
- </plentry>
- <plentry id="args.cssroot">
- <pt>
- <parmname>args.cssroot</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.cssroot.desc"/>
- <pd conaction="pushafter">DITA-OT will copy the file from this location.</pd>
- </plentry>
- <plentry id="args.dita.locale">
- <pt>
- <parmname>args.dita.locale</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.dita.locale.desc"/>
- <pd conaction="pushafter">
- <note>This parameter is not available for the XHTML transformation.</note>
- </pd>
- </plentry>
- <plentry id="args.ftr">
- <pt>
- <parmname>args.ftr</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.ftr.desc"/>
- <pd conaction="pushafter">
- <ph audience="xslt-customizer">Corresponds to the XSLT parameter <parmname>FTR</parmname>.</ph>
- <note>The footer file should be specified using an absolute path and must contain valid XML. A common
- practice is to place all content into a <xmlelement>div</xmlelement> element.</note>
- </pd>
- </plentry>
- <plentry id="args.gen.default.meta">
- <pt>
- <parmname>args.gen.default.meta</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.gen.default.meta.desc"/>
- <pd conaction="pushafter" audience="xslt-customizer">Corresponds to the XSLT parameter
- <parmname>genDefMeta</parmname>.</pd>
- </plentry>
- <plentry conref="conref-dita-ot-parameters.dita#conref-dita-ot-parameters/args.gen.task.lbl">
- <pt/>
- <pd/>
- </plentry>
- <plentry id="args.hdf">
- <pt><parmname>args.hdf</parmname></pt>
- <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.hdf.desc"/>
- <pd conaction="pushafter">
- <p>The contents of the header file will be inserted in the <xmlelement>head</xmlelement> element of the
- generated HTML files.</p>
- <note type="tip">The header file should be specified using an absolute path and must contain valid XML. If
- you need to insert more than one element into the HTML page head, wrap the content in a
- <xmlelement>div</xmlelement> element. The division wrapper in the header file will be discarded when
- generating HTML files, and the contents will be inserted into each page head.</note></pd>
- </plentry>
- <plentry id="args.hdr">
- <pt>
- <parmname>args.hdr</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.hdr.desc"/>
- <pd conaction="pushafter">
- <ph audience="xslt-customizer">Corresponds to the XSLT parameter <parmname>HDR</parmname>.</ph>
- <note>The header file should be specified using an absolute path and must contain valid XML. A common
- practice is to place all content into a <xmlelement>div</xmlelement> element.</note>
- </pd>
- </plentry>
- <plentry id="args.hide.parent.link" importance="deprecated">
- <pt>
- <parmname>args.hide.parent.link</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.hide.parent.link.desc"/>
- <pd conaction="pushafter">
- <ph audience="xslt-customizer">Corresponds to the XSLT parameter <parmname>NOPARENTLINK</parmname>.</ph>
- <note type="notice">This parameter is deprecated in favor of the <parmname>args.rellinks</parmname>
- parameter.</note>
- </pd>
- </plentry>
- <!--<plentry id="args.indexshow">
- <pt><parmname>args.indexshow</parmname></pt>
- <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.indexshow.desc"/>
- <pd conaction="pushafter">Specifies whether the content of <xmlelement>indexterm</xmlelement> 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.outext">
- <pt>
- <parmname>args.outext</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.outext.desc"/>
- <pd conaction="pushafter">
- <ph audience="xslt-customizer">Corresponds to the XSLT parameter <parmname>OUTEXT</parmname>.</ph>
- </pd>
- </plentry>
- <plentry id="args.xhtml.classattr">
- <pt>
- <parmname>args.xhtml.classattr</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.xhtml.classattr.desc"/>
- <pd conaction="pushafter">For example, the <xmlelement>prereq</xmlelement> element (which is specialized
- from <xmlelement>section</xmlelement>) would generate <codeph>class="section prereq"</codeph>. <ph
- audience="xslt-customizer">Corresponds to the XSLT parameter
- <parmname>PRESERVE-DITA-CLASS</parmname>.</ph><note>Beginning with DITA OT release 1.5.2, the default
- value is <option>yes</option>. For release 1.5 and 1.5.1, the default value was <option>no</option>.
- </note></pd>
- </plentry>
- <plentry id="args.xsl">
- <pt>
- <parmname>args.xsl</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-base-html.dita#base-html/args.xsl.desc"/>
- <pd conaction="pushafter">The parameter must specify a fully qualified file name.</pd>
- </plentry>
- </parml>
- </section>
- </refbody>
- </reference>
- <reference id="eclipsecontent">
- <title>Eclipse content</title>
- <titlealts>
- <navtitle>Eclipse content</navtitle>
- </titlealts>
- <shortdesc conaction="pushreplace" conref="parameters-eclipsecontent.dita#eclipsecontent/shortdesc">Certain
- parameters are specific to the Eclipse content transformation.</shortdesc>
- <refbody>
- <section>
- <parml>
- <plentry id="args.eclipsecontent.toc">
- <pt>
- <parmname>args.eclipsecontent.toc</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-eclipsecontent.dita#eclipsecontent/args.eclipse.version.desc"/>
- <pd conaction="pushafter">
- <note type="tip">The toolkit ignores the value of this property when processing an Eclipse Collection Map,
- eclipse.dtd.</note>
- </pd>
- </plentry>
- </parml>
- </section>
- </refbody>
- </reference>
- <reference id="eclipsehelp">
- <title>Eclipse help</title>
- <titlealts>
- <navtitle>Eclipse help</navtitle>
- </titlealts>
- <shortdesc conaction="pushreplace" conref="parameters-eclipsehelp.dita#eclipsehelp/shortdesc">Certain parameters are
- specific to the Eclipse help transformation.</shortdesc>
- <refbody>
- <section>
- <parml>
- <!--<plentry id="args.eclipsehelp.toc">
- <pt><parmname>args.eclipsehelp.toc</parmname></pt>
- <pd conaction="mark" conref="parameters-eclipsehelp.dita#eclipsehelp/args.eclipsehelp.toc.desc"/>
- <pd conaction="pushafter">Specifies the name of the TOC file.</pd>
- </plentry>-->
- <plentry id="args.eclipsehelp.country">
- <pt>
- <parmname>args.eclipsehelp.country</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-eclipsehelp.dita#eclipsehelp/args.eclipsehelp.country.desc"/>
- <pd conaction="pushafter">For example, <option>us</option>, <option>ca</option>, and <option>gb</option>
- would clarify a value of <option>en</option> set for the <parmname>args.eclipsehelp.language</parmname>
- parameter. The content will be moved into the appropriate directory structure for an Eclipse
- fragment.<draft-comment author="Kristen James Eberlein" time="11 August 2012">What does "The content
- will be moved into the appropriate directory structure for an Eclipse fragment"
- mean?</draft-comment></pd>
- </plentry>
- <plentry id="args.eclipsehelp.language">
- <pt>
- <parmname>args.eclipsehelp.language</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-eclipsehelp.dita#eclipsehelp/args.eclipsehelp.language.desc"/>
- <pd conaction="pushafter">This parameter is a prerequisite for the
- <parmname>args.eclipsehelp.country</parmname> parameter. The content will be moved into the appropriate
- directory structure for an Eclipse fragment.</pd>
- </plentry>
- <plentry id="args.eclipse.provider">
- <pt>
- <parmname>args.eclipse.provider</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-eclipsehelp.dita#eclipsehelp/args.eclipse.provider.desc"/>
- <pd conaction="pushafter">The default value is <option>DITA</option>. <note type="tip">The toolkit ignores
- the value of this parameter when it processes an Eclipse map.</note>
- </pd>
- </plentry>
- <plentry id="args.eclipse.version">
- <pt>
- <parmname>args.eclipse.version</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-eclipsehelp.dita#eclipsehelp/args.eclipse.version.desc"/>
- <pd conaction="pushafter">The default value is <option>0.0.0</option>.<note type="tip">The toolkit ignores
- the value of this parameter when it processes an Eclipse map.</note></pd>
- </plentry>
- <plentry id="args.eclipse.symbolic.name">
- <pt>
- <parmname>args.eclipse.symbolic.name</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-eclipsehelp.dita#eclipsehelp/args.eclipse.symbolic.name.desc"/>
- <pd conaction="pushafter">
- <!-- Specifies the symbolic name (aka plugin ID) in the output for an Eclipse Help project. -->The
- <xmlatt>id</xmlatt> value from the DITA map or the Eclipse map collection (Eclipse help specialization)
- is the symbolic name for the plugin in Eclipse. The default value is
- <option>org.sample.help.doc</option>.<note type="tip">The toolkit ignores the value of this parameter
- when it processes an Eclipse map.</note><draft-comment author="Kristen James Eberlein"
- time="11 August 2012">I'm not clear what this means. Is the default value for the
- <parmname>args.eclipse.symbolic.name</parmname> parameter the value of the <xmlatt>id</xmlatt>
- attribute on the <xmlelement>map</xmlelement> or <xmlelement>plugin</xmlelement> element, if provided,
- and the <option>org.sample.help.doc</option> if there is not a value for the <xmlatt>id</xmlatt>
- attribute or the <parmname>args.eclipse.symbolic.name</parmname> parameter?</draft-comment></pd>
- </plentry>
- </parml>
- </section>
- </refbody>
- </reference>
- <reference id="htmlhelp">
- <title>HTML Help</title>
- <titlealts>
- <navtitle>HTML Help</navtitle>
- </titlealts>
- <shortdesc conaction="pushreplace" conref="parameters-htmlhelp.dita#htmlhelp/shortdesc">Certain parameters are
- specific to the HTML Help transformation.</shortdesc>
- <refbody>
- <section>
- <!--<parml>
- <plentry id="args.htmlhelp.includefile">
- <pt><parmname>args.htmlhelp.includefile</parmname></pt>
- <pd conaction="mark" conref="parameters-htmlhelp.dita#htmlhelp/args.htmlhelp.includefile.desc"/>
- <pd conaction="pushafter">Specifies the name of a file that you want included in the HTML Help.</pd>
- </plentry>
- </parml>-->
- </section>
- </refbody>
- </reference>
- <reference id="javahelp">
- <title>JavaHelp</title>
- <titlealts>
- <navtitle>JavaHelp</navtitle>
- </titlealts>
- <shortdesc conaction="pushreplace" conref="parameters-javahelp.dita#javahelp/shortdesc">Certain parameters are
- specific to the JavaHelp transformation.</shortdesc>
- <refbody>
- <section>
- <parml>
- <plentry id="args.javahelp.map">
- <pt>
- <parmname>args.javahelp.map</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-javahelp.dita#javahelp/args.javahelp.map.desc"/>
- <pd conaction="pushafter">
- <draft-comment author="Kristen James Eberlein" time="11 August 2012">What does this mean? How does this
- differ from the <parmname>args.input</parmname> parameter? Or should this read "Specifies the name of
- the JavaHelp map file?</draft-comment>
- </pd>
- </plentry>
- <plentry id="args.javahelp.toc">
- <pt>
- <parmname>args.javahelp.toc</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-javahelp.dita#javahelp/args.javahelp.toc.desc"/>
- <pd conaction="pushafter">Default value is the name of the ditamap file for your project. <draft-comment
- author="Kristen James Eberlein" time="11 August 2012">I assume that the first sentence means "Specifies
- the name of the JavaHelp TOC file." But what does the second sentence mean? That the default value for
- the <parmname>args.javahelp.toc</parmname> parameter is the name of the master DITA map? Or that the
- default value for the <parmname>args.javahelp.toc</parmname> parameter is the value of the
- <parmname>args.javahelp.map</parmname> parameter?</draft-comment></pd>
- </plentry>
- </parml>
- </section>
- </refbody>
- </reference>
- <reference id="odt">
- <title>ODT</title>
- <titlealts>
- <navtitle>ODT</navtitle>
- </titlealts>
- <shortdesc conaction="pushreplace" conref="parameters-odt.dita#odt/shortdesc">Certain parameters are specific to the
- ODT transformation.</shortdesc>
- <refbody>
- <section>
- <!--<parml>
- <plentry>
- <pt><parmname>args.odt.img.embed</parmname></pt>
- <pd conaction="mark" conref="parameters-odt.dita#odt/args.odt.img.embed.desc"/>
- <pd conaction="pushafter">Determines whether images are embedded as binary objects within the ODT file.
- </pd>
- </plentry>
- </parml>-->
- </section>
- </refbody>
- </reference>
- <reference id="ant-parameters-other">
- <title>Other parameters</title>
- <titlealts>
- <navtitle>Other</navtitle>
- </titlealts>
- <shortdesc>These parameters enable you to reload style sheets that the DITA-OT uses for specific pre-processing
- stages.</shortdesc>
- <refbody>
- <section>
- <draft-comment author="Kristen James Eberlein" time="11 August 2012">I've made no attempt to work with the
- content in the topic. Here's what I'd like to know:
- <ul>
- <li>When would someone want to use the various <parmname>dita.preprocess</parmname> parameters? (Other than
- if they need to reduce Java memory consumption.) The use cases are not clear from the current
- description.</li>
- </ul>
- </draft-comment>
- <!--<parml>
- <plentry>
- <pt id="dita.preprocess.reloadstylesheet"><parmname>dita.preprocess.reloadstylesheet</parmname></pt>
- <pt id="dita.preprocess.reloadstylesheet.conref">
- <parmname>dita.preprocess.reloadstylesheet.conref</parmname>
- </pt>
- <pt id="dita.preprocess.reloadstylesheet.mapref">
- <parmname>dita.preprocess.reloadstylesheet.mapref</parmname>
- </pt>
- <pt id="dita.preprocess.reloadstylesheet.mappull">
- <parmname>dita.preprocess.reloadstylesheet.mappull</parmname>
- </pt>
- <pt id="dita.preprocess.reloadstylesheet.maplink">
- <parmname>dita.preprocess.reloadstylesheet.maplink</parmname>
- </pt>
- <pt id="dita.preprocess.reloadstylesheet.topicpull">
- <parmname>dita.preprocess.reloadstylesheet.topicpull</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-other.dita#other/dita.preprocess.reloadstylesheet.desc"/>
- <pd conaction="pushafter">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>.<note type="tip">Set the parameter to <option>true</option> if you want to use
- more than one set of style sheets to process a collection of topics. The parameter also is useful for
- large projects that generate Java out-of-memory errors during transformation. Alternatively, you can
- adjust the size of your Java memory heap if setting <codeph>dita.preprocess.reloadstylesheet</codeph>
- for this reason.</note></pd>
- </plentry>
- </parml>-->
- </section>
- </refbody>
- </reference>
- <reference id="pdf">
- <title>PDF</title>
- <titlealts>
- <navtitle>PDF</navtitle>
- </titlealts>
- <shortdesc conaction="pushreplace" conref="parameters-pdf.dita#pdf/shortdesc">Certain parameters are specific to the
- PDF transformation.</shortdesc>
- <refbody>
- <section>
- <parml>
- <!--<plentry id="args.bookmap-order" rev="1.5.4">
- <pt><parmname>args.bookmap-order</parmname></pt>
- <pd conaction="mark" conref="parameters-pdf.dita#pdf/args.bookmap-order.desc"/>
- <pd conaction="pushafter">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">
- <pt><parmname>args.bookmark.style</parmname></pt>
- <pd conaction="mark" conref="parameters-pdf.dita#pdf/args.bookmark.style.desc"/>
- <pd conaction="pushafter">Specifies whether PDF bookmarks are by default expanded or collapsed. The allowed
- values are <option>COLLAPSED</option> and <option>EXPANDED</option>, the default value is
- <option>COLLAPSE</option>.</pd>
- </plentry>-->
- <!--<plentry id="args.chapter.layout">
- <pt><parmname>args.chapter.layout</parmname></pt>
- <pd conaction="mark" conref="parameters-pdf.dita#pdf/args.chapter.layout.desc"/>
- <pd conaction="pushafter">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 conref="conref-dita-ot-parameters.dita#conref-dita-ot-parameters/args.fo.userconfig">
- <pt/>
- <pd/>
- </plentry>
- <plentry conref="conref-dita-ot-parameters.dita#conref-dita-ot-parameters/args.gen.task.lbl">
- <pt/>
- <pd/>
- </plentry>
- <plentry conref="conref-dita-ot-parameters.dita#conref-dita-ot-parameters/args.rellinks">
- <pt/>
- <pd/>
- </plentry>
- <plentry id="args.xsl.pdf">
- <pt>
- <parmname>args.xsl.pdf</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-pdf.dita#pdf/args.xsl.pdf.desc"/>
- <pd conaction="pushafter">You must specify the fully qualified file name.</pd>
- </plentry>
- <!--<plentry id="custom.xep.config">
- <pt><parmname>custom.xep.config</parmname></pt>
- <pd conaction="mark" conref="parameters-pdf.dita#pdf/custom.xep.config.desc"/>
- <pd conaction="pushafter">Specifies the user configuration file for RenderX.</pd>
- </plentry>-->
- <!--<plentry id="customization.dir" audience="xslt-customizer">
- <pt><parmname>customization.dir</parmname></pt>
- <pd>Specifies the customization directory.</pd>
- </plentry>-->
- <plentry id="pdf.formatter">
- <pt>
- <parmname>pdf.formatter</parmname>
- </pt>
- <pd>The client package comes with Apache FOP; other XSL processors must be separately installed.</pd>
- </plentry>
- <plentry id="publish.required.cleanup" importance="deprecated">
- <pt>
- <parmname>publish.required.cleanup</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-pdf.dita#pdf/publish.required.cleanup.desc"/>
- <pd conaction="pushafter">The default value is the value of the <parmname>args.draft</parmname> parameter.
- <ph audience="xslt-customizer">Corresponds to the XSLT parameter
- <parmname>publishRequiredCleanup</parmname>.</ph><note type="notice">This parameter is deprecated in
- favor of the <parmname>args.draft</parmname> parameter.</note></pd>
- </plentry>
- </parml>
- </section>
- </refbody>
- </reference>
- <reference id="common-html">
- <title>HTML5 and XHTML</title>
- <titlealts>
- <navtitle>HTML5 and XHTML</navtitle>
- </titlealts>
- <shortdesc conaction="pushreplace" conref="parameters-common-html.dita#common-html/shortdesc">Certain parameters are
- specific to the HTML5 and XHTML transformations.</shortdesc>
- <refbody>
- <section>
- <parml>
- <plentry id="args.xhtml.contenttarget">
- <pt>
- <parmname>args.xhtml.contenttarget</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-common-html.dita#common-html/args.xhtml.contenttarget.desc"/>
- <pd conaction="pushafter">The default value is <option>contentwin</option>.</pd>
- </plentry>
- <!--<plentry id="args.xhtml.toc">
- <pt><parmname>args.xhtml.toc</parmname></pt>
- <pd conaction="mark" conref="parameters-common-html.dita#common-html/args.xhtml.toc.desc"/>
- <pd conaction="pushafter">Specifies the base name of the TOC file. The default value is
- <option>index</option>.</pd>
- </plentry>-->
- <plentry id="args.xhtml.toc.class">
- <pt>
- <parmname>args.xhtml.toc.class</parmname>
- </pt>
- <pd conaction="mark" conref="parameters-common-html.dita#common-html/args.xhtml.toc.class.desc"/>
- <pd conaction="pushafter">
- <ph audience="xslt-customizer">Found in <filepath>map2htmltoc.xsl</filepath>.</ph>
- </pd>
- </plentry>
- </parml>
- </section>
- </refbody>
- </reference>
- <reference id="html5">
- <title>HTML5 parameters</title>
- <titlealts>
- <navtitle>HTML5</navtitle>
- </titlealts>
- <shortdesc conaction="pushreplace" conref="parameters-html5.dita#html5/shortdesc">Certain parameters are specific to
- the HTML5 transformation.</shortdesc>
- <refbody>
- <!--<section>
- <parml>
- <plentry id="args.html5.nav-toc">
- <pt><parmname>args.html5.nav-toc</parmname></pt>
- <pd conaction="mark" conref="parameters-html5.dita#html5/args.html5.nav-toc.desc"/>
- <pd conaction="pushafter"/>
- </plentry>
- </parml>
- </section>-->
- </refbody>
- </reference>
- </reference>
|