From 6677404dfad505ef7052ddee20582a3a6e5605da Mon Sep 17 00:00:00 2001 From: Christian Geisert Date: Thu, 24 Apr 2003 22:53:19 +0000 Subject: [PATCH] improved Ant task documentation PR: 18486 Submitted by: Glen Mazza (glenmazza@yahoo.com) git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196343 13f79535-47bb-0310-9956-ffa450edef68 --- src/documentation/content/xdocs/anttask.xml | 106 ++++++++++++-------- 1 file changed, 65 insertions(+), 41 deletions(-) diff --git a/src/documentation/content/xdocs/anttask.xml b/src/documentation/content/xdocs/anttask.xml index 84a71ee6f..e3e14aab6 100644 --- a/src/documentation/content/xdocs/anttask.xml +++ b/src/documentation/content/xdocs/anttask.xml @@ -8,17 +8,33 @@

- FOP provides an Ant task for integration into the build process.

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

Description

- FOP Ant task converts xsl-fo documents to PDF/PS/PCL/MIF/RTF output + The FOP Ant task will convert XSL-FO documents to PDF/PS/PCL/MIF/RTF output (see Output formats for available formats).

- FileSets are used to select files to render.

+ 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 - +
Parameters for FOP Ant task +
parameters for FOP Ant task
@@ -27,16 +43,16 @@ - + - + - - + - + - + - + - + Possible values: error, warn, info, verbose, debug + - - + + + +
Parameters specified as attributes
Attribute Description
fofile XSL-FO file to be renderedOnly if there's no filesetYes, if no fileset nested element is used
outfile Output filenameOnly when fofile is used (if there's no fileset)Yes, when fofile is used. (This attribute is not valid for filesets.)
formatPossible ouput formats:
+ 		Possible output formats:
application/pdf
application/postscript
application/vnd.mif
@@ -44,70 +60,78 @@ application/vnd.hp-PCL
text/plain
text/xml
- Defaults to application/pdf 		No, default is application/pdfNo, defaults to application/pdf
outdir Output directoryYesRequired if a fileset is used to specify the files to render; optional for fofile. (Can alternatively specify the full path in the fofile value.)
userconfigFile with user configuration (same as the "-c" command line option)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 verboseNo, defaults to verbose
logFilesControls whether the names of the files that are processed are logged or notNo; default is trueControls whether the names of the files that are processed are logged + (true) or not (false)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
-

Parameters specified as nested elements -
fileset -

- FileSets are used to select files that will be rendered to the - selected output format.

-
-
+
Examples

- Converts one XSL-FO file to PDF: + The following example converts a single XSL-FO file to a PDF document:

- - - - - + + ]]>

- Converts a whole directory of XSL-FO files to PostScript: + This example converts all XSL-FO files within an entire directory to PostScript:

- - - - + + + + + + + ]]>
-- 2.39.5