| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139 |
- <?xml version="1.0" encoding="UTF-8"?>
- <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
- <!--This file is part of the DITA Open Toolkit project. See the accompanying LICENSE.md file for applicable licenses.-->
- <reference id="configuration" xml:lang="en">
- <title><filepath>configuration.properties</filepath> file</title>
- <shortdesc>The <filepath>lib/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.language</indexterm>
- <indexterm>generate-debug-attributes</indexterm>
- <indexterm>processing-mode</indexterm>
- <indexterm>org.dita.pdf2.i18n.enabled</indexterm>
- <indexterm>org.dita.pdf2.use-out-temp</indexterm>
- </indexterm>
- <indexterm>files
- <indexterm>lib/configuration.properties file</indexterm>
- <indexterm>topic.fo file</indexterm>
- </indexterm>
- <indexterm>topic.fo
- <indexterm>location of</indexterm>
- </indexterm>
- <indexterm>PDF processing
- <indexterm>configuration properties</indexterm>
- </indexterm>
- </keywords>
- </metadata>
- </prolog>
- <refbody>
- <section>
- <fig>
- <title>Properties set in the <filepath>lib/configuration.properties</filepath> file</title>
- <parml>
- <plentry id="default.language">
- <pt><parmname>default.language</parmname></pt>
- <pd id="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>.</pd>
- </plentry>
- <!--<plentry id="generate-debug-attributes">
- <pt><parmname>generate-debug-attributes</parmname></pt>
- <pd id="generate-debug-attributes.desc">Specifies whether the @xtrf and @xtrc debugging attributes are
- generated in the temporary files. The following values are allowed: <ul>
- <li><option>true</option> (default) — Enables generation of debugging attributes</li>
- <li><option>false</option> —Disables generation of debugging attributes</li>
- </ul><note>Disabling debugging attributes reduces the size of temporary files and thus reduces memory
- consumption. However, the log messages no longer have the source information available and thus the
- ability to debug problems might deteriorate.</note></pd>
- </plentry>
- <plentry id="processing-mode">
- <pt><parmname>processing-mode</parmname></pt>
- <pd id="processing-mode.desc">Specifies how the DITA-OT handles errors and error recovery. The following
- values are allowed:
- <ul>
- <li><option>strict</option> — When an error is encountered, the DITA-OT stops processing.</li>
- <li><option>lax</option> (default) — When an error is encountered, the DITA-OT attempts to recover from
- it.</li>
- <li><option>skip</option> — When an error is encountered, the DITA continues processing but does not
- attempt error recovery.</li>
- </ul></pd>
- </plentry>-->
- <plentry id="org.dita.pdf2.i18n.enabled">
- <pt><parmname>org.dita.pdf2.i18n.enabled</parmname></pt>
- <pd id="org.dita.pdf2.i18n.enabled.desc">(PDF transformation only) Enables I18N font processing. The
- following values are allowed:
- <ul>
- <li><option>true</option> (default) — Enables I18N processing</li>
- <li><option>false</option> — Disables I18N processing</li>
- </ul>
- <draft-comment author="Kristen James Eberlein" time="16 August 2012">This needs beefing up. Here is info
- provided by Jarno Elovirta:
- <p>(IIRC, pre 1.0 versions of FOP didn't correctly implement font selection in XSL FO files, that's the
- reason for this feature existing). The PDF2 I18N allows you to say define which characters are output
- with which pseudo-font, and the font mapping files define the actual font. E.g. the configuration for
- English at src/main/plugins/org.dita.pdf2/cfg/fo/i18n/en.xml
- is:<codeblock>
- <alphabet char-set="SymbolsSuperscript">
- <character-set>
- <!-- Copyright -->
- <character>&#169;</character>
- <!-- Registered Trademark -->
- <character>&#174;</character>
- <!-- Trademark -->
- <character>&#8482;</character>
- <!-- Service mark -->
- <character>&#2120;</character>
- </character-set>
- </alphabet>
- <alphabet char-set="SubmenuSymbol">
- <character-set>
- <character>&#x27A4;</character>
- </character-set>
- </alphabet>
- </codeblock></p>
- <p>That is, those specific characters are marked as "SymbolsSuperscript" or "SubmenuSymbol" charset. The
- font mappings at src/main/plugins/org.dita.pdf2/cfg/fo/font-mappings.xml then define which font to use
- for them,
- e.g.:<codeblock><physical-font char-set="SymbolsSuperscript">
- <font-face>Helvetica, Arial Unicode MS</font-face>
- <baseline-shift>20%</baseline-shift>
- <override-size>smaller</override-size>
- </physical-font></codeblock></p>
- <p>The I18N processing is on by default (because it's been on before), but for most users it's just an
- additional level of complexity which should be turned off and support for multiple languages be
- handled in XSLT code.</p>
- </draft-comment>
- </pd>
- </plentry>
- <!--<plentry id="org.dita.pdf2.use-out-temp">
- <pt><parmname>org.dita.pdf2.use-out-temp</parmname></pt>
- <pd id="org.dita.pdf2.use-out-temp.desc">(PDF transformation only) Specifies whether the XSL-FO processing
- writes the intermediate files (for example, the <filepath>topic.fo</filepath> file) to the output
- directory. The following values are allowed:
- <ul>
- <li><option>true</option> — Write intermediate files to the output directory</li>
- <li><option>false</option> (default) — Write intermediate files to the temporary directory</li>
- </ul></pd>
- </plentry>-->
- <plentry id="plugindirs">
- <pt><parmname>plugindirs</parmname></pt>
- <pd id="plugindirs.desc">A semicolon-separated list of directory paths that the 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.</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>
- </parml>
- </fig>
- </section>
- </refbody>
- </reference>
|