| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 2 | <!DOCTYPE html
|
|---|
| 3 | PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|---|
| 4 | <html xml:lang="en" lang="en">
|
|---|
| 5 | <head>
|
|---|
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
|
|---|
| 7 | <meta name="copyright" content="(C) Copyright 2005"/>
|
|---|
| 8 | <meta name="DC.rights.owner" content="(C) Copyright 2005"/>
|
|---|
| 9 | <meta name="DC.Type" content="reference"/>
|
|---|
| 10 | <meta name="DC.Title" content="lib/configuration.properties file"/>
|
|---|
| 11 | <meta name="abstract" content="The lib/configuration.properties file controls certain common properties, as well as some properties that control PDF processing."/>
|
|---|
| 12 | <meta name="description" content="The lib/configuration.properties file controls certain common properties, as well as some properties that control PDF processing."/>
|
|---|
| 13 | <meta name="DC.subject" content="configuration properties, default.language, generate-debug-attributes, processing-mode, org.dita.pdf2.index.frame-markup, org.dita.pdf2.i18n.enabled, org.dita.pdf2.use-out-temp, files, lib/configuration.properties file, topic.fo file, topic.fo, location of, PDF processing, configuration properties"/>
|
|---|
| 14 | <meta name="keywords" content="configuration properties, default.language, generate-debug-attributes, processing-mode, org.dita.pdf2.index.frame-markup, org.dita.pdf2.i18n.enabled, org.dita.pdf2.use-out-temp, files, lib/configuration.properties file, topic.fo file, topic.fo, location of, PDF processing, configuration properties"/>
|
|---|
| 15 | <meta name="DC.Relation" scheme="URI" content="../readme/reference.html"/>
|
|---|
| 16 | <meta name="DC.Format" content="XHTML"/>
|
|---|
| 17 | <meta name="DC.Identifier" content="configuration"/>
|
|---|
| 18 | <meta name="DC.Language" content="en"/>
|
|---|
| 19 | <link rel="stylesheet" type="text/css" href="../commonltr.css"/>
|
|---|
| 20 | <link rel="stylesheet" type="text/css" href="../dita-ot-doc.css"/>
|
|---|
| 21 | <title>lib/configuration.properties file</title>
|
|---|
| 22 | </head>
|
|---|
| 23 | <body id="configuration">
|
|---|
| 24 |
|
|---|
| 25 |
|
|---|
| 26 | <h1 class="title topictitle1"><span class="ph filepath">lib/configuration.properties</span> file</h1>
|
|---|
| 27 |
|
|---|
| 28 |
|
|---|
| 29 |
|
|---|
| 30 | <div class="body refbody"><p class="shortdesc">The <span class="ph filepath">lib/configuration.properties</span> file controls certain common
|
|---|
| 31 | properties, as well as some properties that control PDF processing.</p>
|
|---|
| 32 |
|
|---|
| 33 |
|
|---|
| 34 | <div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" class="table" frame="border" border="1" rules="all"><caption><span class="tablecap">Table 1. Properties set in the <span class="ph filepath">lib/configuration.properties</span> file</span></caption>
|
|---|
| 35 |
|
|---|
| 36 |
|
|---|
| 37 | <thead class="thead" align="left">
|
|---|
| 38 | <tr class="row">
|
|---|
| 39 | <th class="entry" valign="top" width="27.27272727272727%" id="d29644e79">Property</th>
|
|---|
| 40 |
|
|---|
| 41 | <th class="entry" valign="top" width="72.72727272727273%" id="d29644e82">Description</th>
|
|---|
| 42 |
|
|---|
| 43 | </tr>
|
|---|
| 44 |
|
|---|
| 45 | </thead>
|
|---|
| 46 |
|
|---|
| 47 | <tbody class="tbody">
|
|---|
| 48 | <tr class="row">
|
|---|
| 49 | <td class="entry" valign="top" width="27.27272727272727%" headers="d29644e79 "><span class="keyword parmname">default.language</span></td>
|
|---|
| 50 |
|
|---|
| 51 | <td class="entry" valign="top" width="72.72727272727273%" headers="d29644e82 ">Specifies the language that is used if the input file does not have the @xml:lang
|
|---|
| 52 | attribute set on the root element. By default, this is set to<span class="keyword option"> en</span>. The
|
|---|
| 53 | allowed values are those that are defined in IETF BCP 47, <a class="xref" href="https://tools.ietf.org/html/bcp47" target="_blank">Tags for the
|
|---|
| 54 | Identification of Languages</a>.</td>
|
|---|
| 55 |
|
|---|
| 56 | </tr>
|
|---|
| 57 |
|
|---|
| 58 | <tr class="row">
|
|---|
| 59 | <td class="entry" valign="top" width="27.27272727272727%" headers="d29644e79 "><span class="keyword parmname">generate-debug-attributes</span></td>
|
|---|
| 60 |
|
|---|
| 61 | <td class="entry" valign="top" width="72.72727272727273%" headers="d29644e82 ">Specifies whether the @xtrf and @xtrc debugging attributes are generated in the
|
|---|
| 62 | temporary files. The following values are allowed: <ul class="ul">
|
|---|
| 63 | <li class="li"><span class="keyword option">true</span> (default) — Enables generation of debugging
|
|---|
| 64 | attributes</li>
|
|---|
| 65 |
|
|---|
| 66 | <li class="li"><span class="keyword option">false</span> —Disables generation of debugging attributes</li>
|
|---|
| 67 |
|
|---|
| 68 | </ul>
|
|---|
| 69 | <div class="note note"><span class="notetitle">Note:</span> Disabling debugging attributes reduces the size of temporary files and thus
|
|---|
| 70 | reduces memory consumption. However, the log messages no longer have the source
|
|---|
| 71 | information available and thus the ability to debug problems might
|
|---|
| 72 | deteriorate.</div>
|
|---|
| 73 | </td>
|
|---|
| 74 |
|
|---|
| 75 | </tr>
|
|---|
| 76 |
|
|---|
| 77 | <tr id="configuration__processing-mode" class="row">
|
|---|
| 78 | <td class="entry" valign="top" width="27.27272727272727%" headers="d29644e79 "><span class="keyword parmname">processing-mode</span></td>
|
|---|
| 79 |
|
|---|
| 80 | <td class="entry" valign="top" width="72.72727272727273%" headers="d29644e82 ">Specifies how the DITA-OT handles errors and error recovery. The following values
|
|---|
| 81 | are allowed: <ul class="ul">
|
|---|
| 82 | <li class="li"><span class="keyword option">strict</span> — When an error is encountered, the DITA-OT stops
|
|---|
| 83 | processing.</li>
|
|---|
| 84 |
|
|---|
| 85 | <li class="li"><span class="keyword option">lax</span> (default) — When an error is encountered, the DITA-OT
|
|---|
| 86 | attempts to recover from it.</li>
|
|---|
| 87 |
|
|---|
| 88 | <li class="li"><span class="keyword option">skip</span> — When an error is encountered, the DITA continues
|
|---|
| 89 | processing but does not attempt error recovery.</li>
|
|---|
| 90 |
|
|---|
| 91 | </ul>
|
|---|
| 92 | </td>
|
|---|
| 93 |
|
|---|
| 94 | </tr>
|
|---|
| 95 |
|
|---|
| 96 | <tr class="row">
|
|---|
| 97 | <td class="entry" valign="top" width="27.27272727272727%" headers="d29644e79 "><span class="keyword parmname">org.dita.pdf2.index.frame-markup</span></td>
|
|---|
| 98 |
|
|---|
| 99 | <td class="entry" valign="top" width="72.72727272727273%" headers="d29644e82 ">(PDF transformation only) Specifies how the DITA-OT handles legacy FrameMaker
|
|---|
| 100 | syntax for <indexterm> elements. The following values are allowed: <ul class="ul">
|
|---|
| 101 | <li class="li"><span class="keyword option">true</span>— Enables special processing of legacy FrameMaker syntax
|
|---|
| 102 | for <indexterm> elements. Standard DITA <indexterm> elements are processed
|
|---|
| 103 | also.</li>
|
|---|
| 104 |
|
|---|
| 105 | <li class="li"><span class="keyword option">false</span> (default) — Disables special processing of legacy
|
|---|
| 106 | FrameMaker syntax for <indexterm> elements.</li>
|
|---|
| 107 |
|
|---|
| 108 | </ul>
|
|---|
| 109 | <div class="note note"><span class="notetitle">Note:</span> Setting the <span class="keyword parmname">org.dita.pdf2.index.frame-markup</span> parameter
|
|---|
| 110 | to <span class="keyword option">yes</span> only affects how index entries are generated in PDF output.
|
|---|
| 111 | For example, an <samp class="ph codeph"><indexterm>files:topic</index></samp> element will
|
|---|
| 112 | generate an index entry of "files:topic" in a CHM file.</div>
|
|---|
| 113 | </td>
|
|---|
| 114 |
|
|---|
| 115 | </tr>
|
|---|
| 116 |
|
|---|
| 117 | <tr class="row">
|
|---|
| 118 | <td class="entry" valign="top" width="27.27272727272727%" headers="d29644e79 "><span class="keyword parmname">org.dita.pdf2.i18n.enabled</span></td>
|
|---|
| 119 |
|
|---|
| 120 | <td class="entry" valign="top" width="72.72727272727273%" headers="d29644e82 ">(PDF transformation only) Enables I18N font processing. The following values are
|
|---|
| 121 | allowed: <ul class="ul">
|
|---|
| 122 | <li class="li"><span class="keyword option">true</span> (default) — Enables I18N processing</li>
|
|---|
| 123 |
|
|---|
| 124 | <li class="li"><span class="keyword option">false</span> — Disables I18N processing</li>
|
|---|
| 125 |
|
|---|
| 126 | </ul>
|
|---|
| 127 | </td>
|
|---|
| 128 |
|
|---|
| 129 | </tr>
|
|---|
| 130 |
|
|---|
| 131 | <tr class="row">
|
|---|
| 132 | <td class="entry" valign="top" width="27.27272727272727%" headers="d29644e79 "><span class="keyword parmname">org.dita.pdf2.use-out-temp</span></td>
|
|---|
| 133 |
|
|---|
| 134 | <td class="entry" valign="top" width="72.72727272727273%" headers="d29644e82 ">(PDF transformation only) Specifies whether the XSL-FO processing writes the
|
|---|
| 135 | intermediate files (for example, the <span class="ph filepath">topic.fo</span> file) to the output
|
|---|
| 136 | directory. The following values are allowed: <ul class="ul">
|
|---|
| 137 | <li class="li"><span class="keyword option">true</span> — Write intermediate files to the output directory</li>
|
|---|
| 138 |
|
|---|
| 139 | <li class="li"><span class="keyword option">false</span> (default) — Write intermediate files to the temporary
|
|---|
| 140 | directory</li>
|
|---|
| 141 |
|
|---|
| 142 | </ul>
|
|---|
| 143 | </td>
|
|---|
| 144 |
|
|---|
| 145 | </tr>
|
|---|
| 146 |
|
|---|
| 147 | <tr id="configuration__plugindirs" class="row">
|
|---|
| 148 | <td class="entry" valign="top" width="27.27272727272727%" headers="d29644e79 "><span class="keyword parmname">plugindirs</span></td>
|
|---|
| 149 |
|
|---|
| 150 | <td class="entry" valign="top" width="72.72727272727273%" headers="d29644e82 ">A semicolon-separated list of directory paths that the DITA-OT searches for
|
|---|
| 151 | plug-ins to integrate; any relative paths are resolved against the DITA-OT base
|
|---|
| 152 | directory. Any immediate subdirectory that contains a <span class="ph filepath">plugin.xml</span>
|
|---|
| 153 | file is integrated</td>
|
|---|
| 154 |
|
|---|
| 155 | </tr>
|
|---|
| 156 |
|
|---|
| 157 | <tr id="configuration__plugin.ignores" class="row">
|
|---|
| 158 | <td class="entry" valign="top" width="27.27272727272727%" headers="d29644e79 "><span class="keyword parmname">plugin.ignores</span></td>
|
|---|
| 159 |
|
|---|
| 160 | <td class="entry" valign="top" width="72.72727272727273%" headers="d29644e82 ">A semicolon-separated list of directory names to be ignored during plug-in
|
|---|
| 161 | integration; any relative paths are resolved against the DITA-OT base
|
|---|
| 162 | directory.</td>
|
|---|
| 163 |
|
|---|
| 164 | </tr>
|
|---|
| 165 |
|
|---|
| 166 | </tbody>
|
|---|
| 167 |
|
|---|
| 168 | </table>
|
|---|
| 169 | </div>
|
|---|
| 170 |
|
|---|
| 171 | </div>
|
|---|
| 172 |
|
|---|
| 173 | <div class="related-links">
|
|---|
| 174 | <div class="familylinks">
|
|---|
| 175 | <div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../readme/reference.html" title="This section is designed to help users to locate information easily and quickly. It includes documentation for the DITA Open Toolkit (DITA-OT) parameters and configuration properties.">Reference</a></div>
|
|---|
| 176 | </div>
|
|---|
| 177 | </div>
|
|---|
| 178 |
|
|---|
| 179 | </body>
|
|---|
| 180 | </html>
|
|---|
