local-properties-file.dita 3.0 KB

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