README
1$Id: README 1885382 2021-01-12 10:14:28Z ssteiner $
2
3==============================================================================
4 APACHE FOP - README
5==============================================================================
6
7Contents of this file:
8 - What is FOP?
9 - Legal Information
10 - Where to get help?
11 - How do I build FOP?
12 - How do I run FOP?
13 - Release Notes
14
15==============================================================================
16
17
18What is FOP?
19------------
20
21Apache FOP is a print formatter driven by XSL formatting objects. It is a Java
22application that reads a formatting object tree conforming to the XSL 1.1
23Recommendation (05 December 2006) and then turns it into a PDF document,
24certain other output formats or allows you to preview it directly on screen.
25Note that not all parts of the XSL 1.1 specification have yet been
26implemented.
27
28Apache FOP is part of Apache's XML Graphics project. The homepage of Apache
29FOP is http://xmlgraphics.apache.org/fop/.
30
31
32Legal Information
33-----------------
34
35Apache FOP is published under the Apache License version 2.0. For the license
36text, please see the following files:
37- LICENSE
38- NOTICE
39
40Legal information on libraries used by Apache FOP can be found in the
41"lib/README.txt" file.
42
43Here is a list of files included in Apache FOP but not published under Apache
44License version 2.0:
45- K3 3 of 9 barcode font (TrueType)
46 File: examples/fo/advanced/K3.TTF
47 Info: examples/fo/advanced/K3.README
48- DejaVu LGC Serif font (TrueType)
49 File: test/resources/fonts/DejaVuLGCSerif.ttf
50 Info: test/resources/fonts/DejaVuLGCSerif.LICENSE
51
52
53Where to get help?
54------------------
55
56http://xmlgraphics.apache.org/fop/gethelp.html
57
58A mailing list where you can get all your questions about FOP answered is at
59fop-users@xmlgraphics.apache.org. You can subscribe by sending an empty mail
60to fop-users-subscribe@xmlgraphics.apache.org.
61
62Before you post any questions, please have a look at the FAQ at
63http://xmlgraphics.apache.org/fop/faq.html and FO help page at
64http://xmlgraphics.apache.org/fop/fo.html.
65
66Please report bugs to bugzilla at http://issues.apache.org/bugzilla/
67
68
69How do I build FOP?
70-------------------
71
72If you've downloaded a binary distribution, you don't need to build
73FOP.
74
75Otherwise, please follow the instructions found here:
76http://xmlgraphics.apache.org/fop/stable/compiling.html
77
78[TEMPORARY]
79
80Until the above referenced instructions are updated, one of the following
81may be used to build FOP:
82
83Building with Maven (preferred)
84
85% mvn clean install
86
87Building with Ant (deprecated)
88
89% ant -f fop/build.xml clean all
90
91How do I run FOP?
92-----------------
93
94Simply by typing "fop" on the command-line. Without any parameters you
95will receive a screen with instruction on how to call FOP from the
96command-line.
97
98For more details, see:
99http://xmlgraphics.apache.org/fop/stable/running.html
100
101[TEMPORARY]
102
103Note that FOP command line scripts and build results from ant will be found
104under the ./fop sub-directory.
105
106==============================================================================
107 RELEASE NOTES
108==============================================================================
109
110Version 2.6
111===========
112
113Major Changes in Version 2.6
114----------------------------
115
116* Support OTF/TTF SVG fonts
117* Allow overpaint of PDF border
118
119This release also contains a number of bug fixes.
120
121Version 2.5
122===========
123
124Major Changes in Version 2.5
125----------------------------
126
127* Allow to hide empty blocks from structure tree
128
129This release also contains a number of bug fixes.
130
131Version 2.4
132===========
133
134Major Changes in Version 2.4
135----------------------------
136
137* Require Java 7 or later
138* Drop dependency on Avalon-Framework
139* Add change bar generation
140* Add support for Khmer complex script
141
142This release also contains a number of bug fixes.
143
144Version 2.3
145===========
146
147Major Changes in Version 2.3
148----------------------------
149
150* Support for unicode Surrogate pairs
151* OTF fonts not working on Mac Preview
152
153This release also contains a number of bug fixes.
154
155Version 2.2
156===========
157
158Major Changes in Version 2.2
159----------------------------
160
161* PCL Color support
162* Allow generation of bold/italic versions of fonts for PDF
163* Allow to convert OTF fonts to Type 1 for Postscript
164* Deduplicate PDF content streams
165* Update to PDFBox 2
166* Transition from Ant to Maven Build Process
167
168This release also contains a number of bug fixes.
169
170Version 2.1
171===========
172
173Major Changes in Version 2.1
174----------------------------
175
176* Add PreloaderRawPNG to handle images ImageIO cant
177* Support Barcode4J page number
178* Support CMYK JPEG in AFP
179* Support IPD change on last page
180* Support PDF/UA
181* Support TrueType fonts in PCL
182* Support Truetype for AFP
183* Support for PDF/A-3
184
185This release also contains a number of bug fixes.
186
187Version 2.0
188===========
189
190Java 6 or later is the minimum runtime environment needed.
191
192Because of changes to the API, the version number has been bumped to 2.0.
193
194Major Changes in Version 2.0
195----------------------------
196
197* Side float support
198* Whitespace Management Extension
199* fo:inline-container partial support
200* Improved support for complex scripts
201* PDF Linearization
202* Support OpenType CFF fonts
203* Subset support for Type 1 fonts
204* Support for AES 256 PDF encryption
205* SVG graphics can use FOP custom fonts
206
207This release also contains a number of bug fixes.
208
209Version 1.1
210===========
211
212This release of Apache FOP primarily addresses bug fixes and also adds a number
213of new features. See below for details.
214
215Compliance
216----------
217
218This release implements the XSL 1.0 and 1.1 recommendations to a relatively
219high degree of compliance. See the compliance page
220http://xmlgraphics.apache.org/fop/compliance.html for further details.
221
222Known issues
223------------
224
225A detailed list of known issues in this release is available at
226http://xmlgraphics.apache.org/fop/1.1/knownissues_overview.html.
227
228Major Changes in Version 1.1
229----------------------------
230
231* Adds support for complex scripts.
232* Adds support for TTF fonts in PostScript.
233* Adds support for PDF Object Streams.
234* Adds support for PDF 128-bit encryption.
235
236A more detailed list of changes in this release is available at
237http://xmlgraphics.apache.org/fop/1.1/changes_1.1.html.
238
239A more detailed list of changes in this and earlier releases is available at
240http://xmlgraphics.apache.org/fop/changes.html.
241
242Version 1.0
243===========
244
245This is a production grade release of Apache FOP.
246It contains many bug fixes and new features. See below for details.
247
248Compliance
249----------
250
251This release implements the XSL 1.0 and 1.1 recommendations to a high
252degree of compliance. See the compliance page
253http://xmlgraphics.apache.org/fop/compliance.html for a detailed
254overview.
255
256Known issues
257------------
258
259The known issues of this release are listed at
260http://xmlgraphics.apache.org/fop/1.0/knownissues_overview.html.
261
262Major Changes in Version 1.0
263----------------------------
264
265* Added support for addressing all glyphs available in a Type 1 font
266* Added support for auto-configuring TrueType Collections. XML font
267 metrics files for *.ttc fonts are not required anymore.
268* Added support for rendering pages using Java Printing System.
269* Support character-by-character font-selection strategy on
270 fo:character element.
271* Implemented word-by-ford font-selection strategy on text.
272* AFP Output: Various enhancements
273* FOP now creates ToUnicode CMaps for single-byte fonts that don't use
274 built-in encodings
275* Introduced a new, additional intermediate format optimized for
276 performance. See the intermediate format documentation for details.
277* Added an initial set of extensions for prepress support.
278* Added limited support for different page widths within a page-sequence.
279* Added support for TrueType fonts with symbol character maps (like
280 "Wingdings" and "Symbol").
281* Added an event handling framework which allows to get better feedback
282 from within FOP with the ability to customize problem management.
283
284The long list of changes in this release is available at
285http://xmlgraphics.apache.org/fop/1.0/changes_1.0.html.
286
287The long list of changes in this and earlier releases is available at
288http://xmlgraphics.apache.org/fop/changes.html.
289
290Version 0.95
291============
292
293This is a production grade release of Apache FOP.
294It contains many bug fixes and new features. See below for details.
295
296Compliance
297----------
298
299This release implements the XSL 1.0 and 1.1 recommendations to a high
300degree of compliance. See the compliance page
301http://xmlgraphics.apache.org/fop/compliance.html for a detailed
302overview.
303
304Known issues
305------------
306
307The known issues of this release are listed at
308http://xmlgraphics.apache.org/fop/0.95/knownissues_overview.html.
309
310Major Changes in Version 0.95
311-----------------------------
312
313* Add new fox:external-document extension element that allows to insert whole
314 documents into a page-sequence (JM)
315* Add support for background on fo:table-column and fo:table-header/footer/body
316 elements (VH)
317* Add support for conditional borders in tables (VH)
318* Add support for scale-down-to-fit and scale-up-to-fit (JM)
319* Fix various bugs and performance problems with external graphics by
320 introducing a new image loading framework (JM)
321
322The long list of changes in this release is available at
323http://xmlgraphics.apache.org/fop/0.95/changes_0.95.html.
324
325The long list of changes in this and earlier releases is available at
326http://xmlgraphics.apache.org/fop/changes.html.
327
328Changes since Version 0.95beta
329------------------------------
330Please refer to the list of changes on the web:
331http://xmlgraphics.apache.org/fop/changes.html
332
333
334Version 0.94
335============
336
337This is the second production grade release of the new FOP codebase.
338It contains many bug fixes and new features. See below for details.
339
340Compliance
341----------
342
343This release implements the XSL 1.0 and 1.1 recommendations to a high
344degree of compliance. See the compliance page
345http://xmlgraphics.apache.org/fop/compliance.html for a detailed
346overview.
347
348Known issues
349------------
350
351The known issues of this release are listed at
352http://xmlgraphics.apache.org/fop/0.94/knownissues_overview.html.
353
354Major Changes in Version 0.94
355-----------------------------
356
357* Add support for font auto-detection (JM) Thanks to Adrian Cumiskey
358* Add support for the border-collapsing model in tables (VH, JM)
359* Add support for named destinations in PDF (JB)
360* Add support for UAX#14 type line breaking (MM)
361
362The long list of changes in this release is available at
363http://xmlgraphics.apache.org/fop/0.94/changes_0.94.html.
364
365The long list of changes in this and earlier releases is available at
366http://xmlgraphics.apache.org/fop/changes.html.
367
368
369Version 0.93
370============
371
372This is the first production grade release of the new FOP codebase.
373
374* It contains the new API first introduced in release 0.92
375 beta. The preceding API has been removed.
376* This release again contains many bug fixes and new features. See
377 below for details.
378
379Compliance
380----------
381
382This release implements the XSL 1.0 and 1.1 recommendations to a high
383degree of compliance. See the compliance page
384http://xmlgraphics.apache.org/fop/compliance.html for a detailed
385overview.
386
387Known issues
388------------
389
390The known issues of this release are listed at
391http://xmlgraphics.apache.org/fop/knownissues.html.
392
393Upgrading
394---------
395
396You may experience different behaviour compared to version
3970.20.5. Please consult the "Upgrading" page
398(http://xmlgraphics.apache.org/fop/stable/upgrading.html) for
399details.
400
401Major Changes in Version 0.93
402-----------------------------
403
404* Added support for the use of Open Type fonts (BD)
405* Support for the rgb-icc() function and for a proprietary cmyk()
406 function (for device CMYK colors only through the PDF renderer so
407 far). (JM) Thanks to Peter Coppens. Fixes 40729.
408* Enabled Copy/Paste from PDF content in Acrobat Reader for
409 text using embedded TrueType fonts. (BD) Thanks to Adam Strzelecki,
410 Victor Mote. Fixes 5535.
411* Added support for PDF/A-1b and PDF/X-3:2003. (Note: this may still
412 be a bit incomplete. Feedback is welcome!)
413* The Java2DRenderer (and therefore the print and bitmap renderers) is
414 now offering the same quality as the PDF and PS renderers. Note:
415 There can still be little differences between PDF and Print/PNG/TIFF
416 because the latter uses a different font metrics source.
417* Automatic support for all fonts available to the Java2D subsystem
418 for all Java2D-descendant renderers (TIFF, PNG, print, AWT).
419
420The long list of changes in this release is available at
421http://xmlgraphics.apache.org/fop/0.93/changes_0.93.html.
422
423The long list of changes in this and earlier releases is available at
424http://xmlgraphics.apache.org/fop/changes.html.
425
426The Apache FOP team asks you for your continued feedback on the
427software. We're also interested in success stories with the new
428release. So if the latest version works fine for you, please tell us!
429And if it doesn't, you may tell us as well, of course. ;-)
430
431Release notes for older FOP versions can be found on:
432http://xmlgraphics.apache.org/fop/relnotes.html
433