FOP provides an Ant task for automating the document build process.
The FOP Ant task will convert XSL-FO documents to PDF/PS/PCL/MIF/RTF output (see Output formats for available formats).
To call FOP tasks within Ant, first add a FOP task definition to your Ant build file. One method of defining the task is as follows:
Then create FOP tasks within your Ant build file, using the FOP task parameters listed below.
| Attribute | Description | Required |
|---|---|---|
| fofile | XSL-FO file to be rendered | Yes, if no fileset nested element is used |
| outfile | Output filename | Yes, when fofile is used. (This attribute is not valid for filesets.) |
| format | Possible output formats:application/pdfapplication/postscriptapplication/vnd.mifapplication/rtfapplication/vnd.hp-PCLtext/plaintext/xml |
No, defaults to application/pdf |
| outdir | Output directory | Required if a fileset is used to specify the files to render; optional for fofile. (Can alternatively specify the full path in the fofile value.) |
| userconfig | User configuration file (same as the FOP "-c" command line option) | No |
| messagelevel | Logging level Possible values: error, warn, info, verbose, debug |
No, defaults to verbose |
| logFiles | Controls whether the names of the files that are processed are logged
(true) or not (false) |
No, default is true |
| Attribute | Description | Required |
|---|---|---|
| fileset | FileSets are used to specify multiple XSL-FO files to be rendered. | Yes, if no fofile attribute is supplied |
The following example converts a single XSL-FO file to a PDF document:
This example converts all XSL-FO files within an entire directory to PostScript: