local-properties.html 4.8 KB

12345678910111213141516171819202122232425262728293031323334353637
  1. <!DOCTYPE html
  2. SYSTEM "about:legacy-compat">
  3. <html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2018"><meta name="DC.rights.owner" content="(C) Copyright 2018"><meta name="DC.Type" content="reference"><meta name="description" content="A local.properties file in the root directory of the DITA-OT installation can be used to override the default values of various DITA-OT parameters."><meta name="DC.subject" content="files, local.properties, local.properties file"><meta name="keywords" content="files, local.properties, local.properties file"><meta name="DC.Relation" scheme="URI" content="../parameters/configuration-properties.html"><meta name="DC.Format" content="HTML5"><meta name="DC.Identifier" content="local.properties"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>The local.properties file</title></head><body id="local.properties"><header role="banner"><div class="header">
  4. <p>DITA Open Toolkit</p>
  5. <hr>
  6. </div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.0</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/alternative-input-formats.html">Authoring formats</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../parameters/index.html">Setting parameters</a><ul><li><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li><a href="../parameters/parameters_intro.html">DITA-OT parameters</a></li><li><a href="../parameters/configuration-properties.html">Configuration properties</a><ul><li class="active"><a href="../parameters/local-properties.html">local.properties</a></li><li><a href="../parameters/lib-plugin-properties.html">plugin.properties</a></li><li><a href="../parameters/lib-configuration-properties.html">configuration.properties</a></li><li><a href="../parameters/internal-ant-properties.html">Internal Ant properties</a></li></ul></li></ul></li><li><a href="../topics/extending-the-ot.html">Customizing DITA-OT</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
  7. <h1 class="title topictitle1" id="ariaid-title1">The <span class="ph filepath">local.properties</span> file</h1>
  8. <div class="body refbody"><p class="shortdesc">A <span class="ph filepath">local.properties</span> file in the root directory of the DITA-OT installation can be used
  9. to override the default values of various DITA-OT parameters.</p>
  10. <div class="example">
  11. <p class="p">For example, if you always use the same rendering engine to produce PDF output for all of your projects, you
  12. could create a <span class="ph filepath">local.properties</span> file in the root directory of your DITA-OT installation to
  13. set the <span class="keyword parmname">pdf.formatter</span> parameter and additional options for the XSL processor:</p>
  14. <pre class="pre codeblock"><code># Use RenderX XEP Engine for PDF output
  15. pdf.formatter = xep
  16. # Specify the user configuration file for RenderX
  17. custom.xep.config = /path/to/custom.config
  18. </code></pre>
  19. <p class="p">Backslash “\” characters in .properties files must be escaped with a second backslash as “\\”. If you use
  20. Antenna House Formatter on a Windows system, for example, you would set the path to the command using a
  21. properties file entry like this:</p>
  22. <pre class="pre codeblock"><code># Use Antenna House Formatter for PDF output
  23. pdf.formatter = ah
  24. # Specify the path to the Antenna House Formatter command
  25. axf.cmd=C:\\Program Files\\Antenna House\\AHFormatterV62</code></pre>
  26. </div>
  27. <section class="section">
  28. <div class="note note note_note"><span class="note__title">Note:</span> This file can only be used to set Ant property values that can be passed as argument parameters to the
  29. command line. The DITA-OT Java code does not read this file.</div>
  30. </section>
  31. </div>
  32. <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../parameters/configuration-properties.html" title="The DITA-OT uses .properties files and internal properties that store configuration settings for the toolkit and its plug-ins. Configuration properties are available to both Ant and Java processes, but unlike argument properties, they cannot be set at run time.">Configuration properties</a></div></div></nav></article></main></body></html>