Home Verkennen Help
Inloggen
bn
/
se
2
0
Vork 0
Bestanden Issues 0 Pull-aanvragen 0 Wiki
Boom: e89bfafc3a
Aftakkingen Labels
se
/
SE
/
stuff
/
dita-ot-2.3.3
/
doc
/
parameters
/
parameters-base.html

parameters-base.html 20 KB
Geschiedenis Ruwe

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263 
  1. <!DOCTYPE html
    2. 

  2.   SYSTEM "about:legacy-compat">
    3. 

  3. <html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2016"><meta name="DC.rights.owner" content="(C) Copyright 2016"><meta name="DC.Type" content="reference"><meta name="description" content="Certain parameters apply to all transformations that are supported by the DITA Open Toolkit."><meta name="DC.Relation" scheme="URI" content="../parameters/parameters_intro.html"><meta name="DC.Format" content="XHTML"><meta name="DC.Identifier" content="base"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Common parameters</title></head><body id="base"><header role="banner"><div class="header">
    4. 

  4.   <p>DITA Open Toolkit</p>
    5. 

  5.   <hr>
    6. 

  6. </div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 2.3</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../getting-started/index.html">Getting Started</a></li><li><a href="../user-guide/index.html">User Guide</a></li><li><a href="../parameters/index.html">Parameter Reference</a><ul><li><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li><a href="../parameters/parameters_intro.html">DITA-OT parameters</a><ul><li class="active"><a href="../parameters/parameters-base.html">Common</a></li><li><a href="../parameters/parameters-base-html.html">HTML-based output</a></li><li><a href="../parameters/parameters-common-html.html">HTML5 and XHTML</a></li><li><a href="../parameters/parameters-html5.html">HTML5</a></li><li><a href="../parameters/parameters-eclipsecontent.html">Eclipse content</a></li><li><a href="../parameters/parameters-eclipsehelp.html">Eclipse Help</a></li><li><a href="../parameters/parameters-htmlhelp.html">HTMLHelp</a></li><li><a href="../parameters/parameters-javahelp.html">JavaHelp</a></li><li><a href="../parameters/parameters-odt.html">Open Document Format</a></li><li><a href="../parameters/parameters-other.html">Other</a></li><li><a href="../parameters/parameters-pdf.html">PDF</a></li></ul></li><li><a href="../parameters/configuration-properties.html">Configuration properties</a></li></ul></li><li><a href="../dev_ref/index.html">Developer Reference</a></li><li><a href="../user-guide/dita-and-dita-ot-resources.html">DITA Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1 generated" id="ariaid-title1">Common parameters</h1><div class="body refbody"><p class="shortdesc">Certain parameters apply to all
    7. 

  7.       transformations that are supported by the DITA Open Toolkit.</p><section class="section"><dl class="dl parml"><dt class="dt pt dlterm" id="base__args.debug"><span class="keyword parmname">args.debug</span></dt><dd class="dd pd" id="base__args.debug.desc">Specifies whether debugging information is included in the log. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">no</span>.</dd><dt class="dt pt dlterm" id="base__args.draft"><span class="keyword parmname">args.draft</span></dt><dd class="dd pd" id="base__args.draft.desc">Specifies whether the content of &lt;draft-comment&gt; and &lt;required-cleanup&gt; elements is included in the output. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">no</span>.</dd><dd class="dd pd ddexpand">Corresponds to the XSLT parameter
    8. 

  8.                 <span class="keyword parmname">DRAFT</span> in most XSLT modules.<div class="note tip note_tip"><span class="note__title tiptitle">Tip:</span> For PDF output, setting the
    9. 

  9.                   <span class="keyword parmname">args.draft</span> parameter to <span class="keyword option">yes</span> causes the contents of the
    10. 

  10.                   <code class="keyword markupname xmlelement">&lt;titlealts&gt;</code> element to be rendered below the title.</div>
    11. 

  11.             </dd><dt class="dt pt dlterm" id="base__args.figurelink.style"><span class="keyword parmname">args.figurelink.style</span></dt><dd class="dd pd" id="base__args.figurelink.style.desc">Specifies how cross references to figures are styled in output. The allowed values are <span class="keyword option">NUMBER</span>, <span class="keyword option">TITLE</span>, and <span class="keyword option">NUMTITLE</span>.</dd><dd class="dd pd ddexpand">Specifying <span class="keyword option">NUMBER</span> results in "Figure 5"; specifying
    12. 

  12.                 <span class="keyword option">TITLE</span> results in the title of the figure. <span class="ph">Corresponds to
    13. 

  13.                 the XSLT parameter <span class="keyword parmname">FIGURELINK</span>.</span><div class="note note note_note"><span class="note__title notetitle">Note:</span> Support for PDF was added in
    14. 

  14.                 DITA-OT 2.0. By default PDF uses the value <span class="keyword option">NUMTITLE</span>, which is not supported for other
    15. 

  15.                 transformation types; this results in "Figure 5. Title".</div></dd><dt class="dt pt dlterm" id="base__args.filter"><span class="keyword parmname">args.filter</span></dt><dd class="dd pd" id="base__args.filter.desc">Specifies a filter file to be used to include, exclude, or flag content.</dd><dt class="dt pt dlterm" id="base__args.gen.task.lbl"><span class="keyword parmname">args.gen.task.lbl</span></dt><dd class="dd pd" id="base__args.gen.task.lbl.desc">Specifies whether to generate headings for sections within task topics. The allowed values are <span class="keyword option">YES</span> and <span class="keyword option">NO</span>.</dd><dt class="dt pt dlterm" id="base__args.grammar.cache"><span class="keyword parmname">args.grammar.cache</span></dt><dd class="dd pd" id="base__args.grammar.cache.desc">Specifies whether the grammar-caching feature of the XML parser is used. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">yes</span>.</dd><dd class="dd pd ddexpand">
    16. 

  16.               <div class="note note note_note"><span class="note__title notetitle">Note:</span> This option dramatically speeds up processing time. However, there is a known problem with using
    17. 

  17.                 this feature for documents that use XML entities. If your build fails with parser errors about entity
    18. 

  18.                 resolution, set this parameter to <span class="keyword option">no</span>.</div>
    19. 

  19.             </dd><dt class="dt pt dlterm" id="base__args.input"><span class="keyword parmname">args.input</span></dt><dd class="dd pd" id="base__args.input.desc">Specifies the master file for your documentation project.</dd><dd class="dd pd ddexpand">Typically this is a DITA map, however it also can be a DITA topic if you want to
    20. 

  20.               transform a single DITA file. The path can be absolute, relative to <span class="keyword parmname">args.input.dir</span>,
    21. 

  21.               or relative to the directory where your project's ant build script resides if
    22. 

  22.                 <span class="keyword parmname">args.input.dir</span> is not defined. </dd><dt class="dt pt dlterm" id="base__args.input.dir"><span class="keyword parmname">args.input.dir</span></dt><dd class="dd pd" id="base__args.input.dir.desc">Specifies the base directory for your documentation project.</dd><dd class="dd pd ddexpand">The default value is the parent directory of the file specified by
    23. 

  23.                 <span class="keyword parmname">args.input</span>.</dd><dt class="dt pt dlterm" id="base__args.logdir"><span class="keyword parmname">args.logdir</span></dt><dd class="dd pd" id="base__args.logdir.desc">Specifies the location where the DITA-OT places log files for your project.</dd><dt class="dt pt dlterm" id="base__args.rellinks"><span class="keyword parmname">args.rellinks</span></dt><dd class="dd pd" id="base__args.rellinks.desc">Specifies which links to include in the output. The following values are supported:<ul class="ul"><li class="li"><span class="keyword option">none</span> – No links are included.</li><li class="li"><span class="keyword option">all</span> – All links are included.</li><li class="li"><span class="keyword option">noparent</span> – Parent links are not included.</li><li class="li"><span class="keyword option">nofamily</span> – Parent, child, next, and previous links are not included.</li></ul></dd><dt class="dt pt dlterm" id="base__args.tablelink.style"><span class="keyword parmname">args.tablelink.style</span></dt><dd class="dd pd" id="base__args.tablelink.style.desc">Specifies how cross references to tables are styled. The allowed values are <span class="keyword option">NUMBER</span>, <span class="keyword option">TITLE</span>, and <span class="keyword option">NUMTITLE</span>.</dd><dd class="dd pd ddexpand">Specifying <span class="keyword option">NUMBER</span> results in "Table 5"; specifying
    24. 

  24.                 <span class="keyword option">TITLE</span> results in the title of the table. <span class="ph">Corresponds to
    25. 

  25.                 the XSLT parameter <span class="keyword parmname">TABLELINK</span>.</span><div class="note note note_note"><span class="note__title notetitle">Note:</span> Support for PDF was added in
    26. 

  26.                 DITA-OT 2.0. By default PDF uses the value <span class="keyword option">NUMTITLE</span>, which is not supported for other
    27. 

  27.                 transformation types; this results in "Table 5. Title".</div></dd><dt class="dt pt dlterm" id="base__clean.temp"><span class="keyword parmname">clean.temp</span></dt><dd class="dd pd" id="base__clean.temp.desc">Specifies whether the DITA-OT deletes the files in the temporary directory after it finishes a build. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">yes</span>.</dd><dd class="dd pd ddexpand"></dd><dt class="dt pt dlterm" id="base__conserve-memory"><span class="keyword parmname">conserve-memory</span></dt><dd class="dd pd" id="base__conserve-memory.desc">Conserve memory at the expense of processing speed The allowed values are <span class="keyword option">true</span> and <span class="keyword option">false</span>; the default value is <span class="keyword option">false</span>.</dd><dt class="dt pt dlterm" id="base__dita.dir"><span class="keyword parmname">dita.dir</span></dt><dd class="dd pd" id="base__dita.dir.desc">Specifies where the DITA-OT is installed.</dd><dt class="dt pt dlterm" id="base__dita.input.valfile"><span class="keyword parmname">dita.input.valfile</span></dt><dd class="dd pd" id="base__dita.input.valfile.desc">Specifies a filter file to be used to include, exclude, or flag content.</dd><dd class="dd pd ddexpand">
    28. 

  28.               <div class="note note note_note"><span class="note__title notetitle">Note:</span> Deprecated in favor of the <span class="keyword parmname">args.filter</span> parameter.</div>
    29. 

  29.             </dd><dt class="dt pt dlterm" id="base__dita.preprocess.reloadstylesheet.topicpull"><span class="keyword parmname">dita.preprocess.reloadstylesheet.topicpull</span></dt><dd class="dd pd" id="base__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 <span class="keyword option">true</span> and <span class="keyword option">false</span>; the default value is <span class="keyword option">false</span>.</dd><dt class="dt pt dlterm" id="base__dita.temp.dir"><span class="keyword parmname">dita.temp.dir</span></dt><dd class="dd pd" id="base__dita.temp.dir.desc">Specifies the location of the temporary directory.</dd><dd class="dd pd ddexpand">The temporary directory is where the DITA-OT writes temporary files that are
    30. 

  30.               generated during the transformation process.</dd><dt class="dt pt dlterm" id="base__filter-stage"><span class="keyword parmname">filter-stage</span></dt><dd class="dd pd" id="base__filter-stage.desc">Specifies whether filtering is done before all other processing, or after key and conref processing. The allowed values are <span class="keyword option">early</span> and <span class="keyword option">late</span>; the default value is <span class="keyword option">early</span>.</dd><dd class="dd pd ddexpand">
    31. 

  31.               <div class="note note note_note"><span class="note__title notetitle">Note:</span> Changing the filtering stage may produce different results for the same initial data set and
    32. 

  32.                 filtering conditions.</div>
    33. 

  33.             </dd><dt class="dt pt dlterm" id="base__force-unique"><span class="keyword parmname">force-unique</span></dt><dd class="dd pd" id="base__force-unique.desc">Generate copy-to attributes to duplicate topicref elements. The allowed values are <span class="keyword option">true</span> and <span class="keyword option">false</span>; the default value is <span class="keyword option">false</span>.</dd><dd class="dd pd ddexpand">
    34. 

  34.               
    35. 

  35.             </dd><dt class="dt pt dlterm" id="base__generate-debug-attributes"><span class="keyword parmname">generate-debug-attributes</span></dt><dd class="dd pd" id="base__generate-debug-attributes.desc">Specifies whether the @xtrf and @xtrc debugging attributes are generated in the temporary files. The following values are supported:<ul class="ul"><li class="li"><span class="keyword option">true</span> (default) – Enables generation of debugging attributes</li><li class="li"><span class="keyword option">false</span> – Disables generation of debugging attributes</li></ul></dd><dd class="dd pd ddexpand">
    36. 

  36.               <div class="note note note_note"><span class="note__title notetitle">Note:</span> Disabling debugging attributes reduces the size of temporary files and thus reduces memory
    37. 

  37.                 consumption. However, the log messages no longer have the source information available and thus the
    38. 

  38.                 ability to debug problems might deteriorate.</div>
    39. 

  39.             </dd><dt class="dt pt dlterm" id="base__generate.copy.outer"><span class="keyword parmname">generate.copy.outer</span></dt><dd class="dd pd" id="base__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 class="ul"><li class="li"><span class="keyword option">1</span> (default) – Do not generate output for content that is located outside the DITA map directory.</li><li class="li"><span class="keyword option">3</span> – Shift the output directory so that it contains all output for the publication.</li></ul></dd><dd class="dd pd ddexpand">
    40. 

  40.               <p class="p">See <a class="xref" href="generate-copy-outer.html" title="Elaboration on how the generate.copy.outer parameter functions.">generate.copy.outer parameter</a> for more information.</p>
    41. 

  41.             </dd><dt class="dt pt dlterm" id="base__onlytopic.in.map"><span class="keyword parmname">onlytopic.in.map</span></dt><dd class="dd pd" id="base__onlytopic.in.map.desc">Specifies whether files that are linked to, or referenced with a @conref attribute, generate output. The allowed values are <span class="keyword option">true</span> and <span class="keyword option">false</span>; the default value is <span class="keyword option">false</span>.</dd><dd class="dd pd ddexpand">If set to <span class="keyword option">true</span>, only files that are referenced directly from the
    42. 

  42.               map will generate output; the default value is <span class="keyword option">false</span>.</dd><dt class="dt pt dlterm" id="base__outer.control"><span class="keyword parmname">outer.control</span></dt><dd class="dd pd" id="base__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 class="ul"><li class="li"><span class="keyword option">fail</span> – Fail quickly if files are going to be generated or copied outside of the directory.</li><li class="li"><span class="keyword option">warn</span> (default) – Complete the operation if files will be generated or copied outside of the directory, but log a warning.</li><li class="li"><span class="keyword option">quiet</span> – Quietly finish without generating warnings or errors.</li></ul></dd><dd class="dd pd ddexpand">
    43. 

  43.               <div class="note warning note_warning"><span class="note__title warningtitle">Warning:</span> Microsoft HTML Help Compiler cannot produce HTML Help for
    44. 

  44.                 documentation projects that use outer content. The content files must reside in or below the directory
    45. 

  45.                 containing the master DITA map file, and the map file cannot specify ".." at the start of the
    46. 

  46.                   <code class="keyword markupname xmlatt">@href</code> attributes for <code class="keyword markupname xmlelement">&lt;topicref&gt;</code> elements.</div>
    47. 

  47.             </dd><dt class="dt pt dlterm" id="base__output.dir"><span class="keyword parmname">output.dir</span></dt><dd class="dd pd" id="base__output.dir.desc">Specifies the name and location of the output directory.</dd><dd class="dd pd ddexpand">By default, the output is written to
    48. 

  48.                 <span class="ph filepath"><var class="keyword varname">DITA-dir</var>/out</span>.</dd><dt class="dt pt dlterm" id="base__processing-mode"><span class="keyword parmname">processing-mode</span></dt><dd class="dd pd" id="base__processing-mode.desc">Specifies how the DITA-OT handles errors and error recovery. The following values are supported:<ul class="ul"><li class="li"><span class="keyword option">strict</span> – When an error is encountered, the DITA-OT stops processing</li><li class="li"><span class="keyword option">lax</span> (default) – When an error is encountered, the DITA-OT attempts to recover from it</li><li class="li"><span class="keyword option">skip</span> – When an error is encountered, the DITA-OT continues processing but does not attempt error recovery</li></ul></dd><dt class="dt pt dlterm" id="base__root-chunk-override"><span class="keyword parmname">root-chunk-override</span></dt><dd class="dd pd" id="base__root-chunk-override.desc">Override for map chunk attribute value.</dd><dt class="dt pt dlterm" id="base__transtype"><span class="keyword parmname">transtype</span></dt><dd class="dd pd" id="base__transtype.desc">Specifies the output format (transformation type).</dd><dd class="dd pd ddexpand">You can create plug-ins to add new values for this parameter; by default, the
    49. 

  49.               following values are available:
    50. 

  50.               <ul class="ul">
    51. 

  51.                 <li class="li">docbook</li>
    52. 

  52.                 <li class="li">eclipsehelp</li>
    53. 

  53.                 <li class="li">eclipsecontent</li>
    54. 

  54.                 <li class="li">html5</li>
    55. 

  55.                 <li class="li">htmlhelp</li>
    56. 

  56.                 <li class="li">javahelp</li>
    57. 

  57.                 <li class="li">odt</li>
    58. 

  58.                 <li class="li">pdf</li>
    59. 

  59.                 <li class="li">wordrtf</li>
    60. 

  60.                 <li class="li">troff</li>
    61. 

  61.                 <li class="li">xhtml</li>
    62. 

  62.               </ul>
    63. 

  63.             </dd><dt class="dt pt dlterm" id="base__validate"><span class="keyword parmname">validate</span></dt><dd class="dd pd" id="base__validate.desc">Specifies whether the DITA-OT validates the content. The allowed values are <span class="keyword option">true</span> and <span class="keyword option">false</span>; the default value is <span class="keyword option">true</span>.</dd></dl></section></div><nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../parameters/parameters_intro.html" title="Certain parameters apply to all DITA-OT transformations. Other parameters are common to the HTML-based transformations. Some parameters apply only to specific transformation types. These parameters can be passed as options to the dita command using the -Dparameter-name=value syntax or included in build scripts as Ant properties.">DITA-OT parameters</a></div></div></nav></article></main></body></html>
    64.