Loading...
Helix SwarmHelix Swarm
Loading...

README

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

- remove non-namespaced DocBook... source and add
  namespaced DocBook source.

- add Apache FOP 1.1

- copy fonts, images, XSL into _build, establishing new
  asset structure. The original structure remains until
  all guides using it can be upgraded, and several other
  issues can be resolved.

- updated build.xml to allow for per-target build properties.

- upgraded the P4SAG to use the new infrastructure.

- tweaked admonition presentation in PDFs to remove
  admonition graphics, and resemble closely the
  presentation used in the new HTML layout, including
  the same colors.

With these changes, building PDFs involves using a
shell, navigating into the guide's directory (just P4SAG
for now), and executing "ant pdf".

Issues still to be resolved:

- PDF generation encounters several warnings about
  missing fonts (bold versions of Symbol and ZapfDingbats),
  and a couple of locations where the page content
  exceeds the defined content area.

- Due to issues within Apache FOP, PDF generation emits
  a substantial amount of output that is not easily suppressed
  without losing important warning information.

- Apache FOP's interface to ANT does not expose a way
  to set the font base directory. The current configuration does
  work under Mac OSX, but further testing on Windows will
  need to be done to determine if the relative paths defined
  continue to work. The workaround is for Windows users to
  customize the fop-config.xml to provide absolute system
  paths to the required fonts.

- HTML generation needs further browser testing, and
  exhibits broken navigation on iOS browsers within the
  TOC sidebar.

- A number of PDF and HTML presentation tweaks still
  need to be made, for example: sidebars, gui* DocBook
  tags, whitespace, section separation, etc. «		 11 years ago