FO Processors

Besides the built-in formatting objects processor (Apache FOP) the user can use other external processors. <oXygen/> has implemented an easy way to add two of the most used commercial FO processors. You can easily add RenderX XEP as external FO processor if the user has the XEP installed. Also, if you have the Antenna House v4 or v5 FO processors Oxygen will use the environmental variables set by the installation to detect and use it for transformations. If the environmental variables are not set for the Antenna House installation you can browse and choose the executable just as you would for XEP.

The FO Processors preferences panel is opened from menu OptionsPreferences+XML+XSLT/FO/XQuery+FO Processors

 

Figure 24.60. The FO Processors preferences panel

The FO Processors preferences panel

Enable the output of the built-in FOP

When checked all FOP output will be displayed in a results pane at the bottom of the editor window including warning messages about FO instructions not supported by FOP.

Memory available to the built-in FOP

If your FOP transformations fail with an "Out of Memory" error select from this combo box a larger value for the amount of memory reserved for FOP transformations.

Configuration file for the built-in FOP

You should specify here the path to a FOP configuration file, necessary for example to render to PDF using a special true type font a document containing Unicode content.

Generates PDF/A-1b output

When selected PDF/A-1b output is generated.

[Note]Note

All fonts have to be embedded, even the implicit ones. More information about configuring metrics files for the embedded fonts can be found in Add a font to the built-in FOP.

[Note]Note

You cannot use the <filterList> key in the configuration file. FOP will generate the following error: The Filter key is prohibited when PDF/A-1 is active.

The users can configure the external processors for use with <oXygen/> in the following dialog.

 

Figure 24.61. The external FO processor configuration dialog

The external FO processor configuration dialog

Name

The name that will be displayed in the list of available FOP processors on the FOP tab of the Transforming Configuration dialog.

Description

The description of the FO processor displayed in the Preferences->FO Processors option.

Output Encoding

The encoding used for the output stream of the FO processor which will be displayed in a results panel at the bottom of the <oXygen/> window.

Error Encoding

The encoding used for the error stream of the FO processor which will be displayed in a results panel at the bottom of the <oXygen/> window.

Working directory

The directory in which the intermediate and final results of the processing will be stored. Here you can use one of the following editor variables:

${homeDir}

The path to user home directory.

${cfd}

The path of current file directory. If the current file is not a local file the directory will be the user's Desktop directory.

${pd}

The project directory.

${oxygenInstallDir}

The <oXygen/> installation directory.

Command line

The command line that will start the FO processor, specific to each processor. Here you can use one of the following editor variables:

${method}

The FOP transformation method (pdf, ps, txt).

${fo}

The input FO file.

${out}

The output file.

${pd}

The project directory.

${frameworksDir}

The path of the frameworks subdirectory of the <oXygen/> install directory.

${oxygenInstallDir}

The <oXygen/> installation directory.

${ps}

The separator which can be used on different operating systems between libraries specified in the class path.