README 12 KB

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