Configuration

- How to configure FOP -

In the directory {fop-dir}/conf you will find two configuration files. One of them, - config.xml, is only intended for FOP developers, who want to add new default values - to some FOP feature. Don't change this file. For user configuration there is a file called - userconfig.xml. It contains templates for all settings a user can change. Most of them are - commented out. Uncomment the entry you want to set and change the value according to - your wishes. Please regard any comments which specify the value range. And, well, the - configuration files are xml files, so keep them at least well-formed. ;-) -

The file userconfig.xml is not read automatically, but the user must specify its use on - the command line. See Running FOP - or Embedding FOP for details. -

+ Configuration File Basics +

The FOP configuration file is an XML file contains a variety of settings that are useful for controlling FOP's behavior, and for helping it find resources that you wish it to use.

The easiest way to get started using a FOP configuration file is to copy the sample found at {fop-dir}/conf/userconfig.xml to a location of your choice, and then to edit it according to your needs. +It contains templates for the various configuration options, most of which are commented out. Remove the comments and change the settings for entries that you wish to use. +Be sure to follow any instructions, including comments which specify the value range. +Also, since the configuration file is XML, be sure to keep it well-formed.

+ Do not change {fop-dir}/conf/config.xml or use it as the basis for your configuration file. It has an entirely different purpose. +

After creating your configuration file, you must tell FOP how to find it:

If running FOP from the command-line, see the "-c" command-line option in Running FOP.
If running FOP as an embedded application, see FOP: Embedding, Using a Configuration File.