xmlgraphics-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r840169 - in /websites/staging/xmlgraphics/trunk/content: ./ fop/trunk/anttask.html
Date Fri, 30 Nov 2012 14:43:29 GMT
Author: buildbot
Date: Fri Nov 30 14:43:29 2012
New Revision: 840169

Log:
Staging update by buildbot for xmlgraphics

Modified:
    websites/staging/xmlgraphics/trunk/content/   (props changed)
    websites/staging/xmlgraphics/trunk/content/fop/trunk/anttask.html

Propchange: websites/staging/xmlgraphics/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri Nov 30 14:43:29 2012
@@ -1 +1 @@
-1415657
+1415659

Modified: websites/staging/xmlgraphics/trunk/content/fop/trunk/anttask.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/trunk/anttask.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/trunk/anttask.html Fri Nov 30 14:43:29
2012
@@ -340,93 +340,111 @@ $(document).ready(function () {
         <div id="items">
         </div>
       	<!-- <div id="breadcrumb"><a href="/">Home</a>&nbsp;&raquo&nbsp;<a
href="/fop/">Fop</a>&nbsp;&raquo&nbsp;<a href="/fop/trunk/">Trunk</a></div>
-->
-      	<div class="section-content"><h1 id="apachewzxhzdk1-fop-ant-task">Apache&trade;
FOP: Ant task</h1>
+      	<div class="section-content"><h1 id="apachewzxhzdk5-fop-ant-task">Apache&trade;
FOP: Ant task</h1>
 <p><version>$Revision: 1298724 $</version></p>
 <p>Apache&trade; FOP provides an Ant task for automating the document build process.</p>
-<h2 id="description-wzxhzdk5wzxhzdk6">Description <a id="basics"></a></h2>
+<h2 id="description-wzxhzdk9wzxhzdk10">Description <a id="basics"></a></h2>
 <p>The FOP Ant task will convert XSL-FO documents to PDF, PS, PCL etc. output (see
<a href="output.html">Output formats</a> for available formats).</p>
 <p>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:</p>
-<property name="fop.home" value="....path to your FOP HOME directory..."/>
+<div class="codehilite"><pre><span class="nt">&lt;property</span>
<span class="na">name=</span><span class="s">&quot;fop.home&quot;</span>
<span class="na">value=</span><span class="s">&quot;....path to your
FOP HOME directory...&quot;/</span><span class="nt">&gt;</span>
 
-<taskdef name="fop" 
-         classname="org.apache.fop.tools.anttasks.Fop">
-  <classpath>
-    <fileset dir="${fop.home}/lib">
-      <include name="*.jar"/>
-    </fileset>
-    <fileset dir="${fop.home}/build">
-      <include name="fop.jar"/>
-      <include name="fop-hyph.jar" />
-    </fileset>
-  </classpath>
-</taskdef>
-
-Then create FOP tasks within your Ant build file, using the FOP task parameters listed below.
-
-## Parameters for FOP Ant task <a id="parameters"></a>
-
-<caption>Parameters specified as attributes</caption>| Attribute | Description
| Required |
+<span class="nt">&lt;taskdef</span> <span class="na">name=</span><span
class="s">&quot;fop&quot;</span> 
+         <span class="na">classname=</span><span class="s">&quot;org.apache.fop.tools.anttasks.Fop&quot;</span><span
class="nt">&gt;</span>
+  <span class="nt">&lt;classpath&gt;</span>
+    <span class="nt">&lt;fileset</span> <span class="na">dir=</span><span
class="s">&quot;</span><span class="cp">${</span><span class="n">fop</span><span
class="o">.</span><span class="n">home</span><span class="cp">}</span><span
class="s">/lib&quot;</span><span class="nt">&gt;</span>
+      <span class="nt">&lt;include</span> <span class="na">name=</span><span
class="s">&quot;*.jar&quot;/</span><span class="nt">&gt;</span>
+    <span class="nt">&lt;/fileset&gt;</span>
+    <span class="nt">&lt;fileset</span> <span class="na">dir=</span><span
class="s">&quot;</span><span class="cp">${</span><span class="n">fop</span><span
class="o">.</span><span class="n">home</span><span class="cp">}</span><span
class="s">/build&quot;</span><span class="nt">&gt;</span>
+      <span class="nt">&lt;include</span> <span class="na">name=</span><span
class="s">&quot;fop.jar&quot;/</span><span class="nt">&gt;</span>
+      <span class="nt">&lt;include</span> <span class="na">name=</span><span
class="s">&quot;fop-hyph.jar&quot;</span> <span class="nt">/&gt;</span>
+    <span class="nt">&lt;/fileset&gt;</span>
+  <span class="nt">&lt;/classpath&gt;</span>
+<span class="nt">&lt;/taskdef&gt;</span>
+</pre></div>
+
+
+<p>Then create FOP tasks within your Ant build file, using the FOP task parameters
listed below.</p>
+<h2 id="parameters-for-fop-ant-task-wzxhzdk11wzxhzdk12">Parameters for FOP Ant task
<a id="parameters"></a></h2>
+<p><caption>Parameters specified as attributes</caption>
+| Attribute | Description | Required |
 |-----------|-------------|----------|
 | fofile | XSL-FO file to be rendered | Yes, if no fileset nested element is used |
 | xmlfile | XML input file | Yes, if no fofile is specified |
 | xsltfile | XSLT input file | Yes, if no fofile is specified |
 | outfile | Output filename | Yes, when fofile is used. (This attribute is not valid for
filesets.) |
-| format | Possible output formats:<br></br> `application/X-fop-awt-preview`
<br></br> `application/X-fop-print` <br></br> `application/X-fop-areatree`
<br></br> `application/pdf` <br></br> `application/postscript` <br></br>
`application/mif` <br></br> `application/rtf` , `text/richtext` , `text/rtf` <br></br>
`application/x-pcl` , `application/vnd.hp-PCL` <br></br> `application/x-afp` ,
`application/vnd.ibm.modcap` <br></br> `text/plain` <br></br> `image/svg+xml`
<br></br> `image/gif` <br></br> `image/png` <br></br>
`image/tiff` <br></br> | No, defaults to `application/pdf`  |
+| format | Possible output formats:<br></br> <code>application/X-fop-awt-preview</code>
<br></br> <code>application/X-fop-print</code> <br></br>
<code>application/X-fop-areatree</code> <br></br> <code>application/pdf</code>
<br></br> <code>application/postscript</code> <br></br>
<code>application/mif</code> <br></br> <code>application/rtf</code>
, <code>text/richtext</code> , <code>text/rtf</code> <br></br>
<code>application/x-pcl</code> , <code>application/vnd.hp-PCL</code>
<br></br> <code>application/x-afp</code> , <code>application/vnd.ibm.modcap</code>
<br></br> <code>text/plain</code> <br></br> <code>image/svg+xml</code>
<br></br> <code>image/gif</code> <br></br> <code>image/png</code>
<br></br> <code>image/tiff</code> <br></br> | No, defaults
to <code>application/pdf</code>  |
 | 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.) |
-| force | Recreate 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`  |
+| force | Recreate 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 <code>false</code>  |
 | basedir | Base 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.
|
-| relativebase | For 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` . |
+| relativebase | For fileset usage only. A value of <code>true</code> 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 <code>false</code> 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 <code>false</code> . |
 | userconfig | User configuration file (same as the FOP "-c" command line option). | No |
-| messagelevel | Logging level<br></br>Possible values: `error` , `warn` , `info`
, `verbose` , `debug` . **Currently doesn't work in FOP Trunk!!!**  | No, defaults to `verbose`
 |
-| logFiles | Controls 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`
 |
-| throwexceptions | Controls whether or not an exception is thrown if an error occurs during
rendering. | Default is `true`  |
-
-<caption>Parameters specified as nested elements</caption>| Attribute | Description
| Required |
-|-----------|-------------|----------|
-| fileset |  [FileSets](http://ant.apache.org/manual/CoreTypes/fileset.html) are used to
specify multiple XSL-FO files to be rendered. | Yes, if no fofile attribute is supplied |
-
-## Examples <a id="examples"></a>
-
-The following example converts a single XSL-FO file to a PDF document:
-
-<target name="generate-pdf" description="Generates a single PDF file">
-   <fop format="application/pdf" 
-        fofile="c:\working\foDirectory\foDocument.fo"
-        outfile="c:\working\pdfDirectory\pdfDocument.pdf" />
-</target>
-
-This example converts all XSL-FO files within an entire directory to PostScript:
-
-<target name="generate-multiple-ps" 
-        description="Generates multiple PostScript files">
-   <fop format="application/postscript" 
-        outdir="${build.dir}" messagelevel="debug">
-        <fileset dir="${fo.examples.dir}">
-           <include name="*.fo"/>
-        </fileset>
-   </fop>
-</target>
-
-The following example transforms and converts a single XML and XSLT file to an AFP document:
-
-<target name="generate-afp-from-transform" description="Generates a single AFP file from
an XSLT stylesheet">
-   <fop format="application/x-afp" 
-        xmlfile="c:\working\foDirectory\Document.xml"
-        xsltfile="c:\working\foDirectory\Document.xslt"
-        outfile="c:\working\afpDirectory\Document.afp" />
-</target>
-
-This example transforms and converts all XML files within an entire directory to PostScript:
-
-<target name="generate-multiple-ps-from-transform" description="Generates multiple PostScript
files using an XSLT stylesheet">
-   <fop format="application/postscript" 
-        xsltfile="c:\working\foDirectory\Document.xslt"
-        outdir="${build.dir}" messagelevel="debug">
-        <fileset dir="${test.dir}">
-           <include name="*.xml"/>
-        </fileset>
-   </fop>
-</target></div>
+| messagelevel | Logging level<br></br>Possible values: <code>error</code>
, <code>warn</code> , <code>info</code> , <code>verbose</code>
, <code>debug</code> . <strong>Currently doesn't work in FOP Trunk!!!</strong>
 | No, defaults to <code>verbose</code>  |
+| logFiles | Controls whether the names of the files that are processed are logged ( <code>true</code>
) or not ( <code>false</code> ). <strong>Currently doesn't work in FOP Trunk!!!</strong>
 | No, default is <code>true</code>  |
+| throwexceptions | Controls whether or not an exception is thrown if an error occurs during
rendering. | Default is <code>true</code>  |</p>
+<table>
+<thead>
+<tr>
+<th><caption>Parameters specified as nested elements</caption></th>
+<th>Attribute</th>
+<th>Description</th>
+<th>Required</th>
+<th></th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td></td>
+<td>fileset</td>
+<td><a href="http://ant.apache.org/manual/CoreTypes/fileset.html">FileSets</a>
are used to specify multiple XSL-FO files to be rendered.</td>
+<td>Yes, if no fofile attribute is supplied</td>
+<td></td>
+</tr>
+</tbody>
+</table>
+<h2 id="examples-wzxhzdk47wzxhzdk48">Examples <a id="examples"></a></h2>
+<p>The following example converts a single XSL-FO file to a PDF document:</p>
+<div class="codehilite"><pre><span class="nt">&lt;target</span>
<span class="na">name=</span><span class="s">&quot;generate-pdf&quot;</span>
<span class="na">description=</span><span class="s">&quot;Generates
a single PDF file&quot;</span><span class="nt">&gt;</span>
+   <span class="nt">&lt;fop</span> <span class="na">format=</span><span
class="s">&quot;application/pdf&quot;</span> 
+        <span class="na">fofile=</span><span class="s">&quot;c:\working\foDirectory\foDocument.fo&quot;</span>
+        <span class="na">outfile=</span><span class="s">&quot;c:\working\pdfDirectory\pdfDocument.pdf&quot;</span>
<span class="nt">/&gt;</span>
+<span class="nt">&lt;/target&gt;</span>
+</pre></div>
+
+
+<p>This example converts all XSL-FO files within an entire directory to PostScript:</p>
+<div class="codehilite"><pre><span class="nt">&lt;target</span>
<span class="na">name=</span><span class="s">&quot;generate-multiple-ps&quot;</span>

+        <span class="na">description=</span><span class="s">&quot;Generates
multiple PostScript files&quot;</span><span class="nt">&gt;</span>
+   <span class="nt">&lt;fop</span> <span class="na">format=</span><span
class="s">&quot;application/postscript&quot;</span> 
+        <span class="na">outdir=</span><span class="s">&quot;</span><span
class="cp">${</span><span class="n">build</span><span class="o">.</span><span
class="n">dir</span><span class="cp">}</span><span class="s">&quot;</span>
<span class="na">messagelevel=</span><span class="s">&quot;debug&quot;</span><span
class="nt">&gt;</span>
+        <span class="nt">&lt;fileset</span> <span class="na">dir=</span><span
class="s">&quot;</span><span class="cp">${</span><span class="n">fo</span><span
class="o">.</span><span class="n">examples</span><span class="o">.</span><span
class="n">dir</span><span class="cp">}</span><span class="s">&quot;</span><span
class="nt">&gt;</span>
+           <span class="nt">&lt;include</span> <span class="na">name=</span><span
class="s">&quot;*.fo&quot;/</span><span class="nt">&gt;</span>
+        <span class="nt">&lt;/fileset&gt;</span>
+   <span class="nt">&lt;/fop&gt;</span>
+<span class="nt">&lt;/target&gt;</span>
+</pre></div>
+
+
+<p>The following example transforms and converts a single XML and XSLT file to an AFP
document:</p>
+<div class="codehilite"><pre><span class="nt">&lt;target</span>
<span class="na">name=</span><span class="s">&quot;generate-afp-from-transform&quot;</span>
<span class="na">description=</span><span class="s">&quot;Generates
a single AFP file from an XSLT stylesheet&quot;</span><span class="nt">&gt;</span>
+   <span class="nt">&lt;fop</span> <span class="na">format=</span><span
class="s">&quot;application/x-afp&quot;</span> 
+        <span class="na">xmlfile=</span><span class="s">&quot;c:\working\foDirectory\Document.xml&quot;</span>
+        <span class="na">xsltfile=</span><span class="s">&quot;c:\working\foDirectory\Document.xslt&quot;</span>
+        <span class="na">outfile=</span><span class="s">&quot;c:\working\afpDirectory\Document.afp&quot;</span>
<span class="nt">/&gt;</span>
+<span class="nt">&lt;/target&gt;</span>
+</pre></div>
+
+
+<p>This example transforms and converts all XML files within an entire directory to
PostScript:</p>
+<div class="codehilite"><pre><span class="nt">&lt;target</span>
<span class="na">name=</span><span class="s">&quot;generate-multiple-ps-from-transform&quot;</span>
<span class="na">description=</span><span class="s">&quot;Generates
multiple PostScript files using an XSLT stylesheet&quot;</span><span class="nt">&gt;</span>
+   <span class="nt">&lt;fop</span> <span class="na">format=</span><span
class="s">&quot;application/postscript&quot;</span> 
+        <span class="na">xsltfile=</span><span class="s">&quot;c:\working\foDirectory\Document.xslt&quot;</span>
+        <span class="na">outdir=</span><span class="s">&quot;</span><span
class="cp">${</span><span class="n">build</span><span class="o">.</span><span
class="n">dir</span><span class="cp">}</span><span class="s">&quot;</span>
<span class="na">messagelevel=</span><span class="s">&quot;debug&quot;</span><span
class="nt">&gt;</span>
+        <span class="nt">&lt;fileset</span> <span class="na">dir=</span><span
class="s">&quot;</span><span class="cp">${</span><span class="n">test</span><span
class="o">.</span><span class="n">dir</span><span class="cp">}</span><span
class="s">&quot;</span><span class="nt">&gt;</span>
+           <span class="nt">&lt;include</span> <span class="na">name=</span><span
class="s">&quot;*.xml&quot;/</span><span class="nt">&gt;</span>
+        <span class="nt">&lt;/fileset&gt;</span>
+   <span class="nt">&lt;/fop&gt;</span>
+<span class="nt">&lt;/target&gt;</span>
+</pre></div></div>
       </div>
       
       <div class="clear"></div>



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: commits-help@xmlgraphics.apache.org


Mime
View raw message