1999-2001 The Apache Software Foundation Fop What is FOP? FOP is the world's first print formatter driven by XSL formatting objects. It is a Java application that reads a formatting object tree and then turns it into a PDF document. The formatting object tree, can be in the form of an XML document (output by an XSLT engine like XT or Xalan) or can be passed in memory as a DOM Document or (in the case of XT) SAX events. The latest version of Fop is 0.18 and it supports the xsl:fo candidate release. You can download Fop including a precompiled version, the source code and many example files to get you started. Pointers to introductions into xsl:fo can be found in the section specifications. Please be aware, that Fop is at the moment not a full implementation of the basic conformance level of the xsl:fo standard. You can find a list of supported flow objects and properties in the section Features and in section Limitations in what way this support is limited. FOP is part of Apache's XML project. The homepage of FOP is http://xml.apache.org/fop. A list of known bugs, the committers to this project and the tasks they are working on can be found in the file Status in the root of your Fop distribution. A history of the latest changes to the project can be found in CHANGES. FOP Objectives The goals of the Apache XML FOP Project are to deliver an XSL FO->PDF formatter that is compliant to at least the Basic conformance level described in the W3C Candidate Recommendation 21 November 2000, and that complies with the 11 March 1999 Portable Document Format Specification (Version 1.3) from Adobe Systems. Conformance to the XML 1.0 Recommendation, XSLT 1.0 Recommendation and the XML Namespaces Recommendation is understood. Other relevant documents, such as the XPath and XLink Working Drafts, are referenced as necessary. The FOP Project will attempt to use the latest version of evolving specifications. Secondary goals of the FOP Project (also, "FOP") are desirable requirements that also have a high priority. One secondary goal of the FOP Project is to deliver a follow-on version of the formatter that is compliant to the Extended conformance level described in the XSL FO. Any formatting objects that cannot be translated into PDF will be explicitly identified as such. Another secondary goal is to improve the conversion of SVG into PDF. This includes the use of FOP to work as a transcoder for Batik to convert an SVG document into a PDF document and the fully support embedding SVG inside fo documents in an fo:instream-foreign-object. A final secondary goal is the continued refinement of the FOP design and implementation. In particular, maintaining the separation between formatting and rendering, continuing to support the AWT Viewer renderer (backend), and providing new renderers, are all desirable objectives. TODO List for FOP FOP TODO Core Features - these are the areas that are important to getting fop to be useable for general use. Processing improvements - these are mainly things that can be improved in the way fop works, eg. resources usage, pdf output etc. Enhancements - these are added functionality that might be useful, no comment is made about the suitability of these suggestions. Core Features Layout This is the crucial part to getting FOP to make it to the next step. Webstart Demo a demo using Java Webstart that runs the awt viewer and supports linking from an index Website Need to improve the website to better demonstrate what fop is and can do. Examples, screenshots, pdf documents. Property Support Currently all properties are in the xml file. We need to handle all default values properly (including ones that change depending on the element) and all possible values. Property Resolution This is support for the functions in property values that evaluate some expression. Better support for resolution including support for "inherit" and values with lists. Validity Checking Check the validity of children for a particular element to ensure there are no invalid children. Should help process the layout better. Processing Improvements Logging Support for proper logging with logKit. Image Handling Needs to be a bit more solid and allow for direct insertion of images (jpeg) into the pdf. Configuration Support for avalon. Better multithread handling. More PDF Outputs Support for streaming and linearized pdf to help with different deployement of pdf documents. i18n in awt viewer Use proper i18n handling for awt viewer. better abstraction of rendering classes put all common rendering processes into an abstract class that has no dependancies on any specific renderers. Enhancements linking support in svg support the a link rendering for the svg output. input from url be able to specify a url as the input fo (or xml, xsl) documents. improve text handling in svg support (better) the direct rendering of text into pdf graphics and other similair outputs svg renderer (output to svg doc for slide presentation) Create an SVGRenderer that will render all pages onto a single svg document suitable for slide show presentations (with batik) suggested by Vincent Hardy. stream encoding support for different encoding on different types of streams in pdf document. svg features currently patterns and gradients are not generated properly Downloading FOP You can download the latest release version from the distribution directory. The file contains also the documentation (including some example fo files) and the source. If you want to work with the latest and nicest code, you can use the cvs version. See the section on AnonCVS in the xml.apache.org documentation for details. Sometimes people have difficulties to access the cvs server; in this case you can download a snapshot from the cvs files here. In both cases you have to build Fop yourself - see Compiling Fop for details. To run FOP from the command line, see Running FOP. If you are interested in embedding FOP in a Java application of your own, see Embedding FOP. Running FOP Prerequisites Following software must be installed: a) Java 1.1.x or later (If you want to use the previewer (option -awt), you need Swing or Java 2) b) All libraries you need are part of the Fop distribution and can be found in the xml-fop/lib directory. Look at the batch/shell script fop.bat/fop.sh to see, how Fop can be invoked easily. These libraries are included: lAn XML parser which supports SAX and DOM like Xerces-J. (Xerces is the default xml parser) lAn XSLT processor lThe SVG library batik.jar is the library from the batik project at xml.apache.org. lThe imaging library Jimi from Sun Starting FOP as an standalone application Fop [options] [-fo|-xml] infile [-xsl file] [-awt|-pdf|-mif|-pcl|-txt|-print] <outfile> [OPTIONS] -d debug mode -x dump configuration settings -q quiet mode -c cfg.xml use additional configuration file cfg.xml -l lang the language to use for user information [INPUT] infile xsl:fo input file (the same as the next) -fo infile xsl:fo input file -xml infile xml input file, must be used together with -xsl -xsl stylesheet xslt stylesheet [OUTPUT] outfile input will be rendered as pdf file into outfile -pdf outfile input will be rendered as pdf file (outfile req'd) -awt input will be displayed on screen -mif outfile input will be rendered as mif file (outfile req'd) -pcl outfile input will be rendered as pcl file (outfile req'd) -txt outfile input will be rendered as text file (outfile req'd) -print input file will be rendered and sent to the printer see options with "-print help" [Examples] Fop foo.fo foo.pdf Fop -fo foo.fo -pdf foo.pdf (does the same as the previous line) Fop -xsl foo.xsl -xml foo.xml -pdf foo.pdf Fop foo.fo -mif foo.mif Fop foo.fo -print or Fop -print foo.fo Fop foo.fo -awt Problems If you have problems running FOP, please have a look at the FOP FAQ. If you don't find a solution there, you can ask for help on the list fop-dev@xml.apache.org. Maybe it is a bug and maybe somebody is already working on it. Features What's Implemented? The following formatting objects and properties of the xsl-fo candidate recommendation are implemented.Please have also a look at the section on limitations 1) Formatting Objects This section follows the table "B Formatting Object Summary" in the xsl:fo specification. At the end of each sub-section you find listed what is not implemented. B.1 Declaration and Pagination and Layout Formatting Objects lroot lpage-sequence lpage-sequence-master lsingle-page-master-reference lrepeatable-page-master-reference lrepeatable-page-master-alternatives lconditional-page-master-reference llayout-master-set lsimple-page-master lregion-body lregion-before lregion-after lregion-start lregion-end lflow lstatic-content Not implemented: declarations, color-profile, title B.2 Block Formatting Objects lblock Not implemented: block-container B.3 Inline Formatting Objects lcharacter lexternal-graphic linline linstream-foreign-object lleader lpage-number lpage-number-citation, see limitations Not implemented: bidi-override, initial-property-set, inline-container B.4 Table Formatting Objects ltable ltable-body ltable-cell ltable-column ltable-footer ltable-header ltable-row Not implemented: table-and-caption, table-caption B.5 List Formatting Objects llist-block llist-item llist-item-body llist-item-label B.6 Link and Multi Formatting Objects lbasic-link (internal and external) Not implemented: multi-switch, multi-case, multi-toggle, multi-properties, multi-property-set B.7 Out-of-line Formatting Objects lfootnote lfootnote-body Not implemented: float B.8 Other Formatting Objects lwrapper Not implemented: marker, retrieve-marker border and padding shorthand properties 2) Properties Property values can be computed. Compound properties are also understood by Fop. lbackground-color lblank-or-not-blank lborder-after-color lborder-after-style lborder-after-width lborder-before-color lborder-before-style lborder-before-width lborder-bottom lborder-bottom-color lborder-bottom-style lborder-bottom-width lborder-color (only one value allowed) lborder-end-color lborder-end-style lborder-end-width lborder-left lborder-left-color lborder-left-style lborder-left-width lborder-right lborder-right-color lborder-right-style lborder-right-width lborder-start-color lborder-start-style lborder-start-width lborder-style lborder-top lborder-top-color lborder-top-style lborder-top-width lborder-width lbottom lbreak-after lbreak-before lcharacter lcolor lcolumn-count lcolumn-gap lcolumn-width lcountry lend-indent lextent lexternal-destination lflow-name lfont-family lfont-size lfont-style lfont-weight lheight lhyphenate lhyphenation-character lhyphenation-push-character-count lhyphenation-remain-character-count lid linitial-page-number linternal-destination lkeep-with-next (broken) llanguage lleader-alignment (not value "page") lleader-length (see limitations) lleader-pattern (not value "use-content") lleader-pattern-width lleft lline-height lmargin-bottom (only on pages and regions) lmargin-left (only on pages and regions) lmargin-right (only on pages and regions) lmargin-top (only on pages and regions) lmaster-name lmaximum-repeats lnumber-columns-spanned lodd-or-even lpadding (only one value allowed) lpadding-after lpadding-before lpadding-bottom lpadding-end lpadding-left lpadding-right lpadding-start lpadding-top lpage-height lpage-position lpage-width lposition (allowed values: "static" (default),"relative", "absolute", fixed ) lprovisional-distance-between-starts lprovisional-label-separation lref-id lregion-name lright lrule-style lrule-thickness lspace-after.optimum lspace-before.optimum lspan lsrc lstart-indent ltable-omit-footer-at-break ltable-omit-header-at-break ltext-align ltext-align-last ltext-decoration ltext-indent ltop lwhite-space-collapse lwidth lwrap-option All other properties are not implemented. 3)SVG Support FOP uses Batik directly for its SVG support. Therefore FOP supports the same elements and properties as are supported by Batik. As FOP is designed for rendering to a static medium then only static SVG is rendered. Due to some limitations in PDF some SVG images, particularly ones with effects or transparency, may not come out correctly. The images should still be rendered correctly for the AWT and Print renderers. Limitations FOP implements the fo objects and properties listed in features, sometimes it does so only in a limited way. fo:leader leader-length.minimum is not used at all page-number-citation