1.6. Element `processFO`
Prev | 1. Reference | Next

### 1.6. Element `processFO`

    <processFO
      processor = Non empty token
      file = Path
      to = Path
    >
      Content: [ parameter ]* [ processFO ]?
    </processFO>

    <parameter
      name = Non empty token
    >
      Content: Parameter value
    </parameter>

    <parameterGroup
      name = Non empty token
    />

Converts a XSL-FO file to another format, typically a page description language such as PDF.

Attributes:

processor

  Specifies which FO processor to use.

  Unlike the XSLT engine used by a `transform` element, the FO processor used to perform this conversion is not built-in into XXE. A FO processor plug-in having a name equals the value of the `processor` attribute (case-insensitive) must have been registered with XXE.

file

  Input file.

to

  Output file.

`Parameter` child elements are passed, as is, to the FO processor in order to parametrize its behavior. These parameters are described in the documentation of the FO processors.

XFC example:

    <parameter name="outputEncoding">Cp1252</parameter>

XEP example:

    <parameter name="PS.LANGUAGE_LEVEL">2</parameter>

Pseudo-parameters:

XEP

  The XEP FO processor understands a number of actual parameters but also a pseudo-parameter called `OUTPUT_FORMAT`. Its value specifies which is the target format of XEP: `pdf`, `ps`.

  If this pseudo-parameter is absent, which format to use is guessed from the extension of the output file name.

FOP

  The FOP FO processor understands a number of actual parameters, but also the following pseudo-parameters:

  renderer

    Its value specifies which renderer to use: `pdf`, `ps`, `pcl`, `svg`, `xml`, `mif`, `txt`.

    If this pseudo-parameter is absent, which renderer to use is guessed from the extension of the output file name.

  configuration

    Specifies the absolute URL or filename of a FOP user configuration file. Such configuration files are useful to specify font metrics, hyphenation files, etc. More information on FOP's web site.

The `processFO` optional child element:

This optional child element specifies which FO processor to use when the FO processor specified by the parent `processFO` element is not available.

Example: try to use FOP when XEP is not available:

    <processFO processor="XEP" file="__doc.fo" to="__doc.pdf">
      <parameter name="OUTPUT_FORMAT">pdf</parameter>

      <processFO processor="FOP" file="__doc.fo" to="__doc.pdf">
        <parameter name="renderer">pdf</parameter>
      </processFO>
    </processFO>

Unless used in XMLmind XML Editor Professional Edition, this element will cause its parent process command to be disabled.

Prev | Up | Next
1.5. Element `transform` | Home | 1.7. Element `upload`