from code-server
This commit is contained in:
parent
eda5c02fe9
commit
5ef8bdba47
2652 changed files with 528235 additions and 0 deletions
4
dita-ot-3.6/docsrc/parameters/all-parameters.dita
Normal file
4
dita-ot-3.6/docsrc/parameters/all-parameters.dita
Normal file
File diff suppressed because one or more lines are too long
872
dita-ot-3.6/docsrc/parameters/ant-parameters-details.dita
Normal file
872
dita-ot-3.6/docsrc/parameters/ant-parameters-details.dita
Normal file
|
|
@ -0,0 +1,872 @@
|
|||
<?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 file for applicable license. -->
|
||||
<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 DITA Open Toolkit supports.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<!-- This is a resource-only topic. Place index entries in the content below. -->
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<refbody>
|
||||
<section>
|
||||
<parml>
|
||||
<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.
|
||||
<indexterm><xmlelement>titlealts</xmlelement></indexterm>
|
||||
<indexterm>XSLT</indexterm>
|
||||
<indexterm>draft
|
||||
<indexterm>args.draft</indexterm>
|
||||
<indexterm>PDF</indexterm></indexterm>
|
||||
<indexterm>PDF
|
||||
<indexterm>draft</indexterm></indexterm>
|
||||
<indexterm>parameters
|
||||
<indexterm>args.draft</indexterm></indexterm>
|
||||
</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">
|
||||
<pt>
|
||||
<parmname>args.filter</parmname>
|
||||
</pt>
|
||||
<pd conaction="pushreplace" conref="parameters-base.dita#base/args.filter.desc">
|
||||
<p>Specifies filter file(s) used to include, exclude, or flag content. Relative paths are resolved against
|
||||
the DITA-OT base directory (for backwards compatibility) and internally converted to absolute paths.</p>
|
||||
<note>
|
||||
<p>To specify multiple filter files, use the system path separator character to delimit individual file
|
||||
paths (semicolon ‘<codeph>;</codeph>’ on Windows, and colon ‘<codeph>:</codeph>’ on macOS and Linux)
|
||||
and wrap the value in quotes:</p>
|
||||
<p><codeph>--args.filter="filter1.ditaval;filter2.ditaval;filter3.ditaval"</codeph></p>
|
||||
<p>DITAVAL files are evaluated in the order specified, so conditions specified in the first file take
|
||||
precedence over matching conditions specified in later files, just as conditions at the start of a
|
||||
DITAVAL document take precedence over matching conditions later in the same document.</p>
|
||||
<indexterm>DITAVAL
|
||||
<indexterm><parmname>args.filter</parmname></indexterm></indexterm>
|
||||
<!-- https://github.com/dita-ot/dita-ot/issues/3319 -->
|
||||
<indexterm>DITAVAL
|
||||
<index-see-also>filters</index-see-also></indexterm>
|
||||
<indexterm>DITAVAL
|
||||
<index-see-also>profiling</index-see-also></indexterm>
|
||||
<indexterm>OS X
|
||||
<index-see>macOS</index-see></indexterm>
|
||||
<indexterm>macOS
|
||||
<indexterm>delimiter</indexterm></indexterm>
|
||||
<indexterm>Linux
|
||||
<indexterm>delimiter</indexterm></indexterm>
|
||||
<indexterm>Windows
|
||||
<indexterm>delimiter</indexterm></indexterm>
|
||||
</note>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="args.gen.task.lbl">
|
||||
<pt>
|
||||
<parmname>args.gen.task.lbl</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/args.gen.task.lbl.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<ph audience="xslt-customizer">Corresponds to the XSLT parameter
|
||||
<parmname>GENERATE-TASK-LABELS</parmname>.</ph></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>.
|
||||
<indexterm>processing time</indexterm></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.rellinks">
|
||||
<pt><parmname>args.rellinks</parmname></pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/args.rellinks.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<p>For PDF output, the default value is <option>nofamily</option>. For all other formats, the default
|
||||
value is <option>all</option>.
|
||||
<indexterm>args.rellinks</indexterm>
|
||||
<indexterm>PDF
|
||||
<indexterm>related links</indexterm>
|
||||
<indexterm>args.rellinks</indexterm></indexterm>
|
||||
<indexterm>HTML5
|
||||
<indexterm>related links</indexterm>
|
||||
<indexterm>args.rellinks</indexterm></indexterm>
|
||||
</p></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".
|
||||
<indexterm>tables
|
||||
<indexterm>args.tablelink.style</indexterm></indexterm>
|
||||
</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="default.language">
|
||||
<pt>
|
||||
<parmname>default.language</parmname>
|
||||
</pt>
|
||||
<pd conaction="pushreplace" conref="parameters-base.dita#base/default.language.desc">Specifies the language
|
||||
that is used if the input file does not have the <xmlatt>xml:lang</xmlatt> attribute set on the root
|
||||
element. By default, this is set to <option>en</option>. The allowed values are those that are defined in
|
||||
IETF BCP 47,
|
||||
<xref href="https://tools.ietf.org/html/bcp47" format="html" scope="external">Tags for Identifying
|
||||
Languages</xref>.
|
||||
<indexterm><xmlatt>xml:lang</xmlatt></indexterm>
|
||||
<indexterm>IETF BCP 47</indexterm>
|
||||
<indexterm>languages
|
||||
<indexterm>default</indexterm></indexterm>
|
||||
</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 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">
|
||||
<p>Setting this to <option>true</option> ensures that unique output files are created for each instance of
|
||||
a resource when a map contains multiple references to a single topic.</p></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.
|
||||
<indexterm>debugging
|
||||
<indexterm>generate-debug-attributes</indexterm></indexterm>
|
||||
<indexterm>memory</indexterm>
|
||||
</note>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="generate.copy.outer">
|
||||
<pt>
|
||||
<parmname>generate.copy.outer</parmname>
|
||||
<ph>
|
||||
<indexterm><parmname>generate.copy.outer</parmname></indexterm></ph>
|
||||
</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.</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.
|
||||
<indexterm><xmlelement>topicref</xmlelement></indexterm>
|
||||
<indexterm><xmlatt>href</xmlatt></indexterm>
|
||||
</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="result.rewrite-rule.class">
|
||||
<pt>
|
||||
<parmname>result.rewrite-rule.class</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/result.rewrite-rule.class.desc"/>
|
||||
<pd conaction="pushafter">The custom class should implement the
|
||||
<codeph>org.dita.dost.module.RewriteRule</codeph> interface.
|
||||
<indexterm><parmname>result.rewrite-rule.class</parmname></indexterm>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="result.rewrite-rule.xsl">
|
||||
<pt>
|
||||
<parmname>result.rewrite-rule.xsl</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/result.rewrite-rule.xsl.desc"/>
|
||||
<pd conaction="pushafter">See
|
||||
<xref keyref="plugin-rewrite-rules"/> for details.
|
||||
<indexterm><parmname>result.rewrite-rule.xsl</parmname></indexterm>
|
||||
</pd>
|
||||
</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">Acceptable values include any value normally allowed on the <xmlatt>chunk</xmlatt>
|
||||
attribute. If the map does not have a <xmlatt>chunk</xmlatt> attribute, this value will be used; if the
|
||||
map already has a <xmlatt>chunk</xmlatt> attribute specified, this value will be used instead.
|
||||
<indexterm><xmlatt>chunk</xmlatt>
|
||||
<indexterm><parmname>root-chunk-override</parmname></indexterm></indexterm>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="store-type">
|
||||
<pt>
|
||||
<parmname>store-type</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/store-type.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<p>
|
||||
<ph conkeyref="migrating-to-3.6/io-bound"/> For more information, see
|
||||
<xref keyref="store-api"/>.</p>
|
||||
<note type="important">Custom plug-ins that expect to find certain files on disk in the temporary
|
||||
directory will not work with in-memory processing.</note>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="transtype">
|
||||
<pt>
|
||||
<parmname>transtype</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/transtype.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<p conkeyref="conref-task/transtypes"/>
|
||||
</pd>
|
||||
</plentry>
|
||||
</parml>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
|
||||
<reference id="base-html">
|
||||
<title>HTML-based output parameters</title>
|
||||
<titlealts>
|
||||
<navtitle>HTML-based output</navtitle>
|
||||
</titlealts>
|
||||
<shortdesc conaction="pushreplace" conref="parameters-base-html.dita#base-html/shortdesc">Certain parameters apply
|
||||
to all HTML-based transformation types: HTML5, XHTML, HTML Help, and Eclipse help. <ph>
|
||||
<indexterm>HTML5
|
||||
<indexterm>parameters</indexterm></indexterm>
|
||||
</ph>
|
||||
</shortdesc>
|
||||
<refbody>
|
||||
<section>
|
||||
<parml>
|
||||
<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">
|
||||
<div id="args.copycss.details">If an external process will copy your custom .css file to the output
|
||||
directory, leave this parameter unset (or set it to <option>no</option>). If DITA-OT should copy the
|
||||
file when generating output, set it to <option>yes</option>.</div></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">
|
||||
<div id="args.css.details">The value of this parameter should be only the file name. The absolute path to
|
||||
the parent directory should be specified with <parmname>args.cssroot</parmname>.</div></pd>
|
||||
</plentry>
|
||||
<plentry id="args.csspath">
|
||||
<pt>
|
||||
<parmname>args.csspath</parmname>
|
||||
</pt>
|
||||
<pd conaction="pushreplace" conref="parameters-base-html.dita#base-html/args.csspath.desc">
|
||||
<div id="args.csspath.desc">Specifies the <b>destination</b> directory to which .css files are copied
|
||||
(relative to the output directory).</div></pd>
|
||||
<pd conaction="mark" conref="parameters-base-html.dita#base-html/args.csspath.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div id="args.csspath.details">
|
||||
<p audience="xslt-customizer">Corresponds to the XSLT parameter <parmname>CSSPATH</parmname>.</p>
|
||||
<p>DITA-OT will copy the file <b>to</b> this location.</p>
|
||||
<note type="tip">If <parmname>args.csspath</parmname> is not set, the custom CSS file (and the default
|
||||
CSS files) will be copied to the root level of the output folder. To copy CSS files to an output
|
||||
subfolder named <filepath>css</filepath>, set <parmname>args.csspath</parmname> to
|
||||
<option>css</option>.
|
||||
<indexterm>CSS
|
||||
<indexterm>copy to specific location</indexterm></indexterm>
|
||||
</note></div>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="args.cssroot">
|
||||
<pt>
|
||||
<parmname>args.cssroot</parmname>
|
||||
</pt>
|
||||
<pd conaction="pushreplace" conref="parameters-base-html.dita#base-html/args.cssroot.desc">
|
||||
<div id="args.cssroot.desc">Specifies the <b>source</b> directory that contains the custom .css
|
||||
file.</div></pd>
|
||||
<pd conaction="mark" conref="parameters-base-html.dita#base-html/args.cssroot.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div id="args.cssroot.details">
|
||||
<p>DITA-OT will copy the file <b>from</b> this location.</p>
|
||||
<note type="important">Enter the absolute path to the parent directory of the custom CSS file specified
|
||||
with <parmname>args.css</parmname>.</note>
|
||||
</div></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">
|
||||
<div id="args.ftr.details">
|
||||
<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. In HTML5 output, the
|
||||
footer file contents will be wrapped in an HTML5 <xmlelement>footer</xmlelement> element with the
|
||||
<xmlatt>role</xmlatt> attribute set to <option>contentinfo</option>.
|
||||
<indexterm><xmlelement>div</xmlelement>
|
||||
<indexterm>HTML footer</indexterm>
|
||||
<indexterm><parmname>args.ftr</parmname></indexterm></indexterm>
|
||||
<indexterm><xmlatt>role</xmlatt></indexterm>
|
||||
<indexterm>HTML5
|
||||
<indexterm>footers</indexterm></indexterm>
|
||||
</note>
|
||||
</div></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">
|
||||
<div id="args.gen.default.meta.details">Corresponds to the XSLT parameter <parmname>genDefMeta</parmname>.
|
||||
</div>
|
||||
</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">
|
||||
<div id="args.hdf.details">
|
||||
<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.
|
||||
<indexterm><xmlelement>div</xmlelement>
|
||||
<indexterm>HTML <xmlelement>head</xmlelement></indexterm>
|
||||
<indexterm><parmname>args.hdf</parmname></indexterm></indexterm>
|
||||
</note></div></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">
|
||||
<div id="args.hdr.details">
|
||||
<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. In HTML5 output, the
|
||||
contents of the header file will be wrapped in an HTML5 <xmlelement>header</xmlelement> element with
|
||||
the <xmlatt>role</xmlatt> attribute set to <option>banner</option>.
|
||||
<indexterm><xmlelement>div</xmlelement>
|
||||
<indexterm>HTML header</indexterm>
|
||||
<indexterm><parmname>args.hdr</parmname></indexterm></indexterm>
|
||||
<indexterm><xmlelement>header</xmlelement></indexterm>
|
||||
<indexterm><xmlatt>role</xmlatt></indexterm>
|
||||
<indexterm>HTML5
|
||||
<indexterm>headers</indexterm></indexterm>
|
||||
</note>
|
||||
</div></pd>
|
||||
</plentry>
|
||||
<plentry id="args.hide.parent.link" importance="deprecated">
|
||||
<pt>
|
||||
<parmname>args.hide.parent.link</parmname>
|
||||
<ph>
|
||||
<indexterm>deprecated features
|
||||
<indexterm><parmname>args.hide.parent.link</parmname></indexterm></indexterm></ph>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base-html.dita#base-html/args.hide.parent.link.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div id="args.hide.parent.link.details">
|
||||
<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>
|
||||
</div></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">
|
||||
<div id="args.outext.details">
|
||||
<ph audience="xslt-customizer">Corresponds to the XSLT parameter <parmname>OUTEXT</parmname>.</ph>
|
||||
</div></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>
|
||||
<indexterm><xmlelement>prereq</xmlelement></indexterm>
|
||||
<indexterm><xmlelement>section</xmlelement></indexterm>
|
||||
</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">
|
||||
<div id="args.xsl.details">The parameter must specify a fully qualified file name.</div></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.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.
|
||||
<indexterm><xmlatt>id</xmlatt>
|
||||
<indexterm><parmname>args.eclipse.symbolic.name</parmname></indexterm></indexterm>
|
||||
</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 Microsoft Compiled HTML Help (.chm) transformation.</shortdesc>
|
||||
<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.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="org.dita.index.skip">
|
||||
<pt>
|
||||
<parmname>org.dita.index.skip</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-pdf.dita#pdf/org.dita.index.skip.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<p>Up until DITA-OT 3.4, indexing code was provided in the PDF plug-in and only available for PDF output.
|
||||
In version 3.4 and above, indexing is provided by a separate plug-in to allow other transformations to
|
||||
access the results.</p>
|
||||
<p>If you have overridden PDF index processing via the <codeph>transform.topic2fo</codeph> target in the
|
||||
past, you can set the <parmname>org.dita.index.skip</parmname> property to <option>yes</option> and
|
||||
re-enable the <codeph>transform.topic2fo.index</codeph> target with <xmlelement>feature
|
||||
extension="depend.org.dita.pdf2.index" value="transform.topic2fo.index"/</xmlelement> in your plug-in
|
||||
configuration.</p>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="org.dita.pdf2.i18n.enabled">
|
||||
<pt><parmname>org.dita.pdf2.i18n.enabled</parmname></pt>
|
||||
<pd conaction="pushreplace" conref="parameters-pdf.dita#pdf/org.dita.pdf2.i18n.enabled.desc">
|
||||
<p>Enables internationalization (I18N) font processing to provide per-character font selection for FO
|
||||
renderers that do not support the <codeph>font-selection-strategy</codeph> property (such as Apache
|
||||
FOP).
|
||||
<indexterm>Apache FOP
|
||||
<indexterm>I18N</indexterm></indexterm>
|
||||
<indexterm>FOP
|
||||
<index-see>Apache FOP</index-see></indexterm>
|
||||
<indexterm>I18N
|
||||
<indexterm><parmname>org.dita.pdf2.i18n.enabled</parmname></indexterm></indexterm>
|
||||
<indexterm>fonts
|
||||
<indexterm>PDF</indexterm></indexterm>
|
||||
</p>
|
||||
<p>When this feature is enabled, DITA-OT uses a font mapping process that takes the content language into
|
||||
consideration. The mapping process uses configuration files for each language to define characters that
|
||||
should be rendered with certain logical fonts, and font mappings that associate each logical font to
|
||||
physical font files.</p>
|
||||
<p>The following values are allowed:</p>
|
||||
<ul>
|
||||
<li><option>true</option> (default) — Enables font mapping</li>
|
||||
<li><option>false</option> — Disables font mapping</li>
|
||||
</ul>
|
||||
<note type="tip">If you don’t use custom character mappings, turning off font mapping makes it easier to
|
||||
define custom fonts simply by changing font names in the XSL attributes files of your custom PDF
|
||||
plug-in. For details, see
|
||||
<xref keyref="jelovirt-on-pdf2-i18n"/>.</note>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="outputFile.base">
|
||||
<pt>
|
||||
<parmname>outputFile.base</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-pdf.dita#pdf/outputFile.base.desc"/>
|
||||
<pd conaction="pushafter">By default, the PDF file uses the base filename of the input
|
||||
<filepath>.ditamap</filepath> file.
|
||||
<indexterm>DITA maps
|
||||
<indexterm>PDF file name</indexterm></indexterm></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>
|
||||
<!-- Added to inject index entries into the right location. -->
|
||||
<pd conaction="mark" conref="parameters-pdf.dita#pdf/pdf.formatter.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<indexterm>Apache FOP
|
||||
<indexterm><parmname>pdf.formatter</parmname></indexterm></indexterm>
|
||||
<indexterm>formatter</indexterm>
|
||||
<indexterm>PDF
|
||||
<indexterm>formatter</indexterm></indexterm>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="publish.required.cleanup" importance="deprecated">
|
||||
<pt>
|
||||
<parmname>publish.required.cleanup</parmname>
|
||||
<ph>
|
||||
<indexterm>deprecated features
|
||||
<indexterm><parmname>publish.required.cleanup</parmname></indexterm></indexterm></ph>
|
||||
</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="xhtml">
|
||||
<title>XHTML</title>
|
||||
<shortdesc conaction="pushreplace" conref="parameters-xhtml.dita#xhtml/shortdesc">Certain parameters are specific to
|
||||
the XHTML transformation.</shortdesc>
|
||||
<refbody>
|
||||
<section>
|
||||
<parml>
|
||||
<plentry id="args.xhtml.contenttarget">
|
||||
<pt>
|
||||
<parmname>args.xhtml.contenttarget</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-xhtml.dita#xhtml/args.xhtml.contenttarget.desc"/>
|
||||
<pd conaction="pushafter">The default value is <option>contentwin</option>. Change this value to use a
|
||||
different target name for the table of contents.
|
||||
<indexterm>table of contents
|
||||
<indexterm>XHTML</indexterm></indexterm>
|
||||
</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">The HTML5 transformation shares
|
||||
common parameters with other HTML-based transformations and provides additional parameters that are specific to
|
||||
HTML5 output. <ph>
|
||||
<indexterm>HTML5</indexterm></ph>
|
||||
</shortdesc>
|
||||
<refbody>
|
||||
<!-- args.html5.contenttarget is listed in generated topic, but does not appear in default HTML5 output files. -->
|
||||
<section>
|
||||
<!-- Re-use extended base-html parameter descriptions for #132 -->
|
||||
<parml>
|
||||
<plentry id="args.copycss">
|
||||
<pt><parmname>args.copycss</parmname></pt>
|
||||
<pd conaction="mark" conref="parameters-html5.dita#html5/args.copycss.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.copycss.details"/></pd>
|
||||
</plentry>
|
||||
<plentry id="args.css">
|
||||
<pt><parmname>args.css</parmname></pt>
|
||||
<pd conaction="mark" conref="parameters-html5.dita#html5/args.css.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.css.details"/></pd>
|
||||
</plentry>
|
||||
<!-- ↓ excerpt-csspath ↓ -->
|
||||
<plentry id="args.csspath">
|
||||
<pt>
|
||||
<parmname>args.csspath</parmname>
|
||||
</pt>
|
||||
<pd conaction="pushreplace" conref="parameters-html5.dita#html5/args.csspath.desc">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.csspath.desc"/>
|
||||
</pd>
|
||||
<pd conaction="mark" conref="parameters-html5.dita#html5/args.csspath.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.csspath.details"/>
|
||||
</pd>
|
||||
</plentry>
|
||||
<!-- ↑ end-excerpt ↑ -->
|
||||
<plentry id="args.cssroot">
|
||||
<pt>
|
||||
<parmname>args.cssroot</parmname>
|
||||
</pt>
|
||||
<pd conaction="pushreplace" conref="parameters-html5.dita#html5/args.cssroot.desc">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.cssroot.desc"/></pd>
|
||||
<pd conaction="mark" conref="parameters-html5.dita#html5/args.cssroot.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.cssroot.details"/></pd>
|
||||
</plentry>
|
||||
<plentry id="args.ftr">
|
||||
<pt>
|
||||
<parmname>args.ftr</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-html5.dita#html5/args.ftr.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.ftr.details"/></pd>
|
||||
</plentry>
|
||||
<plentry id="args.gen.default.meta">
|
||||
<pt>
|
||||
<parmname>args.gen.default.meta</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-html5.dita#html5/args.gen.default.meta.desc"/>
|
||||
<pd conaction="pushafter" audience="xslt-customizer">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.gen.default.meta.details"/>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="args.hdf">
|
||||
<pt><parmname>args.hdf</parmname></pt>
|
||||
<pd conaction="mark" conref="parameters-html5.dita#html5/args.hdf.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.hdf.details"/></pd>
|
||||
</plentry>
|
||||
<plentry id="args.hdr">
|
||||
<pt>
|
||||
<parmname>args.hdr</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-html5.dita#html5/args.hdr.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.hdr.details"/></pd>
|
||||
</plentry>
|
||||
<plentry id="args.hide.parent.link" importance="deprecated">
|
||||
<pt>
|
||||
<parmname>args.hide.parent.link</parmname>
|
||||
<ph>
|
||||
<indexterm>deprecated features
|
||||
<indexterm><parmname>args.hide.parent.link</parmname></indexterm></indexterm></ph>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-html5.dita#html5/args.hide.parent.link.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.hide.parent.link.details"/></pd>
|
||||
</plentry>
|
||||
<plentry id="args.outext">
|
||||
<pt>
|
||||
<parmname>args.outext</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-html5.dita#html5/args.outext.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.outext.details"/></pd>
|
||||
</plentry>
|
||||
<plentry id="args.xsl">
|
||||
<pt>
|
||||
<parmname>args.xsl</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-html5.dita#html5/args.xsl.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.xsl.details"/></pd>
|
||||
</plentry>
|
||||
<!-- End shared base-html parameter descriptions -->
|
||||
<plentry id="nav-toc">
|
||||
<pt><parmname>nav-toc</parmname></pt>
|
||||
<pd conaction="pushreplace" conref="parameters-html5.dita#html5/nav-toc.desc">
|
||||
<p>Specifies whether to generate a table of contents (ToC) in the HTML5 <xmlelement>nav</xmlelement>
|
||||
element of each page. The navigation can then be rendered in a sidebar or menu via CSS.
|
||||
<indexterm>HTML5
|
||||
<indexterm>nav-toc</indexterm></indexterm>
|
||||
</p>
|
||||
<p>The following values are supported:
|
||||
<ul>
|
||||
<li><option>none</option> (default) – No table of contents will be generated</li>
|
||||
<li><option>partial</option> – Include the current topic in the ToC along with its parents, siblings
|
||||
and children</li>
|
||||
<li><option>full</option> – Generate a complete ToC for the entire map</li>
|
||||
</ul>
|
||||
<indexterm>table of contents
|
||||
<indexterm>HTML5</indexterm></indexterm>
|
||||
<indexterm>table of contents
|
||||
<indexterm>nav-toc</indexterm></indexterm>
|
||||
</p>
|
||||
</pd>
|
||||
</plentry>
|
||||
</parml>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
</reference>
|
||||
163
dita-ot-3.6/docsrc/parameters/configuration-properties-file.dita
Normal file
163
dita-ot-3.6/docsrc/parameters/configuration-properties-file.dita
Normal file
|
|
@ -0,0 +1,163 @@
|
|||
<?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 file for applicable license. -->
|
||||
<reference id="configuration" xml:lang="en">
|
||||
<title>The <filepath>configuration.properties</filepath> file</title>
|
||||
<titlealts>
|
||||
<navtitle><filepath>configuration.properties</filepath></navtitle>
|
||||
</titlealts>
|
||||
<shortdesc>The <filepath>configuration.properties</filepath> file controls certain common properties, as well as some
|
||||
properties that control PDF processing.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>configuration properties
|
||||
<indexterm>default.cascade</indexterm>
|
||||
<indexterm>org.dita.pdf2.i18n.enabled</indexterm>
|
||||
<indexterm>plugin.ignores</indexterm>
|
||||
<indexterm>plugin.order</indexterm>
|
||||
<indexterm>plugindirs</indexterm>
|
||||
<indexterm>temp-file-name-scheme</indexterm>
|
||||
<indexterm>cli.color</indexterm>
|
||||
<indexterm>registry</indexterm>
|
||||
<indexterm>default.coderef-charset</indexterm>
|
||||
</indexterm>
|
||||
<indexterm>files
|
||||
<indexterm>config/configuration.properties file</indexterm>
|
||||
</indexterm>
|
||||
<indexterm>PDF
|
||||
<indexterm>configuration properties</indexterm>
|
||||
</indexterm>
|
||||
<indexterm><xmlatt>cascade</xmlatt></indexterm>
|
||||
<indexterm>macOS
|
||||
<indexterm>colored console output</indexterm></indexterm>
|
||||
<indexterm>Linux
|
||||
<indexterm>colored console output</indexterm></indexterm>
|
||||
<indexterm>Windows
|
||||
<indexterm>colored console output</indexterm></indexterm>
|
||||
<indexterm>command line
|
||||
<index-see-also>dita command</index-see-also></indexterm>
|
||||
<indexterm>terminal
|
||||
<index-see>command line</index-see></indexterm>
|
||||
<indexterm>grammar files
|
||||
<index-see-also>schema</index-see-also>
|
||||
<index-see-also>DTD</index-see-also></indexterm>
|
||||
<indexterm><cmdname>dita</cmdname> command
|
||||
<indexterm>colored console output</indexterm></indexterm>
|
||||
<indexterm>metadata
|
||||
<indexterm><xmlatt>cascade</xmlatt></indexterm></indexterm>
|
||||
<indexterm>DITA 1.3
|
||||
<indexterm><xmlatt>cascade</xmlatt></indexterm></indexterm>
|
||||
<indexterm>default.cascade</indexterm>
|
||||
<indexterm>org.dita.pdf2.i18n.enabled</indexterm>
|
||||
<indexterm>plugin.ignores</indexterm>
|
||||
<indexterm>plugin.order</indexterm>
|
||||
<indexterm>plugindirs</indexterm>
|
||||
<indexterm>temp-file-name-scheme</indexterm>
|
||||
<indexterm>cli.color</indexterm>
|
||||
<indexterm>registry</indexterm>
|
||||
<indexterm>default.coderef-charset</indexterm>
|
||||
<indexterm>Java
|
||||
<indexterm>temporary file names</indexterm></indexterm>
|
||||
<indexterm>temporary file names</indexterm>
|
||||
<indexterm>catalog
|
||||
<indexterm>import precedence</indexterm></indexterm>
|
||||
<indexterm>internationalization
|
||||
<index-see>I18N</index-see></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<refbody>
|
||||
<section>
|
||||
<p>The contents of the <filepath>config/configuration.properties</filepath> file are added to the DITA-OT
|
||||
configuration in the <codeph>dost-configuration.jar</codeph> file when the plug-in integration process runs. The
|
||||
following properties are typically set in this file:</p>
|
||||
<parml>
|
||||
<plentry id="default-cascade">
|
||||
<pt><parmname>default.cascade</parmname></pt>
|
||||
<pd>
|
||||
<p>Specifies the processing default value for the DITA 1.3 <xmlatt>cascade</xmlatt> attribute, which
|
||||
determines how map-level metadata attributes are applied to the children of elements where the attributes
|
||||
are specified. DITA-OT uses the <option>merge</option> value by default for backwards compatibility with
|
||||
DITA 1.2 and earlier.</p>
|
||||
<note type="warning" id="protected-config-props">This property can only be set in
|
||||
<filepath>configuration.properties</filepath> and should not be modified.</note></pd>
|
||||
</plentry>
|
||||
<plentry id="temp-file-name-scheme">
|
||||
<pt><parmname>temp-file-name-scheme</parmname></pt>
|
||||
<!-- org.dita.dost.module.GenMapAndTopicListModule$DefaultTempFileScheme -->
|
||||
<pd>
|
||||
<p>This setting specifies the name of the Java class that defines how the source URL of a topic is mapped to
|
||||
the URL of the temporary file name. The current default method uses a 1:1 mapping, though future
|
||||
implementations may use alternative approaches such as hashes or full absolute paths as file names.</p>
|
||||
<note conref="#configuration/protected-config-props"/>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="cli-color" rev="2.5">
|
||||
<pt><parmname>cli.color</parmname></pt>
|
||||
<pd>
|
||||
<p>Specifies whether the <cmdname>dita</cmdname> command prints colored output on the command line console.
|
||||
When set to <option>true</option>, error messages in <cmdname>dita</cmdname> command output will appear in
|
||||
red on terminals that support
|
||||
<xref href="https://en.wikipedia.org/wiki/ANSI_escape_code" format="html" scope="external">ANSI escape
|
||||
codes</xref>, such as on Linux or macOS. Set to <option>false</option> to disable the color. (Colored
|
||||
output is not supported on Windows consoles such as <cmdname>cmd.exe</cmdname> or PowerShell).</p>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="plugindirs">
|
||||
<pt><parmname>plugindirs</parmname></pt>
|
||||
<pd id="plugindirs.desc">
|
||||
<p>A semicolon-separated list of directory paths that DITA-OT searches for plug-ins to install; any relative
|
||||
paths are resolved against the DITA-OT base directory. Any immediate subdirectory that contains a
|
||||
<filepath>plugin.xml</filepath> file is installed.</p>
|
||||
<note type="tip">You can use this property to test custom plug-ins that are stored in other locations. For
|
||||
example, to install all of the sample plug-ins that are included in the DITA-OT documentation, append
|
||||
<filepath>;docsrc/samples/plugins</filepath> to the property value and run <cmdname>dita</cmdname>
|
||||
<parmname>--install</parmname>. You can maintain custom plug-ins in version-controlled repositories
|
||||
outside of the DITA-OT installation directory, and add the repository locations to the list of plug-in
|
||||
directories here to test your code.</note></pd>
|
||||
</plentry>
|
||||
<plentry id="plugin.ignores">
|
||||
<pt><parmname>plugin.ignores</parmname></pt>
|
||||
<pd id="plugin.ignores.desc">A semicolon-separated list of directory names to be ignored during plug-in
|
||||
installation; any relative paths are resolved against the DITA-OT base directory.</pd>
|
||||
</plentry>
|
||||
<plentry id="plugin-order">
|
||||
<pt><parmname>plugin.order</parmname></pt>
|
||||
<pd>Defines the order in which plug-ins are processed. In XML catalog files, the order of imports is
|
||||
significant. If multiple plug-ins define the same thing (differently), the first catalog entry “wins”.
|
||||
DITA-OT uses this property to define the order in which catalog entries are written. This mechanism is
|
||||
currently used to ensure that DITA 1.3 grammar files take precedence over their DITA 1.2 equivalents.</pd>
|
||||
</plentry>
|
||||
<plentry id="registry">
|
||||
<pt><parmname>registry</parmname></pt>
|
||||
<pd>Defines the list (and order) of plug-in repositories that are searched for available plug-ins during the
|
||||
installation process. In addition to the main plug-in registry at
|
||||
<xref keyref="site-plugin-registry"/>, you can create a registry of your own to store the custom plug-ins
|
||||
for your company or organization. To add a new entry, append the URL for your custom registry directory to
|
||||
the <codeph>registry</codeph> key value, separating each entry with a space. For more information, see
|
||||
<xref keyref="plugins-registry"/>.</pd>
|
||||
</plentry>
|
||||
<plentry conref="ant-parameters-details.dita#pdf/org.dita.pdf2.i18n.enabled">
|
||||
<pt/>
|
||||
<pd/>
|
||||
</plentry>
|
||||
<plentry id="charset">
|
||||
<pt><parmname>default.coderef-charset</parmname></pt>
|
||||
<pd>As of DITA-OT 3.3, the default character set for code references can be changed by specifying one of the
|
||||
character set values supported by the Java
|
||||
<xref
|
||||
format="html"
|
||||
href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html"
|
||||
scope="external"
|
||||
>Charset</xref> class.</pd>
|
||||
</plentry>
|
||||
</parml>
|
||||
</section>
|
||||
</refbody>
|
||||
<related-links>
|
||||
<link keyref="dita13-spec-metadata-cascade"/>
|
||||
<link keyref="dita13-spec-metadata-cascade-example"/>
|
||||
<link keyref="jelovirt-on-pdf2-i18n"/>
|
||||
</related-links>
|
||||
</reference>
|
||||
49
dita-ot-3.6/docsrc/parameters/configuration-properties.dita
Normal file
49
dita-ot-3.6/docsrc/parameters/configuration-properties.dita
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
<?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 file for applicable license. -->
|
||||
<reference id="configuring-the-dita-ot">
|
||||
<title>Configuration properties</title>
|
||||
<shortdesc>DITA-OT uses <filepath>.properties</filepath> files and internal properties that store configuration
|
||||
settings for the toolkit and its plug-ins. Configuration properties are available to both Ant and Java processes,
|
||||
but unlike argument properties, they cannot be set at run time.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>command line
|
||||
<indexterm>properties</indexterm></indexterm>
|
||||
<indexterm>properties</indexterm>
|
||||
<indexterm>Ant
|
||||
<indexterm>properties</indexterm></indexterm>
|
||||
<indexterm>Java
|
||||
<indexterm>properties</indexterm></indexterm>
|
||||
<indexterm>Ant
|
||||
<indexterm>configuring</indexterm></indexterm>
|
||||
<indexterm>Java
|
||||
<indexterm>configuring</indexterm></indexterm>
|
||||
<indexterm>Ant
|
||||
<indexterm>precedence</indexterm></indexterm>
|
||||
<indexterm>Java
|
||||
<indexterm>precedence</indexterm></indexterm>
|
||||
<indexterm><filepath>local.properties file</filepath></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<refbody>
|
||||
<section>
|
||||
<p>When DITA-OT starts the Ant process, it looks for property values in the following order and locations:</p>
|
||||
<ol>
|
||||
<li>Any property passed to Ant from the command line with <parmname>-Dproperty</parmname> or
|
||||
<parmname>--property</parmname>=<option>value</option></li>
|
||||
<li>A custom property file passed with <parmname>--propertyfile</parmname></li>
|
||||
<li>A <filepath>local.properties</filepath> file in the root directory of the DITA-OT installation</li>
|
||||
<li>The <filepath>lib/org.dita.dost.platform/plugin.properties</filepath> file</li>
|
||||
<li>The <filepath>configuration.properties</filepath> file</li>
|
||||
</ol>
|
||||
<p>If a given property is set in multiple places, the first value “wins” and subsequent entries for the same
|
||||
property are ignored.</p>
|
||||
<p>You can use this mechanism to override DITA-OT default settings for your environment by passing parameters to
|
||||
the <cmdname>dita</cmdname> command with <parmname>--property</parmname>=<option>value</option>, or using
|
||||
entries in <filepath>.properties</filepath> files.</p>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
422
dita-ot-3.6/docsrc/parameters/dita-command-arguments.dita
Normal file
422
dita-ot-3.6/docsrc/parameters/dita-command-arguments.dita
Normal file
|
|
@ -0,0 +1,422 @@
|
|||
<?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 file for applicable license. -->
|
||||
<reference id="dita-command-properties" xml:lang="en">
|
||||
<title>Arguments and options for the <cmdname>dita</cmdname> command</title>
|
||||
<titlealts>
|
||||
<navtitle>DITA command arguments</navtitle>
|
||||
</titlealts>
|
||||
<shortdesc>The <cmdname>dita</cmdname> command takes mandatory arguments to process DITA content. Subcommands can be
|
||||
used to manage plug-ins, or print information about the current configuration. A series of options are available to
|
||||
modify the command behavior or specify additional configuration parameters.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>filters
|
||||
<indexterm><cmdname>dita</cmdname> command</indexterm></indexterm>
|
||||
<indexterm><cmdname>dita</cmdname> command
|
||||
<indexterm>arguments list</indexterm></indexterm>
|
||||
<indexterm>arguments
|
||||
<index-see-also><cmdname>dita</cmdname> command</index-see-also></indexterm>
|
||||
<indexterm>installing</indexterm>
|
||||
<indexterm>uninstalling</indexterm>
|
||||
<indexterm>artlbl
|
||||
<index-see>args.artlbl</index-see></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<refbody>
|
||||
<section>
|
||||
<title>Usage</title>
|
||||
<p>To convert content from one format to another, specify the file to transform and the desired output format. If
|
||||
necessary, you can set additional configuration parameters with options.</p>
|
||||
<syntaxdiagram>
|
||||
<fragment>
|
||||
<groupseq>
|
||||
<kwd>dita</kwd>
|
||||
<kwd>--input</kwd>
|
||||
<oper>=</oper>
|
||||
<var>file</var>
|
||||
<kwd>--format</kwd>
|
||||
<oper>=</oper>
|
||||
<var>name</var>
|
||||
<groupcomp importance="optional">
|
||||
<var>options</var>
|
||||
</groupcomp>
|
||||
</groupseq>
|
||||
</fragment>
|
||||
<fragment>
|
||||
<groupseq>
|
||||
<kwd>dita</kwd>
|
||||
<kwd>--project</kwd>
|
||||
<oper>=</oper>
|
||||
<var>file</var>
|
||||
<groupcomp importance="optional">
|
||||
<var>options</var>
|
||||
</groupcomp>
|
||||
</groupseq>
|
||||
</fragment>
|
||||
</syntaxdiagram>
|
||||
<note>Most <cmdname>dita</cmdname> command options support several syntax alternatives. All options can be
|
||||
specified with a GNU-style option keyword preceded by two hyphens. In many cases, Unix-style single-letter
|
||||
options (preceded by a single hyphen) are also available for brevity and backwards compatibility.</note>
|
||||
<p>The <cmdname>dita</cmdname> command also supports a series of subcommands that can be used to manage plug-ins,
|
||||
or print information about the current configuration or version.</p>
|
||||
<syntaxdiagram>
|
||||
<fragment>
|
||||
<groupseq>
|
||||
<kwd>dita</kwd>
|
||||
<kwd>deliverables</kwd>
|
||||
<var>file</var>
|
||||
</groupseq>
|
||||
</fragment>
|
||||
<fragment>
|
||||
<groupseq>
|
||||
<kwd>dita</kwd>
|
||||
<kwd>install</kwd>
|
||||
<groupchoice importance="optional">
|
||||
<var>ID</var>
|
||||
<var>URL</var>
|
||||
<var>file</var>
|
||||
</groupchoice>
|
||||
</groupseq>
|
||||
</fragment>
|
||||
<fragment>
|
||||
<groupseq>
|
||||
<kwd>dita</kwd>
|
||||
<kwd>plugins</kwd>
|
||||
</groupseq>
|
||||
</fragment>
|
||||
<fragment>
|
||||
<groupseq>
|
||||
<kwd>dita</kwd>
|
||||
<kwd>transtypes</kwd>
|
||||
</groupseq>
|
||||
</fragment>
|
||||
<fragment>
|
||||
<groupseq>
|
||||
<kwd>dita</kwd>
|
||||
<kwd>uninstall</kwd>
|
||||
<var>ID</var>
|
||||
</groupseq>
|
||||
</fragment>
|
||||
<fragment>
|
||||
<groupseq>
|
||||
<kwd>dita</kwd>
|
||||
<kwd>version</kwd>
|
||||
</groupseq>
|
||||
</fragment>
|
||||
</syntaxdiagram>
|
||||
<note type="attention">Prior to DITA-OT 3.5, subcommands were specified with the double-hyphen option syntax,
|
||||
which is still supported for backwards compatibility. (For example, <cmdname>dita</cmdname>
|
||||
<parmname>--install</parmname> will still work.)</note>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>Arguments</title>
|
||||
<indexterm><parmname>--input</parmname></indexterm>
|
||||
<indexterm><parmname>-i</parmname></indexterm>
|
||||
<indexterm><parmname>--format</parmname></indexterm>
|
||||
<indexterm><parmname>-f</parmname></indexterm>
|
||||
<p>Each transformation requires you to specify at least the file to transform and the desired output format.</p>
|
||||
<parml>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--input</parmname>=<varname>file</varname></pt>
|
||||
<pt>
|
||||
<parmname>-i</parmname>
|
||||
<varname>file</varname>
|
||||
</pt>
|
||||
<pd id="args.input.desc">Specifies the master file for your documentation project. This argument corresponds
|
||||
to the common parameter <parmname>args.input</parmname>. 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 current directory if
|
||||
<parmname>args.input.dir</parmname> is not defined.</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--format</parmname>=<varname>name</varname></pt>
|
||||
<pt>
|
||||
<parmname>-f</parmname>
|
||||
<varname>name</varname>
|
||||
</pt>
|
||||
<pd conkeyref="parameters-base/transtype.desc"/>
|
||||
<pd>This argument corresponds to the common parameter <parmname>transtype</parmname>.</pd>
|
||||
<pd>To list the formats that are currently available in your environment, use <cmdname>dita
|
||||
transtypes</cmdname>.</pd>
|
||||
<pd>
|
||||
<p conkeyref="conref-task/transtypes"/>
|
||||
</pd>
|
||||
</plentry>
|
||||
</parml>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>Subcommands</title>
|
||||
<indexterm><cmdname>deliverables</cmdname> subcommand</indexterm>
|
||||
<indexterm><cmdname>install</cmdname> subcommand</indexterm>
|
||||
<indexterm><parmname>--install</parmname>
|
||||
<index-see><cmdname>install</cmdname> subcommand</index-see></indexterm>
|
||||
<indexterm><cmdname>uninstall</cmdname> subcommand</indexterm>
|
||||
<indexterm><parmname>--uninstall</parmname>
|
||||
<index-see><cmdname>uninstall</cmdname> subcommand</index-see></indexterm>
|
||||
<indexterm><cmdname>plugins</cmdname> subcommand</indexterm>
|
||||
<indexterm><parmname>--plugins</parmname>
|
||||
<index-see><cmdname>plugins</cmdname> subcommand</index-see></indexterm>
|
||||
<indexterm><cmdname>transtypes</cmdname> subcommand</indexterm>
|
||||
<indexterm><parmname>--transtypes</parmname>
|
||||
<index-see><cmdname>transtypes</cmdname> subcommand</index-see></indexterm>
|
||||
<indexterm><parmname>--help</parmname></indexterm>
|
||||
<indexterm><parmname>-h</parmname></indexterm>
|
||||
<indexterm><cmdname>version</cmdname> subcommand</indexterm>
|
||||
<indexterm><parmname>--version</parmname>
|
||||
<index-see><cmdname>version</cmdname> subcommand</index-see></indexterm>
|
||||
<parml>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>deliverables</parmname>
|
||||
<varname>file</varname></pt>
|
||||
<pd>Show a list of the available deliverables in the specified project <varname>file</varname>.</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>install</parmname>
|
||||
<varname>{ ID | URL | file }</varname></pt>
|
||||
<pt>
|
||||
<parmname>--install</parmname>=<varname>{ ID | URL | file }</varname></pt>
|
||||
<pd>Install a single plug-in <varname>ID </varname>from the registry at
|
||||
<xref keyref="site-plugin-registry"/> (or a local registry), from a remote <varname>URL</varname>, or a
|
||||
local ZIP <varname>file</varname>.</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>install</parmname>
|
||||
</pt>
|
||||
<pt>
|
||||
<parmname>--install</parmname>
|
||||
</pt>
|
||||
<pd><ph conkeyref="conref-task/plugin-integrate-all"/></pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>uninstall</parmname>
|
||||
<varname>ID</varname>
|
||||
</pt>
|
||||
<pt>
|
||||
<parmname>--uninstall</parmname>=<varname>ID</varname>
|
||||
</pt>
|
||||
<pd>Remove the plug-in with the specified <varname>ID</varname>.</pd>
|
||||
<pd>For a list of the currently installed plug-in IDs, use <cmdname>dita plugins</cmdname>.</pd>
|
||||
<pd>
|
||||
<note conkeyref="conref-task/plugin-remove-subdir"/>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>plugins</parmname>
|
||||
</pt>
|
||||
<pt>
|
||||
<parmname>--plugins</parmname>
|
||||
</pt>
|
||||
<pd>Show a list of the currently installed plug-ins.</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>transtypes</parmname>
|
||||
</pt>
|
||||
<pt>
|
||||
<parmname>--transtypes</parmname>
|
||||
</pt>
|
||||
<pd>Show a list of the available output formats (transformation types).</pd>
|
||||
<pd>The entries in this list may be passed as values to the <parmname>--format</parmname> argument.</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>version</parmname>
|
||||
</pt>
|
||||
<pt>
|
||||
<parmname>--version</parmname>
|
||||
</pt>
|
||||
<pd>Print version information and exit.</pd>
|
||||
</plentry>
|
||||
</parml>
|
||||
</section>
|
||||
<section>
|
||||
<title>Options</title>
|
||||
<indexterm><parmname>-o</parmname></indexterm>
|
||||
<indexterm><parmname>--output</parmname></indexterm>
|
||||
<indexterm><parmname>--filter</parmname></indexterm>
|
||||
<indexterm><parmname>--force</parmname></indexterm>
|
||||
<indexterm><parmname>--temp</parmname></indexterm>
|
||||
<indexterm><parmname>-t</parmname></indexterm>
|
||||
<indexterm><parmname>--verbose</parmname></indexterm>
|
||||
<indexterm><parmname>-v</parmname></indexterm>
|
||||
<indexterm><parmname>--debug</parmname></indexterm>
|
||||
<indexterm><parmname>-d</parmname></indexterm>
|
||||
<indexterm><parmname>--logfile</parmname></indexterm>
|
||||
<indexterm><parmname>-l</parmname></indexterm>
|
||||
<indexterm><parmname>--parameter</parmname></indexterm>
|
||||
<indexterm><parmname>-D</parmname></indexterm>
|
||||
<indexterm><parmname>--propertyfile</parmname></indexterm>
|
||||
<indexterm>Java
|
||||
<indexterm>classes</indexterm></indexterm>
|
||||
<indexterm>debugging
|
||||
<indexterm><cmdname>dita</cmdname> command</indexterm></indexterm>
|
||||
<parml id="dita_build_options">
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--debug</parmname></pt>
|
||||
<pt>
|
||||
<parmname>-d</parmname>
|
||||
</pt>
|
||||
<pd>Debug logging prints considerably more additional information. The debug log includes all information from
|
||||
the verbose log, plus details on Java classes, additional Ant properties and overrides, preprocessing
|
||||
filters, parameters, and stages, and the complete build sequence. Debug logging requires additional
|
||||
resources and can slow down the build process, so it should only be enabled when further details are
|
||||
required to diagnose problems.</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--output</parmname>=<varname>dir</varname></pt>
|
||||
<pt>
|
||||
<parmname>-o</parmname>
|
||||
<varname>dir</varname>
|
||||
</pt>
|
||||
<pd id="output.dir.desc">
|
||||
<p>Specifies the path of the output directory; the path can be absolute or relative to the current
|
||||
directory.</p>
|
||||
<p>This argument corresponds to the common parameter <parmname>output.dir</parmname>. By default, the output
|
||||
is written to the <filepath>out</filepath> subdirectory of the current directory.</p>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--filter</parmname>=<varname>files</varname>
|
||||
</pt>
|
||||
<pd>
|
||||
<!-- Based on ant-parameters-details.dita#args.filter but not identical. Relative paths & repeat differs -->
|
||||
<p>Specifies filter file(s) used to include, exclude, or flag content. Relative paths are resolved against
|
||||
the current directory and internally converted to absolute paths.</p>
|
||||
<note>
|
||||
<p>To specify multiple filter files, use the system path separator character to delimit individual file
|
||||
paths (semicolon ‘<codeph>;</codeph>’ on Windows, and colon ‘<codeph>:</codeph>’ on macOS and Linux) and
|
||||
wrap the value in quotes:</p>
|
||||
<p><codeph>--filter="filter1.ditaval;filter2.ditaval;filter3.ditaval"</codeph></p>
|
||||
<p>As of DITA-OT 3.6, the <parmname>--filter</parmname> option can also be passed multiple times:</p>
|
||||
<p><codeph>--filter=filter1.ditaval --filter=filter2.ditaval --filter=filter3.ditaval</codeph></p>
|
||||
<p>DITAVAL files are evaluated in the order specified, so conditions specified in the first file take
|
||||
precedence over matching conditions specified in later files, just as conditions at the start of a
|
||||
DITAVAL document take precedence over matching conditions later in the same document.</p>
|
||||
</note>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--force</parmname>
|
||||
</pt>
|
||||
<pd>Force-install an existing plug-in.</pd>
|
||||
<pd>Passed as an additional option to the installation subcommand: <cmdname>dita
|
||||
install</cmdname> <varname>plug-in-zip</varname> <parmname>--force</parmname></pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--help</parmname></pt>
|
||||
<pt>
|
||||
<parmname>-h</parmname>
|
||||
</pt>
|
||||
<pd>Print a list of available arguments, options, and subcommands.</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--logfile</parmname>=<varname>file</varname></pt>
|
||||
<pt>
|
||||
<parmname>-l</parmname>
|
||||
<varname>file</varname>
|
||||
</pt>
|
||||
<pd>Write logging messages to a file.</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--parameter</parmname>=<varname>value</varname></pt>
|
||||
<pt>
|
||||
<parmname>-D</parmname><varname>parameter</varname>=<varname>value</varname>
|
||||
</pt>
|
||||
<pd>Specify a value for a DITA-OT or Ant build parameter.</pd>
|
||||
<pd>The GNU-style <parmname>--parameter</parmname>=<varname>value</varname> form is only available for
|
||||
parameters that are configured in the plug-in configuration file; the Java-style <parmname>-D</parmname>
|
||||
form can also be used to specify additional non-configured parameters or set system properties.</pd>
|
||||
<pd>Parameters not implemented by the specified transformation type or referenced in a
|
||||
<filepath>.properties</filepath> file are ignored. <note conkeyref="conref-task/pass-input-dir"/>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--propertyfile</parmname>=<varname>file</varname>
|
||||
</pt>
|
||||
<pd>Use build parameters defined in the referenced <filepath>.properties</filepath> file.</pd>
|
||||
<pd>Build parameters specified on the command line override those set in the <filepath>.properties</filepath>
|
||||
file.</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--repeat</parmname>=<varname>N</varname>
|
||||
</pt>
|
||||
<pd>Repeat the transformation <varname>N</varname> number of times.</pd>
|
||||
<pd>This option can be used by plug-in developers to measure performance. To run a conversion five times, for
|
||||
example, use <parmname>--repeat</parmname>=<option>5</option>. The duration of each execution will appear in
|
||||
the console when the final transformation is complete.
|
||||
<codeblock outputclass="syntax-bash multi-platform">$ <cmdname>dita</cmdname> <parmname
|
||||
>--input</parmname>=<filepath>docsrc/samples/sequence.ditamap</filepath> <parmname
|
||||
>--format</parmname>=<option>html5</option> <parmname>--repeat</parmname>=<option>5</option>
|
||||
1 11281ms
|
||||
2 4132ms
|
||||
3 3690ms
|
||||
4 4337ms
|
||||
5 3634ms</codeblock>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--resource</parmname>=<varname>file</varname>
|
||||
</pt>
|
||||
<pt>
|
||||
<parmname>-r</parmname>
|
||||
<varname>file</varname>
|
||||
</pt>
|
||||
<pd>Convert partial documentation sets by processing input with additional resources.</pd>
|
||||
<pd>For example, to process a single topic file with a map that contains key definitions, use a command like
|
||||
this:
|
||||
<codeblock outputclass="syntax-bash"><cmdname>dita</cmdname> <parmname>--input</parmname>=<filepath
|
||||
>topic.dita</filepath> <parmname>--resource</parmname>=<filepath>keys.ditamap</filepath> <parmname
|
||||
>--format</parmname>=<option>html5</option></codeblock>
|
||||
</pd>
|
||||
<pd>To convert a chapter map to HTML5 and insert related links from relationship tables in a separate map,
|
||||
use:
|
||||
<codeblock outputclass="syntax-bash"><cmdname>dita</cmdname> <parmname>--input</parmname>=<filepath
|
||||
>chapter.ditamap</filepath> <parmname>--resource</parmname>=<filepath
|
||||
>reltables.ditamap</filepath> <parmname>--format</parmname>=<option>html5</option></codeblock>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--temp</parmname>=<varname>dir</varname></pt>
|
||||
<pt>
|
||||
<parmname>-t</parmname>
|
||||
<varname>dir</varname>
|
||||
</pt>
|
||||
<pd conkeyref="parameters-base/dita.temp.dir.desc"/>
|
||||
<pd>This argument corresponds to the common parameter <parmname>dita.temp.dir</parmname>.</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--verbose</parmname></pt>
|
||||
<pt>
|
||||
<parmname>-v</parmname>
|
||||
</pt>
|
||||
<pd>Verbose logging prints additional information to the console, including directory settings, effective
|
||||
values for Ant properties, input/output files, and informational messages to assist in troubleshooting.</pd>
|
||||
</plentry>
|
||||
</parml>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
83
dita-ot-3.6/docsrc/parameters/generate-copy-outer.dita
Normal file
83
dita-ot-3.6/docsrc/parameters/generate-copy-outer.dita
Normal file
|
|
@ -0,0 +1,83 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<concept id="ID">
|
||||
<title>Handling content outside the map directory</title>
|
||||
<shortdesc>By default, DITA-OT assumes content is located in or beneath the directory containing the DITA map file.
|
||||
The <parmname>generate.copy.outer</parmname> parameter can be used to adjust how output is generated for content
|
||||
that is located outside the map directory.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm><parmname>generate.copy.outer</parmname></indexterm>
|
||||
<indexterm>HTML
|
||||
<indexterm>files outside map directory</indexterm></indexterm>
|
||||
<indexterm>DITA maps
|
||||
<indexterm>relative file locations</indexterm></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
|
||||
<conbody>
|
||||
<section>
|
||||
<title>Background</title>
|
||||
<p>This is an issue in the following situations:
|
||||
<ul>
|
||||
<li>The DITA map is in a directory that is a peer to directories that contain referenced objects.</li>
|
||||
<li>The DITA map is in a directory that is below the directories that contain the referenced objects.</li>
|
||||
</ul></p>
|
||||
<p>Let’s assume that the directory structure for the DITA content looks like the following:</p>
|
||||
<p><pre>images/
|
||||
fig.png
|
||||
maps/
|
||||
start.ditamap
|
||||
topics/
|
||||
topic.dita</pre></p>
|
||||
<p>The DITA map is in the <filepath>maps</filepath> directory, the topics are in the <filepath>topics</filepath>
|
||||
directory, and the images are in the <filepath>images</filepath> directory.</p>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>Exclude content outside the map directory</title>
|
||||
<indexterm>index
|
||||
<index-see-also>entry file</index-see-also></indexterm>
|
||||
<indexterm>entry file
|
||||
<indexterm>broken links, reason for</indexterm></indexterm>
|
||||
<p>Let’s assume that you run the HTML5 transformation. By default, DITA-OT uses the
|
||||
<parmname>generate.copy.outer</parmname> parameter with a value of <option>1</option>, which means that no
|
||||
output is generated for content that is located outside the DITA map directory.</p>
|
||||
<p>You receive only the following output:</p>
|
||||
<p><pre>index.html
|
||||
commonltr.css
|
||||
commonrtl.css</pre></p>
|
||||
<p>The <filepath>index.html</filepath> file contains the navigation structure, but all the links are broken, since
|
||||
no HTML files were built for the topics.</p>
|
||||
<p>How do you fix this? By adjusting the parameter setting to shift the output directory.</p>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>Shift the output directory to include all content</title>
|
||||
<p>To preserve the links to referenced topics and images and make it easier to copy the output directory, set the
|
||||
<parmname>generate.copy.outer</parmname> parameter to <option>3</option>.</p>
|
||||
<p>Now your output directory structure resembles the structure of the source directory:</p>
|
||||
<p><pre>images/
|
||||
fig.png
|
||||
maps/
|
||||
index.html
|
||||
topics/
|
||||
topic.html
|
||||
commonltr.css
|
||||
commonrtl.css</pre></p>
|
||||
<p>The <filepath>index.html</filepath> file is in the <filepath>maps</filepath> directory, the HTML files for the
|
||||
topics are in the <filepath>topics</filepath> directory, and the referenced images are in the
|
||||
<filepath>images</filepath> directory.</p>
|
||||
<note type="tip">If <parmname>args.csspath</parmname> is not set, the default CSS files (and any custom CSS files
|
||||
specified via <parmname>args.css</parmname>) will be copied to the root level of the output folder. To copy CSS
|
||||
files to an output subfolder named <filepath>css</filepath>, set <parmname>args.csspath</parmname> to
|
||||
<option>css</option>.
|
||||
<indexterm>CSS
|
||||
<indexterm>copy to specific location</indexterm></indexterm>
|
||||
</note>
|
||||
</section>
|
||||
</conbody>
|
||||
</concept>
|
||||
13
dita-ot-3.6/docsrc/parameters/index.dita
Normal file
13
dita-ot-3.6/docsrc/parameters/index.dita
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
<?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 file for applicable license. -->
|
||||
<reference id="ID">
|
||||
<title>DITA Open Toolkit parameters</title>
|
||||
<titlealts>
|
||||
<navtitle>Parameters</navtitle>
|
||||
</titlealts>
|
||||
<shortdesc>
|
||||
<ph id="ph_docs-pr-desc">You can adjust DITA Open Toolkit behavior via <cmdname>dita</cmdname> command arguments and
|
||||
options, DITA-OT parameter settings, and configuration properties.</ph>
|
||||
</shortdesc>
|
||||
</reference>
|
||||
57
dita-ot-3.6/docsrc/parameters/internal-ant-properties.dita
Normal file
57
dita-ot-3.6/docsrc/parameters/internal-ant-properties.dita
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
<?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 file for applicable license. -->
|
||||
<reference id="ant-properties">
|
||||
<title>Internal Ant properties</title>
|
||||
<shortdesc>Reference list of Ant properties used by DITA-OT internally.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm><xmlatt>role</xmlatt></indexterm>
|
||||
<indexterm>args.rellinks</indexterm>
|
||||
<indexterm>PDF
|
||||
<indexterm>related links</indexterm>
|
||||
<indexterm>args.rellinks</indexterm></indexterm>
|
||||
<indexterm>HTML5
|
||||
<indexterm>related links</indexterm>
|
||||
<indexterm>args.rellinks</indexterm></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<refbody>
|
||||
<section>
|
||||
<parml>
|
||||
<plentry>
|
||||
<pt><codeph>include.rellinks</codeph></pt>
|
||||
<pd>A space-separated list of link roles to be output; the <codeph>#default</codeph> value token represents
|
||||
links without an explicit role (those for which no <xmlatt>role</xmlatt> attribute is defined). Defined by
|
||||
<codeph>args.rellinks</codeph>, but may be overridden directly. Valid roles include:
|
||||
<ul>
|
||||
<li>parent </li>
|
||||
<li>child </li>
|
||||
<li>sibling </li>
|
||||
<li>friend </li>
|
||||
<li>next </li>
|
||||
<li>previous </li>
|
||||
<li>cousin </li>
|
||||
<li>ancestor </li>
|
||||
<li>descendant </li>
|
||||
<li>sample </li>
|
||||
<li>external </li>
|
||||
<li>other</li>
|
||||
</ul></pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt><codeph>temp.output.dir.name</codeph></pt>
|
||||
<pd>An internal property for use with custom transform types; this property can be used to place all output in
|
||||
an internal directory, so that a final step in the transform type can do some form of post-processing before
|
||||
the files are placed in the specified output directory.
|
||||
<p>For example, if a custom HTML5 transform sets the property to <codeph>zip_dir</codeph>, all output files
|
||||
(including HTML, images, and CSS) will be placed within the directory <filepath>zip_dir</filepath> in the
|
||||
temporary processing directory. A final step can then be used to add more files, zip the directory, and
|
||||
return that zip to the designated output directory.</p></pd>
|
||||
</plentry>
|
||||
</parml>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
63
dita-ot-3.6/docsrc/parameters/local-properties-file.dita
Normal file
63
dita-ot-3.6/docsrc/parameters/local-properties-file.dita
Normal file
|
|
@ -0,0 +1,63 @@
|
|||
<?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 file for applicable license. -->
|
||||
<reference id="local.properties">
|
||||
<title>The <filepath>local.properties</filepath> file</title>
|
||||
<titlealts>
|
||||
<navtitle><filepath>local.properties</filepath></navtitle>
|
||||
</titlealts>
|
||||
<shortdesc>A <filepath>local.properties</filepath> file in the root directory of the DITA-OT installation can be used
|
||||
to override the default values of various DITA-OT parameters.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>files
|
||||
<indexterm>local.properties</indexterm></indexterm>
|
||||
<indexterm>local.properties file</indexterm>
|
||||
<indexterm>Windows</indexterm>
|
||||
<indexterm>RenderX
|
||||
<indexterm><filepath>local.properties</filepath></indexterm></indexterm>
|
||||
<indexterm>Antenna House
|
||||
<indexterm><filepath>local.properties</filepath></indexterm></indexterm>
|
||||
<indexterm>command line
|
||||
<indexterm><filepath>local.properties</filepath> file</indexterm></indexterm>
|
||||
<indexterm>Java
|
||||
<indexterm>local.properties file</indexterm></indexterm>
|
||||
<indexterm>PDF
|
||||
<indexterm>formatter</indexterm></indexterm>
|
||||
<indexterm>formatter
|
||||
<index-see-also>Apache FOP</index-see-also>
|
||||
<index-see-also>Antenna House</index-see-also>
|
||||
<index-see-also>RenderX</index-see-also></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<refbody>
|
||||
<example>
|
||||
<p>For example, if you always use the same rendering engine to produce PDF output for all of your projects, you
|
||||
could create a <filepath>local.properties</filepath> file in the root directory of your DITA-OT installation to
|
||||
set the <parmname>pdf.formatter</parmname> parameter and additional options for the XSL processor:</p>
|
||||
<codeblock
|
||||
outputclass="language-properties normalize-space show-line-numbers show-whitespace"
|
||||
># Use RenderX XEP Engine for PDF output
|
||||
pdf.formatter = xep
|
||||
|
||||
# Specify the user configuration file for RenderX
|
||||
custom.xep.config = /path/to/custom.config</codeblock>
|
||||
<p>Backslash “\” characters in .properties files must be escaped with a second backslash as “\\”. If you use
|
||||
Antenna House Formatter on a Windows system, for example, you would set the path to the command using a
|
||||
properties file entry like this:</p>
|
||||
<codeblock
|
||||
outputclass="language-properties normalize-space show-line-numbers show-whitespace"
|
||||
># Use Antenna House Formatter for PDF output
|
||||
pdf.formatter = ah
|
||||
|
||||
# Specify the path to the Antenna House Formatter command
|
||||
axf.cmd=C:\\Program Files\\Antenna House\\AHFormatterV62</codeblock>
|
||||
</example>
|
||||
<section>
|
||||
<note>This file can only be used to set Ant property values that can be passed as argument parameters to the
|
||||
command line. The DITA-OT Java code does not read this file.</note>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
4
dita-ot-3.6/docsrc/parameters/parameters-base-html.dita
Normal file
4
dita-ot-3.6/docsrc/parameters/parameters-base-html.dita
Normal file
File diff suppressed because one or more lines are too long
4
dita-ot-3.6/docsrc/parameters/parameters-base.dita
Normal file
4
dita-ot-3.6/docsrc/parameters/parameters-base.dita
Normal file
File diff suppressed because one or more lines are too long
4
dita-ot-3.6/docsrc/parameters/parameters-dita.dita
Normal file
4
dita-ot-3.6/docsrc/parameters/parameters-dita.dita
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
<?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="dita"><title outputclass="generated">Normalized DITA parameters</title><titlealts><navtitle>Normalized DITA</navtitle></titlealts><shortdesc id="shortdesc"/><refbody><section><parml/></section></refbody></reference>
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
<?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="eclipsehelp"><title outputclass="generated">Eclipse Help parameters</title><titlealts><navtitle>Eclipse Help</navtitle></titlealts><shortdesc id="shortdesc"/><refbody><section><parml><plentry id="args.eclipse.provider" props="eclipsehelp"><pt><parmname>args.eclipse.provider</parmname><ph><indexterm><parmname>args.eclipse.provider</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.eclipse.provider</parmname></indexterm></indexterm></ph></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.symbolic.name" props="eclipsehelp"><pt><parmname>args.eclipse.symbolic.name</parmname><ph><indexterm><parmname>args.eclipse.symbolic.name</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.eclipse.symbolic.name</parmname></indexterm></indexterm></ph></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><ph><indexterm><parmname>args.eclipse.version</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.eclipse.version</parmname></indexterm></indexterm></ph></pt><pd id="args.eclipse.version.desc">Specifies the version number to include in the output.</pd></plentry><plentry id="args.eclipsehelp.country" props="eclipsehelp"><pt><parmname>args.eclipsehelp.country</parmname><ph><indexterm><parmname>args.eclipsehelp.country</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.eclipsehelp.country</parmname></indexterm></indexterm></ph></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.jar.name" props="eclipsehelp"><pt><parmname>args.eclipsehelp.jar.name</parmname><ph><indexterm><parmname>args.eclipsehelp.jar.name</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.eclipsehelp.jar.name</parmname></indexterm></indexterm></ph></pt><pd id="args.eclipsehelp.jar.name.desc">Specifies that the output should be zipped and returned using this name.</pd></plentry><plentry id="args.eclipsehelp.language" props="eclipsehelp"><pt><parmname>args.eclipsehelp.language</parmname><ph><indexterm><parmname>args.eclipsehelp.language</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.eclipsehelp.language</parmname></indexterm></indexterm></ph></pt><pd id="args.eclipsehelp.language.desc">Specifies the base language for translated content, such as en for English.</pd></plentry></parml></section></refbody></reference>
|
||||
4
dita-ot-3.6/docsrc/parameters/parameters-html5.dita
Normal file
4
dita-ot-3.6/docsrc/parameters/parameters-html5.dita
Normal file
File diff suppressed because one or more lines are too long
4
dita-ot-3.6/docsrc/parameters/parameters-htmlhelp.dita
Normal file
4
dita-ot-3.6/docsrc/parameters/parameters-htmlhelp.dita
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
<?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="htmlhelp"><title outputclass="generated">Microsoft Compiled HTML Help parameters</title><titlealts><navtitle>Microsoft Compiled HTML Help</navtitle></titlealts><shortdesc id="shortdesc"/><refbody><section><parml><plentry id="args.htmlhelp.includefile" props="htmlhelp"><pt><parmname>args.htmlhelp.includefile</parmname><ph><indexterm><parmname>args.htmlhelp.includefile</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.htmlhelp.includefile</parmname></indexterm></indexterm></ph></pt><pd id="args.htmlhelp.includefile.desc">Specifies the name of a file that you want included in the HTML Help.</pd></plentry></parml></section></refbody></reference>
|
||||
4
dita-ot-3.6/docsrc/parameters/parameters-markdown.dita
Normal file
4
dita-ot-3.6/docsrc/parameters/parameters-markdown.dita
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
<?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="markdown"><title outputclass="generated">Markdown parameters</title><titlealts><navtitle>Markdown</navtitle></titlealts><shortdesc id="shortdesc"/><refbody><section><parml/></section></refbody></reference>
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
<?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="markdown_gitbook"><title outputclass="generated">GitBook parameters</title><titlealts><navtitle>GitBook</navtitle></titlealts><shortdesc id="shortdesc"/><refbody><section><parml/></section></refbody></reference>
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
<?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="markdown_github"><title outputclass="generated">GitHub-flavored Markdown parameters</title><titlealts><navtitle>GitHub-flavored Markdown</navtitle></titlealts><shortdesc id="shortdesc"/><refbody><section><parml/></section></refbody></reference>
|
||||
84
dita-ot-3.6/docsrc/parameters/parameters-other.dita
Normal file
84
dita-ot-3.6/docsrc/parameters/parameters-other.dita
Normal file
|
|
@ -0,0 +1,84 @@
|
|||
<?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 file for applicable license. -->
|
||||
|
||||
<reference id="ant-parameters-other">
|
||||
<title>Other parameters</title>
|
||||
<titlealts>
|
||||
<navtitle>Other</navtitle>
|
||||
</titlealts>
|
||||
<shortdesc>These parameters enable you to reload style sheets that DITA-OT uses for specific pre-processing
|
||||
stages.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>XSLT
|
||||
<index-see-also>extension points</index-see-also>
|
||||
<index-see-also>preprocessing</index-see-also></indexterm>
|
||||
<indexterm>preprocessing
|
||||
<indexterm>XSLT</indexterm></indexterm>
|
||||
<indexterm>preprocessing
|
||||
<index-see-also>Java</index-see-also></indexterm>
|
||||
<indexterm>preprocessing
|
||||
<indexterm>extension points, parameters</indexterm></indexterm>
|
||||
<indexterm>Java
|
||||
<indexterm>out of memory</indexterm></indexterm>
|
||||
<indexterm>memory</indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<refbody>
|
||||
<section>
|
||||
<parml>
|
||||
<plentry>
|
||||
<pt id="dita.html5.reloadstylesheet">
|
||||
<parmname>dita.html5.reloadstylesheet</parmname>
|
||||
</pt>
|
||||
<pt id="dita.preprocess.reloadstylesheet">
|
||||
<parmname>dita.preprocess.reloadstylesheet</parmname>
|
||||
</pt>
|
||||
<pt id="dita.preprocess.reloadstylesheet.clean-map">
|
||||
<parmname>dita.preprocess.reloadstylesheet.clean-map</parmname>
|
||||
</pt>
|
||||
<pt id="dita.preprocess.reloadstylesheet.conref">
|
||||
<parmname>dita.preprocess.reloadstylesheet.conref</parmname>
|
||||
</pt>
|
||||
<pt id="dita.preprocess.reloadstylesheet.flag-module">
|
||||
<parmname>dita.preprocess.reloadstylesheet.lag-module</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>
|
||||
<pt id="dita.xhtml.reloadstylesheet">
|
||||
<parmname>dita.xhtml.reloadstylesheet</parmname>
|
||||
</pt>
|
||||
<pd id="dita.preprocess.reloadstylesheet.desc">
|
||||
<p>Specifies whether 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>.</p>
|
||||
<p>During the pre-processing stage, DITA-OT processes one DITA topic at a time, using the same XSLT
|
||||
stylesheet for the entire process. These parameters control whether Ant will use the same
|
||||
<codeph>Transformer</codeph> object in Java, the object that handles the XSLT processing, for all
|
||||
topics, or create a separate <codeph>Transformer</codeph> for each topic.</p>
|
||||
<p>The default (<option>false</option>) option uses the same <codeph>Transformer</codeph>, which is a little
|
||||
faster, because it will not need to parse/compile the XSLT stylesheets and only needs to read the source
|
||||
trees with <codeph>document()</codeph> once. The downside is that it will not release the source trees
|
||||
from memory, so you can run out of memory.</p>
|
||||
<note type="tip">For large projects that generate Java out-of-memory errors during transformation, set the
|
||||
parameter to <option>true</option> to allow the XSLT processor to release memory. You may also need to
|
||||
increase the memory available to Java.</note>
|
||||
</pd>
|
||||
</plentry>
|
||||
</parml>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
4
dita-ot-3.6/docsrc/parameters/parameters-pdf.dita
Normal file
4
dita-ot-3.6/docsrc/parameters/parameters-pdf.dita
Normal file
File diff suppressed because one or more lines are too long
4
dita-ot-3.6/docsrc/parameters/parameters-pdf2.dita
Normal file
4
dita-ot-3.6/docsrc/parameters/parameters-pdf2.dita
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
<?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="pdf2"><title outputclass="generated">PDF2 parameters</title><titlealts><navtitle>PDF2</navtitle></titlealts><shortdesc id="shortdesc"/><refbody><section><parml/></section></refbody></reference>
|
||||
4
dita-ot-3.6/docsrc/parameters/parameters-xhtml.dita
Normal file
4
dita-ot-3.6/docsrc/parameters/parameters-xhtml.dita
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
<?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="xhtml"><title outputclass="generated">XHTML parameters</title><titlealts><navtitle>XHTML</navtitle></titlealts><shortdesc id="shortdesc"/><refbody><section><parml><plentry id="args.xhtml.contenttarget" props="xhtml"><pt><parmname>args.xhtml.contenttarget</parmname><ph><indexterm><parmname>args.xhtml.contenttarget</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.xhtml.contenttarget</parmname></indexterm></indexterm></ph></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="xhtml"><pt><parmname>args.xhtml.toc</parmname><ph><indexterm><parmname>args.xhtml.toc</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.xhtml.toc</parmname></indexterm></indexterm></ph></pt><pd id="args.xhtml.toc.desc">Specifies the base name of the TOC file.</pd></plentry><plentry id="args.xhtml.toc.class" props="xhtml"><pt><parmname>args.xhtml.toc.class</parmname><ph><indexterm><parmname>args.xhtml.toc.class</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.xhtml.toc.class</parmname></indexterm></indexterm></ph></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="xhtml"><pt><parmname>args.xhtml.toc.xsl</parmname><ph><indexterm><parmname>args.xhtml.toc.xsl</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.xhtml.toc.xsl</parmname></indexterm></indexterm></ph></pt><pd id="args.xhtml.toc.xsl.desc">Specifies a custom XSL file to be used for TOC generation.</pd></plentry></parml></section></refbody></reference>
|
||||
28
dita-ot-3.6/docsrc/parameters/parameters.ditamap
Normal file
28
dita-ot-3.6/docsrc/parameters/parameters.ditamap
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<map>
|
||||
<title>Parameter Reference</title>
|
||||
<topicref keyref="dita-command-arguments"/>
|
||||
<topicref keyref="parameters_intro" keys="dita-ot-params">
|
||||
<topicref keyref="parameters-base"/>
|
||||
<topicref keyref="parameters-pdf"/>
|
||||
<topicref keyref="parameters-base-html"/>
|
||||
<topicref keyref="parameters-html5"/>
|
||||
<topicref keyref="parameters-xhtml"/>
|
||||
<topicref keyref="parameters-htmlhelp" locktitle="yes" platform="windows">
|
||||
<topicmeta>
|
||||
<navtitle>HTML Help</navtitle>
|
||||
</topicmeta>
|
||||
</topicref>
|
||||
<topicref keyref="parameters-eclipsehelp"/>
|
||||
<topicref keyref="parameters-other"/>
|
||||
<topicref keyref="ant-parameters-details" keys="parameters-push" processing-role="resource-only" toc="no"/>
|
||||
</topicref>
|
||||
<topicref keyref="configuration-properties">
|
||||
<topicref keyref="local-properties-file"/>
|
||||
<topicref keyref="plugin-properties-file"/>
|
||||
<topicref keyref="configuration-properties-file"/>
|
||||
<topicref keyref="internal-ant-properties"/>
|
||||
</topicref>
|
||||
</map>
|
||||
37
dita-ot-3.6/docsrc/parameters/parameters_intro.dita
Normal file
37
dita-ot-3.6/docsrc/parameters/parameters_intro.dita
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
<?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 file for applicable license. -->
|
||||
<reference id="dita-ot-ant-properties">
|
||||
<title>DITA-OT parameters</title>
|
||||
|
||||
<shortdesc>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 <cmdname>dita</cmdname> command using the <parmname>--parameter</parmname>=<varname>value</varname>
|
||||
syntax or included in build scripts as Ant properties.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm><cmdname>dita</cmdname> command
|
||||
<indexterm>parameters</indexterm></indexterm>
|
||||
<indexterm>parameters</indexterm>
|
||||
<indexterm>transformations
|
||||
<indexterm>parameters</indexterm></indexterm>
|
||||
<indexterm>transformations
|
||||
<indexterm>HTML</indexterm></indexterm>
|
||||
<indexterm>Ant
|
||||
<indexterm>properties</indexterm>
|
||||
<indexterm>parameters</indexterm></indexterm>
|
||||
<indexterm>Ant
|
||||
<indexterm>build script</indexterm>
|
||||
<indexterm>script</indexterm></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
|
||||
<refbody>
|
||||
<section>
|
||||
<p>If your toolkit installation includes custom plug-ins that define additional parameters, you can add entries to
|
||||
the following topics by rebuilding the DITA-OT documentation.</p>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
33
dita-ot-3.6/docsrc/parameters/plugin-properties-file.dita
Normal file
33
dita-ot-3.6/docsrc/parameters/plugin-properties-file.dita
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
<?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 file for applicable license. -->
|
||||
<reference id="lib-org.dita.dost.platform-plugin.properties">
|
||||
<title>The <filepath>plugin.properties</filepath> file</title>
|
||||
<titlealts>
|
||||
<navtitle><filepath>plugin.properties</filepath></navtitle>
|
||||
</titlealts>
|
||||
<shortdesc>The <filepath>plugin.properties</filepath> file is used to store configuration properties that are set by
|
||||
the plug-in installation process.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>files
|
||||
<indexterm>plugin.properties</indexterm></indexterm>
|
||||
<indexterm>plugin.properties file</indexterm>
|
||||
<indexterm>Java
|
||||
<indexterm>plugin.properties</indexterm></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<refbody>
|
||||
<section>
|
||||
<p>The file is located in the <filepath>lib/org.dita.dost.platform</filepath> directory of the DITA-OT
|
||||
installation and stores a cached version of the plug-in configuration used by the Java code.</p>
|
||||
<p>The contents of this file depend on the installed plug-ins. Each plug-in may contribute properties such as the
|
||||
path to the plug-in folder, supported extensions and print transformation types.</p>
|
||||
<note type="warning">The <filepath>plugin.properties</filepath> file is regenerated each time the plug-in
|
||||
integration process is run, so it should not be edited manually as these changes would be lost the next time a
|
||||
plug-in is installed or removed.</note>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
Loading…
Add table
Add a link
Reference in a new issue