1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE faqs PUBLIC "-//APACHE//DTD FAQ V1.1//EN"
"http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/resources/schema/dtd/faq-v11.dtd">
<faqs title="FOP FAQ">
<part id="part-general">
<title>General questions</title>
<faq id="fop-general">
<question>What is FOP?</question>
<answer>
<p>
FOP is a print formatter for <link href="#XSLFO">XSL formatting
objects</link>.
</p>
<p>
It can be used to render an XML file containing XSL formatting objects
into a page layout. The main target is PDF but other rendering targets
are supported, such as AWT, PCL, text and direct printing.
</p>
</answer>
</faq>
<faq id="fop-functions">
<question>What can I do with FOP?</question>
<answer>
<p>
FOP provides both an application and a library that converts an XSL FO
document into paginated output.
</p>
<p>
The FOP command line application can be directly used to transform XML
into PDF, PostScript, PCL and other formats, there is also an AWT
based viewer integrated.
</p>
<p>
The library can be used in servlets and other Java applications.
</p>
</answer>
</faq>
<faq id="fop-acronym">
<question>What does "FOP" stand for?</question>
<answer>
<p>
It's an acronym for <strong>F</strong>ormatting
<strong>O</strong>bject <strong>P</strong>rocessor
</p>
</answer>
</faq>
<faq id="fop-other-apache">
<question>How does FOP interact with other Apache Projects?</question>
<answer>
<p>
FOP is distributed with <link
href="http://xml.apache.org/cocoon">Cocoon</link> as a PDF serializer
for XSL (FO) documents.
</p>
<p>
<link href="http://xml.apache.org/batik">Batik</link> can be used with
FOP to <link
href="http://xml.apache.org/batik/svgrasterizer.html">transcode an SVG
image</link> into a PDF document.
</p>
</answer>
</faq>
<faq id="xsl-def">
<question>What is XSL?</question>
<answer>
<p>
XSL is a W3C standard concerned with publishing XML documents. It
consists of two parts: <link href="#XSLT">XSLT</link> and <link
href="#XSLFO">XSLFO</link>. The acronym expands to
e<strong>X</strong>tensible <strong>S</strong>tylesheet
<strong>L</strong>anguage.
</p>
</answer>
</faq>
<faq id="xslfo">
<question>What is XSL-FO?</question>
<answer>
<p>
XSLFO is an XML vocabulary that is used to specify a pagination and
other styling for page layout output. The acronym “FO”
stands for
<strong>F</strong>ormatting <strong>O</strong>bjects. XSLFO can be
used in conjunction with <link href="#XSLT">XSLT</link> to convert
from any XML format into a paginated layout ready for printing or
displaying.
</p>
<p>
XSLFO defines a set of elements in XML that describes the way pages
are set up. The contents of the pages are filled from flows. There can
be static flows that appear on every page (for headers and footers)
and the main flow which fills the body of the page.
</p>
<p>
Synonyms: XSL FO, XSL (FO), XSL:FO, XSL-FO, Formatting Objects
</p>
</answer>
</faq>
<faq id="XSLT">
<question>What is XSLT?</question>
<answer>
<p>
XSLT describes the transformation of arbitrary XML input into other
XML (like XSLFO), HTML or plain text. The “T” comes from
<strong>T</strong>ransformation. For historical reasons, a
transformation is often also called a “style sheet”.
</p>
<p>
Synonyms: XSL transformation, XSL:T, XSL style sheet.
</p>
</answer>
</faq>
<faq id="contribute">
<question>How can I contribute?</question>
<answer>
<p>
There are numerous ways that you can help. They are outlined in the <link href="dev/index.html">Developer's Introduction</link>.
</p>
</answer>
</faq>
</part>
<part id="part-running">
<title>Problems running FOP</title>
<faq id="no-page-master">
<question>I get the error: [ERROR]: 'master-reference' for
'fo:page-sequence'matches no 'simple-page-master' or
'page-sequence-master'</question>
<answer>
<p>
FOP was changed to be in accordance with the latest standard (see
<link href="resources.html#w3-xsl">XSL standard</link>).The page
master for a fo:page-sequence is now refereced by the
master-reference attribute. Replace the master-name attributes of
your fo:page-sequence elements by master-reference attributes. You
have to do this also for fo:single-page-master-reference,
fo:repeatable-page-master-reference and
fo:conditional-page-master-reference elements in you page master
definitions.
</p>
<p>
Update your FO documents and style sheets.
</p>
</answer>
</faq>
<faq id="NoClassDefFound">
<question>I get a NoClassDefFound exception.</question>
<answer>
<p>This is typically a problem with your classpath.</p>
<p>If you are running FOP from the command line:</p>
<ul>
<li>
Use the fop.bat or fop.sh command file from the FOP
distribution. If you have a FOP version older than 0.20.5,
ensure the directory where FOP and these files have been
installed is the current working directory.
</li>
<li>
If this doesn't help, check whether still all the jar files
mentioned in the classpath in the fop.bat file are in their
respective places.
</li>
</ul>
<p>
If you run FOP embedded in your servlet, web application or
other Java application, check the classpath of the
application. Check the also the information pertaining <link
href="servlets.html#servlet-engine">servlet engines</link>
for further hints.
</p>
</answer>
</faq>
<faq id="NoSuchMethodException">
<question>I get a NoSuchMethodException or a NoSuchFieldException
exception.</question>
<answer>
<p>
This is usually caused by an older version of one of the FOP jars or
old XML tools in the classpath. Check in particular for parser.jar,
jaxp.jar, xml4j.jar or lotusxsl.jar.
</p>
<p>
Incompatible versions of Batik may also cause this problem. Use the
version of Batik that comes with FOP. It is not always possible to
use a more recent version of Batik.
</p>
</answer>
</faq>
<faq id="OutOfMemoryException">
<question>I get an OutOfMemoryException.</question>
<answer>
<p>
See <link href="running.html#memory">FOP Memory</link>.
</p>
</answer>
</faq>
<faq id="MalformedURLException">
<question>I get a MalformedURLException.</question>
<answer>
<anchor id="MalformedURL"/>
<p>
What you probably think of as "file names" are usually URLs, in
particular the src attribute of fo:external-graphic.
</p>
<p>
Because usage of URLs is growing, you should make yourself familiar
with it. The relevant specification is <link
href="http://www.rfc-editor.org/rfc/rfc2396.txt">RFC 2396</link>.
</p>
<p>
In a nutshell, the correct syntax for an absolute file URL is
<code>file:///some/path/file.ext</code> on Unix and
<code>file:///z:/some/path/file.ext</code> on Windows systems. Note
the triple slash, and also that only forward slashes are used, even on
windows.
</p>
<p>
A relative file URL starts with anything but a slash, and doesn't have
the <code>file:</code> prefix, for example <code>file.ext</code>,
<code>path/file.ext</code> or <code>../file.ext</code>. The string
<code>file:path/file.ext</code> is <em>not</em> a relative URL,
in fact, it isn't a valid URL at all. A relative URL is subject to a
resolving process, which transforms it into an absolute
URL.
</p>
<!--p>
See Understanding URIs and URLs and Understanding
URL resolving.
</p-->
</answer>
</faq>
<faq id="NullPointerException">
<question>I get an "[ERROR]: null", or a NullPointerException.</question>
<answer>
<p>
This is often caused by an invalid FO document. Currently only very
common errors are intercepted and produce a comprehensible error
message. If you forgot container elements like fo:page-sequence or
fo:flow and put blocks and inline elements directly as children of
fo:root or fo:page-sequence, you'll only get a
NullPointerException. Check whether your FO file has a proper
structure. In some cases there are mandatory properties, like the
master-reference in fo:conditional-page-master-reference, check also
whether you got them right.
</p>
<p>
You may find it helpful to use the <link
href="#FO-validate">validation tools</link> to validate your
FO document. This will catch most problems, but should not be
relied upon to catch all.
</p>
<p>
If you use XSLT, problems in your style sheet and in your source XML
also can produce a NullPointerException. Run the transformation
separately to check for this, usually you'll get a detailed error
message from the XSLT processor.
</p>
<p>
If you turn on debugging with the "-d" option you may be able to
see more detailed information.
</p>
</answer>
</faq>
<faq id="not-implemented">
<question>FOP returns the message "[ERROR] <em>object|property - 'x'</em> is not implemented yet." When will it be implemented?</question>
<answer>
<p>See the article "<link href="gethelp.html#compliance">Review FOP's Standards Compliance</link>".</p>
</answer>
</faq>
<faq id="fop-hangs">
<question>FOP hangs. FOP does not exit.</question>
<answer>
<p>
The most likely reason is a known problem with the Java run time
environment which is triggered by rendering SVGs. Suns JDK 1.4 does
not have this problem. See also <link href="#svghangs">FOP does not
exit if a SVG is included</link>.
</p>
<p>
Another possibility is that FOP went into a non terminating
loop. Usually this is indicated by lots of log messages of the form
"[INFO]: [NNNN]" which indicate a new page has been started or <link
href="#boxoverflow">box overflows</link>. After some time, FOP will
crash with an OutOfMemoryException.
</p>
<p>
If you called the FOP command line application from some other
programm, for example from Java using Runtime.exec(), it may hang
while trying to write log entries to the output pipe. You have to read
the FOP output regularly to empty the pipe buffer. It is best to avoid
exec'ing FOP, use the library interface instead.
</p>
</answer>
</faq>
<faq id="boxoverflow">
<question>FOP runs forever, writing lots of ">" to the log.</question>
<answer>
<p>
There is something too large to fit into the intended place, usually a
large image, a table whose rows are kept together or a block with a
space-before or space-after larger than the page size. Catch the first
page showing this phenomenon and check it. If it is not obvious which
element causes the trouble, remove stuff until the problem goes
away. Decrease the dimensions of the offending element or property, or
increase the dimension of the enclosing element or container, or
remove keep-with-* properties.
</p>
</answer>
</faq>
<faq id="cannot-find-external-graphics">
<question>FOP cannot find a file for fo:external-graphics.</question>
<answer>
<p>
The src attribute of the fo:external-graphics element takes an URI,
not a file name.
</p>
<p>
Relative URLs are resolved against the baseDir property of FOP. For
the command line FOP application, the baseDir is the directory of the
input file, either the FO file or the XML source. If FOP is used
embedded in a servlet, <link href="embedding.html">baseDir can be
set explicitely</link>. If it's not set, it is usually the current
working directory of the process which runs FOP.
</p>
<!--p>
See Understanding URIs and URLs and Understanding
URL resolving.
</p-->
</answer>
</faq>
<faq id="fonts-not-found">
<question>FOP does not find my fonts.</question>
<answer>
<p>
Did you get: «Failed to read font metrics file C:\foo\arial.xml
: File "C:\foo\arial.xml" not found»? The value for the
metrics-file attribute in the user config file is actually an URL, not
a file name. Use "file:///C:/foo/arial.xml" instead.
</p>
<p>
If you used a relative URL, make sure your application has the working
directory you expect. Currently FOP does not use the baseDir for
resolving relative URLs pointing to font metric files.
</p>
<p>
Try also setting the fontBaseDir configuration. (FIXME: add
link to congfiguration page)
</p>
</answer>
</faq>
</part>
<part id="part-output">
<title>Problems with FOP output</title>
<faq id="leader-expansion">
<question>Leaders don't work anymore in 0.20.5. Instead of
filling the line, only three dots or a short ruler is
output.</question>
<answer>
<p>
Leaders still work, in fact they work better than ever
before. You'll just have to add text-align="justify" and/or
text-align-last="justify" to the block with the leader. Be
sure you haven't accidentally overridden the
leader-length.maximum="100%" default value.
</p>
<p>
Earlier versions of FOP used to expand a leader to fill the
rest of the line unconditionally, anything following it,
like page numbers in a TOC, was actually shifted beyong the
right margin.
</p>
<p>
The new implementation uses leader-length.optimum to
determine where to break the line, and expands the leader
only further if the line should be filled, as indicated by
the text-aling and text-align-last properties.
</p>
<p>
Actually due to the fuzzyness of the specification both the
old and the new method are conformant (although adding text
after the expanded leader in the old variant never was).
</p>
<p>
If you want to have a longer ruler or space in a
non-justified line, you have to increase the
leader-length.optimum property.
</p>
</answer>
</faq>
<faq id="blank-page-between-page-sequences">
<question>Why does FOP insert a blank page between my page sequences?</question>
<answer>
<p>
This is because spec conformance has been improved.
</p>
<p>
The <link
href="http://www.w3.org/TR/xsl/slice7.html#force-page-count">force-page-count
property</link> controls how a FO processor pads page sequences in
order to get certain page counts or last page numbers. The default is
"<code>auto</code>". With this setting, if the next page sequence
begins with an odd page number because you set the
initial-page-number, and the current page sequence also ends with an
odd page number, the processor inserts a blank page to keep odd and
even page numbers alternating (similar for the case the current page
sequence ends with an even page number and the next page sequence
starts with an even page number.
</p>
<p>
If you don't want to have this blank page, use
<code>force-page-count="no-force"</code>.
</p>
</answer>
</faq>
<faq id="graphic-not-displayed">
<question>Why is my graphic not rendered?</question>
<answer>
<p>Most commonly, the external file is not being found by FOP.
Check the following:</p>
<ul>
<li>Empty or wrong baseDir setting.</li>
<li>Spelling errors in the file name (including using the wrong case).</li>
<li>Security Problems (i.e. image was not delivered because FOP is not allowed to read the file).
This is especially a problem if the external file is retrieved over HTTP.
Possible issues include security settings on the server, server configuration, and missing cookies or other authorization information.
Any easy way to check this is to cut&paste the source URL from the fo:external-graphic into the Location field of a browser <strong>on the machine where the FOP process will be running</strong>.</li>
</ul>
<p>Other possibilities:</p>
<ul>
<li>The image format is not supported or not supported completely. See <link href="graphics.html">FOP Graphics Formats</link> for a list of supported formats and related issues.</li>
<li>The graphic may be too large to fit into the intended space.</li>
<li>There may be something (static content) that is obscuring the graphic. (This is very rare).
</li>
</ul>
</answer>
</faq>
<faq id="png-fails">
<question>My graphical images do not work properly.</question>
<answer>
<p>See <link href="graphics.html">FOP Graphics Formats</link> for a list of supported formats and related issues.</p>
</answer>
</faq>
<faq id="graphic-resolution">
<question>Why is my graphic rendered at a different resolution than it was created?</question>
<answer>
<p>See <link href="graphics.html#resolution">Graphics Resolution</link>.</p>
</answer>
</faq>
<faq id="keep-with">
<question>Keep-with-next, keep-with-previous, keep-together
don't work.</question>
<answer>
<p>
These properties are not implemented, except on table rows. In
order to take advantage of them, you have to nest stuff to be
kept together in a table.
</p>
<p>
The concept is called “blind table”. The table is used for
pure layout reasons and not obvious in the output.
</p>
<p>
An example of an image and the image caption to be kept together:
</p>
<source><![CDATA[<fo:table table-layout="fixed" width="100%">
<fo:table-column column-width="proportional-column-width(1)"/>
<fo:table-body>
<fo:table-row keep-with-next="always">
<fo:table-cell>
<fo:block>
<fo:external-graphic src="foo.jpg"/>
</fo:block>
</fo:table-cell>
</fo:table-row>
<fo:table-row>
<fo:table-cell>
<fo:block>Image Caption</fo:block>
</fo:table-cell>
</fo:table-row>
</fo:table-body>
</fo:table>]]></source>
</answer>
</faq>
<faq id="table-missing">
<question>My tables are missing, or missing their content.</question>
<answer>
<p>
Check for fo:table-body around the rows. FOP up to 0.20.4 doesn't
raise an error if it is omitted, it just drops the content. More
recent releases will catch this problem.
</p>
<p>
Also, the fo:table-with-caption element is not implemented, tables
within such an element are dropped too. FOP generates an error
message for this problem. The DocBook style sheets generate
fo:table-with-caption elements, so watch out.
</p>
</answer>
</faq>
<faq id="cells-overflow">
<question>Text overflowing table cells and the like is not clipped. Long
text flows into adjacent cells/block, obscuring stuff there.</question>
<answer>
<p>
Clipping as specified by the <code>overflow="hidden"</code> is not yet
implemented. If you have long words overflowing table cells, try to
get them hyphenated. Artificial names like product identifications or
long numbers usually aren't hyphenated. You can try special processing
at XSLT level, like
</p>
<ul>
<li>
clip long text,
</li>
<li>
explicit wrapping+clipping,
</li>
<li>
insert zero width spaces (U+200B or &#x200B;) to allow FOP to
wrap.
</li>
</ul>
<p>
Check the <link href="http://dpawson.co.uk/xsl">XSL FAQ</link> and the
<link href="http://www.mulberrytech.com/xsl/xsl-list/">XSL list
archive</link> for how to perform these tasks.
</p>
</answer>
</faq>
<faq id="page-number-align">
<question>Page numbers are not properly right aligned.</question>
<answer>
<p>
This happens for fo:page-number-citation elements if the
citation occurs before FOP formatted the requested page,
usually in TOC or index pages. It is caused by the problem
that FOP has to guess how much space the yet unknown page
number will occupy, and usually the guesses are somewhat
off.
</p>
<p>
The most recent FOP releases should have this problem
fixed. Check whether you can upgrade.
</p>
</answer>
</faq>
<faq id="hyphenation-fails">
<question>Hyphenation does not work.</question>
<answer>
<p>
Set the language attribute somewhere and explicitly enable hyphenation.
Check whether you use a language for which hyphenation is supported.
Supported languages can be deduced from the files in the {fop-dir}/src/hyph
directory of the FOP source distribution. If you want to use a language
FOP currently doesn't hyphenate, please see the
<link href="configuration.html#hyphenation">Configuration page</link>.
</p>
<p>
Set the language (on fo:page-sequence, fo:block or fo:character):
</p>
<source><![CDATA[<fo:page-sequence language="fi">]]></source>
<p>
Enable hyphenation on a block:
</p>
<source><![CDATA[<fo:block hyphenate="true">]]></source>
</answer>
</faq>
</part>
<part id="part-embedding">
<title>Embedding FOP. Using FOP in a servlet.</title>
<faq id="servlet">
<question>How do I use FOP in a servlet?</question>
<answer>
<p>
See <link href="embedding.html#servlet">Using FOP in a Servlet</link>.
</p>
</answer>
</faq>
<faq id="servlet-with-xslt">
<question>How do I use FOP in a servlet with an XSLT
transformation?</question>
<answer>
<p>
See <link href="embedding.html#servlet-transform">Using FOP in a Servlet with XSLT Transformation</link>.
</p>
</answer>
</faq>
<faq id="servlet-xslt-params">
<question>How do I pass parameters to the XSLT transformation?</question>
<answer>
<p>
See <link href="embedding.html#servlet-transform">Using FOP in a Servlet with XSLT Transformation</link>.
</p>
</answer>
</faq>
<faq id="servlet-nonstd-fonts">
<question>How do I use my own fonts when running FOP from a
servlet?</question>
<answer>
<p>
Declare the fonts in the <code>userconfig.xml</code> file as usual.
See <link href="#usercfg">loading the user configuration file</link> for further details.
</p>
</answer>
</faq>
<faq id="servlet-baseDir">
<question>How do I set the baseDir property in a servlet environment?</question>
<answer>
<p>
See <link href="embedding.html#config-internal">Setting the Configuration Programmatically</link>.
</p>
</answer>
</faq>
<faq id="usercfg">
<question>How do I use a user configuration file from a servlet?</question>
<answer>
<p>
See <link href="embedding.html#config-external">Using a Configuration File in an Embedded App</link>.
</p>
</answer>
</faq>
<faq id="servlet-NoClassDefFound">
<question>I keep getting NoClassDefFound and other exceptions. How do I
get FOP working for various servlet engines?</question>
<answer>
<p>
See <link href="embedding.html#servlet-engine">Servlet Engines</link>.
</p>
</answer>
</faq>
<faq id="multithreaded">
<question>Can FOP be used in multithreaded environments?</question>
<answer>
<p>
See <link href="embedding.html#multithreading">Multithreading FOP</link>.
</p>
</answer>
</faq>
</part>
<part id="part-svg">
<title>SVG specific questions</title>
<faq id="svg-text">
<question>The rendering of SVG text in my PDF is of poor quality.
Can I control this?</question>
<answer>
<p>See <link href="graphics.html#svg-pdf-text">Placing SVG Text into PDF</link>.</p>
</answer>
</faq>
<faq id="svg-headless">
<question>How do I use FOP with SVG on headless servers?</question>
<answer>
<p>See <link href="graphics.html#batik">FOP: Graphics (Batik)</link>.</p>
</answer>
</faq>
<faq id="svghangs">
<question>FOP does not exit if a SVG is included.</question>
<answer>
<p>
Applies to older FOP versions and JDK 1.3 and older. That's because
there is an AWT thread hanging around. The solution is to put a
System.exit(0) somewhere.
</p>
</answer>
</faq>
<faq id="svg-url">
<question>I have problems with SVG referring to gradients etc. using
"uri(#stuff)". I get a MalformedURLException.</question>
<answer>
<p>
This is really a "resolving relative URI" problem with some
twists. The problem is that the <code>#stuff</code> URL fragment
identifier is resolved within the current SVG document. So the
reference must be valid within the XML subset and it cannot
reference other SVG documents in the same XML file. Some options
to try:
</p>
<ul>
<li>
Put the SVG into a separate file and use it with
fo:external-graphics.
</li>
<li>
Use a separate SVG file which contains only the gradient (and
perhaps other SVG stuff you want to reference) and point an absolute
URL to it:
<code>fill="url(file:///c:/refstuff/grad.svg#PurpleToWhite)"</code>.
</li>
<li>
Same as above but use a relative URL:
<code>fill="url(grad.svg#PurpleToWhite)"</code>. This may be easier
to deploy.
</li>
<li>
Make sure that the reference is valid in the current SVG document.
</li>
</ul>
<p>
In any case, the referenced stuff has to be pointed to by an URL. It
doesn't necessarily have to be a file URL, HTTP should also
work. Also, expect a performance hit in all cases, because another XML
file has to be retrieved and parsed.
</p>
<p>
Ultimately, both FOP and especially Batik should be fixed to make
your code work as expected, but this will not only take some time
but also some effort by a standard committee in order to make the
semantics of this kind of references in embedded SVG clearer.
</p>
<p>See also <link href="#MalformedURL">MalformedURLException</link></p>
</answer>
</faq>
<faq id="svg-scaling">
<question>Why is my SVG rendered at a size different from that specified in my fo:external-graphic element?</question>
<answer>
<p>See <link href="graphics.html#svg-scaling">SVG Scaling</link>.</p>
</answer>
</faq>
</part>
<part id="part-pdf">
<title>PDF specific (includes Acrobat peculiarities)</title>
<faq id="pdf-embed-font">
<question>How do I embed fonts in PDF?</question>
<answer>
<p>
See the <link href="fonts.html">Fonts</link> page for information
about embedding fonts.
</p>
</answer>
</faq>
<faq id="pdf-characters">
<question>Some characters are not displayed, or displayed incorrectly, or
displayed as “#”.</question>
<answer>
<p>
This usually means the selected font doesn't have a glyph
for the character.
</p>
<p>
The standard text fonts supplied with Acrobat Reader have
mostly glyphs for characters from the ISO Latin 1 character
set. For a variety of reasons, even those are not completely
guaranteed to work, for example you can't use the fi
ligature from the standard serif font. Check the <link
href="output.html#pdf-fonts">overview</link> for the default
PDF fonts.
</p>
<p>
If you use your own fonts, the font must have a glyph for
the desired character. Furthermore the font must be
available on the machine where the PDF is viewed or it must
have been embedded in the PDF file. See <link
href="fonts.html">embedding fonts</link>.
</p>
<p>
For most symbols, it is better to select the symbol font
explicitely, for example in order to get the symbol for the
mathematical empty set, write:
</p>
<source><![CDATA[<fo:inline font-family="Symbol">∅</fo:inline>]]></source>
<p>
The "#" shows up if the selected font does not define a glyph for the
required character, for example if you try:
</p>
<source><![CDATA[<fo:inline font-family="Helvetica">∅</fo:inline>]]></source>
</answer>
</faq>
<faq id="pdf-postprocess">
<question>What tools are available for post-processing my PDF document?</question>
<answer>
<p>See <link href="output.html#pdf-postprocess">PDF Post-processing</link>.</p>
</answer>
</faq>
<faq id="pdf-security">
<question>How do I add security features (encryption, disable printing)
to my PDF document?</question>
<answer>
<p>
See <link href="pdfencryption.html">PDF Encryption</link>.
See also <link href="output.html#pdf-postprocess">PDF Post-processing</link>.
</p>
</answer>
</faq>
<faq id="pdf-doc-properties">
<question>How do I add document properties (title, author, etc.) to my
PDF document?</question>
<answer>
<p>See <link href="output.html#pdf-postprocess">PDF Post-processing</link>.</p>
</answer>
</faq>
<faq id="pdf-watermark">
<question>How do I add watermarks to my PDF document?</question>
<answer>
<p>See <link href="output.html#pdf-watermark">PDF Watermarks</link>.</p>
</answer>
</faq>
<faq id="pdf-print-contortion">
<question>The PDF is printed contorted!</question>
<answer>
<p>
Check the paper size in Acrobat settings and the "fit to page" print
setting. Contorted printing is often caused by a mismatched paper
format, for example if the setting is "US Letter" but the PDF was
made for A4. Sometimes also the printer driver interferes, check its
settings too.
</p>
</answer>
</faq>
<faq id="pdf-bookmark-display">
<question>How do I control the Acrobat bookmark display?</question>
<answer>
<p>
FOP does not currently support this feature. Possible workarounds
include those mentioned in the <link href="#PDF-postprocess">PDF
Post-Processing FAQ</link>.
</p>
</answer>
</faq>
</part>
<part id="part-iex">
<title>IEx specific stuff</title>
<faq id="iex-servlet-multiple">
<question>The FOP servlet is called multiple times!</question>
<answer>
<p>
This is a problem of Internet Explorer requesting the content several
times. Please see the <link href="servlets.html#ie">notes on Internet Explorer</link>
for more information.
</p>
</answer>
</faq>
<faq id="iex-pdf-print-from-browser">
<question>How do I print PDF directly from the browser?</question>
<answer>
<p>
It depends whether you mean "printing to a printer under control of
the server" or "printing on the client's printer".
</p>
<p>
For the first problem, look at the print servlet in the FOP
examples. You'll have to gather any printer settings in a HTML form
and send it to the server.
</p>
<p>
For the second task, you can use some client side script to start
Acrobat Reader in print mode, or use a Java applet based on the FOP
print servlet. This depends heavily on the client installation and
should not relied on except in tightly controlled environments.
</p>
<p>
See also http://marc.theaimsgroup.com/?l=fop-dev&m=101065988325115&w=2
</p>
</answer>
</faq>
</part>
<part id="part-input">
<title>General questions regarding XSLT, XSLFO, and basic XML</title>
<faq id="fo-center">
<question>(FO) How do I vertically center an image or a table (or
whatever)?</question>
<answer>
<p>
See <link href="fo.html#fo-center-vertical">XSL-FO Vertical Centering</link>.
</p>
</answer>
</faq>
<faq id="fo-center-table-horizon">
<question>(FO) How do I center a table horizontally?</question>
<answer>
<p>
See <link href="fo.html#fo-center-table-horizon">XSL-FO Horizontal Centering (Tables)</link>.
</p>
</answer>
</faq>
<faq id="fo-page-outer">
<question>(FO) How to get page numbers printed on the "outer side" of the
page (for books, for example)?</question>
<answer>
<p>
See <link href="fo.html#fo-oddeven">Recto/Verso Static Content Differences</link>.
</p>
</answer>
</faq>
<faq id="oddeven">
<question>(FO) How do I use different static content for odd and even
pages?</question>
<answer>
<p>
See <link href="fo.html#fo-oddeven">Recto/Verso Static Content Differences</link>.
</p>
</answer>
</faq>
<faq id="fo-first-page-header">
<question>(FO) How do I get a special header on the first page?</question>
<answer>
<p>
See <link href="fo.html#fo-first-page">Making the First Page Special</link>.
</p>
</answer>
</faq>
<faq id="fo-omit-headers">
<question>(FO) How do I omit my headers on a blank page? How do I write
"This page is left blank" on an intentionally blank page?</question>
<answer>
<p>
See <link href="fo.html#fo-blank-pages">Blank Pages</link>.
</p>
</answer>
</faq>
<faq id="fo-special-symbols">
<question>(FO) How do I print an Euro sign, a checkbox or other some other
special symbols?</question>
<answer>
<p>
See <link href="fo.html#xml-special-chars">Special Characters</link>.
</p>
</answer>
</faq>
<faq id="fo-preformat">
<question>(FO) How do I keep linebreaks and hard spaces? How do I get
preformatted text displayed as expected?</question>
<answer>
<p>
See <link href="fo.html#fo-preformat">Preformatting Content</link>.
</p>
</answer>
</faq>
<faq id="fo-total-pages">
<question>(FO) How do I print the total number of pages, for example "page 1
of 12"</question>
<answer>
<p>
See <link href="fo.html#fo-total-pages">Total Document Pages</link>.
</p>
</answer>
</faq>
<faq id="fo-region-overlap">
<question>(FO) The header overlaps body content. The body extends into
the footer.</question>
<answer>
<p>
See <link href="fo.html#fo-region-align">Aligning Regions</link>.
</p>
</answer>
</faq>
<faq id="fo-lines">
<question>(FO) How do I get lines in the document, as separators, side
bars or folding marks?</question>
<answer>
<p>
See <link href="fo.html#fo-lines">Drawing Lines</link>.
</p>
</answer>
</faq>
<faq id="fo-validate">
<question>(FO) How do I validate my FO document?</question>
<answer>
<p>
See <link href="fo.html#fo-validate">Validating XSL-FO</link>.
</p>
</answer>
</faq>
<faq id="xml-non-breaking-space">
<question>(XML) How do I get a non-breaking space in FO? There are complaints about <code>&nbsp;</code>.</question>
<answer>
<p>
See <link href="fo.html#xml-special-chars">XML Special Characters</link>.
</p>
</answer>
</faq>
<faq id="xml-undefined-entities">
<question>(XML) How do I enter special characters in XML? There are complaints about undefined entities, such as <code>&uuml;</code>, which work in HTML. </question>
<answer>
<p>
See <link href="fo.html#xml-special-chars">XML Special Characters</link>.
</p>
</answer>
</faq>
<faq id="xml-illegal-entities">
<question>(XML) There are complaints about illegal characters and entities
in the input.</question>
<answer>
<p>
See <link href="fo.html#xml-entity-chars">Using HTML Character Names</link>.
</p>
</answer>
</faq>
<faq id="xml-illegal-chars">
<question>(XML) There are complaints about illegal bytes or characters in
the input. There are odd characters in the result.</question>
<answer>
<p>
See <link href="fo.html#xml-encoding">XML Encoding Issues</link>.
</p>
</answer>
</faq>
</part>
<part id="part-help">
<title>General suggestions. How to solve problems.</title>
<faq id="bugs">
<question>I think I have found a bug in FOP. What should I do?</question>
<answer>
<p>
See <link href="bugs.html">the Bugs page</link> for information about
bugs already reported and how to report new ones.
</p>
</answer>
</faq>
<faq id="postquestions">
<question>I have questions that are not addressed in this FAQ. Where
should I post them?</question>
<answer>
<ul>
<li>If your question is a development-related question, please see the <link href="dev/faq.html">Developer FAQs</link>.</li>
<li>
If you have a runtime exception or other runtime problem:
<ul>
<li>
double-check the <link href="#part-running">Runtime FAQs</link>.
</li>
<li>
ClassNotFoundException, NoSuchMethodException and
NoSuchFieldException problems are almost always a problem with
the local environment. Try to get local help first.
</li>
<li>
Check <link href="bugs.html#issues_existing">Reported Issues</link>
to see if this is a known problem.
</li>
<li>If none of the above apply, post a question to the fop-dev
mailing list.
</li>
</ul>
</li>
<li>
In the case where something works properly with another formatter,
(AntennaHouse, PassiveTex, etc.) but doesn't work with FOP, please
check the <link href="relnotes.html">Release Notes</link>, the
<link href="compliance.html">FOP Standards Compliance</link> document,
and the remaining FAQ in this document. If not found there, look at the
list of <link href="bugs.html#issues_existing">Bugs Already Reported</link>.
If not found there, please post a question on the fop-user mailing list
or <link href="bugs.html#issues_new">Open a New Bug</link>.
</li>
<li>
Question about how to use FOP, how to perform certain tasks with FOP
or how to integrate FOP into another application should be posted to
fop-user.
</li>
<li>
XSLT specific stuff sould go to the <link
href="http://www.mulberrytech.com/xsl/xsl-list/">XSL
list</link>. This includes problems with the language and XSLT
HOW-TOs.
</li>
<li>
Problems specific to a certain XSLT processor, like Xalan, Saxon or
MSXML, should be handled by processor specific lists. This includes
problems with deployment, processor specific extensions, suspected
bugs and processor specific APIs. Note that JDK 1.4 comes with an
XML parser and an XSLT processor which are older versions of
Xerces and Xalan, respectively, and both have a number of annoying
bugs. See $$$FIXME on how to use more recent versions or other
packages instead.
</li>
<li>
Problems with servlet containers should be asked on the vendor
specific lists for these software packages.
</li>
<li>
More general questions regarding Java, including deployment, Java
APIs, classpath issues and property definitions should be redirected
to some Java specific list.
</li>
</ul>
</answer>
</faq>
</part>
</faqs>
|