From ed18821511f2a5be10434072250e69dcf7fde171 Mon Sep 17 00:00:00 2001 From: Jeremias Maerki Date: Tue, 25 Oct 2005 19:49:46 +0000 Subject: Removed 0.90 again and created a "trunk" instead. When a release is done, trunk can be copied to the version number. FOP Trunk documentation added. Fixed all broken internal links. git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@328462 13f79535-47bb-0310-9956-ffa450edef68 --- src/documentation/content/xdocs/trunk/anttask.xml | 183 ++++++++++++++++++++++ 1 file changed, 183 insertions(+) create mode 100644 src/documentation/content/xdocs/trunk/anttask.xml (limited to 'src/documentation/content/xdocs/trunk/anttask.xml') diff --git a/src/documentation/content/xdocs/trunk/anttask.xml b/src/documentation/content/xdocs/trunk/anttask.xml new file mode 100644 index 000000000..fd8a7e0dc --- /dev/null +++ b/src/documentation/content/xdocs/trunk/anttask.xml @@ -0,0 +1,183 @@ + + + + + +
+ Ant task + $Revision$ +
+ +

+ Apache FOP provides an Ant task for automating the document build process. +

+
+ Description +

+ The FOP Ant task will convert XSL-FO documents to PDF, PS, PCL etc. 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.

+
+ +
Parameters for FOP Ant task + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameters specified as attributes
AttributeDescriptionRequired
fofileXSL-FO file to be renderedYes, if no fileset nested element is used
outfileOutput filenameYes, when fofile is used. (This attribute is not valid for filesets.)
formatPossible output formats:
+ application/pdf
+ application/postscript
+ application/vnd.mif
+ application/rtf
+ application/vnd.hp-PCL
+ text/plain
+ text/xml
+ 		No, defaults to application/pdf
outdirOutput directoryRequired if a fileset is used to specify the files to render; optional for fofile. (Can alternatively specify the full path in the fofile value.)
forceRecreate target files, even if they are newer than their corresponding + source files. Note: This attribute is available in post-0.20.5 + versions (0.20.x nightly build and 1.0dev) only; target files are + always generated (i.e., force=true) in 0.20.5 release. + No, default is false
basedirBase directory to resolve relative references (e.g., graphics files) within the + FO document. + No, for single FO File entry, default is to use the location + of that FO file. +
relativebaseFor fileset usage only. A value of true specifies using the location + of each .fo file as the base directory for resolving relative file references located + within that .fo file. A value of false specifies using the value of + basedir for all files within the fileset, or just the current working directory + if basedir is not specified. + No, default is false. +
userconfigUser configuration file (same as the FOP "-c" command line option). Currently doesn't work in FOP Trunk!!!No
messagelevelLogging level
+ Possible values: error, warn, info, verbose, debug. Currently doesn't work in FOP Trunk!!!		No, defaults to verbose
logFilesControls whether the names of the files that are processed are logged + (true) or not (false). Currently doesn't work in FOP Trunk!!!No, default is true
+

+ + + + + + + + + + + +
Parameters specified as nested elements
AttributeDescriptionRequired
filesetFileSets + are used to specify multiple XSL-FO files to be rendered.Yes, if no fofile attribute is supplied
+

+
+ Examples +

+ 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: +

+ + + + + + + + ]]> +
+ + + -- cgit v1.2.3