README 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319
  1. $Id: README 1395624 2012-10-08 15:43:53Z vhennebert $
  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. How do I run FOP?
  59. -----------------
  60. Simply by typing "fop" on the command-line. Without any parameters you
  61. will receive a screen with instruction on how to call FOP from the
  62. command-line.
  63. For more details, see:
  64. http://xmlgraphics.apache.org/fop/stable/running.html
  65. ==============================================================================
  66. RELEASE NOTES
  67. ==============================================================================
  68. Version 1.1
  69. ===========
  70. This release of Apache FOP primarily addresses bug fixes and also adds a number
  71. of new features. See below for details.
  72. Compliance
  73. ----------
  74. This release implements the XSL 1.0 and 1.1 recommendations to a relatively
  75. high degree of compliance. See the compliance page
  76. http://xmlgraphics.apache.org/fop/compliance.html for further details.
  77. Known issues
  78. ------------
  79. A detailed list of known issues in this release is available at
  80. http://xmlgraphics.apache.org/fop/1.1/knownissues_overview.html.
  81. Major Changes in Version 1.1
  82. ----------------------------
  83. * Adds support for complex scripts.
  84. * Adds support for TTF fonts in PostScript.
  85. * Adds support for PDF Object Streams.
  86. * Adds support for PDF 128-bit encryption.
  87. A more detailed list of changes in this release is available at
  88. http://xmlgraphics.apache.org/fop/1.1/changes_1.1.html.
  89. A more detailed list of changes in this and earlier releases is available at
  90. http://xmlgraphics.apache.org/fop/changes.html.
  91. Version 1.0
  92. ===========
  93. This is a production grade release of Apache FOP.
  94. It contains many bug fixes and new features. See below for details.
  95. Compliance
  96. ----------
  97. This release implements the XSL 1.0 and 1.1 recommendations to a high
  98. degree of compliance. See the compliance page
  99. http://xmlgraphics.apache.org/fop/compliance.html for a detailed
  100. overview.
  101. Known issues
  102. ------------
  103. The known issues of this release are listed at
  104. http://xmlgraphics.apache.org/fop/1.0/knownissues_overview.html.
  105. Major Changes in Version 1.0
  106. ----------------------------
  107. * Added support for addressing all glyphs available in a Type 1 font
  108. * Added support for auto-configuring TrueType Collections. XML font
  109. metrics files for *.ttc fonts are not required anymore.
  110. * Added support for rendering pages using Java Printing System.
  111. * Support character-by-character font-selection strategy on
  112. fo:character element.
  113. * Implemented word-by-ford font-selection strategy on text.
  114. * AFP Output: Various enhancements
  115. * FOP now creates ToUnicode CMaps for single-byte fonts that don't use
  116. built-in encodings
  117. * Introduced a new, additional intermediate format optimized for
  118. performance. See the intermediate format documentation for details.
  119. * Added an initial set of extensions for prepress support.
  120. * Added limited support for different page widths within a page-sequence.
  121. * Added support for TrueType fonts with symbol character maps (like
  122. "Wingdings" and "Symbol").
  123. * Added an event handling framework which allows to get better feedback
  124. from within FOP with the ability to customize problem management.
  125. The long list of changes in this release is available at
  126. http://xmlgraphics.apache.org/fop/1.0/changes_1.0.html.
  127. The long list of changes in this and earlier releases is available at
  128. http://xmlgraphics.apache.org/fop/changes.html.
  129. Version 0.95
  130. ============
  131. This is a production grade release of Apache FOP.
  132. It contains many bug fixes and new features. See below for details.
  133. Compliance
  134. ----------
  135. This release implements the XSL 1.0 and 1.1 recommendations to a high
  136. degree of compliance. See the compliance page
  137. http://xmlgraphics.apache.org/fop/compliance.html for a detailed
  138. overview.
  139. Known issues
  140. ------------
  141. The known issues of this release are listed at
  142. http://xmlgraphics.apache.org/fop/0.95/knownissues_overview.html.
  143. Major Changes in Version 0.95
  144. -----------------------------
  145. * Add new fox:external-document extension element that allows to insert whole
  146. documents into a page-sequence (JM)
  147. * Add support for background on fo:table-column and fo:table-header/footer/body
  148. elements (VH)
  149. * Add support for conditional borders in tables (VH)
  150. * Add support for scale-down-to-fit and scale-up-to-fit (JM)
  151. * Fix various bugs and performance problems with external graphics by
  152. introducing a new image loading framework (JM)
  153. The long list of changes in this release is available at
  154. http://xmlgraphics.apache.org/fop/0.95/changes_0.95.html.
  155. The long list of changes in this and earlier releases is available at
  156. http://xmlgraphics.apache.org/fop/changes.html.
  157. Changes since Version 0.95beta
  158. ------------------------------
  159. Please refer to the list of changes on the web:
  160. http://xmlgraphics.apache.org/fop/changes.html
  161. Version 0.94
  162. ============
  163. This is the second production grade release of the new FOP codebase.
  164. It contains many bug fixes and new features. See below for details.
  165. Compliance
  166. ----------
  167. This release implements the XSL 1.0 and 1.1 recommendations to a high
  168. degree of compliance. See the compliance page
  169. http://xmlgraphics.apache.org/fop/compliance.html for a detailed
  170. overview.
  171. Known issues
  172. ------------
  173. The known issues of this release are listed at
  174. http://xmlgraphics.apache.org/fop/0.94/knownissues_overview.html.
  175. Major Changes in Version 0.94
  176. -----------------------------
  177. * Add support for font auto-detection (JM) Thanks to Adrian Cumiskey
  178. * Add support for the border-collapsing model in tables (VH, JM)
  179. * Add support for named destinations in PDF (JB)
  180. * Add support for UAX#14 type line breaking (MM)
  181. The long list of changes in this release is available at
  182. http://xmlgraphics.apache.org/fop/0.94/changes_0.94.html.
  183. The long list of changes in this and earlier releases is available at
  184. http://xmlgraphics.apache.org/fop/changes.html.
  185. Version 0.93
  186. ============
  187. This is the first production grade release of the new FOP codebase.
  188. * It contains the new API first introduced in release 0.92
  189. beta. The preceding API has been removed.
  190. * This release again contains many bug fixes and new features. See
  191. below for details.
  192. Compliance
  193. ----------
  194. This release implements the XSL 1.0 and 1.1 recommendations to a high
  195. degree of compliance. See the compliance page
  196. http://xmlgraphics.apache.org/fop/compliance.html for a detailed
  197. overview.
  198. Known issues
  199. ------------
  200. The known issues of this release are listed at
  201. http://xmlgraphics.apache.org/fop/knownissues.html.
  202. Upgrading
  203. ---------
  204. You may experience different behaviour compared to version
  205. 0.20.5. Please consult the "Upgrading" page
  206. (http://xmlgraphics.apache.org/fop/stable/upgrading.html) for
  207. details.
  208. Major Changes in Version 0.93
  209. -----------------------------
  210. * Added support for the use of Open Type fonts (BD)
  211. * Support for the rgb-icc() function and for a proprietary cmyk()
  212. function (for device CMYK colors only through the PDF renderer so
  213. far). (JM) Thanks to Peter Coppens. Fixes 40729.
  214. * Enabled Copy/Paste from PDF content in Acrobat Reader for
  215. text using embedded TrueType fonts. (BD) Thanks to Adam Strzelecki,
  216. Victor Mote. Fixes 5535.
  217. * Added support for PDF/A-1b and PDF/X-3:2003. (Note: this may still
  218. be a bit incomplete. Feedback is welcome!)
  219. * The Java2DRenderer (and therefore the print and bitmap renderers) is
  220. now offering the same quality as the PDF and PS renderers. Note:
  221. There can still be little differences between PDF and Print/PNG/TIFF
  222. because the latter uses a different font metrics source.
  223. * Automatic support for all fonts available to the Java2D subsystem
  224. for all Java2D-descendant renderers (TIFF, PNG, print, AWT).
  225. The long list of changes in this release is available at
  226. http://xmlgraphics.apache.org/fop/0.93/changes_0.93.html.
  227. The long list of changes in this and earlier releases is available at
  228. http://xmlgraphics.apache.org/fop/changes.html.
  229. The Apache FOP team asks you for your continued feedback on the
  230. software. We're also interested in success stories with the new
  231. release. So if the latest version works fine for you, please tell us!
  232. And if it doesn't, you may tell us as well, of course. ;-)
  233. Release notes for older FOP versions can be found on:
  234. http://xmlgraphics.apache.org/fop/relnotes.html