source: trunk/Distribution/SW/FOP/build/site/anttask.html

Last change on this file was 2, checked in by jkacer, 18 years ago

Added all DocBook Framework stuff:

  • DocBook DTD
  • Transformation software FOP 0.20.5 and Saxon 6
  • XSL styles
  • Rexx scripts

Also added some WarpIN-related stuff for creation of WarpIN installation packages.
This state corresponds to version 1.0.0 from November 2005, just slightly modified to carry versioning information (Rexx scripts).
File size: 17.6 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html>
3<head>
4<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5<title>Ant task</title>
6<link type="text/css" href="skin/page.css" rel="stylesheet">
7</head>
8<body text="#000000" bgcolor="#FFFFFF">
9<!--================= start Navigation Path ==================-->
10<table summary="navigation path" width="100%" border="0" cellpadding="0" cellspacing="0">
11<tr>
12<td nowrap="nowrap" valign="middle" bgcolor="#CFDCED" height="20"><img height="1" width="5" alt="" border="0" src="skin/images/spacer.gif"><!--===== breadcrumb trail (javascript-generated) ====--><font size="2" face="Arial, Helvetica, Sans-serif"><script src="skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script></font></td>
13</tr>
14<tr>
15<td bgcolor="#4C6C8F" height="2"><img height="2" width="2" alt="" border="0" src="skin/images/spacer.gif"></td>
16</tr>
17</table>
18<!--================= end Navigation Path ==================-->
19<!--================= start Banner ==================-->
20<table summary="header with logos" width="100%" border="0" cellpadding="0" cellspacing="0">
21<tr>
22<!--================= start Group Logo ==================-->
23<td bgcolor="#294563"><a href="http://xml.apache.org/"><img border="0" class="logoImage" alt="Apache XML" src="images/group-logo.gif"></a></td>
24<!--================= end Group Logo ==================-->
25<!--================= start Project Logo ==================--><td width="100%" align="center" bgcolor="#294563"><a href="http://xml.apache.org/fop/"><img border="0" class="logoImage" alt="FOP" src="images/logo.jpg"></a></td>
26<!--================= end Project Logo ==================-->
27<!--================= start Search ==================--><td valign="top" rowspan="2" bgcolor="#294563">
28<form target="_blank" action="http://www.google.com/search" method="get">
29<table summary="search" border="0" cellspacing="0" cellpadding="0" bgcolor="#4C6C8F">
30<tr>
31<td colspan="3"><img height="10" width="1" alt="" src="skin/images/spacer.gif"></td>
32</tr>
33<tr>
34<td><img height="1" width="1" alt="" src="skin/images/spacer.gif"></td><td nowrap="nowrap"><input value="xml.apache.org" name="sitesearch" type="hidden"><input size="15" name="q" id="query" type="text"><img height="1" width="5" alt="" src="skin/images/spacer.gif"><input name="Search" value="Search" type="submit">
35<br>
36<font face="Arial, Helvetica, Sans-serif" size="2" color="white">
37 the Apache XML site
38
39
40 </font></td><td><img height="1" width="1" alt="" src="skin/images/spacer.gif"></td>
41</tr>
42<tr>
43<td><img alt="" border="0" height="10" width="9" src="skin/images/search-left.gif"></td><td><img height="1" width="1" alt="" src="skin/images/spacer.gif"></td><td><img alt="" border="0" height="10" width="9" src="skin/images/search-right.gif"></td>
44</tr>
45</table>
46</form>
47</td>
48<!--================= start Search ==================--><td bgcolor="#294563"><img height="10" width="10" alt="" src="skin/images/spacer.gif"></td>
49</tr>
50<tr>
51<td valign="bottom" bgcolor="#294563" colspan="2">
52<!--================= start Tabs ==================-->
53<div class="tab">
54<table summary="tab bar" border="0" cellpadding="0" cellspacing="0">
55<tr>
56<td width="8"><img alt="" height="8" width="8" src="skin/images/spacer.gif"></td><td valign="bottom">
57<table summary="selected tab" style="height: 1.7em" border="0" cellpadding="0" cellspacing="0">
58<tr>
59<td valign="top" width="5" bgcolor="#4C6C8F"><img height="5" width="5" alt="" src="skin/images/tabSel-left.gif"></td><td valign="middle" bgcolor="#4C6C8F"><font color="#ffffff" size="2" face="Arial, Helvetica, Sans-serif"><b><a href="index.html"><font color="#000000">Home</font></a></b></font></td><td valign="top" width="5" bgcolor="#4C6C8F"><img height="5" width="5" alt="" src="skin/images/tabSel-right.gif"></td>
60</tr>
61</table>
62</td><td width="8"><img alt="" height="8" width="8" src="skin/images/spacer.gif"></td><td valign="bottom">
63<table summary="non selected tab" style="height: 1.6em" border="0" cellpadding="0" cellspacing="0">
64<tr>
65<td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="skin/images/tab-left.gif"></td><td valign="middle" bgcolor="#B2C4E0"><a href="dev/index.html"><font face="Arial, Helvetica, Sans-serif">Development</font></a></td><td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="skin/images/tab-right.gif"></td>
66</tr>
67</table>
68</td>
69</tr>
70</table>
71</div>
72<!--================= end Tabs ==================-->
73</td><td bgcolor="#294563"><img alt="" width="1" height="1" src="skin/images/spacer.gif"></td>
74</tr>
75<tr>
76<td bgcolor="#4C6C8F" colspan="4"><img width="1" height="10" alt="" src="skin/images/spacer.gif"></td>
77</tr>
78</table>
79<!--================= end Banner ==================-->
80<!--================= start Menu, NavBar, Content ==================-->
81<table summary="page content" bgcolor="#ffffff" width="100%" border="0" cellpadding="0" cellspacing="0">
82<tr>
83<td valign="top">
84<table summary="menu" border="0" cellspacing="0" cellpadding="0">
85<tr>
86<!--================= start left top NavBar ==================-->
87<td rowspan="3" valign="top">
88<table summary="blue line" border="0" cellpadding="0" cellspacing="0">
89<tr>
90<td bgcolor="#294563"><img width="10" height="1" alt="" src="skin/images/spacer.gif"></td>
91</tr>
92<tr>
93<td bgcolor="#CFDCED"><font color="#4C6C8F" size="4" face="Arial, Helvetica, Sans-serif">&nbsp;</font></td>
94</tr>
95<tr>
96<td bgcolor="#294563"><img width="10" height="1" alt="" src="skin/images/spacer.gif"></td>
97</tr>
98</table>
99</td>
100<!--================= end left top NavBar ==================--><td bgcolor="#294563"><img width="1" height="1" alt="" src="skin/images/spacer.gif"></td><td valign="bottom" bgcolor="#4C6C8F"><img width="10" height="10" alt="" src="skin/images/spacer.gif"></td><td nowrap="nowrap" valign="top" bgcolor="#4C6C8F">
101<!--================= start Menu items ==================-->
102<div class="menu">
103<ul>
104<li>
105<font color="#CFDCED">Home</font>
106<ul>
107
108<li>
109<a href="index.html">Introduction</a>
110</li>
111
112</ul>
113</li>
114<li>
115<font color="#CFDCED">Using FOP</font>
116<ul>
117
118<li>
119<a href="relnotes.html">Release Notes</a>
120</li>
121
122<li>
123<a href="download.html">Download</a>
124</li>
125
126<li>
127<a href="compiling.html">Build</a>
128</li>
129
130<li>
131<a href="configuration.html">Configure</a>
132</li>
133
134<li>
135<a href="running.html">Run</a>
136</li>
137
138<li>
139<a href="embedding.html">Embed</a>
140</li>
141
142<li>
143<a href="servlets.html">Servlets</a>
144</li>
145
146<li>
147<span class="sel"><font color="#ffcc00">Ant task</font></span>
148</li>
149
150</ul>
151</li>
152<li>
153<font color="#CFDCED">Features</font>
154<ul>
155
156<li>
157<a href="compliance.html">Compliance</a>
158</li>
159
160<li>
161<a href="output.html">Output Targets</a>
162</li>
163
164<li>
165<a href="pdfencryption.html">PDF encryption</a>
166</li>
167
168<li>
169<a href="graphics.html">Graphics</a>
170</li>
171
172<li>
173<a href="fonts.html">Fonts</a>
174</li>
175
176<li>
177<a href="hyphenation.html">Hyphenation</a>
178</li>
179
180<li>
181<a href="extensions.html">Extensions</a>
182</li>
183
184</ul>
185</li>
186<li>
187<font color="#CFDCED">Resources</font>
188<ul>
189
190<li>
191<a href="gethelp.html">Getting Help</a>
192</li>
193
194<li>
195<a href="faq.html">FAQs</a>
196</li>
197
198<li>
199<a href="fo.html">XSL-FO</a>
200</li>
201
202<li>
203<a href="examples.html">Examples</a>
204</li>
205
206<li>
207<a href="maillist.html">Mailing Lists</a>
208</li>
209
210<li>
211<a href="bugs.html">Bugs</a>
212</li>
213
214<li>
215<a href="license.html">License</a>
216</li>
217
218<li>
219<a href="resources.html">Other</a>
220</li>
221
222</ul>
223</li>
224<li>
225<font color="#CFDCED">Project</font>
226<ul>
227
228<li>
229<a href="news.html">News</a>
230</li>
231
232<li>
233<a href="logocontest.html">Logo contest</a>
234</li>
235
236<li>
237<a href="status.html">Status</a>
238</li>
239
240
241<li>
242<a href="team.html">Team</a>
243</li>
244
245</ul>
246</li>
247</ul>
248</div>
249<!--================= end Menu items ==================-->
250</td><td valign="bottom" bgcolor="#4C6C8F"><img width="10" height="10" alt="" src="skin/images/spacer.gif"></td><td bgcolor="#294563"><img width="1" height="1" alt="" src="skin/images/spacer.gif"></td>
251</tr>
252<tr>
253<td valign="bottom" align="left" colspan="2" rowspan="2" bgcolor="#4C6C8F"><img height="10" width="10" border="0" alt="" src="skin/images/menu-left.gif"></td><td bgcolor="#4C6C8F"><img height="10" width="10" border="0" alt="" src="skin/images/spacer.gif"></td><td valign="bottom" align="right" colspan="2" rowspan="2" bgcolor="#4C6C8F"><img height="10" width="10" border="0" alt="" src="skin/images/menu-right.gif"></td>
254</tr>
255<tr>
256<td height="1" bgcolor="#294563"><img width="1" height="1" alt="" src="skin/images/spacer.gif"></td>
257</tr>
258</table>
259</td><td valign="top" width="100%">
260<table summary="content" width="100%" border="0" cellpadding="0" cellspacing="0">
261<!--================= start middle NavBar ==================-->
262<tr>
263<td colspan="4" bgcolor="#294563"><img width="10" height="1" alt="" src="skin/images/spacer.gif"></td>
264</tr>
265<tr>
266<td align="left" width="10" bgcolor="#CFDCED"><img width="10" height="1" alt="" src="skin/images/spacer.gif"></td><td align="left" width="50%" bgcolor="#CFDCED"><font color="#4C6C8F" size="3" face="Arial, Helvetica, Sans-serif">
267 &nbsp;
268
269 </font><img width="10" height="8" alt="" src="skin/images/spacer.gif"></td><td align="right" width="50%" bgcolor="#CFDCED"><font color="#4C6C8F" size="3" face="Arial, Helvetica, Sans-serif">
270 &nbsp;
271
272 </font><img width="10" height="8" alt="" src="skin/images/spacer.gif"></td><td width="10" bgcolor="#CFDCED"><img width="10" height="1" alt="" src="skin/images/spacer.gif"></td>
273</tr>
274<tr>
275<td colspan="4" bgcolor="#294563"><img width="10" height="1" alt="" src="skin/images/spacer.gif"></td>
276</tr>
277<!--================= end middle NavBar ==================-->
278<!--================= start Content==================-->
279<tr>
280<td align="left" width="10"><img width="10" height="1" alt="" src="skin/images/spacer.gif"></td><td align="left" width="100%">
281<div class="content">
282<table class="title" summary="">
283<tr>
284<td valign="middle">
285<h1>Ant task</h1>
286</td><td nowrap="nowrap" width="80" align="center"><a class="dida" href="anttask.pdf"><img alt="printer" src="skin/images/printer.gif" border="0"><br>
287 print-friendly<br>
288 PDF</a></td>
289</tr>
290</table>
291<ul class="minitoc">
292<li>
293<a href="#Description">Description</a>
294</li>
295<li>
296<a href="#Parameters+for+FOP+Ant+task">Parameters for FOP Ant task</a>
297</li>
298<li>
299<a href="#Examples">Examples</a>
300</li>
301</ul>
302
303<p>
304 FOP provides an Ant task for automating the document build process.</p>
305
306<a name="N101C1"></a><a name="Description"></a>
307<h3>Description</h3>
308<div style="margin-left: 0 ; border: 2px">
309<p>
310 The FOP Ant task will convert XSL-FO documents to PDF/PS/PCL/MIF/RTF output
311 (see <a href="output.html">Output formats</a> for available formats).</p>
312<p>
313 To call FOP tasks within Ant, first add a FOP task definition to your Ant build file.
314 One method of defining the task is as follows:
315 </p>
316<pre class="code">
317&lt;property name="fop.dir" value="....path to your FOP jar files..."/&gt;
318
319&lt;taskdef name="fop"
320 classname="org.apache.fop.tools.anttasks.Fop"&gt;
321 &lt;classpath&gt;
322 &lt;pathelement location="${fop.dir}\fop.jar"/&gt;
323 &lt;pathelement location="${fop.dir}\avalon.jar"/&gt;
324 &lt;pathelement location="${fop.dir}\batik.jar"/&gt;
325 &lt;/classpath&gt;
326&lt;/taskdef&gt;
327 </pre>
328<p>
329 Then create FOP tasks within your Ant build file, using the FOP task parameters listed below.</p>
330</div>
331 <!-- TODO: Installation/Configuration -->
332
333<a name="N101DA"></a><a name="Parameters+for+FOP+Ant+task"></a>
334<h3>Parameters for FOP Ant task</h3>
335<div style="margin-left: 0 ; border: 2px">
336<table class="ForrestTable" cellspacing="1" cellpadding="4">
337<caption>Parameters specified as attributes</caption>
338
339<tr>
340
341<th colspan="1" rowspan="1">Attribute</th>
342 <th colspan="1" rowspan="1">Description</th>
343 <th colspan="1" rowspan="1">Required</th>
344
345</tr>
346
347<tr>
348
349<td colspan="1" rowspan="1">fofile</td>
350 <td colspan="1" rowspan="1">XSL-FO file to be rendered</td>
351 <td colspan="1" rowspan="1">Yes, if no fileset nested element is used</td>
352
353</tr>
354
355<tr>
356
357<td colspan="1" rowspan="1">outfile</td>
358 <td colspan="1" rowspan="1">Output filename</td>
359 <td colspan="1" rowspan="1">Yes, when fofile is used. (This attribute is not valid for filesets.)</td>
360
361</tr>
362
363<tr>
364
365<td colspan="1" rowspan="1">format</td>
366 <td colspan="1" rowspan="1">Possible output formats:<br>
367
368<span class="codefrag">application/pdf</span>
369<br>
370
371<span class="codefrag">application/postscript</span>
372<br>
373
374<span class="codefrag">application/vnd.mif</span>
375<br>
376
377<span class="codefrag">application/rtf</span>
378<br>
379
380<span class="codefrag">application/vnd.hp-PCL</span>
381<br>
382
383<span class="codefrag">text/plain</span>
384<br>
385
386<span class="codefrag">text/xml</span>
387<br>
388
389</td>
390 <td colspan="1" rowspan="1">No, defaults to <span class="codefrag">application/pdf</span></td>
391
392</tr>
393
394<tr>
395
396<td colspan="1" rowspan="1">outdir</td>
397 <td colspan="1" rowspan="1">Output directory</td>
398 <td colspan="1" rowspan="1">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.)</td>
399
400</tr>
401 <!--tr Commented out; attribute is currently unimplemented according to the code>
402 <td>basedir</td>
403 <td>Directory to work from</td>
404 <td>Yes</td>
405 </tr-->
406
407<tr>
408
409<td colspan="1" rowspan="1">userconfig</td>
410 <td colspan="1" rowspan="1">User configuration file (same as the FOP "-c" command line option)</td>
411 <td colspan="1" rowspan="1">No</td>
412
413</tr>
414
415<tr>
416
417<td colspan="1" rowspan="1">messagelevel</td>
418 <td colspan="1" rowspan="1">Logging level<br>
419 Possible values: <span class="codefrag">error</span>, <span class="codefrag">warn</span>, <span class="codefrag">info</span>, <span class="codefrag">verbose</span>, <span class="codefrag">debug</span></td>
420 <td colspan="1" rowspan="1">No, defaults to <span class="codefrag">verbose</span></td>
421
422</tr>
423
424<tr>
425
426<td colspan="1" rowspan="1">logFiles</td>
427 <td colspan="1" rowspan="1">Controls whether the names of the files that are processed are logged
428 (<span class="codefrag">true</span>) or not (<span class="codefrag">false</span>)</td>
429 <td colspan="1" rowspan="1">No, default is <span class="codefrag">true</span></td>
430
431</tr>
432
433</table>
434<p></p>
435<table class="ForrestTable" cellspacing="1" cellpadding="4">
436<caption>Parameters specified as nested elements</caption>
437
438<tr>
439
440<th colspan="1" rowspan="1">Attribute</th>
441 <th colspan="1" rowspan="1">Description</th>
442 <th colspan="1" rowspan="1">Required</th>
443
444</tr>
445
446<tr>
447
448<td colspan="1" rowspan="1">fileset</td>
449 <td colspan="1" rowspan="1"><a href="http://ant.apache.org/manual/CoreTypes/fileset.html">FileSets</a>
450 are used to specify multiple XSL-FO files to be rendered.</td>
451 <td colspan="1" rowspan="1">Yes, if no fofile attribute is supplied</td>
452
453</tr>
454
455</table>
456</div>
457
458<a name="N102DF"></a><a name="Examples"></a>
459<h3>Examples</h3>
460<div style="margin-left: 0 ; border: 2px">
461<p>
462 The following example converts a single XSL-FO file to a PDF document:
463 </p>
464<pre class="code">
465&lt;target name="generate-pdf" description="Generates a single PDF file"&gt;
466 &lt;fop format="application/pdf"
467 fofile="c:\working\foDirectory\foDocument.fo"
468 outfile="c:\working\pdfDirectory\pdfDocument.pdf" /&gt;
469&lt;/target&gt;
470 </pre>
471<p>
472 This example converts all XSL-FO files within an entire directory to PostScript:
473 </p>
474<pre class="code">
475&lt;target name="generate-multiple-ps"
476 description="Generates multiple PostScript files"&gt;
477 &lt;fop format="application/postscript"
478 outdir="${build.dir}" messagelevel="debug"&gt;
479 &lt;fileset dir="${fo.examples.dir}"&gt;
480 &lt;include name="*.fo"/&gt;
481 &lt;/fileset&gt;
482 &lt;/fop&gt;
483&lt;/target&gt;
484 </pre>
485</div>
486
487</div>
488</td><td width="10"><img width="10" height="1" alt="" src="skin/images/spacer.gif"></td>
489</tr>
490<!--================= end Content==================-->
491</table>
492</td>
493</tr>
494</table>
495<!--================= end Menu, NavBar, Content ==================-->
496<!--================= start Footer ==================-->
497<table summary="footer" cellspacing="0" cellpadding="0" width="100%" border="0">
498<tr>
499<td colspan="2" height="1" bgcolor="#4C6C8F"><img height="1" width="1" alt="" src="skin/images/spacer.gif"><a href="skin/images/label.gif"></a><a href="skin/images/page.gif"></a><a href="skin/images/chapter.gif"></a><a href="skin/images/chapter_open.gif"></a><a href="skin/images/current.gif"></a><a href="/favicon.ico"></a></td>
500</tr>
501<tr>
502<td colspan="2" bgcolor="#CFDCED" class="copyright" align="center"><font size="2" face="Arial, Helvetica, Sans-Serif">Copyright &copy;
503 1999-2003&nbsp;The Apache Software Foundation. All rights reserved.<script type="text/javascript" language="JavaScript"><!--
504 document.write(" - "+"Last Published: " + document.lastModified);
505 // --></script></font></td>
506</tr>
507<tr>
508<td colspan="2" align="left" bgcolor="#CFDCED" class="logos"></td>
509</tr>
510</table>
511<!--================= end Footer ==================-->
512</body>
513</html>
Note: See TracBrowser for help on using the repository browser.