diff --git a/docs/xml-docs/fop.xml b/docs/xml-docs/fop.xml index ac3c17d11..eec25e93c 100644 --- a/docs/xml-docs/fop.xml +++ b/docs/xml-docs/fop.xml @@ -1,32 +1,32 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/xml-docs/fop/download.xml b/docs/xml-docs/fop/download.xml index 454c58532..8ef87431a 100644 --- a/docs/xml-docs/fop/download.xml +++ b/docs/xml-docs/fop/download.xml @@ -21,8 +21,12 @@ 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 + +

Important: Currently, releases of FOP are coming out of the "fop-0_20_2-maintain" branch. The "MAIN" branch is + used for the redesign. See NEW DESIGN for more information.

+ +

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.

diff --git a/docs/xml-docs/fop/embedding.xml b/docs/xml-docs/fop/embedding.xml index 5e3a41a78..919fa98e8 100644 --- a/docs/xml-docs/fop/embedding.xml +++ b/docs/xml-docs/fop/embedding.xml @@ -37,23 +37,6 @@ driver.setRenderer(RENDER_PDF); driver.run();]]> -

You also need to set the Logger for logging messages, see - Jakarta Logkit - for more information. -

- -

To setup the user config file you can do the following

System.exit. These issues should be fixed in the upcoming JDK1.4

+ + +

FOP uses Jakarta Avalon's + Logger + interface to do logging. See the Jakarta Avalon project for more information.

+

Per default FOP uses the ConsoleLogger which logs to System.out. If you want to do logging using a + logging framework (such as LogKit, Log4J or JDK 1.4 Logging) you can set a + different Logger implementation on the Driver object. Here's an example how you would use LogKit:

+ +

The LogKitLogger class implements the Logger interface so all logging calls are being redirected to LogKit. + More information on Jakarta LogKit can be found here.

+

Similar implementations exist for Log4J (org.apache.avalon.framework.logger.Log4JLogger) and + JDK 1.4 logging (org.apache.avalon.framework.logger.Jdk14Logger).

+

If you want FOP to be totally silent you can also set an org.apache.avalon.framework.logger.NullLogger instance.

+

If you want to use yet another logging facility you simply have to create a class that implements org.apache.avalon.framework.logging.Logger + and set it on the Driver object. See the existing implementations in Avalon Framework for examples.

+ +

If FOP is going to be used multiple times within your application it may be useful to reuse certain objects to save time. @@ -117,6 +130,14 @@ after the rendering is complete and the reset method is called. You will need to setup the driver again with a new OutputStream, IntputStream and renderer.

+ + + To get the number of pages that were rendered by FOP you can call Driver.getResults(). This returns a + FormattingResults object where you can lookup the number of pages produced. It also gives you the + page-sequences that were produced along with their id attribute and their number of pages. This is particularly useful if you + render multiple documents (each enclosed by a page-sequence) and have to know the number of pages + of each document. +

diff --git a/docs/xml-docs/fop/implemented.xml b/docs/xml-docs/fop/implemented.xml index 65d2e616c..c5985fc1b 100644 --- a/docs/xml-docs/fop/implemented.xml +++ b/docs/xml-docs/fop/implemented.xml @@ -6,8 +6,8 @@

The following formatting objects and properties of the XSL-FO 1.0 - W3C Recommandation are implemented.Please have also a look at the - section on limitations + W3C Recommandation are implemented. Please have also a look at the + section on limitations.

@@ -17,28 +17,28 @@
  • root
    • -
  • page-sequence
    • +
  • page-sequence
  • page-sequence-master
  • single-page-master-reference
  • repeatable-page-master-reference
  • repeatable-page-master-alternatives
  • conditional-page-master-reference
    • -
  • layout-master-set
    • -
  • simple-page-master
    • -
  • region-body
    • -
  • region-before
    • -
  • region-after
    • +
  • layout-master-set
    • +
  • simple-page-master
    • +
  • region-body
    • +
  • region-before
    • +
  • region-after
  • region-start
  • region-end
  • flow
    • -
  • static-content
    • +
  • static-content

Not implemented: declarations, color-profile, title
    -
  • block
    • +
  • block
  • block-container (limited)
 @@ -58,7 +58,7 @@
    -
  • table
    • +
  • table
  • table-body
  • table-cell
  • table-column
    • diff --git a/docs/xml-docs/fop/output.xml b/docs/xml-docs/fop/output.xml index 49aaa32f9..3b7a4c45c 100644 --- a/docs/xml-docs/fop/output.xml +++ b/docs/xml-docs/fop/output.xml @@ -115,13 +115,24 @@ print the output generated by the PCLRenderer. - +

    -The postscript format can be used to send to a printer or any other -purpose you may have. It has good support for most text and -layout. images and SVG are not fully supported due to some ps -issues. +The PostScript renderer is still in its early stages and therefore still +missing some features. It provides good support for most text and layout. +Images and SVG are not fully supported, yet. Currently, the PostScript +renderer generates PostScript Level 3 with most DSC comments. Actually, +the only Level 3 feature used is FlateDecode, everthing else is Level 2.

    + +
      +
    • Images and SVG may not be display correctly. SVG support is far from being complete. No image transparency is available.
      • +
    • Character spacing may be wrong.
      • +
    • No font embedding is supported.
      • +
    • Multibyte characters are not supported.
      • +
    • PPD support is still missing.
      • +
    • The renderer is not yet configurable.
      • +
    +

    diff --git a/docs/xml-docs/fop/readme.xml b/docs/xml-docs/fop/readme.xml index 2547f5bc6..2b44465e4 100644 --- a/docs/xml-docs/fop/readme.xml +++ b/docs/xml-docs/fop/readme.xml @@ -15,7 +15,7 @@

    -

    FOP is the world's first print formatter driven by XSL formatting +

    FOP (Formatting Objects Processor) is the world's first print formatter driven by XSL formatting objects and the world's first output independent formatter. It is a Java application that reads a formatting object tree and then renders the resulting pages to a specified output. Output formats diff --git a/docs/xml-docs/fop/relnotes.xml b/docs/xml-docs/fop/relnotes.xml index 589701226..6daf30b54 100644 --- a/docs/xml-docs/fop/relnotes.xml +++ b/docs/xml-docs/fop/relnotes.xml @@ -22,7 +22,7 @@ on fo:page-sequence, fo:single-page-master-reference, fo:repeatable-page-master-reference and fo:conditional-page-master-reference.

    -
  • JDK 1.2 (or better) is required
    • +
  • JDK 1.2 (or later) is required
  • Jimi has been removed for licensing reasons

    If you need PNG support you have to download Jimi, @@ -33,6 +33,9 @@ (search for jdk1.4 and remove the comments)

    • +
  • +

    For a more detailed list of changes, see the CHANGES file in the root of the FOP distribution.

    +

diff --git a/docs/xml-docs/fop/resources.xml b/docs/xml-docs/fop/resources.xml index a05f1f22a..2d3b93e21 100644 --- a/docs/xml-docs/fop/resources.xml +++ b/docs/xml-docs/fop/resources.xml @@ -13,6 +13,38 @@ + + +
    +
  • Send a mail to fop-user-subscribe@xml.apache.org + to subscribe. This is where user specific topics are discussed. For detailed instructions on the subscription, see + Apache XML Mailing Lists.
    • +
  • The Mailing list ARChives (MARC) at the AIMS group: + fop-user +
    • (searchable) +
  • Apache archive of fop-user@apache.org
    • +
+ + +
    +
  • Send a mail to fop-dev-subscribe@xml.apache.org + to subscribe. For detailed instructions on the subscription, see + Apache XML Mailing Lists.
    • +
  • The Mailing list ARChives (MARC) at the AIMS group: + fop-dev +
    • (searchable) +
  • Apache archive of fop-dev@apache.org
    • +
+ + +
    +
  • There is an XSL:FO mailing list: www-xsl-fo@w3.org. Subscription info can be found here: + http://www.w3.org/Mail/Request.
    • +
  • The archive can be found here: + http://lists.w3.org/Archives/Public/www-xsl-fo/
    • +
+ +
  • XSL-FO Recommendation (15 October 2001)
    • @@ -36,14 +68,8 @@
  • Dave Pawson: An introduction to XSL Formatting Objects
 - +
    -
  • Apache archive of fop-dev@apache.org
    • -
  • The Mailing list ARChives (MARC) at the AIMS group: fop-dev, - fop-user
    • (searchable) -
  • There is an xsl:fo mailing list: www-xsl-fo@w3.org. Subscription info can be found here: - http://www.w3.org/Mail/Request. And the archive can be found here: - http://lists.w3.org/Archives/Public/www-xsl-fo/
  • PJ is an open source product that can be used to modify PDF documents: http://www.etymon.com/pj/index.html diff --git a/docs/xml-docs/fop/running.xml b/docs/xml-docs/fop/running.xml index 56bb026b1..7931377d4 100644 --- a/docs/xml-docs/fop/running.xml +++ b/docs/xml-docs/fop/running.xml @@ -67,13 +67,7 @@ -

    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 - fop-user@xml.apache.org - (see here for - howto subscribe). Maybe it is a bug and maybe somebody is already working on it. -

    +

    If you have problems running FOP, please have a look at the "How to get Help" page.