Skip to content

Commit

Permalink
Update ‘4.2’ docs for 4.2.4
Browse files Browse the repository at this point in the history
Signed-off-by: DITA-OT Bot <[email protected]>
  • Loading branch information
dita-ot-bot authored and infotexture committed Dec 15, 2024
1 parent 1c67a91 commit 060f106
Show file tree
Hide file tree
Showing 25 changed files with 199 additions and 90 deletions.
2 changes: 1 addition & 1 deletion 4.2/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ <h1 class="title topictitle1" id="ariaid-title1">DITA Open Toolkit <span class="
the toolkit.</p>
<ul class="ul list-group mb-5">
<li class="li list-group-item list-group-item-action">See the
<a class="xref stretched-link" href="release-notes/index.html" title="DITA Open Toolkit 4.2.3 is a maintenance release that fixes issues reported in DITA-OT 4.2, which uses map-first pre-processing for HTML5 output and includes a new local configuration file, better CLI messages with support for overrides, a new version of the Lightweight DITA plug-in with enhancements to Markdown processing, and updates for the latest DITA 2.0 draft standard.">DITA Open Toolkit 4.2 Release Notes</a> for information on the changes in the current
<a class="xref stretched-link" href="release-notes/index.html" title="DITA Open Toolkit 4.2.4 is a maintenance release that fixes issues reported in DITA-OT 4.2, which uses map-first pre-processing for HTML5 output and includes a new local configuration file, better CLI messages with support for overrides, a new version of the Lightweight DITA plug-in with enhancements to Markdown processing, and updates for the latest DITA 2.0 draft standard.">DITA Open Toolkit 4.2 Release Notes</a> for information on the changes in the current
release.</li>
<li class="li list-group-item list-group-item-action">
<a class="xref stretched-link" href="topics/installing-client.html" title="The DITA-OT distribution package can be installed on Linux, macOS, and Windows. It contains everything that you need to run the toolkit except for Java.">Installing DITA Open Toolkit</a> shows how to install the toolkit and run a
Expand Down
14 changes: 13 additions & 1 deletion 4.2/parameters/configuration-properties-file.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
src: 'parameters/configuration-properties-file.dita'
---

<nav class="col-lg-3 toc" role="navigation"><ul><li><a href="../index.html">DITA Open Toolkit 4.2</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a><ul class="nav nav-list"><li><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li><a href="../parameters/parameters_intro.html">DITA-OT parameters</a></li><li><a href="../parameters/configuration-properties.html">Configuration properties</a><ul class="nav nav-list"><li><a href="../parameters/local-properties-file.html">local.properties</a></li><li><a href="../parameters/plugin-properties-file.html">plugin.properties</a></li><li class="active"><a href="../parameters/configuration-properties-file.html">configuration.properties</a></li><li><a href="../parameters/internal-ant-properties.html">Internal Ant properties</a></li></ul></li></ul></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main" class="col-lg-9"><article role="article" aria-labelledby="ariaid-title1">
<nav class="col-lg-3 toc" role="navigation"><ul><li><a href="../index.html">DITA Open Toolkit 4.2</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a><ul class="nav nav-list"><li><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li><a href="../parameters/parameters_intro.html">DITA-OT parameters</a></li><li><a href="../parameters/configuration-properties.html">Configuration properties</a><ul class="nav nav-list"><li><a href="../parameters/dot-ditaotrc-file.html">.ditaotrc</a></li><li><a href="../parameters/local-properties-file.html">local.properties</a></li><li><a href="../parameters/plugin-properties-file.html">plugin.properties</a></li><li class="active"><a href="../parameters/configuration-properties-file.html">configuration.properties</a></li><li><a href="../parameters/internal-ant-properties.html">Internal Ant properties</a></li></ul></li></ul></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main" class="col-lg-9"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">The <span class="ph filepath">configuration.properties</span> file</h1>


Expand All @@ -21,6 +21,18 @@ <h1 class="title topictitle1" id="ariaid-title1">The <span class="ph filepath">c
following properties are typically set in this file:</p>
<dl class="dl parml">

<dt class="dt pt dlterm" id="configuration__compatibility-keyref-treat-blank-as-empty"><span class="keyword parmname">compatibility.keyref.treat-blank-as-empty</span></dt>
<dd class="dd pd">
<p class="p">When set to <code class="ph codeph">true</code>, this property enables a compatibility mode that processes key
references that contain only whitespace characters like earlier versions of DITA-OT (prior to version
4.2.4). This behavior is not correct according to the DITA specification, but this setting ensures that
existing content that relies on this behavior will be processed in the same way as in earlier versions.
Set this property to <code class="ph codeph">false</code> to skip these references as intended in the DITA
specification.</p>
<div class="note warning note_warning"><span class="note__title">Warning:</span> <div class="note__body">This property can only be set in
<span class="ph filepath">configuration.properties</span>.</div></div></dd>


<dt class="dt pt dlterm" id="configuration__default-cascade"><span class="keyword parmname">default.cascade</span></dt>
<dd class="dd pd">
<p class="p">Specifies the processing default value for the DITA 1.3 <code class="keyword markupname xmlatt">@cascade</code> attribute, which
Expand Down
8 changes: 5 additions & 3 deletions 4.2/parameters/configuration-properties.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
src: 'parameters/configuration-properties.dita'
---

<nav class="col-lg-3 toc" role="navigation"><ul><li><a href="../index.html">DITA Open Toolkit 4.2</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a><ul class="nav nav-list"><li><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li><a href="../parameters/parameters_intro.html">DITA-OT parameters</a></li><li class="active"><a href="../parameters/configuration-properties.html">Configuration properties</a><ul class="nav nav-list"><li><a href="../parameters/local-properties-file.html">local.properties</a></li><li><a href="../parameters/plugin-properties-file.html">plugin.properties</a></li><li><a href="../parameters/configuration-properties-file.html">configuration.properties</a></li><li><a href="../parameters/internal-ant-properties.html">Internal Ant properties</a></li></ul></li></ul></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main" class="col-lg-9"><article role="article" aria-labelledby="ariaid-title1">
<nav class="col-lg-3 toc" role="navigation"><ul><li><a href="../index.html">DITA Open Toolkit 4.2</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a><ul class="nav nav-list"><li><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li><a href="../parameters/parameters_intro.html">DITA-OT parameters</a></li><li class="active"><a href="../parameters/configuration-properties.html">Configuration properties</a><ul class="nav nav-list"><li><a href="../parameters/dot-ditaotrc-file.html">.ditaotrc</a></li><li><a href="../parameters/local-properties-file.html">local.properties</a></li><li><a href="../parameters/plugin-properties-file.html">plugin.properties</a></li><li><a href="../parameters/configuration-properties-file.html">configuration.properties</a></li><li><a href="../parameters/internal-ant-properties.html">Internal Ant properties</a></li></ul></li></ul></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main" class="col-lg-9"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">Configuration properties</h1>


Expand All @@ -22,6 +22,8 @@ <h1 class="title topictitle1" id="ariaid-title1">Configuration properties</h1>
<li class="li">Any property passed to Ant from the command line with <span class="keyword parmname">-Dproperty</span> or
<span class="keyword parmname">--property</span>=<span class="keyword option">value</span></li>
<li class="li">A custom property file passed with <span class="keyword parmname">--propertyfile</span></li>
<li class="li">A <span class="ph filepath">.ditaotrc</span> configuration file in the current directory or any ancestor directory, in
the user’s home directory, or in the root directory of the DITA-OT installation</li>
<li class="li">A <span class="ph filepath">local.properties</span> file in the root directory of the DITA-OT installation</li>
<li class="li">The <span class="ph filepath">lib/org.dita.dost.platform/plugin.properties</span> file</li>
<li class="li">The <span class="ph filepath">configuration.properties</span> file</li>
Expand All @@ -30,7 +32,7 @@ <h1 class="title topictitle1" id="ariaid-title1">Configuration properties</h1>
property are ignored.</p>
<p class="p">You can use this mechanism to override DITA-OT default settings for your environment by passing parameters to
the <span class="keyword cmdname">dita</span> command with <span class="keyword parmname">--property</span>=<span class="keyword option">value</span>, or using
entries in <span class="ph filepath">.properties</span> files.</p>
entries in runtime configurations or <span class="ph filepath">.properties</span> files.</p>
</section>
</div>
<nav role="navigation" class="related-links"><ul class="ullinks"><li class="link ulchildlink"><strong><a href="local-properties-file.html">The local.properties file</a></strong><br>A <span class="ph filepath">local.properties</span> file in the root directory of the DITA-OT installation can be used to override the default values of various DITA-OT parameters.</li><li class="link ulchildlink"><strong><a href="plugin-properties-file.html">The plugin.properties file</a></strong><br>The <span class="ph filepath">plugin.properties</span> file is used to store configuration properties that are set by the plug-in installation process.</li><li class="link ulchildlink"><strong><a href="configuration-properties-file.html">The configuration.properties file</a></strong><br>The <span class="ph filepath">configuration.properties</span> file controls certain common properties, as well as some properties that control PDF processing.</li><li class="link ulchildlink"><strong><a href="internal-ant-properties.html">Internal Ant properties</a></strong><br>DITA-OT uses these Ant properties in certain internal operations. They are not intended for general use, but may be adjusted by plug-in developers to configure custom transform types.</li></ul></nav></article></main>
<nav role="navigation" class="related-links"><ul class="ullinks"><li class="link ulchildlink"><strong><a href="dot-ditaotrc-file.html">The .ditaotrc configuration file</a></strong><br>As of DITA-OT 4.2, new files can be used to store DITA-OT runtime configurations in multiple places to support fine-grained configuration layers.</li><li class="link ulchildlink"><strong><a href="local-properties-file.html">The local.properties file</a></strong><br>A <span class="ph filepath">local.properties</span> file in the root directory of the DITA-OT installation can be used to override the default values of various DITA-OT parameters.</li><li class="link ulchildlink"><strong><a href="plugin-properties-file.html">The plugin.properties file</a></strong><br>The <span class="ph filepath">plugin.properties</span> file is used to store configuration properties that are set by the plug-in installation process.</li><li class="link ulchildlink"><strong><a href="configuration-properties-file.html">The configuration.properties file</a></strong><br>The <span class="ph filepath">configuration.properties</span> file controls certain common properties, as well as some properties that control PDF processing.</li><li class="link ulchildlink"><strong><a href="internal-ant-properties.html">Internal Ant properties</a></strong><br>DITA-OT uses these Ant properties in certain internal operations. They are not intended for general use, but may be adjusted by plug-in developers to configure custom transform types.</li></ul></nav></article></main>
Loading

0 comments on commit 060f106

Please sign in to comment.