lib-configuration-properties.dita 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
  3. <!--This file is part of the DITA Open Toolkit project. See the accompanying LICENSE.md file for applicable licenses.-->
  4. <reference id="configuration" xml:lang="en">
  5. <title><filepath>configuration.properties</filepath> file</title>
  6. <shortdesc>The <filepath>lib/configuration.properties</filepath> file controls certain common properties, as well as
  7. some properties that control PDF processing.</shortdesc>
  8. <prolog>
  9. <metadata>
  10. <keywords>
  11. <indexterm>configuration properties
  12. <indexterm>default.language</indexterm>
  13. <indexterm>generate-debug-attributes</indexterm>
  14. <indexterm>processing-mode</indexterm>
  15. <indexterm>org.dita.pdf2.i18n.enabled</indexterm>
  16. <indexterm>org.dita.pdf2.use-out-temp</indexterm>
  17. </indexterm>
  18. <indexterm>files
  19. <indexterm>lib/configuration.properties file</indexterm>
  20. <indexterm>topic.fo file</indexterm>
  21. </indexterm>
  22. <indexterm>topic.fo
  23. <indexterm>location of</indexterm>
  24. </indexterm>
  25. <indexterm>PDF processing
  26. <indexterm>configuration properties</indexterm>
  27. </indexterm>
  28. </keywords>
  29. </metadata>
  30. </prolog>
  31. <refbody>
  32. <section>
  33. <fig>
  34. <title>Properties set in the <filepath>lib/configuration.properties</filepath> file</title>
  35. <parml>
  36. <plentry id="default.language">
  37. <pt><parmname>default.language</parmname></pt>
  38. <pd id="default.language.desc">Specifies the language that is used if the input file does not have the
  39. <xmlatt>xml:lang</xmlatt> attribute set on the root element. By default, this is set to
  40. <option>en</option>. The allowed values are those that are defined in IETF BCP 47,
  41. <xref href="https://tools.ietf.org/html/bcp47" format="html" scope="external">Tags for Identifying
  42. Languages</xref>.</pd>
  43. </plentry>
  44. <!--<plentry id="generate-debug-attributes">
  45. <pt><parmname>generate-debug-attributes</parmname></pt>
  46. <pd id="generate-debug-attributes.desc">Specifies whether the @xtrf and @xtrc debugging attributes are
  47. generated in the temporary files. The following values are allowed: <ul>
  48. <li><option>true</option> (default) — Enables generation of debugging attributes</li>
  49. <li><option>false</option> —Disables generation of debugging attributes</li>
  50. </ul><note>Disabling debugging attributes reduces the size of temporary files and thus reduces memory
  51. consumption. However, the log messages no longer have the source information available and thus the
  52. ability to debug problems might deteriorate.</note></pd>
  53. </plentry>
  54. <plentry id="processing-mode">
  55. <pt><parmname>processing-mode</parmname></pt>
  56. <pd id="processing-mode.desc">Specifies how the DITA-OT handles errors and error recovery. The following
  57. values are allowed:
  58. <ul>
  59. <li><option>strict</option> — When an error is encountered, the DITA-OT stops processing.</li>
  60. <li><option>lax</option> (default) — When an error is encountered, the DITA-OT attempts to recover from
  61. it.</li>
  62. <li><option>skip</option> — When an error is encountered, the DITA continues processing but does not
  63. attempt error recovery.</li>
  64. </ul></pd>
  65. </plentry>-->
  66. <plentry id="org.dita.pdf2.i18n.enabled">
  67. <pt><parmname>org.dita.pdf2.i18n.enabled</parmname></pt>
  68. <pd id="org.dita.pdf2.i18n.enabled.desc">(PDF transformation only) Enables I18N font processing. The
  69. following values are allowed:
  70. <ul>
  71. <li><option>true</option> (default) — Enables I18N processing</li>
  72. <li><option>false</option> — Disables I18N processing</li>
  73. </ul>
  74. <draft-comment author="Kristen James Eberlein" time="16 August 2012">This needs beefing up. Here is info
  75. provided by Jarno Elovirta:
  76. <p>(IIRC, pre 1.0 versions of FOP didn't correctly implement font selection in XSL FO files, that's the
  77. reason for this feature existing). The PDF2 I18N allows you to say define which characters are output
  78. with which pseudo-font, and the font mapping files define the actual font. E.g. the configuration for
  79. English at src/main/plugins/org.dita.pdf2/cfg/fo/i18n/en.xml
  80. is:<codeblock>
  81. &lt;alphabet char-set="SymbolsSuperscript">
  82. &lt;character-set>
  83. &lt;!-- Copyright -->
  84. &lt;character>&amp;#169;&lt;/character>
  85. &lt;!-- Registered Trademark -->
  86. &lt;character>&amp;#174;&lt;/character>
  87. &lt;!-- Trademark -->
  88. &lt;character>&amp;#8482;&lt;/character>
  89. &lt;!-- Service mark -->
  90. &lt;character>&amp;#2120;&lt;/character>
  91. &lt;/character-set>
  92. &lt;/alphabet>
  93. &lt;alphabet char-set="SubmenuSymbol">
  94. &lt;character-set>
  95. &lt;character>&amp;#x27A4;&lt;/character>
  96. &lt;/character-set>
  97. &lt;/alphabet>
  98. </codeblock></p>
  99. <p>That is, those specific characters are marked as "SymbolsSuperscript" or "SubmenuSymbol" charset. The
  100. font mappings at src/main/plugins/org.dita.pdf2/cfg/fo/font-mappings.xml then define which font to use
  101. for them,
  102. e.g.:<codeblock>&lt;physical-font char-set="SymbolsSuperscript">
  103. &lt;font-face>Helvetica, Arial Unicode MS&lt;/font-face>
  104. &lt;baseline-shift>20%&lt;/baseline-shift>
  105. &lt;override-size>smaller&lt;/override-size>
  106. &lt;/physical-font></codeblock></p>
  107. <p>The I18N processing is on by default (because it's been on before), but for most users it's just an
  108. additional level of complexity which should be turned off and support for multiple languages be
  109. handled in XSLT code.</p>
  110. </draft-comment>
  111. </pd>
  112. </plentry>
  113. <!--<plentry id="org.dita.pdf2.use-out-temp">
  114. <pt><parmname>org.dita.pdf2.use-out-temp</parmname></pt>
  115. <pd id="org.dita.pdf2.use-out-temp.desc">(PDF transformation only) Specifies whether the XSL-FO processing
  116. writes the intermediate files (for example, the <filepath>topic.fo</filepath> file) to the output
  117. directory. The following values are allowed:
  118. <ul>
  119. <li><option>true</option> — Write intermediate files to the output directory</li>
  120. <li><option>false</option> (default) — Write intermediate files to the temporary directory</li>
  121. </ul></pd>
  122. </plentry>-->
  123. <plentry id="plugindirs">
  124. <pt><parmname>plugindirs</parmname></pt>
  125. <pd id="plugindirs.desc">A semicolon-separated list of directory paths that the DITA-OT searches for
  126. plug-ins to install; any relative paths are resolved against the DITA-OT base directory. Any immediate
  127. subdirectory that contains a <filepath>plugin.xml</filepath> file is installed.</pd>
  128. </plentry>
  129. <plentry id="plugin.ignores">
  130. <pt><parmname>plugin.ignores</parmname></pt>
  131. <pd id="plugin.ignores.desc">A semicolon-separated list of directory names to be ignored during plug-in
  132. installation; any relative paths are resolved against the DITA-OT base directory.</pd>
  133. </plentry>
  134. </parml>
  135. </fig>
  136. </section>
  137. </refbody>
  138. </reference>