chrisg 2003/03/11 01:03:51 Modified: src/documentation/content/xdocs anttask.xml Log: Doh committed wrong file (I blame forrest because when running as webapp you have to edit the files in build ;-) Revision Changes Path 1.2 +95 -20 xml-fop/src/documentation/content/xdocs/anttask.xml Index: anttask.xml =================================================================== RCS file: /home/cvs/xml-fop/src/documentation/content/xdocs/anttask.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- anttask.xml 10 Mar 2003 18:09:13 -0000 1.1 +++ anttask.xml 11 Mar 2003 09:03:51 -0000 1.2 @@ -8,32 +8,107 @@ </header> <body> <p> - FOP has also an ANT task for integration into your build process. - </p> - <section><title>Parameter</title> + FOP provides an Ant task for integration into the build process.</p> + <section><title>Description</title> + <p> + FOP Ant task converts xsl-fo documents to PDF/PS/PCL/MIF/RTF output + (see <link href="output.html">Output formats</link> for available formats).</p> + <p> + FileSets are used to select files to render.</p> + </section> + <!-- TODO: Installation/Configuration --> + <section><title>Parameters</title> + <table><caption>parameters for FOP Ant task</caption> + <tr> + <th>Attribute</th> + <th>Description</th> + <th>Required</th> + </tr> + <tr> + <td>fofile</td> + <td>XSL-FO file to be rendered</td> + <td>Only if there's no fileset</td> + </tr> + <tr> + <td>outfile</td> + <td>Output filename</td> + <td>Only when fofile is used (if there's no fileset)</td> + </tr> + <tr> + <td>format</td> + <td>Possible ouput formats:<br/> + <code>application/pdf</code><br/> + <code>application/postscript</code><br/> + <code>application/vnd.mif</code><br/> + <code>application/rtf</code><br/> + <code>application/vnd.hp-PCL</code><br/> + <code>text/plain</code><br/> + <code>text/xml</code><br/> + Defaults to <code>application/pdf</code> + </td> + <td>No, default is <code>application/pdf</code></td> + </tr> + <tr> + <td>outdir</td> + <td>Output directory</td> + <td>Yes</td> + </tr> + <tr> + <td>basedir</td> + <td>Directory to work from</td> + <td>Yes</td> + </tr> + <tr> + <td>userconfig</td> + <td>File with user configuration (same as the "-c" command line option)</td> + <td>No</td> + </tr> + <tr> + <td>messagelevel</td> + <td>Logging level<br/> + Possible values: error, warn, info, verbose, debug</td> + <td>No; defaults to verbose</td> + </tr> + <tr> + <td>logFiles</td> + <td>Controls whether the names of the files that are processed are logged or not</td> + <td>No; default is true</td> + </tr> + </table> + <section><title>Parameters specified as nested elements</title> + <section><title>fileset</title> + <p> + FileSets are used to select files that will be rendered to the + selected output format.</p> + </section> + </section> </section> <section> <title>Examples</title> <p> - + Converts one XSL-FO file to PDF: </p> <source><![CDATA[ - <target name="examples" depends="package" description="Generates example PDF files"> - <taskdef name="fop" classname="org.apache.fop.tools.anttasks.Fop" - classpathref="libs-run-classpath"/> - <mkdir dir="${build.examples.dir}"/> - <fop format="${build.property.examples.mime.type}" outdir="${build.examples.dir}" - messagelevel="debug" basedir="${fo.examples.dir}"> - <fileset dir="${fo.examples.dir}"> - <include name="**/*.fo"/> - </fileset> - </fop> - </target> - ]]></source> - <p> - See the full text of the <link - href="http://archives.apache.org/eyebrowse/[EMAIL PROTECTED]&msgNo=4509">announcement</link>. - </p> +<target name="generate-pdf" depends="init" description="Generates PDF file"> + + <taskdef name="fop" classname="org.apache.fop.tools.anttasks.Fop" + classpathref="libs-run-classpath"/> + + <fop fofile="examples/fo/basic/extensive.fo" outfile="${build.dir}/extensive.pdf"/> + +</target> + ]]></source> + <p> + Converts a whole directory of XSL-FO files to PostScript: + </p> + <source><![CDATA[ +<fop format="application/postscript" outdir="${build.dir}" + messagelevel="debug" basedir="${fo.examples.dir}"> + <fileset dir="${fo.examples.dir}"> + <include name="**/*.fo"/> + </fileset> +</fop> + ]]></source> </section> </body> </document>
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]