FOP Development: Coding Conventions

Configuration File Basics -

The FOP configuration file is an XML file containing a +

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

@@ -56,7 +56,7 @@ to find it.

From the Command Line

When you run FOP from the command-line, use the -“-c” command-line option with the path to the +“-c” command-line option with the path to the configuration file as the option value.

@@ -100,7 +100,7 @@ configuration object with the user agent as described above.

The Configuration File

The top-level element is arbitrary. You may give it any name that is useful for you, e.g. <fop-configuration -version="2">.

+version="2">.

Inside the top-level element the configuration may contain three sections: userAgent, renderers, and hyphenation. At the moment of this writing the @@ -110,7 +110,7 @@ not used by FOP.

renderer. There may be one subsection for each type of renderer. The renderers are identified by their MIME type, which is given in the mime attribute. For example: -<renderer mime="application/pdf">. The content +<renderer mime="application/pdf">. The content of each renderer subsection depends on the type of renderer.

The PDF renderer (MIME type application/pdf) has @@ -163,8 +163,7 @@ more information on creating and modifying hyphenation within FOP.

Font configuration information is included in the FOP configuration file as describe above. It is documented in more detail at FOP: Fonts. Note -especially the section entitled Register Fonts with FOP.

+especially the section entitled Register Fonts with FOP.

@@ -182,7 +181,7 @@ to use. For example:

systems. On Java 1.4 systems JDK 1.4 is the default.

Secondly, you configure the selected logging package. How this is done depends on the logging package. The most important -feature is the log level. The default is level “info”. An +feature is the log level. The default is level “info”. An example configuration file for SimpleLog is:

# logging level for all loggers, default info @@ -193,7 +192,7 @@ org.apache.commons.logging.simplelog.log.xxxxx=debug org.apache.commons.logging.simplelog.log.org.apache.fop.pdf=trace

FOP uses several named loggers. When you set the logging level -for all loggers to “info”, you get a decent small amount +for all loggers to “info”, you get a decent small amount of information about application progress. The debugging and especially the trace levels produce a lot of output. If you need these logging levels, @@ -203,5 +202,4 @@ bear the name of their package, their class or of a superclass.