FOP Plugin (quokka.plugin.fop:0.3, namespace=fop)
The FOP plugin uses Apache's FOP (Formatting Objects Processor) to transform FO xml documents into PDFs and other formats.
Template Targets
| transform | Transforms a FO xml document into another format, such as a PDF |
To use the FOP plugin, create an instance of the transform target and supply any properties. e.g. the following transforms a FO xml document into a PDF:
<plugin group="quokka.plugin.fop" version="?">
<target name="fop-pdf" template="transform">
<property name="in" value="src/fop/fo.xml"/>
<property name="out" value="${q.project.targetDir}/fop/fo.pdf"/>
</target>
</plugin>
Properties:
- in Mandatory. Input XML file in FO format
- out Mandatory. Output file
- options Optional. Any combination of options below.
- configuration Optional. A FOP xml configuration file
- outputType Optional. Output format, either pdf, mif, pcl, ps, txt, svg, or at. Defaults to pdf
- maxMemory Optional. The maximum heap size to use for the forked JVM
-d debug mode
-x dump configuration settings
-q quiet mode
-l lang the language to use for user information
-s (-at output) omit tree below block areas
-txt.encoding (-txt output encoding use the encoding for the output file.
The encoding must be a valid java encoding.
-o [password] pdf file will be encrypted with option owner password
-u [password] pdf file will be encrypted with option user password
-noprint pdf file will be encrypted without printing permission
-nocopy pdf file will be encrypted without copy content permission
-noedit pdf file will be encrypted without edit content permission
-noannotations pdf file will be encrypted without edit annotation permission
Default Properties
| maxMemory | ${@setifdef q.project.forkMaxMemory} |
Plugin Paths
runtime : Runtime class path
apache.fop fop 0.20.5
apache.fop batik 0.20.5
apache.avalon.framework framework 4.0
quokka.core.plugin-spi plugin-spi 0.3
apache.ant ant 1.7.1