local-properties-file.dita 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  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="local.properties">
  5. <title>The <filepath>local.properties</filepath> file</title>
  6. <titlealts>
  7. <navtitle><filepath>local.properties</filepath></navtitle>
  8. </titlealts>
  9. <shortdesc>A <filepath>local.properties</filepath> file in the root directory of the DITA-OT installation can be used
  10. to override the default values of various DITA-OT parameters.</shortdesc>
  11. <prolog>
  12. <metadata>
  13. <keywords>
  14. <indexterm>files<indexterm>local.properties</indexterm></indexterm>
  15. <indexterm>local.properties file</indexterm>
  16. <indexterm>Windows</indexterm>
  17. <indexterm>RenderX<indexterm><filepath>local.properties</filepath></indexterm></indexterm>
  18. <indexterm>Antenna House<indexterm><filepath>local.properties</filepath></indexterm></indexterm>
  19. <indexterm>command line<indexterm><filepath>local.properties</filepath> file</indexterm></indexterm>
  20. <indexterm>Java<indexterm>local.properties file</indexterm></indexterm>
  21. <indexterm>PDF<indexterm>formatter</indexterm></indexterm>
  22. <indexterm>formatter<index-see-also>Apache FOP</index-see-also><index-see-also>Antenna
  23. House</index-see-also><index-see-also>RenderX</index-see-also></indexterm>
  24. </keywords>
  25. </metadata>
  26. </prolog>
  27. <refbody>
  28. <example>
  29. <p>For example, if you always use the same rendering engine to produce PDF output for all of your projects, you
  30. could create a <filepath>local.properties</filepath> file in the root directory of your DITA-OT installation to
  31. set the <parmname>pdf.formatter</parmname> parameter and additional options for the XSL processor:</p>
  32. <codeblock outputclass="language-properties normalize-space show-line-numbers show-whitespace"># Use RenderX XEP Engine for PDF output
  33. pdf.formatter = xep
  34. # Specify the user configuration file for RenderX
  35. custom.xep.config = /path/to/custom.config</codeblock>
  36. <p>Backslash “\” characters in .properties files must be escaped with a second backslash as “\\”. If you use
  37. Antenna House Formatter on a Windows system, for example, you would set the path to the command using a
  38. properties file entry like this:</p>
  39. <codeblock outputclass="language-properties normalize-space show-line-numbers show-whitespace"># Use Antenna House Formatter for PDF output
  40. pdf.formatter = ah
  41. # Specify the path to the Antenna House Formatter command
  42. axf.cmd=C:\\Program Files\\Antenna House\\AHFormatterV62</codeblock>
  43. </example>
  44. <section>
  45. <note>This file can only be used to set Ant property values that can be passed as argument parameters to the
  46. command line. The DITA-OT Java code does not read this file.</note>
  47. </section>
  48. </refbody>
  49. </reference>