configuration-properties.dita 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  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 file for applicable license. -->
  4. <reference id="configuring-the-dita-ot">
  5. <title>Configuration properties</title>
  6. <shortdesc>DITA-OT uses <filepath>.properties</filepath> files and internal properties that store configuration
  7. settings for the toolkit and its plug-ins. Configuration properties are available to both Ant and Java processes,
  8. but unlike argument properties, they cannot be set at run time.</shortdesc>
  9. <prolog>
  10. <metadata>
  11. <keywords>
  12. <indexterm>command line<indexterm>properties</indexterm></indexterm>
  13. <indexterm>properties</indexterm>
  14. <indexterm>Ant<indexterm>properties</indexterm></indexterm>
  15. <indexterm>Java<indexterm>properties</indexterm></indexterm>
  16. <indexterm>Ant<indexterm>configuring</indexterm></indexterm>
  17. <indexterm>Java<indexterm>configuring</indexterm></indexterm>
  18. <indexterm>Ant<indexterm>precedence</indexterm></indexterm>
  19. <indexterm>Java<indexterm>precedence</indexterm></indexterm>
  20. <indexterm><filepath>local.properties file</filepath></indexterm>
  21. </keywords>
  22. </metadata>
  23. </prolog>
  24. <refbody>
  25. <section>
  26. <p>When DITA-OT starts the Ant process, it looks for property values in the following order and locations:</p>
  27. <ol>
  28. <li>Any property passed to Ant from the command line with <parmname>-Dproperty</parmname> or
  29. <parmname>--property</parmname>=<option>value</option></li>
  30. <li>A custom property file passed with <parmname>--propertyfile</parmname></li>
  31. <li>A <filepath>local.properties</filepath> file in the root directory of the DITA-OT installation</li>
  32. <li>The <filepath>lib/org.dita.dost.platform/plugin.properties</filepath> file</li>
  33. <li>The <filepath>configuration.properties</filepath> file</li>
  34. </ol>
  35. <p>If a given property is set in multiple places, the first value “wins” and subsequent entries for the same
  36. property are ignored.</p>
  37. <p>You can use this mechanism to override DITA-OT default settings for your environment by passing parameters to
  38. the <cmdname>dita</cmdname> command with <parmname>--property</parmname>=<option>value</option>, or using
  39. entries in <filepath>.properties</filepath> files.</p>
  40. </section>
  41. </refbody>
  42. </reference>