| 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="base"><title outputclass="generated">Common parameters</title><titlealts><navtitle>Common</navtitle></titlealts><shortdesc id="shortdesc"/><refbody><section><parml><plentry id="args.debug" importance="deprecated"><pt><parmname>args.debug</parmname><ph><indexterm><parmname>args.debug</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.debug</parmname></indexterm></indexterm></ph><ph><indexterm>deprecated features<indexterm>parameters<indexterm><parmname>args.debug</parmname></indexterm></indexterm></indexterm></ph></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.draft"><pt><parmname>args.draft</parmname><ph><indexterm><parmname>args.draft</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.draft</parmname></indexterm></indexterm></ph></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.figurelink.style"><pt><parmname>args.figurelink.style</parmname><ph><indexterm><parmname>args.figurelink.style</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.figurelink.style</parmname></indexterm></indexterm></ph></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><ph><indexterm><parmname>args.filter</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.filter</parmname></indexterm></indexterm></ph></pt><pd id="args.filter.desc">Specifies a filter file to be used to include, exclude, or flag content.</pd></plentry><plentry id="args.gen.task.lbl"><pt><parmname>args.gen.task.lbl</parmname><ph><indexterm><parmname>args.gen.task.lbl</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.gen.task.lbl</parmname></indexterm></indexterm></ph></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><ph><indexterm><parmname>args.grammar.cache</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.grammar.cache</parmname></indexterm></indexterm></ph></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.input" importance="required"><pt><parmname>args.input</parmname><ph><indexterm><parmname>args.input</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.input</parmname></indexterm></indexterm></ph></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><ph><indexterm><parmname>args.input.dir</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.input.dir</parmname></indexterm></indexterm></ph></pt><pd id="args.input.dir.desc">Specifies the base directory for your documentation project.</pd></plentry><plentry id="args.logdir" importance="deprecated"><pt><parmname>args.logdir</parmname><ph><indexterm><parmname>args.logdir</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.logdir</parmname></indexterm></indexterm></ph><ph><indexterm>deprecated features<indexterm>parameters<indexterm><parmname>args.logdir</parmname></indexterm></indexterm></indexterm></ph></pt><pd id="args.logdir.desc">Specifies the location where DITA-OT places log files for your project.</pd></plentry><plentry id="args.output.base"><pt><parmname>args.output.base</parmname><ph><indexterm><parmname>args.output.base</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.output.base</parmname></indexterm></indexterm></ph></pt><pd id="args.output.base.desc">Specifies the name of the output file without file extension.</pd></plentry><plentry id="args.rellinks"><pt><parmname>args.rellinks</parmname><ph><indexterm><parmname>args.rellinks</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.rellinks</parmname></indexterm></indexterm></ph></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><ph><indexterm><parmname>args.tablelink.style</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.tablelink.style</parmname></indexterm></indexterm></ph></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="clean.temp"><pt><parmname>clean.temp</parmname><ph><indexterm><parmname>clean.temp</parmname></indexterm><indexterm>parameters<indexterm><parmname>clean.temp</parmname></indexterm></indexterm></ph></pt><pd id="clean.temp.desc">Specifies whether 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><ph><indexterm><parmname>conserve-memory</parmname></indexterm><indexterm>parameters<indexterm><parmname>conserve-memory</parmname></indexterm></indexterm></ph></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="default.language"><pt><parmname>default.language</parmname><ph><indexterm><parmname>default.language</parmname></indexterm><indexterm>parameters<indexterm><parmname>default.language</parmname></indexterm></indexterm></ph></pt><pd id="default.language.desc">Specifies the default language for source documents.</pd></plentry><plentry id="dita.dir"><pt><parmname>dita.dir</parmname><ph><indexterm><parmname>dita.dir</parmname></indexterm><indexterm>parameters<indexterm><parmname>dita.dir</parmname></indexterm></indexterm></ph></pt><pd id="dita.dir.desc">Specifies where DITA-OT is installed.</pd></plentry><plentry id="dita.input.valfile" importance="deprecated"><pt><parmname>dita.input.valfile</parmname><ph><indexterm><parmname>dita.input.valfile</parmname></indexterm><indexterm>parameters<indexterm><parmname>dita.input.valfile</parmname></indexterm></indexterm></ph><ph><indexterm>deprecated features<indexterm>parameters<indexterm><parmname>dita.input.valfile</parmname></indexterm></indexterm></indexterm></ph></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.temp.dir"><pt><parmname>dita.temp.dir</parmname><ph><indexterm><parmname>dita.temp.dir</parmname></indexterm><indexterm>parameters<indexterm><parmname>dita.temp.dir</parmname></indexterm></indexterm></ph></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><ph><indexterm><parmname>filter-stage</parmname></indexterm><indexterm>parameters<indexterm><parmname>filter-stage</parmname></indexterm></indexterm></ph></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><ph><indexterm><parmname>force-unique</parmname></indexterm><indexterm>parameters<indexterm><parmname>force-unique</parmname></indexterm></indexterm></ph></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><ph><indexterm><parmname>generate-debug-attributes</parmname></indexterm><indexterm>parameters<indexterm><parmname>generate-debug-attributes</parmname></indexterm></indexterm></ph></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><ph><indexterm><parmname>generate.copy.outer</parmname></indexterm><indexterm>parameters<indexterm><parmname>generate.copy.outer</parmname></indexterm></indexterm></ph></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="link-crawl"><pt><parmname>link-crawl</parmname><ph><indexterm><parmname>link-crawl</parmname></indexterm><indexterm>parameters<indexterm><parmname>link-crawl</parmname></indexterm></indexterm></ph></pt><pd id="link-crawl.desc">Specifies whether to crawl only those topic links found in maps, or all discovered topic links. The allowed values are <option>map</option> and <option>topic</option>; the default value is <option>topic</option>.</pd></plentry><plentry id="onlytopic.in.map"><pt><parmname>onlytopic.in.map</parmname><ph><indexterm><parmname>onlytopic.in.map</parmname></indexterm><indexterm>parameters<indexterm><parmname>onlytopic.in.map</parmname></indexterm></indexterm></ph></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="outer.control"><pt><parmname>outer.control</parmname><ph><indexterm><parmname>outer.control</parmname></indexterm><indexterm>parameters<indexterm><parmname>outer.control</parmname></indexterm></indexterm></ph></pt><pd id="outer.control.desc">Specifies how 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><ph><indexterm><parmname>output.dir</parmname></indexterm><indexterm>parameters<indexterm><parmname>output.dir</parmname></indexterm></indexterm></ph></pt><pd id="output.dir.desc">Specifies the name and location of the output directory.</pd></plentry><plentry id="processing-mode"><pt><parmname>processing-mode</parmname><ph><indexterm><parmname>processing-mode</parmname></indexterm><indexterm>parameters<indexterm><parmname>processing-mode</parmname></indexterm></indexterm></ph></pt><pd id="processing-mode.desc">Specifies how DITA-OT handles errors and error recovery. The following values are supported:<ul><li><option>strict</option> – When an error is encountered, DITA-OT stops processing</li><li><option>lax</option> (default) – When an error is encountered, DITA-OT attempts to recover from it</li><li><option>skip</option> – When an error is encountered, DITA-OT continues processing but does not attempt error recovery</li></ul></pd></plentry><plentry id="remove-broken-links"><pt><parmname>remove-broken-links</parmname><ph><indexterm><parmname>remove-broken-links</parmname></indexterm><indexterm>parameters<indexterm><parmname>remove-broken-links</parmname></indexterm></indexterm></ph></pt><pd id="remove-broken-links.desc">Remove broken related links. The allowed values are <option>true</option> and <option>false</option>; the default value is <option>false</option>.</pd></plentry><plentry id="root-chunk-override"><pt><parmname>root-chunk-override</parmname><ph><indexterm><parmname>root-chunk-override</parmname></indexterm><indexterm>parameters<indexterm><parmname>root-chunk-override</parmname></indexterm></indexterm></ph></pt><pd id="root-chunk-override.desc">Override for map chunk attribute value.</pd></plentry><plentry id="transtype" importance="required"><pt><parmname>transtype</parmname><ph><indexterm><parmname>transtype</parmname></indexterm><indexterm>parameters<indexterm><parmname>transtype</parmname></indexterm></indexterm></ph></pt><pd id="transtype.desc">Specifies the output format (transformation type).</pd></plentry><plentry id="validate"><pt><parmname>validate</parmname><ph><indexterm><parmname>validate</parmname></indexterm><indexterm>parameters<indexterm><parmname>validate</parmname></indexterm></indexterm></ph></pt><pd id="validate.desc">Specifies whether 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>
|
