source: trunk/Distribution/SW/FOP/build/site/configuration.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.5 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>FOP: Configuration</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<span class="sel"><font color="#ffcc00">Configure</font></span>
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<a href="anttask.html">Ant task</a>
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>FOP: Configuration</h1>
286</td><td nowrap="nowrap" width="80" align="center"><a class="dida" href="configuration.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="#general">Configuration File Basics</a>
294<ul class="minitoc">
295<li>
296<a href="#general-entries">Creating Entries</a>
297</li>
298<li>
299<a href="#general-available">Making Configuration Available to FOP</a>
300</li>
301</ul>
302</li>
303<li>
304<a href="#summary-key-value">Summary of Key-Value Configuration Options</a>
305</li>
306<li>
307<a href="#detail-key-value">Detail for Key-Value Configuration Options</a>
308<ul class="minitoc">
309<li>
310<a href="#hyphenation-dir">hyphenation-dir (URL, none)</a>
311</li>
312<li>
313<a href="#strokeSVGText">strokeSVGText (boolean, True)</a>
314</li>
315</ul>
316</li>
317<li>
318<a href="#fonts">Fonts</a>
319</li>
320</ul>
321
322<a name="N101BE"></a><a name="general"></a>
323<h3>Configuration File Basics</h3>
324<div style="margin-left: 0 ; border: 2px">
325<p>The FOP configuration file is an XML file containing a variety of settings that are useful for controlling FOP's behavior, and for helping it find resources that you wish it to use.</p>
326<p>The easiest way to get started using a FOP configuration file is to copy the sample found at <span class="codefrag">{fop-dir}/conf/userconfig.xml</span> to a location of your choice, and then to edit it according to your needs.
327It contains templates for the various configuration options, most of which are commented out. Remove the comments and change the settings for entries that you wish to use.
328Be sure to follow any instructions, including comments which specify the value range.
329Also, since the configuration file is XML, be sure to keep it well-formed.</p>
330<div class="frame note">
331<div class="label">Note</div>
332<div class="content">Do <strong>not</strong> change <span class="codefrag">{fop-dir}/conf/config.xml</span> or use it as the basis for your configuration file. It has an entirely different purpose.</div>
333</div>
334<a name="N101D6"></a><a name="general-entries"></a>
335<h4>Creating Entries</h4>
336<div style="margin-left: 0 ; border: 2px">
337<p>The general structure of the configuration file is a series of &lt;entry&gt; tags, each containing a &lt;key&gt; and a &lt;value&gt;. (Fonts use a different format). Here is an example:</p>
338<pre class="code">&lt;entry&gt;
339 &lt;key&gt;strokeSVGText&lt;/key&gt;
340 &lt;value&gt;false&lt;/value&gt;
341&lt;/entry&gt;</pre>
342</div>
343<a name="N101E4"></a><a name="general-available"></a>
344<h4>Making Configuration Available to FOP</h4>
345<div style="margin-left: 0 ; border: 2px">
346<p>After creating your configuration file, you must tell FOP how to find it:</p>
347<ul>
348
349<li>If running FOP from the command-line, see the "-c" command-line option in <a href="running.html">Running FOP</a>.</li>
350
351<li>If running FOP as an embedded application, see <a href="embedding.html#config-external">FOP: Embedding, Using a Configuration File</a>.</li>
352
353</ul>
354<p>See <a href="embedding.html#config-internal">Setting the Configuration Programmatically</a> for instructions on how to do so in an embedded environment.</p>
355</div>
356</div>
357
358<a name="N10207"></a><a name="summary-key-value"></a>
359<h3>Summary of Key-Value Configuration Options</h3>
360<div style="margin-left: 0 ; border: 2px">
361<table class="ForrestTable" cellspacing="1" cellpadding="4">
362
363<tr>
364
365<th colspan="1" rowspan="1">Option (key)</th>
366 <th colspan="1" rowspan="1">Data Type (for the value)</th>
367 <th colspan="1" rowspan="1">Default Value</th>
368
369</tr>
370
371<tr>
372
373<td colspan="1" rowspan="1">baseDir</td>
374 <td colspan="1" rowspan="1">URL</td>
375 <td colspan="1" rowspan="1">For command-line, the directory containing the input FO or XML file. For embedded, the current working directory.</td>
376
377</tr>
378
379<tr>
380
381<td colspan="1" rowspan="1">fontBaseDir</td>
382 <td colspan="1" rowspan="1">URL</td>
383 <td colspan="1" rowspan="1">value of baseDir</td>
384
385</tr>
386
387<tr>
388
389<td colspan="1" rowspan="1"><a href="#hyphenation-dir">hyphenation-dir</a></td>
390 <td colspan="1" rowspan="1">URL</td>
391 <td colspan="1" rowspan="1">None. This is for custom hyphenation patterns.</td>
392
393</tr>
394
395<tr>
396
397<td colspan="1" rowspan="1"><a href="#svg-strokeSVGText">strokeSVGText</a></td>
398 <td colspan="1" rowspan="1">Boolean</td>
399 <td colspan="1" rowspan="1">True</td>
400
401</tr>
402
403</table>
404</div>
405
406<a name="N1026F"></a><a name="detail-key-value"></a>
407<h3>Detail for Key-Value Configuration Options</h3>
408<div style="margin-left: 0 ; border: 2px">
409<p>The sections below provide detailed information for configuration options that are not self-explanatory. The parenthetical information after each key name indicates (Data Type, Default).</p>
410<a name="N10278"></a><a name="hyphenation-dir"></a>
411<h4>hyphenation-dir (URL, none)</h4>
412<div style="margin-left: 0 ; border: 2px">
413<p>Use this entry to indicate a directory containing custom hyphenation files (if any).
414See <a href="hyphenation.html">FOP: Hyphenation</a> for more information on creating and modifying hyphenation within FOP.</p>
415</div>
416<a name="N10286"></a><a name="strokeSVGText"></a>
417<h4>strokeSVGText (boolean, True)</h4>
418<div style="margin-left: 0 ; border: 2px">
419<p>In some cases, some text in SVG documents is converted to graphical shapes instead of retaining its character as text. To force all text to be rendered as text, set strokeSVGText = false. For a discussion of this issue, see <a href="graphics.html#svg-pdf-text">FOP: Graphics, Placing SVG Text into PDF</a>.</p>
420<div class="frame note">
421<div class="label">Note</div>
422<div class="content">strokeSVGText is currently only effective in the PDF renderer.</div>
423</div>
424</div>
425</div>
426
427<a name="N10298"></a><a name="fonts"></a>
428<h3>Fonts</h3>
429<div style="margin-left: 0 ; border: 2px">
430<p>Font configuration information is included in the FOP configuration file, but is documented at <a href="fonts.html">FOP: Fonts</a>. Note especially the section entitled <a href="fonts.html#register">Register Fonts with FOP</a>.</p>
431</div>
432
433</div>
434</td><td width="10"><img width="10" height="1" alt="" src="skin/images/spacer.gif"></td>
435</tr>
436<!--================= end Content==================-->
437</table>
438</td>
439</tr>
440</table>
441<!--================= end Menu, NavBar, Content ==================-->
442<!--================= start Footer ==================-->
443<table summary="footer" cellspacing="0" cellpadding="0" width="100%" border="0">
444<tr>
445<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>
446</tr>
447<tr>
448<td colspan="2" bgcolor="#CFDCED" class="copyright" align="center"><font size="2" face="Arial, Helvetica, Sans-Serif">Copyright &copy;
449 1999-2003&nbsp;The Apache Software Foundation. All rights reserved.<script type="text/javascript" language="JavaScript"><!--
450 document.write(" - "+"Last Published: " + document.lastModified);
451 // --></script></font></td>
452</tr>
453<tr>
454<td colspan="2" align="left" bgcolor="#CFDCED" class="logos"></td>
455</tr>
456</table>
457<!--================= end Footer ==================-->
458</body>
459</html>
Note: See TracBrowser for help on using the repository browser.