lib/configuration.properties file

The lib/configuration.properties file controls certain common properties, as well as some properties that control PDF processing.

Properties set in the lib/configuration.properties file

Property Description
default.language Specifies the language that is used if the input file does not have the @xml:lang attribute set on the root element. By default, this is set to en. The allowed values are those that are defined in IETF BCP 47, Tags for the Identification of Languages.
generate-debug-attributes Specifies whether the @xtrf and @xtrc debugging attributes are generated in the temporary files. The following values are allowed:
  • true (default) — Enables generation of debugging attributes
  • false —Disables generation of debugging attributes

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.
processing-mode Specifies how the DITA-OT handles errors and error recovery. The following values are allowed:
  • strict — When an error is encountered, the DITA-OT stops processing.
  • lax (default) — When an error is encountered, the DITA-OT attempts to recover from it.
  • skip — When an error is encountered, the DITA continues processing but does not attempt error recovery.
org.dita.pdf2.index.frame-markup (PDF transformation only) Specifies how the DITA-OT handles legacy FrameMaker syntax for <indexterm> elements. The following values are allowed:
  • true— Enables special processing of legacy FrameMaker syntax for <indexterm> elements. Standard DITA <indexterm> elements are processed also.
  • false (default) — Disables special processing of legacy FrameMaker syntax for <indexterm> elements.

Note

Setting the org.dita.pdf2.index.frame-markup parameter to yes only affects how index entries are generated in PDF output. For example, an <indexterm>files:topic</index> element will generate an index entry of "files:topic" in a CHM file.
org.dita.pdf2.i18n.enabled (PDF transformation only) Enables I18N font processing. The following values are allowed:
  • true (default) — Enables I18N processing
  • false — Disables I18N processing
This needs beefing up. Here is info provided by Jarno Elovirta:

(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:

        <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>

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.:

<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>

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.

org.dita.pdf2.use-out-temp (PDF transformation only) Specifies whether the XSL-FO processing writes the intermediate files (for example, the topic.fo file) to the output directory. The following values are allowed:
  • true — Write intermediate files to the output directory
  • false (default) — Write intermediate files to the temporary directory

Was this helpful?