From 99cfed96f71c2deff9afdf30c71f93c2ca30d005 Mon Sep 17 00:00:00 2001 From: Vincent Hennebert Date: Thu, 23 Aug 2007 18:30:05 +0000 Subject: [PATCH] Merged revisions 556567-558280,558282-562946,562948-563926,563928-563950,563952-563955,563957-564855,564857-567293,567295-567296,567298-567302,567304-569099 via svnmerge from https://svn.apache.org/repos/asf/xmlgraphics/fop/branches/fop-0_94 MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit ........ r560595 | vhennebert | 2007-07-28 21:26:51 +0200 (sam, 28 jui 2007) | 2 lines Remove tab for the no longer supported 0.20.5 version ........ r560596 | vhennebert | 2007-07-28 21:28:30 +0200 (sam, 28 jui 2007) | 2 lines Create a tab for the new 0.94 version ........ r560600 | vhennebert | 2007-07-28 21:45:13 +0200 (sam, 28 jui 2007) | 2 lines Remove any reference to the old maintenance branch ........ r560886 | vhennebert | 2007-07-30 10:19:59 +0200 (lun, 30 jui 2007) | 2 lines Update the documentation before releasing ........ r562023 | clay | 2007-08-02 08:08:49 +0200 (jeu, 02 aoû 2007) | 1 line Changes to fop-0_94 branch to prepare it for 0.94 release. ........ r562024 | clay | 2007-08-02 08:09:33 +0200 (jeu, 02 aoû 2007) | 1 line Changes to fop-0_94 branch to prepare it for 0.94 release. ........ r562027 | clay | 2007-08-02 08:27:01 +0200 (jeu, 02 aoû 2007) | 1 line Changes to fop-0_94 branch to prepare it for 0.94 release. ........ r562332 | clay | 2007-08-03 07:09:50 +0200 (ven, 03 aoû 2007) | 1 line Updated FOP Compliance page to include additional column for 0.94 (did not remove 0.20.5 or 0.93 column). Also 'Notes' column was *not* modified for 0.94-specific information. ........ r562333 | clay | 2007-08-03 07:10:47 +0200 (ven, 03 aoû 2007) | 1 line Updated FOP Compliance page to include additional column for 0.94 (did not remove 0.20.5 or 0.93 column). Also 'Notes' column was *not* modified for 0.94-specific information. ........ r562880 | vhennebert | 2007-08-05 17:05:41 +0200 (dim, 05 aoû 2007) | 4 lines - Update the website content - Fix some typos - Fix broken links ........ r562881 | vhennebert | 2007-08-05 17:06:59 +0200 (dim, 05 aoû 2007) | 5 lines Changes in the trunk tab: - update content - fix typos - fix broken links ........ r562887 | vhennebert | 2007-08-05 17:22:15 +0200 (dim, 05 aoû 2007) | 2 lines Merge changes on the Trunk tab from revision 562881 ........ r562891 | vhennebert | 2007-08-05 17:32:33 +0200 (dim, 05 aoû 2007) | 4 lines Update the list of known issues: - border-collapsing model for tables is available - internal links point to the exact location ........ r562900 | vhennebert | 2007-08-05 17:48:50 +0200 (dim, 05 aoû 2007) | 2 lines Setup the "known issues" infrastructure for the 0.94 tab ........ r562903 | vhennebert | 2007-08-05 18:23:59 +0200 (dim, 05 aoû 2007) | 2 lines Style only: remove tab characters ........ r562909 | vhennebert | 2007-08-05 19:11:58 +0200 (dim, 05 aoû 2007) | 2 lines Disable "Valid HTML" icons. The site isn't valid... ........ r562919 | vhennebert | 2007-08-05 19:52:13 +0200 (dim, 05 aoû 2007) | 3 lines Disable any link to relnotes.html. This file is not properly placed (in no tab), and only contains release notes for versions up to 0.92. TODO determine what to do with this file; newer versions have their own system ........ r562924 | vhennebert | 2007-08-05 20:09:44 +0200 (dim, 05 aoû 2007) | 2 lines Add a link to the Release Notes for version 0.94 ........ r562925 | vhennebert | 2007-08-05 20:10:34 +0200 (dim, 05 aoû 2007) | 2 lines Replace "Apache Forrest" with "Apache FOP". Copy-paste error? ........ r564159 | vhennebert | 2007-08-09 11:56:41 +0200 (jeu, 09 aoû 2007) | 2 lines Introduce 0.94 in status.xml and README ........ r564233 | vhennebert | 2007-08-09 17:09:49 +0200 (jeu, 09 aoû 2007) | 2 lines Update the compliance page ........ r564864 | vhennebert | 2007-08-11 10:41:15 +0200 (sam, 11 aoû 2007) | 2 lines Fix error that made the 0.94 menu appear in the Trunk tab and vice-versa ........ r564866 | vhennebert | 2007-08-11 10:45:39 +0200 (sam, 11 aoû 2007) | 2 lines Add my key for signing the release ........ r564871 | vhennebert | 2007-08-11 10:51:35 +0200 (sam, 11 aoû 2007) | 2 lines Update dependency on version 1.2 of XML Graphics Commons ........ r567299 | vhennebert | 2007-08-18 19:23:09 +0200 (sam, 18 aoû 2007) | 2 lines Update .htaccess to 0.94 release ........ r567539 | clay | 2007-08-20 06:12:42 +0200 (lun, 20 aoû 2007) | 1 line Added formatting for code in page. ........ git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@569104 13f79535-47bb-0310-9956-ffa450edef68 --- KEYS | 37 + README | 39 +- known-issues.xml | 8 - src/documentation/content/.htaccess | 40 +- .../content/xdocs/0.20.5/compiling.xml | 89 - .../content/xdocs/0.20.5/configuration.xml | 105 - .../content/xdocs/0.20.5/embedding.xml | 521 -- .../content/xdocs/0.20.5/graphics.xml | 289 - .../content/xdocs/0.20.5/output.xml | 329 - .../content/xdocs/0.20.5/running.xml | 190 - .../content/xdocs/0.93/configuration.xml | 20 +- .../content/xdocs/0.93/running.xml | 38 +- .../content/xdocs/0.93/upgrading.xml | 2 +- .../xdocs/{0.20.5 => 0.94}/anttask.xml | 80 +- .../content/xdocs/0.94/compiling.xml | 141 + .../content/xdocs/0.94/configuration.xml | 385 + .../content/xdocs/0.94/embedding.xml | 689 ++ .../xdocs/{0.20.5 => 0.94}/extensions.xml | 89 +- .../content/xdocs/{0.20.5 => 0.94}/fonts.xml | 175 +- .../xdocs/0.94/fotree/disabled-testcases.xml | 31 + .../content/xdocs/0.94/graphics.xml | 401 + .../xdocs/{0.20.5 => 0.94}/hyphenation.xml | 126 +- .../content/xdocs/{0.20.5 => 0.94}/index.xml | 28 +- .../content/xdocs/0.94/intermediate.xml | 146 + .../content/xdocs/0.94/known-issues.xml | 94 + .../xdocs/0.94/knownissues_overview.xml | 70 + .../0.94/layoutengine/disabled-testcases.xml | 327 + .../content/xdocs/0.94/output.xml | 805 ++ src/documentation/content/xdocs/0.94/pdfa.xml | 159 + .../xdocs/{0.20.5 => 0.94}/pdfencryption.xml | 62 +- src/documentation/content/xdocs/0.94/pdfx.xml | 136 + .../content/xdocs/0.94/running.xml | 348 + .../xdocs/{0.20.5 => 0.94}/servlets.xml | 149 +- .../content/xdocs/0.94/upgrading.xml | 132 + .../content/xdocs/compliance.ihtml | 7958 ++++++----------- .../xdocs/dev/design/configuration.xml | 104 +- src/documentation/content/xdocs/dev/faq.xml | 6 +- .../content/xdocs/dev/release.xml | 44 +- src/documentation/content/xdocs/download.xml | 37 +- src/documentation/content/xdocs/examples.xml | 8 +- src/documentation/content/xdocs/faq.xml | 151 +- src/documentation/content/xdocs/fo.xml | 32 +- src/documentation/content/xdocs/index.xml | 39 +- src/documentation/content/xdocs/maillist.xml | 6 +- src/documentation/content/xdocs/news.xml | 23 +- src/documentation/content/xdocs/relnotes.xml | 15 +- src/documentation/content/xdocs/resources.xml | 6 +- src/documentation/content/xdocs/site.xml | 30 +- src/documentation/content/xdocs/status.xml | 18 +- src/documentation/content/xdocs/tabs.xml | 2 +- .../content/xdocs/trunk/compiling.xml | 5 +- .../content/xdocs/trunk/configuration.xml | 36 +- .../content/xdocs/trunk/extensions.xml | 6 +- .../content/xdocs/trunk/fonts.xml | 14 +- .../content/xdocs/trunk/graphics.xml | 1 - .../content/xdocs/trunk/output.xml | 3 + .../content/xdocs/trunk/pdfencryption.xml | 4 - .../content/xdocs/trunk/running.xml | 49 +- .../content/xdocs/trunk/upgrading.xml | 16 +- .../stylesheets/releaseNotes2document.xsl | 2 +- src/documentation/skinconf.xml | 12 +- status.xml | 2 + xmlgraphics-fop-pom-template.pom | 2 +- 63 files changed, 7523 insertions(+), 7388 deletions(-) delete mode 100644 src/documentation/content/xdocs/0.20.5/compiling.xml delete mode 100644 src/documentation/content/xdocs/0.20.5/configuration.xml delete mode 100644 src/documentation/content/xdocs/0.20.5/embedding.xml delete mode 100644 src/documentation/content/xdocs/0.20.5/graphics.xml delete mode 100644 src/documentation/content/xdocs/0.20.5/output.xml delete mode 100644 src/documentation/content/xdocs/0.20.5/running.xml rename src/documentation/content/xdocs/{0.20.5 => 0.94}/anttask.xml (70%) create mode 100644 src/documentation/content/xdocs/0.94/compiling.xml create mode 100644 src/documentation/content/xdocs/0.94/configuration.xml create mode 100644 src/documentation/content/xdocs/0.94/embedding.xml rename src/documentation/content/xdocs/{0.20.5 => 0.94}/extensions.xml (50%) rename src/documentation/content/xdocs/{0.20.5 => 0.94}/fonts.xml (54%) create mode 100644 src/documentation/content/xdocs/0.94/fotree/disabled-testcases.xml create mode 100644 src/documentation/content/xdocs/0.94/graphics.xml rename src/documentation/content/xdocs/{0.20.5 => 0.94}/hyphenation.xml (68%) rename src/documentation/content/xdocs/{0.20.5 => 0.94}/index.xml (52%) create mode 100644 src/documentation/content/xdocs/0.94/intermediate.xml create mode 100644 src/documentation/content/xdocs/0.94/known-issues.xml create mode 100644 src/documentation/content/xdocs/0.94/knownissues_overview.xml create mode 100644 src/documentation/content/xdocs/0.94/layoutengine/disabled-testcases.xml create mode 100644 src/documentation/content/xdocs/0.94/output.xml create mode 100644 src/documentation/content/xdocs/0.94/pdfa.xml rename src/documentation/content/xdocs/{0.20.5 => 0.94}/pdfencryption.xml (79%) create mode 100644 src/documentation/content/xdocs/0.94/pdfx.xml create mode 100644 src/documentation/content/xdocs/0.94/running.xml rename src/documentation/content/xdocs/{0.20.5 => 0.94}/servlets.xml (63%) create mode 100644 src/documentation/content/xdocs/0.94/upgrading.xml diff --git a/KEYS b/KEYS index 0495ad8dc..f49f8d6be 100644 --- a/KEYS +++ b/KEYS @@ -17,6 +17,9 @@ pub 1024D/7C611584 2005-07-19 Jeremias M sub 2048g/C0F1AD34 2005-07-19 pub 1024D/5F298824 2006-09-30 Simon Pepping sub 2048g/40F32100 2006-09-30 +pub 1024D/4358C584 2006-12-08 Vincent Hennebert +sub 2048g/0BD6AC9B 2006-12-08 + -----BEGIN PGP PUBLIC KEY BLOCK----- Version: GnuPG v1.0.6 (GNU/Linux) @@ -130,3 +133,37 @@ CQlmAYAACgkQPipvwl8piCQmlgCgmxawADNcQDnWuFpJ/jaHRdhDKLAAnjhAoZ/D nruGzxj+A7iyYEB9I6Uk =NbVl -----END PGP PUBLIC KEY BLOCK----- + +-----BEGIN PGP PUBLIC KEY BLOCK----- +Version: GnuPG v1.4.2.2 (GNU/Linux) + +mQGiBEV5mbgRBACBd9xGOGzs8ah/N11zlDi8woJUh02EgztXdMfij4F3u12DkneC +OIwGH14fWHdkhKjwYMi5LQfvBsnd3P5v5PTBxYati7ZQDDjvYsAJiMXbyUdszdyQ +ig/UuNMwdB5YBrdtklzZcOuiNt/yeoocURQRwkwklsVBIYWwovcdXLTRWwCglPVQ +0NrC7VPRPTgK0Y1wxOgwzj0D/RpwFEAcl1SJHoOwhwKykNzA05YABaxXhksKi2qQ +C8M4mUofqweU3ocU0tBqQAR351n7hQWAaIs6ScOQtcKPJj9SV8SQgqxwj7WfHscj +9X3lkP6cxstW+W8SblTgrKwl7JLLkja1u1cNUeD0QzWImuRBpOjh4s97ZFwSHRoH +hCLgA/4/GDXbOhC4Wi9i8HHQNhEA6l86ZBteGq5u4SW57cK69mnOGj8iBxenIWeU ++NuB/LqVcG/75JnDvVGImvoykCBEl9xASNOj1C4HvBwNrU7iIpvRig1wwHK8/wqU +Dhq5433rh40YbOfN0PLZDhQNhf3MysP3ipTZkVdwIKhsvl/vibQ2VmluY2VudCBI +ZW5uZWJlcnQgPHZpbmNlbnQuaGVubmViZXJ0QGFueXdhcmUtdGVjaC5jb20+iGAE +ExECACAFAkV5mgcCGwMGCwkIBwMCBBUCCAMEFgIDAQIeAQIXgAAKCRCgctTQQ1jF +hH7uAJ9BFRNMuSpvSq//lEWLc6WOTMW70ACghjA0jtaMQUVjDU3RUOdGMRkqRZu0 +KVZpbmNlbnQgSGVubmViZXJ0IDx2aGVubmViZXJ0QGFwYWNoZS5vcmc+iGMEExEC +ACMCGwMGCwkIBwMCBBUCCAMEFgIDAQIeAQIXgAUCRXmahgIZAQAKCRCgctTQQ1jF +hLRSAJ9KgHLa9V4Q2k0NFiMpPuhfnsK9bQCeJbGjFdIgrzyIvYIUZUPQGww597+5 +Ag0ERXmZwhAIAJhskbWZaLuwdZ3aLqVimVu65bR2ve1U28dfsSVCKx0uYCl3YJkj +lF9P3BfMMPVdNRqDz4Agz/Vrn13j+p4ZQQhVhv6IGhE4p4T4RebMaZ/d30/6REls +DP3Luc9IrnJbA72jSeXt+vI3WysB/wuJJ/kb+3KtFa1NowwVVypHCiSmme0VCUaR +K6jlN0245IpR0IA4Q1VziRO7v1VufZAef64/2U2T/IthwPqDoThNj++9Zg5Tctrt +TL02Z++n2Nj9bQf9R+FhA3YhvHuf6OLAPE2emcM/0As+JwBHqcMrmybnrxEJg0Aq +4Q1k1Ka7beb35QJ7158rzL1PU1V2totLeW8AAwUH/1NJVnMD/p4op2kbJYMgKSqz +zZfypt60aWeImeJ2qZD7FAtsz6KQu2a5ZkcVmyCeuAo9Sj0IqxXyn8Z6bHuHXNe+ +aidjS+n5kc2Y+5RQ1oMGV+BzXQMPGOgh0ertbLaairT7mCljTEd4kUGxOIcfAh/q +Ie+p7Guvw6+T4K7hgfY8bAiVgzhZLWIFTQXpjU+91q6kTt4eIWjdCGdNQ/OBezGY +f5SCy0phzTmRqcu68nKaLznwUpI7SuSFSIeVemGz602KdFsLEHHbZE0KJgd6aHYu +ynK3sugKIpz/NXpT2vBsVkK6EP5xzWYOpqMGb8uQD8CT7loY81SK+rHBm7dicgiI +SQQYEQIACQUCRXmZwgIbDAAKCRCgctTQQ1jFhBc3AKCQ1X7oIVR8g7GvSGEUw6DE +HgEaUgCgkl30lcl9gGa9hqk4cuGYn1OTyks= +=XphF +-----END PGP PUBLIC KEY BLOCK----- diff --git a/README b/README index 4f66c558b..67a3b0fe1 100644 --- a/README +++ b/README @@ -20,7 +20,7 @@ What is FOP? Apache FOP is the world's first print formatter driven by XSL formatting objects. It is a Java application that reads a formatting object tree -conforming to the XSL 1.0 Recommendation (15 October 2001) and then turns it +conforming to the XSL 1.1 Recommendation (05 December 2006) and then turns it into a PDF document, certain other output formats or allows you to preview it directly on screen. Some parts of the XSL 1.1 specification (work in progress!) have also been implemented. @@ -90,6 +90,41 @@ http://xmlgraphics.apache.org/fop/stable/running.html RELEASE NOTES ============================================================================== +Version 0.94 +============ + +This is the second production grade release of the new FOP codebase. +It contains many bug fixes and new features. See below for details. + +Compliance +---------- + +This release implements the XSL 1.0 and 1.1 recommendations to a high +degree of compliance. See the compliance page +http://xmlgraphics.apache.org/fop/compliance.html for a detailed +overview. + +Known issues +------------ + +The known issues of this release are listed at +http://xmlgraphics.apache.org/fop/0.94/knownissues_overview.html. + +Major Changes in Version 0.94 +----------------------------- + +* Add support for font auto-detection (JM) Thanks to Adrian Cumiskey +* Add support for the border-collapsing model in tables (VH, JM) +* Add support for named destinations in PDF (JB) +* Add support for UAX#14 type line breaking (MM) + +The long list of changes in this release is available at +http://xmlgraphics.apache.org/fop/0.94/changes_0.94.html. + +The long list of changes in this and earlier releases is available at +http://xmlgraphics.apache.org/fop/changes.html. + + Version 0.93 ============ @@ -153,4 +188,4 @@ release. So if the latest version works fine for you, please tell us! And if it doesn't, you may tell us as well, of course. ;-) Release notes for older FOP versions can be found on: -http://xmlgraphics.apache.org/fop/relnotes.html \ No newline at end of file +http://xmlgraphics.apache.org/fop/relnotes.html diff --git a/known-issues.xml b/known-issues.xml index 25af2a217..27ae55494 100644 --- a/known-issues.xml +++ b/known-issues.xml @@ -27,10 +27,6 @@ Auto table layout is not implemented, yet. - - The collapsing border model on tables is not implemented, yet. Please - use border-collapse="separate" for now. - Footnotes may overlap with text of the region-body in multi-column documents. @@ -95,8 +91,4 @@ Column balancing in multi-column documents may not work as expected (Bugzilla #36356) - - Internal basic-links don't point to the exact location on a page, yet, as they - did in 0.20.5. Currently you land in the upper left corner of the page. - diff --git a/src/documentation/content/.htaccess b/src/documentation/content/.htaccess index 7a0a17476..db766b7c4 100644 --- a/src/documentation/content/.htaccess +++ b/src/documentation/content/.htaccess @@ -1,28 +1,28 @@ # redirect moved files -RedirectMatch Permanent ^/fop/anttask(.*) http://xmlgraphics.apache.org/fop/0.93/anttask$1 -RedirectMatch Permanent ^/fop/compiling(.*) http://xmlgraphics.apache.org/fop/0.93/compiling$1 -RedirectMatch Permanent ^/fop/configuration(.*) http://xmlgraphics.apache.org/fop/0.93/configuration$1 -RedirectMatch Permanent ^/fop/embedding(.*) http://xmlgraphics.apache.org/fop/0.93/embedding$1 -RedirectMatch Permanent ^/fop/extensions(.*) http://xmlgraphics.apache.org/fop/0.93/extensions$1 -RedirectMatch Permanent ^/fop/fonts(.*) http://xmlgraphics.apache.org/fop/0.93/fonts$1 -RedirectMatch Permanent ^/fop/graphics(.*) http://xmlgraphics.apache.org/fop/0.93/graphics$1 -RedirectMatch Permanent ^/fop/hyphenation(.*) http://xmlgraphics.apache.org/fop/0.93/hyphenation$1 -RedirectMatch Permanent ^/fop/intermediate(.*) http://xmlgraphics.apache.org/fop/0.93/intermediate$1 -RedirectMatch Permanent ^/fop/output(.*) http://xmlgraphics.apache.org/fop/0.93/output$1 -RedirectMatch Permanent ^/fop/pdfa(.*) http://xmlgraphics.apache.org/fop/0.93/pdfa$1 -RedirectMatch Permanent ^/fop/pdfencryption(.*) http://xmlgraphics.apache.org/fop/0.93/pdfencryption$1 -RedirectMatch Permanent ^/fop/pdfx(.*) http://xmlgraphics.apache.org/fop/0.93/pdfx$1 -RedirectMatch Permanent ^/fop/running(.*) http://xmlgraphics.apache.org/fop/0.93/running$1 -RedirectMatch Permanent ^/fop/servlets(.*) http://xmlgraphics.apache.org/fop/0.93/servlets$1 -RedirectMatch Permanent ^/fop/upgrading(.*) http://xmlgraphics.apache.org/fop/0.93/upgrading$1 +RedirectMatch Permanent ^/fop/anttask(.*) http://xmlgraphics.apache.org/fop/0.94/anttask$1 +RedirectMatch Permanent ^/fop/compiling(.*) http://xmlgraphics.apache.org/fop/0.94/compiling$1 +RedirectMatch Permanent ^/fop/configuration(.*) http://xmlgraphics.apache.org/fop/0.94/configuration$1 +RedirectMatch Permanent ^/fop/embedding(.*) http://xmlgraphics.apache.org/fop/0.94/embedding$1 +RedirectMatch Permanent ^/fop/extensions(.*) http://xmlgraphics.apache.org/fop/0.94/extensions$1 +RedirectMatch Permanent ^/fop/fonts(.*) http://xmlgraphics.apache.org/fop/0.94/fonts$1 +RedirectMatch Permanent ^/fop/graphics(.*) http://xmlgraphics.apache.org/fop/0.94/graphics$1 +RedirectMatch Permanent ^/fop/hyphenation(.*) http://xmlgraphics.apache.org/fop/0.94/hyphenation$1 +RedirectMatch Permanent ^/fop/intermediate(.*) http://xmlgraphics.apache.org/fop/0.94/intermediate$1 +RedirectMatch Permanent ^/fop/output(.*) http://xmlgraphics.apache.org/fop/0.94/output$1 +RedirectMatch Permanent ^/fop/pdfa(.*) http://xmlgraphics.apache.org/fop/0.94/pdfa$1 +RedirectMatch Permanent ^/fop/pdfencryption(.*) http://xmlgraphics.apache.org/fop/0.94/pdfencryption$1 +RedirectMatch Permanent ^/fop/pdfx(.*) http://xmlgraphics.apache.org/fop/0.94/pdfx$1 +RedirectMatch Permanent ^/fop/running(.*) http://xmlgraphics.apache.org/fop/0.94/running$1 +RedirectMatch Permanent ^/fop/servlets(.*) http://xmlgraphics.apache.org/fop/0.94/servlets$1 +RedirectMatch Permanent ^/fop/upgrading(.*) http://xmlgraphics.apache.org/fop/0.94/upgrading$1 # redirect to versioned documentation -Redirect Temp /fop/stable http://xmlgraphics.apache.org/fop/0.93 -Redirect Temp /fop/current http://xmlgraphics.apache.org/fop/0.93 +Redirect Temp /fop/stable http://xmlgraphics.apache.org/fop/0.94 +Redirect Temp /fop/current http://xmlgraphics.apache.org/fop/0.94 Redirect Temp /fop/unstable http://xmlgraphics.apache.org/fop/trunk Redirect Temp /fop/latest http://xmlgraphics.apache.org/fop/trunk -Redirect Temp /fop/maintenance http://xmlgraphics.apache.org/fop/0.20.5 -Redirect Temp /fop/previous http://xmlgraphics.apache.org/fop/0.20.5 +Redirect Temp /fop/maintenance http://xmlgraphics.apache.org/fop/0.93 +Redirect Temp /fop/previous http://xmlgraphics.apache.org/fop/0.93 Redirect Temp /fop/0.90alpha1 http://xmlgraphics.apache.org/fop/0.93 Redirect Temp /fop/0.91beta http://xmlgraphics.apache.org/fop/0.93 Redirect Temp /fop/0.92beta http://xmlgraphics.apache.org/fop/0.93 diff --git a/src/documentation/content/xdocs/0.20.5/compiling.xml b/src/documentation/content/xdocs/0.20.5/compiling.xml deleted file mode 100644 index e2e2ca8d5..000000000 --- a/src/documentation/content/xdocs/0.20.5/compiling.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - -
- FOP: Building from Source Code - $Revision$ -
- -
- Do You Need To Build? -

FOP distributions are either pre-compiled binary or source. -If you are using a binary distribution, it is already built and there is no need to build it again. See the Download Instructions for information about whether a binary or source distribution is best for your needs. -

-
-
- Set Up Your Environment -
- JDK -

- Building FOP requires a minimum Java Development Kit (JDK/SDK) of 1.3 - (A Java Runtime Environment is not sufficient). -

-
-
- CLASSPATH -

There is generally no need to setup a classpath. All libraries needed to compile FOP are included in the source distribution and are referenced by the build script. -You will only need to adjust the classpath if you build FOP in some other way. See the build scripts (build.bat for Windows, and build.sh for Unix) for details.

-
-
- JAVA_HOME -

The build script uses Ant, a popular java-based build tool, which requires that the environment variable JAVA_HOME point to your local JDK root directory. This is true even if you use JDK 1.2 or above, which normally does not need this setting.

-
-
-
- Run the "build" Script -

Build FOP by executing the "build" script, which is located in the FOP root directory. -The Windows batch file is build.bat, and the Unix shell script is build.sh. -The examples below are for running the shell script, but except for the build file extension, the syntax is identical.

-

The file build.xml in the FOP root directory is the blueprint that Ant uses for the build. It contains information for numerous build targets, many of which are building blocks to more useful target, and others which are primarily used by the FOP developers. -You may benefit from looking through this file to learn more about the various build targets. -To obtain a complete list of useful build targets:

- build.sh -projecthelp -

The most useful targets are:

-
    -
  • package: Generates the jar files (default). This is the normal build that produces a jar file usable for running FOP.
    • -
  • clean : Cleans the build directory. This is useful for making sure that any build errors are cleaned up before starting a new build. It should not ordinarily be needed, but may be helpful if you are having problems with the build process itself.
    • -
  • javadocs: Generates javadocs. This creates the FOP API documentation.
    • -
-

To run the build:

- build.sh [target ...] -

For example to do a normal build for the package target (which is the default):

- build.sh -

OR

- build.sh package -

To clean the build directory first:

- build.sh clean package -
-
- Troubleshooting -

If you have problems building FOP, please try the following:

-
    -
  • Run the build with the target of "clean", then rerun the build.
    • -
  • Delete the build directory completely, then rerun the build.
    • -
  • Make sure you do not have a non-FOP version of xerces.jar, xalan.jar, batik.jar, or another dependency product somewhere in your CLASSPATH.
    • -
  • If the build still fails, see the Getting Help page for further help.
    • -
-
- - - diff --git a/src/documentation/content/xdocs/0.20.5/configuration.xml b/src/documentation/content/xdocs/0.20.5/configuration.xml deleted file mode 100644 index 88097059a..000000000 --- a/src/documentation/content/xdocs/0.20.5/configuration.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - -
- FOP: Configuration - $Revision$ -
- - -
- Configuration File Basics -

The FOP configuration file is an XML file containing a variety of settings that are useful for controlling FOP's behavior, and for helping it find resources that you wish it to use.

-

The easiest way to get started using a FOP configuration file is to copy the sample found at {fop-dir}/conf/userconfig.xml to a location of your choice, and then to edit it according to your needs. -It contains templates for the various configuration options, most of which are commented out. Remove the comments and change the settings for entries that you wish to use. -Be sure to follow any instructions, including comments which specify the value range. -Also, since the configuration file is XML, be sure to keep it well-formed.

- Do not change {fop-dir}/conf/config.xml or use it as the basis for your configuration file. It has an entirely different purpose. -
- Creating Entries -

The general structure of the configuration file is a series of <entry> tags, each containing a <key> and a <value>. (Fonts use a different format). Here is an example:

- - strokeSVGText - false -]]> -
-
- Making Configuration Available to FOP -

After creating your configuration file, you must tell FOP how to find it:

-
    -
  • If running FOP from the command-line, see the "-c" command-line option in Running FOP.
    • -
  • If running FOP as an embedded application, see FOP: Embedding, Using a Configuration File.
    • -
-

See Setting the Configuration Programmatically for instructions on how to do so in an embedded environment.

-
-
-
- Summary of Key-Value Configuration Options - - - - - - - - - - - - - - - - - - - - - - - - - - -
Option (key)Data Type (for the value)Default Value
baseDirURLFor command-line, the directory containing the input FO or XML file. For embedded, the current working directory.
fontBaseDirURLvalue of baseDir
hyphenation-dirURLNone. This is for custom hyphenation patterns.
strokeSVGTextBooleanTrue
-
-
- Detail for Key-Value Configuration Options -

The sections below provide detailed information for configuration options that are not self-explanatory. The parenthetical information after each key name indicates (Data Type, Default).

-
- hyphenation-dir (URL, none) -

Use this entry to indicate a directory containing custom hyphenation files (if any). -See FOP: Hyphenation for more information on creating and modifying hyphenation within FOP.

-
-
- strokeSVGText (boolean, True) -

In some cases, some text in SVG documents is converted to graphical shapes instead of retaining its character as text. To force all text to be rendered as text, set strokeSVGText = false. For a discussion of this issue, see FOP: Graphics, Placing SVG Text into PDF.

- strokeSVGText is currently only effective in the PDF renderer. -
-
-
- Fonts -

Font configuration information is included in the FOP configuration file, but is documented at FOP: Fonts. Note especially the section entitled Register Fonts with FOP.

-
- - - diff --git a/src/documentation/content/xdocs/0.20.5/embedding.xml b/src/documentation/content/xdocs/0.20.5/embedding.xml deleted file mode 100644 index e3cff158a..000000000 --- a/src/documentation/content/xdocs/0.20.5/embedding.xml +++ /dev/null @@ -1,521 +0,0 @@ - - - - - - - - -
- FOP: Embedding - How to Embed FOP in a Java application - $Revision$ -
- - -
- Overview -

Review Running FOP for important information that applies to embedded applications as well as command-line use, such as options and performance. -

-

To embed FOP in your application, instantiate org.apache.fop.apps.Driver. - Once this class is - instantiated, methods are called to set the - Renderer to use - and the OutputStream to use to output the results of the - rendering (where applicable). In the case of the Renderer and - ElementMapping(s), the Driver may be supplied either with the - object itself, or the name of the class, in which case Driver will - instantiate the class itself. The advantage of the latter is it - enables runtime determination of Renderer and ElementMapping(s). -

-
-
- Basics -

The simplest way to use Driver is to instantiate it with the - InputSource and OutputStream, then set the renderer desired and - call the run method. -

-

Here is an example use of Driver which outputs PDF: -

- -

-In the example above, args[0] contains the path to an XSL-FO file, while -args[1] contains a path for the target PDF file. -

-
- Logging -

- You also need to set up logging. Global logging for all FOP - processes is managed by MessageHandler. Per-instance logging - is handled by Driver. You want to set both using an implementation - of org.apache.avalon.framework.logger.Logger. See - below for more information. -

-

- Call setLogger(Logger) always immediately after - instantiating the Driver object. See here: -

- -
- -
- Logging (Upcoming FOP 1.0 Version only) -

- Logging is handled automatically via Jakarta Commons-Logging, which uses - JDK logging by default. No special driver configuration is needed. - For specialized configuration of Commons-Logging (e.g. to use a - different logger or to change logging levels), please see the - Jakarta Commons-Logging - site. -

-
- -
- Processing XSL-FO -

- Once the Driver is set up, one of the render() methods - is called. Depending on whether DOM or an InputSource is being used, the - invocation of the method is either render(Document) or - render(Parser, InputSource) respectively. -

-

- Another possibility may be used to build the FO Tree: You can - call getContentHandler() and fire the SAX events yourself. - - You don't have to call run() or render() on the - Driver object if you use getContentHandler(). -

-

Here is an example use of Driver:

- -
- -
- Processing XSL-FO generated from XML+XSLT -

- If you want to process XSL-FO generated from XML using XSLT we recommend - using standard JAXP to do the XSLT part and piping the generated SAX - events directly through to FOP. Here's how this would look like: -

- - There's no need to call run() or render(). -

- This may look complicated at first, but it's really just the combination of an - XSL transformation and a FOP run. It's also easy to comment out the FOP part - for debugging purposes, for example when you're tracking down a bug in your - stylesheet. You can easily write the XSL-FO output from the XSL transformation - to a file to check if that part generates the expected output. -

-

- For fully working examples of the above and hints to some interesting - possibilities, see the examples section below. -

-
-
-
- Controlling logging -

- Current FOP 0.20.x production uses the - Logger package - from Apache Avalon Framework to do logging. See the - Apache Avalon Framework - for more information. -

-

- Per default FOP uses the SimpleLog 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. -

-
-
- Input Sources -

- The input XSL-FO document is always handled internally as SAX (see the - Parsing Design Document for the rationale). - However, the input itself can be provided in a variety of ways to FOP, - which normalizes the input (if necessary) into SAX events: -

-
    -
  • SAX Events through SAX Handler: FOTreeBuilder is the SAX Handler which is obtained through getContentHandler on Driver.
    • -
  • DOM (which is converted into SAX Events): The conversion of a DOM tree is done via the render(Document) method on Driver.
    • -
  • Data Source (which is parsed and converted into SAX Events): The Driver can take an InputSource as input. -This can use a Stream, String etc.
    • -
  • XML+XSLT Transformation (which is transformed using an XSLT Processor and the result is fired as SAX Events: XSLTInputHandler is used as an InputSource in the render(XMLReader, InputSource) method on Driver.
    • -
-

- There are a variety of upstream data manipulations possible. - For example, you may have a DOM and an XSL stylesheet; or you may want to - set variables in the stylesheet. Interface documentation and some cookbook - solutions to these situations are provided in - Xalan Basic Usage Patterns. -

-

- See the Examples for some variations on input. -

-
-
- Using a Configuration File -

- To access an external configuration: -

- - - This is all you need to do, it sets up a static configuration class. - -

- No further reference to the options variable is necessary. - The "options = " is actually not even necessary. -

-

- See Multithreading FOP for issues related to changing configuration in a multithreaded environment. -

-
-
- Setting the Configuration Programmatically -

- If you wish to set configuration options from within your embedded application, use the Configuration.put method. Here is an example that sets the "baseDir" configuration in a Unix environment: -

- org.apache.fop.configuration.Configuration.put("baseDir","/my/base/dir"); -

- Here is another that sets baseDir in a Windows environment: -

- org.apache.fop.configuration.Configuration.put("baseDir","C:\my\base\dir"); -

- See Multithreading FOP for issues related to changing configuration in a multithreaded environment. -

-
-
- Hints -
- Object reuse -

-If FOP is going to be used multiple times within your application -it may be useful to reuse certain objects to save time. -

-

-The renderers and the driver can both be reused. A renderer is reusable -once the previous render has been completed. The driver is reuseable -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. -

-
-
- AWT issues -

- If your XSL-FO files contain SVG then Batik will be used. When Batik is - initialised it uses certain classes in java.awt that - intialises the java AWT classes. This means that a daemon thread - is created by the JVM and on Unix it will need to connect to a - DISPLAY. -

-

- The thread means that the Java application may not automatically quit - when finished, you will need to call System.exit(). These - issues should be fixed in the upcoming JDK 1.4. -

-

- If you run into trouble running FOP on a head-less server, please see the - notes on Batik. -

-
-
- Getting information on the rendering process -

-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. -

-
-
-
- Improving performance -

- There are several options to consider: -

-
    -
  • - Whenever possible, try to use SAX to couple the individual components involved - (parser, XSL transformer, SQL datasource etc.). -
    • -
  • - Depending on the target OutputStream (in case of an FileOutputStream, but not - for a ByteArrayOutputStream, for example) it may improve performance considerably - if you buffer the OutputStream using a BufferedOutputStream: - driver.setOutputStream(new java.io.BufferedOutputStream(out)); -
    - Make sure you properly close the OutputStream when FOP is finished. -
    • -
  • - Cache the stylesheet. If you use the same stylesheet multiple times - you can setup a JAXP Templates object and reuse it each time you do - the XSL transformation. (More information can be found - here.) -
    • -
  • - Use an XSLT compiler like XSLTC - that comes with Xalan-J. -
    • -
-
-
- Multithreading FOP -

- FOP is not currently completely thread safe. -Although the relevant methods of the Driver object are synchronized, FOP uses static -variables for configuration data and loading images. -Here are some tips to mitigate these problems: -

-
    -
  • - To avoid having your threads blocked, create a Driver object for each thread. -
    • -
  • - If possible, do not change the configuration data while there is a Driver object rendering. - Setup the configuration only once, preferably in the init() method of the servlet. -
    • -
  • - If you must change the configuration data more often, or if you have multiple - servlets within the same webapp using FOP, consider implementing a singleton - class to encapsulate the configuration settings and to run FOP in synchronized methods. -
    • -
-

There is also a known issue with fonts being jumbled between threads when using the AWT renderer (which is used by the -awt and -print output options). -In general, you cannot safely run multiple threads through the AWT renderer.

-
-
- Examples -

-The directory "{fop-dir}/examples/embedding" contains several working examples. -In contrast to the examples above the examples here primarily use JAXP for -XML access. This may be easier to understand for people familiar with JAXP. -

-
- ExampleFO2PDF.java -

This example - - (current 0.20.5) - - (future 1.0dev) -demonstrates the basic usage pattern to transform an XSL-FO -file to PDF using FOP. -

-
-
-
- ExampleXML2FO.java -

This example - - (current 0.20.5) - - (future 1.0dev) -has nothing to do with FOP. It is there to show you how an XML -file can be converted to XSL-FO using XSLT. The JAXP API is used to do the -transformation. Make sure you've got a JAXP-compliant XSLT processor in your -classpath (ex. Xalan). -

-
-
-
- ExampleXML2PDF.java -

This example - - (current 0.20.5) - - (future 1.0dev) -demonstrates how you can convert an arbitrary XML file to PDF -using XSLT and XSL-FO/FOP. It is a combination of the first two examples -above. The example uses JAXP to transform the XML file to XSL-FO and FOP to -transform the XSL-FO to PDF. -

-
-

-The output (XSL-FO) from the XSL transformation is piped through to FOP using -SAX events. This is the most efficient way to do this because the -intermediate result doesn't have to be saved somewhere. Often, novice users -save the intermediate result in a file, a byte array or a DOM tree. We -strongly discourage you to do this if it isn't absolutely necessary. The -performance is significantly higher with SAX. -

-
-
- ExampleObj2XML.java -

This example - - (current 0.20.5) - - (future 1.0dev) -is a preparatory example for the next one. It's an example that -shows how an arbitrary Java object can be converted to XML. It's an often -needed task to do this. Often people create a DOM tree from a Java object and -use that. This is pretty straightforward. The example here however shows how -to do this using SAX which will probably be faster and not even more -complicated once you know how this works. -

-
-

-For this example we've created two classes: ProjectTeam and ProjectMember -(found in xml-fop/examples/embedding/java/embedding/model). They represent -the same data structure found in -xml-fop/examples/embedding/xml/xml/projectteam.xml. We want to serialize a -project team with several members which exist as Java objects to XML. -Therefore we created the two classes: ProjectTeamInputSource and -ProjectTeamXMLReader (in the same place as ProjectTeam above). -

-

-The XMLReader implementation (regard it as a special kind of XML parser)is -responsible for creating SAX events from the Java object. The InputSource -class is only used to hold the ProjectTeam object to be used. -

-

-Have a look at the source of ExampleObj2XML.java to find out how this is -used. For more detailed information see other resources on JAXP (ex. -An older JAXP tutorial). -

-
-
- ExampleObj2PDF.java -

This example - - (current 0.20.5) - - (future 1.0dev) -combines the previous and the third to demonstrate -how you can transform a Java object to a PDF directly in one smooth run -by generating SAX events from the Java object that get fed to an XSL -transformation. The result of the transformation is then converted to PDF -using FOP as before. -

-
-
-
- ExampleDOM2PDF.java -

This example - - (current 0.20.5) - - (future 1.0dev) -has FOP use a DOMSource instead of a StreamSource in order to -use a DOM tree as input for an XSL transformation. -

-
-
- ExampleSVG2PDF.java (PDF Transcoder example) -

This example - - (applies to 0.20.5 and future 1.0dev) -shows use of the PDF Transcoder, a sub-application within FOP. -It is used to generate a PDF document from an SVG file. -

-
-
- Final notes -

-These examples should give you an idea of what's possible. It should be easy -to adjust these examples to your needs. Also, if you have other examples that you -think should be added here, please let us know via either the FOP-USER or FOP-DEV -mailing lists. Finally, for more help please send your questions to the FOP-USER -mailing list. -

-
-
- - - diff --git a/src/documentation/content/xdocs/0.20.5/graphics.xml b/src/documentation/content/xdocs/0.20.5/graphics.xml deleted file mode 100644 index fe0a63a8e..000000000 --- a/src/documentation/content/xdocs/0.20.5/graphics.xml +++ /dev/null @@ -1,289 +0,0 @@ - - - - - -
- FOP: Graphics Formats - $Revision$ -
- -
- Overview of Graphics Support -

- The table below summarizes the theoretical support for graphical formats within FOP. In other words, within the constraints of the limitations listed here, these formats should work. However, many of them have not been tested, and there may be limitations that have not yet been discovered or documented. The packages needed to support some formats are not included in the FOP distribution and must be installed separately. Follow the links in the "Support Thru" column for more details. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FormatTypeSupport Thru
BMP (Microsoft Windows Bitmap)bitmapFOP native
EPS (Encapsulated PostScript)metafile (both bitmap and vector), probably most frequently used for vector drawingsFOP native (limited support, see restrictions below)
GIF (Graphics Interchange Format)bitmapFOP native
JPEG (Joint Photographic Experts Group)bitmapFOP native
PNG (Portable Network Graphic)bitmapJIMI or JAI
SVG (Scalable Vector Graphics)vector (with embedded bitmaps)Batik
TIFF (Tag Image Format File)bitmapFOP native or JAI, depending on the subformat. See TIFF for more details.(JIMI also supports TIFF, but this has not been implemented within FOP).
-
-
- Graphics Packages -
- FOP Native -

- FOP has native ability to handle some graphic file formats. -

-
-
- JIMI -

- Because of licensing issues, the JIMI image library is not included in the FOP distribution. First, download and install it. -Then, copy the file "JimiProClasses.zip" from the archive to {fop-install-dir}/lib/jimi-1.0.jar. Please note that FOP binary distributions are compiled with JIMI support, so there is no need for you to build FOP to add the support. If jimi-1.0.jar is installed in the right place, it will automatically be used by FOP, otherwise it will not. -

-
-
- JAI (Java Advanced Imaging API) - JAI support is available for Release 0.20.5 and later. The comments in this section do not apply to releases earlier than 0.20.5. -

- FOP has been compiled with JAI support, but JAI is not included in the FOP distribution. -To use it, install JAI, then copy the jai_core.jar and the jai_codec.jar files to {fop-install-dir}/lib. -JAI is much faster than JIMI, but is not available for all platforms. See What platforms are supported? on the JAI FAQ page for more details. -

-
-
- Batik -

Current FOP distributions include a distribution of the Apache Software Foundation's Batik version 1.5beta4. -It is automatically installed with FOP. -Because Batik's API changes frequently, it is highly recommended that you use the version that ships with FOP, at least when running FOP.

- Batik must be run in a graphical environment. -

Batik must be run in a graphical environment. -It uses AWT classes for rendering SVG, which in turn require an X server on Unixish systems. -If you run a server without X, or if you can't connect to the X server due to security restrictions or policies (a so-called "headless" environment), SVG rendering will fail.

-

Here are some workarounds:

-
    -
  • If you are using JDK 1.4, start it with the -Djava.awt.headless=true command line option.
    • -
  • Install an X server which provides an in-memory framebuffer without actually using a screen device or any display hardware. One example is Xvfb.
    • -
  • Install a toolkit which emulates AWT without the need for an underlying X server. One example is the PJA toolkit, which is free and comes with detailed installation instructions.
    • -
-
-
-
- BMP -

FOP native support for BMP images is limited to the RGB color-space.

-
-
- EPS -

FOP provides support for two output targets:

-
    -
  • PostScript (full support).
    • -
  • - PDF (partial support). Due to the lack of a built-in PostScript interpreter, FOP - can only embed the EPS file into the PDF. Acrobat Reader will not currently display - the EPS (it doesn't have a PostScript interpreter, either) but it will be shown - correctly when you print the PDF on a PostScript-capable printer. PostScript devices - (including GhostScript) will render the EPS correctly. -
    • -
-

- Other output targets can't be supported at the moment because - FOP lacks a PostScript interpreter. -

-
-
- JPEG -

FOP native support of JPEG does not include all variants, especially those containing unusual color lookup tables and color profiles. -If you have trouble with a JPEG image in FOP, try opening it with an image processing program (such as Photoshop or Gimp) and then saving it. -Specifying 24-bit color output may also help. -For the PDF and PostScript renderers most JPEG images can be passed through without decompression. -User reports indicate that grayscale, RGB, and CMYK color-spaces are all rendered properly. -

-
-
- PNG -

If using JAI for PNG support, only RGB and RGBA color-spaces are supported for FOP rendering.

-
-
- SVG -
- Introduction -

FOP uses Batik for SVG support. -This format can be handled as an fo:instream-foreign-object or in a separate -file referenced with fo:external-graphic.

- -Batik's SVG Rasterizer utility may also be used to convert standalone SVG -documents into PDF. For more information please see the -SVG Rasterizer documentation -on the Batik site. - -
-
- Placing SVG Graphics into PDF -

-The SVG is rendered into PDF by using PDF commands to draw and fill -lines and curves. This means that the graphical objects created with -this remain as vector graphics. -

-

-There are a number of SVG things that cannot be converted directly into -PDF. Parts of the graphic such as effects, patterns and images are inserted -into the PDF as a raster graphic. The resolution of this graphic may not -be ideal depending on the FOP dpi (72dpi) and the scaling for that graphic. -We hope to improve this in the future.

-

-Currently transparency is not supported in PDF so many svg images that -contain effects or graphics with transparent areas will not be displayed -correctly. -

-
-
- Placing SVG Text into PDF -

If possible, Batik will use normal PDF text when inserting text. It does -this by checking if the text can be drawn normally and the font is -supported. This example svg text.svg / -text.pdf -shows how various types and effects with text are handled. -Note that tspan and outlined text are not yet implemented.

-

-Otherwise, text is converted and drawn as a set of shapes by batik, using the stroking text painter. -This means that a typical character will -have about 10 curves (each curve consists of at least 20 characters). -This can make the pdf files large and when the pdf is viewed the -viewer does not normally draw those fine curves very well (turning on -Smooth Line Art in the Acrobat preferences will fix this). -If the text is inserted into the PDF using the inbuilt text commands -for PDF it will use a single character. -

-

-For PDF output, there is a configuration option to force SVG text to be rendered as text. -The drawback to this approach is that it is effective only for available fonts (including embedded fonts). -Font sizes are rounded to the next integer point size. -This will be improved in the future. -

-

Note that because SVG text can be rendered as either text or a vector graphic, you may need to consider settings in your viewer for both. -The Acrobat viewer has both "smooth line art" and "smooth text" settings that may need to be set for SVG images to be displayed nicely on your screen (see Edit / Preferences / Display). -This setting will not affect the printing of your document, which should be OK in any case, but will only affect the quality of the screen display.

-
-
- Scaling -

Currently, SVG images are rendered with the dimensions specified in the SVG file, within the viewport specified in the fo:external-graphic element. -For everything to work properly, the two should be equal. -The SVG standard leaves this issue as an implementation detail. -FOP will probably implement a scaling mechanism in the future.

-
-
- Known Problems -
    -
  • -soft mask transparency is combined with white so that it looks better -on pdf 1.3 viewers but this causes the soft mask to be slightly lighter -or darker on pdf 1.4 viewers -
    • -
  • -there is some problem with a gradient inside a pattern causing a pdf -error when viewed in acrobat 5 -
    • -
  • -text is not always handled correctly, it may select the wrong font -especially if characters have multiple fonts in the font list -
    • -
  • -more pdf text handling could be implemented -It could draw the string using the attributed character iterator -to handle tspans and other simple changes of text. -
    • -
  • -JPEG images are not inserted directly into the pdf document -This area has not been implemented yet since the appropriate -method in batik is static -
    • -
  • -Uniform transparency for images and other svg elements that are converted -into a raster graphic are not drawn properly in PDF. The image is opaque. -
    • -
-
-
-
- TIFF -

FOP-native TIFF support is limited to PDF and PostScript output only. Also, according to user reports, FOP's native support for TIFF is limited to images with the following characteristics (all must be true for successful rendering):

-
    -
  • single channel images (i.e., bi-level and grayscale only)
    • -
  • uncompressed images, or images using CCITT T.4, CCITT T.6, or JPEG compression
    • -
  • images using white-is-zero encoding in the TIFF PhotometricInterpretation tag
    • -
-

JAI: Supports RGB and RGBA only for FOP rendering.

-
-
- Graphics Resolution -

Some bitmapped image file formats store a dots-per-inch (dpi) or other resolution value. Since PDF and most output formats do not have a concept of resolution, but only of absolute image units (i.e. pixels) FOP ignores the resolution values as well. Instead, FOP uses the dimensions of the image as specified in the fo:external-graphic element to render the image:

-
    -
  • If no dimensions are given, FOP uses a default value of 72 dpi to compute the graphic's dimensions. For example, suppose a graphic 300 pixels wide and 400 pixels high. FOP will render the graphic at 4.167 inches wide, 5.555 inches high, with an apparent resolution of 72 dpi.
    • -
  • If only one dimension is given, FOP by default uses the same aspect ratio to compute the other dimension (to avoid the appearance of stretching). For example, suppose a graphic 300 pixels wide and 400 pixels high, for which content-width = ".5in". FOP will compute the content-height = .667 inches, and will render the graphic at that size, with an apparent resolution of 600 dpi.
    • -
  • If both dimensions are given, FOP simply renders the image in that space. For example, suppose a graphic 300 pixels wide and 400 pixels high, for which content-width = "3in" and content-height = "4in". FOP will render the graphic at that size, with an apparent resolution of 100 dpi.
    • -
-

If you need a higher apparent output resolution for bitmapped images, first make sure that at least one dimension of the image is defined in your XSL-FO input. Apart from that, resolution problems are in the image file itself, and must be corrected there: use or create a higher-resolution image file.

- The explanation above describes only the basic default behavior. There are other attributes of the fo:external-graphic element that can affect the behavior described above. -
-
- Image caching -

- FOP caches images between runs. The URL is used as a key to identify images which means that when - a particular URL appears again, the image is taken from the cache. If you have a servlet that - generates a different image each time it is called with the same URL you need to use a constantly - changing dummy parameter on the URL to avoid caching. -

-

- Currently, the images are not automatically released when an OutOfMemoryError is imminent. The - image cache can grow to a considerable size over time when a lot of different URLs are in use. - Starting with version 0.20.5 you can call org.apache.fop.image.FopImageFactory.resetCache() - to manually empty the cache. Image caching will be improved as part of our redesign effort. -

-
- - diff --git a/src/documentation/content/xdocs/0.20.5/output.xml b/src/documentation/content/xdocs/0.20.5/output.xml deleted file mode 100644 index 577e51b04..000000000 --- a/src/documentation/content/xdocs/0.20.5/output.xml +++ /dev/null @@ -1,329 +0,0 @@ - - - - - - - -
- FOP Output Options - $Revision$ - - - - -
- - -

-FOP supports multiple output formats by using a different renderer for each format. -The renderers do not all have the same set of capabilities, sometimes because of the output format itself, sometimes because some renderers get more development attention than others. -

-
- General Information -
- Fonts -

-Most FOP renderers use a FOP-specific system for font registration. -However, the AWT and print renderers use the java awt package, which gets its font information from the operating system registration. -This can result in several differences, including actually using different fonts, and having different font metrics for the same font. -The net effect is that the layout of a given FO document can be quite different between renderers that do not use the same font information. -

-
-
- Output to a Printer or Other Device -

-The most obvious way to print your document is to use the FOP print renderer, which uses the Java API (AWT). -However, you can also send output from the Postscript renderer directly to a Postscript device, or output from the PCL renderer directly to a PCL device. -

-

-Here are Windows command-line examples for Postscript and PCL: -

- - -

-Here is some Java code to accomplish the task in UNIX: -

- -

-Set the OutputStream (out) to the PCLRenderer and it happily sends the -PCL to the UNIX printer queue. -

-
-
-
- PDF -

-PDF is the best supported output format. It is also the most accurate -with text and layout. This creates a PDF document that is streamed out -as each page is rendered. This means that the internal page index -information is stored near the end of the document. -The PDF version supported is 1.3 which is currently the most popular -version for Acrobat Reader (4.0), PDF versions are forwards/backwards -compatible. -

-

Note that FOP does not currently support "tagged pdf".

-
- Fonts -

- PDF has a set of fonts that are always available to all PDF viewers, - to quote from the PDF Specification: - -"PDF prescribes a set of 14 standard fonts that can be used without prior -definition. -These include four faces each of three Latin text typefaces (Courier, -Helvetica, and Times), as well as two symbolic fonts (Symbol and ITC Zapf -Dingbats). These fonts, or suitable substitute fonts with the same metrics, are -guaranteed to be available in all PDF viewer applications." -

-
-
- Post-processing -

FOP does not currently support several desirable PDF features: document properties (title, author, etc.), and watermarks. One workaround is to use Adobe Acrobat (the full version, not the Reader) to process the file manually or with scripting that it supports.

-

Another popular post-processing tool is iText, which has tools for adding security features, document properties, watermarks, and many other features to PDF files. -

- - Caveat: iText may swallow PDF bookmarks. But - Jens Stavnstrup tells us - that this doesn't happen if you use iText's PDFStamper. - -

Here is some sample code that uses iText to encrypt a FOP-generated PDF. (Note that FOP now supports PDF encryption. However the principles for using iText for other PDF features are similar.)

- -

Check the iText tutorial and documentation for setting access flags, password, encryption strength and other parameters. -

-
-
- Watermarks -

- In addition to the PDF Post-processing options, consider the following workarounds: -

-
    -
  • - Use a background image for the body region. -
    • -
  • - (submitted by Trevor_Campbell@kaz.com.au) Place an image in a - region that overlaps the flowing text. For example, make - region-before large enough to contain your image. Then include a - block (if necessary, use an absolutely positioned block-container) - containing the watermark image in the static-content for the - region-before. Note that the image will be drawn on top of the - normal content. -
    • -
-
-
-
- PCL -

-This format is for the Hewlett-Packard PCL printers. -It should produce output as close to identical as possible to the -printed output of the PDFRenderer within the limitations of the -renderer, and output device. -

-

-The output created by the PCLRenderer is generic PCL 5 as documented -in the "HP PCL 5 Printer Language Technical Reference Manual" (copyright 1990). -This should allow any device fully supporting PCL 5 to be able to -print the output generated by the PCLRenderer. -

-
- Limitations -
    -
  • Text or graphics outside the left or top of the printable area are not rendered properly. In general things that should print to the left of the printable area are shifted to the right so that they start at the left edge of the printable area and an error message is generated.
    • -
  • The Helvetica and Times fonts are not well supported among PCL printers so Helvetica is mapped to Arial and Times is mapped to Times New. This is done in the PCLRenderer, no changes are required in the FO's. The metrics and appearance for Helvetica/Arial and Times/Times New are nearly identical, so this has not been a problem so far.
    • -
  • Only the original fonts built into FOP are supported.
    • -
  • For the non-symbol fonts, the ISO 8859/1 symbol set is used (PCL set "0N").
    • -
  • Multibyte characters are not supported.
    • -
  • SVG is not supported.
    • -
  • Images print black and white only (not dithered). When the renderer prints a color image it uses a threshold value, colors above the threshold are printed as white and below are black. If you need to print a non-monochrome image you should dither it first.
    • -
  • Image scaling is accomplished by modifying the effective resolution of the image data. The available resolutions are 75, 100, 150, 300, and 600 DPI.
    • -
  • Color printing is not supported. Colors are rendered by mapping the color intensity to one of the PCL fill shades (from white to black in 9 steps).
    • -
-
- -
- Additional Features -

There are some special features that are controlled by some public variables on the PCLRenderer class.

- -
-
orientation
-
The logical page orientation is controlled by the public orientation variable. Legal values are: - -
-
curdiv, paperheight
-
The curdiv and paperheight variables allow multiple virtual pages to be printed on a piece of paper. This allows a standard laser printer to use perforated paper where every perforation will represent an individual page. The paperheight sets the height of a piece of paper in decipoints. This will be divided by the page.getHeight() to determine the number of equal sized divisions (pages) that will fit on the paper. The curdiv variable may be read/written to get/set the current division on the page (to set the starting division and read the ending division for multiple invocations).
-
topmargin, leftmargin
-
The topmargin and leftmargin may be used to increase the top and left margins for printing.
-
-
-
-
- PostScript -

-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. -

-
- Limitations -
    -
  • 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.
    • -
-
-
-
- RTF -

-This is currently not integrated with FOP but it will soon. -This will create an rtf (rich text format) document that will -attempt to contain as much information from the fo document as -possible. -

-
-
- SVG -

-This format creates an SVG document that has links between the pages. -This is primarily for slides and creating svg images of pages. -Large documents will create SVG files that are far too large for -and SVG viewer to handle. Since fo documents usually have text the -SVG document will have a large number of text elements. -The font information for the text is obtained from the jvm in the -same way as the AWT viewer, if the svg is view where the fonts are -different, such as another platform, then the page will appear wrong. -

-
-
- XML -

-This is for testing and verification. The XML created is simply -a representation of the internal area tree put into XML. It does -not perform any other purpose. -

-
-
- Print -

-It is possible to directly print the document from the command line. -This is done with the same code that renders to the AWT renderer. -

-
-
- AWT -

-The AWT viewer shows a window with the pages displayed inside a -java graphic. It displays one page at a time. -The fonts used for the formatting and viewing depend on the fonts -available to your JRE. -

-
-
- MIF -

-This format is the Maker Interchange Format which is used by -Adobe Framemaker. This is currently not fully implemented. -

-
-
- TXT -

-The text renderer produces plain ASCII text output -that attempts to match the output of the PDFRenderer as closely as -possible. This was originally developed to accommodate an archive system -that could only accept plain text files, and is primarily useful for getting -a quick-and-dirty view of the document text. The renderer is very limited, -so do not be surprised if it gives unsatisfactory results. -

-

-The Text renderer works with a fixed size page buffer. The size of this -buffer is controlled with the textCPI and textLPI public variables. -The textCPI is the effective horizontal characters per inch to use. -The textLPI is the vertical lines per inch to use. From these values -and the page width and height the size of the buffer is calculated. -The formatting objects to be rendered are then mapped to this grid. -Graphic elements (lines, borders, etc) are assigned a lower priority -than text, so text will overwrite any graphic element representations. -

-

Because FOP lays the text onto a grid during layout, there are frequently extra or missing spaces between characters and lines, which is generally unsatisfactory. -Users have reported that the optimal settings to avoid such spacing problems are:

-
    -
  • font-family="Courier"
    • -
  • font-size="7.3pt"
    • -
  • line-height="10.5pt"
    • -
-
- - - - diff --git a/src/documentation/content/xdocs/0.20.5/running.xml b/src/documentation/content/xdocs/0.20.5/running.xml deleted file mode 100644 index 0432735f6..000000000 --- a/src/documentation/content/xdocs/0.20.5/running.xml +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - -
- Running FOP - $Revision$ -
- - -
- System Requirements -

The following software must be installed:

-
    -
  • Java 1.2.x or later Runtime Environment.
    • -
  • FOP. The FOP distribution includes all libraries that you will need to run a basic FOP installation. These can be found in the xml-fop/lib directory. These libraries include the following: -
      -
    • Apache Xerces-J for XML parsing. You can use other XML parsers which support SAX and DOM.
      • -
    • Apache Xalan-J, an XSLT processor.
      • -
    • Apache Batik, an SVG library.
      • -
    -
    • -
-

The following software is optional, depending on your needs:

-
    -
  • Graphics libraries. Support for some graphics formats requires additional packages. See FOP: Graphics Formats for details.
    • -
  • PDF encryption. See FOP: PDF Encryption for details.
    • -
-

In addition, the following system requirements apply:

-
    -
  • If you will be using FOP to process SVG, you must do so in a graphical environment. See FOP: Graphics (Batik) for details.
    • -
-
-
- Installation -
- Instructions -

Basic FOP installation consists of first unzipping the .gz file that is the distribution medium, then unarchiving the resulting .tar file in a directory/folder that is convenient on your system. Please consult your operating system documentation or Zip application software documentation for instructions specific to your site.

-
-
- Problems -

Some Mac OSX users have experienced filename truncation problems using Stuffit to unzip and unarchive their distribution media. This is a legacy of older Mac operating systems, which had a 31-character pathname limit. Several Mac OSX users have recommended that Mac OSX users use the shell command tar -xzf instead.

-
-
-
- Starting FOP as a Standalone Application -

The usual and recommended practice for starting FOP from the command line is to run the batch file fop.bat (Windows) or the shell script fop.sh (Unix/Linux). -If you write your own scripts, be sure to review these standard scripts to make sure that you get your environment properly configured.

-

The standard scripts for starting FOP require that the environment variable JAVA_HOME be set to a path pointing to the appropriate Java installation on your system. Macintosh OSX includes a Java environment as part of its distribution. We are told by Mac OSX users that the path to use in this case is /Library/Java/Home. Caveat: We suspect that, as Apple releases new Java environments and as FOP upgrades the minimum Java requirements, the two will inevitably not match on some systems. Please see Java on Mac OSX FAQ for information as it becomes available.

-

fop [options] [-fo|-xml] infile [-xsl file] [-awt|-pdf|-mif|-pcl|-ps|-txt|-svg|-at|-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 - -s (-at output) omit tree below block areas - -txt.encoding (-txt output encoding use the encoding for the output file. - The encoding must be a valid java encoding. - -o [password] pdf file will be encrypted with option owner password - -u [password] pdf file will be encrypted with option user password - -noprint pdf file will be encrypted without printing permission - -nocopy pdf file will be encrypted without copy content permission - -noedit pdf file will be encrypted without edit content permission - -noannotations pdf file will be encrypted without edit annotation permission -

[INPUT]

- infile XSLFO 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) - -ps outfile input will be rendered as PostScript file (outfile req'd) - -txt outfile input will be rendered as text file (outfile req'd) - -svg outfile input will be rendered as an svg slides file (outfile req'd) - -at outfile representation of area tree as XML (outfile req'd) - -print input file will be rendered and sent to the printer - see print specific 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 -

PDF encryption is only available if FOP was compiled with encryption support and if compatible encryption support is availabe at run time. Currently, only the JCE is supported. Check the Details.

-
-
- Using Xalan to Check XSL-FO Input -

FOP sessions that use -xml and -xsl input instead of -fo input are actually controlling two distinct conversions: Tranforming XML to XSL-FO, then formatting the XSL-FO to PDF (or another FOP output format). -Although FOP controls both of these processes, the first is included merely as a convenience and for performance reasons. -Only the second is part of FOP's core processing. -If a user has a problem running FOP, it is important to determine which of these two processes is causing the problem. -If the problem is in the first process, the user's stylesheet is likely the cause. -The FOP development team does not have resources to help with stylesheet issues, although we have included links to some useful Specifications and Books/Articles. -If the problem is in the second process, FOP may have a bug or an unimplemented feature that does require attention from the FOP development team.

- The user is always responsible to provide correct XSL-FO code to FOP. -

In the case of using -xml and -xsl input, although the user is responsible for the XSL-FO code that is FOP's input, it is not visible to the user. To make the intermediate FO file visible, the FOP distribution includes xalan.bat (Windows batch file) and xalan.sh (Unix/Linux script), which run only the first (transformation) step, and write the results to a file.

- When asking for help on the FOP mailing lists, never attach XML and XSL to illustrate the issue. Always run the xalan script and send the resulting XSL-FO file instead. Of course, be sure that the XSL-FO file is correct before sending it. -

- The scripts are invoked the same way that Xalan is: -

-

- xalan -in xmlfile -xsl file -out outfile -

-

- Note that there are some subtle differences between the "fop" and "xalan" command lines. -

-
-
- Memory Usage -

-FOP can consume quite a bit of memory, even though this has been continually improved. -This is partly inherent to the formatting process and partly caused by implementation choices. -All FO processors currently on the market have memory problems with certain layouts. -

-

-If you are running out of memory when using FOP, here are some ideas that may help: -

-
    -
  • -Increase memory available to the JVM. See the -Xmx option for more information. - -(Warning: It is usually unwise to increase the memory allocated to the JVM beyond the amount of physical RAM, as this will generally cause significantly slower performance.) - -
    • -
  • -Avoid forward references. -Forward references are references to some later part of a document. -Examples include page number citations which refer to pages which follow the citation, tables of contents at the beginning of a document, and page numbering schemes that include the total number of pages in the document ("page N of TOTAL"). -Forward references cause all subsequent pages to be held in memory until the reference can be resolved, i.e. until the page with the referenced element is encountered. -Forward references may be required by the task, but if you are getting a memory overflow, at least consider the possibility of eliminating them. -A table of contents could be replaced by PDF bookmarks instead or moved to the end of the document (reshuffle the paper could after printing). -
    • -
  • -Avoid large images, especially if they are scaled down. -If they need to be scaled, scale them in another application upstream from FOP. -For many image formats, memory consumption is driven mainly by the size of the image file itself, not its dimensions (width*height), so increasing the compression rate may help. -If FOP is running embedded, clearing the image from time to time cache might prevent memory exhaustion, you can call -org.apache.fop.image.FopImageFactory.resetCache() to empty the -image cache. -
    • -
  • -Use multiple page sequences. -FOP starts rendering after the end of a page sequence is encountered. -While the actual rendering is done page-by-page, some additional memory is freed after the page sequence has been rendered. -This can be substantial if the page sequence contains lots of FO elements. -
    • -
-

-There are currently some bugs which cause FOP to go into a nonterminating loop, which will also often result in a memory overflow. -A characteristic symptom is continuous box overflows in the log. -Most of these loops are triggered by elements that do not fit in the available space, such as big images or an improperly specified width in nested block elements. -The only workaround is to locate such problems and correct them. -

-

-One of FOP's stated design goals is to be able to process input of arbitrary size. -Addressing this goal is one of the prime motivations behind the FOP Redesign. -

-
-
- Problems -

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

-
- - diff --git a/src/documentation/content/xdocs/0.93/configuration.xml b/src/documentation/content/xdocs/0.93/configuration.xml index c40a64de5..ed96c3eb7 100644 --- a/src/documentation/content/xdocs/0.93/configuration.xml +++ b/src/documentation/content/xdocs/0.93/configuration.xml @@ -290,10 +290,10 @@ -
- When it does not work +
+ When it does not work -

FOP searches the configuration file for the information it +

FOP searches the configuration file for the information it expects, at the position it expects. When that information is not present, FOP will not complain, it will just continue. When there is other information in the file, FOP will not complain, it will just @@ -301,14 +301,14 @@ ignore it. That means that when your configuration information is in the file but in a different XML element, or in a different XML path, than FOP expects, it will be silently ignored.

-

Check the following possibilities:

+

Check the following possibilities:

-
    -
  • The format of the configuration file has changed +
      +
    • The format of the configuration file has changed considerably between FOP 0.20.5 and FOP 1.0 and its beta versions. Did you convert your file to the new format?
      • -
    • The FOP distribution contains a schema for configuration +
    • The FOP distribution contains a schema for configuration files, at src/foschema/fop-configuration.xsd. Did you validate your configuration file against it? Add the following schema location to the schema element: @@ -323,13 +323,13 @@ and run the configuration file through a validating schema parser. Note that the schema cannot detect all errors, and that it is stricter about the order of some elements than FOP itself is.
      • -
    • Run FOP in debug mode (command line option +
    • Run FOP in debug mode (command line option -d). This makes FOP report which configuration information it finds. Check if FOP finds what you expect.
      • -
    +
-
+
diff --git a/src/documentation/content/xdocs/0.93/running.xml b/src/documentation/content/xdocs/0.93/running.xml index 492c55ca1..3e852ea98 100644 --- a/src/documentation/content/xdocs/0.93/running.xml +++ b/src/documentation/content/xdocs/0.93/running.xml @@ -212,35 +212,35 @@ Fop [options] [-fo|-xml] infile [-xsl file] [-awt|-pdf|-mif|-rtf|-tiff|-png|-pcl directory in a single directory. If you use hyphenation, you must also put fop-hyph.jar in that directory.

-

In both cases the arguments consist of the options and +

In both cases the arguments consist of the options and infile and outfile specifications as shown above for the standard scripts.

- FOP's dynamical classpath construction + FOP's dynamical classpath construction -

If FOP is started without a proper classpath, it tries to - add its dependencies dynamically. FOP uses the current working - directory as the base directory for its search. If the base - directory is called build, then its parent - directory becomes the base directory.

+

If FOP is started without a proper classpath, it tries to + add its dependencies dynamically. FOP uses the current working + directory as the base directory for its search. If the base + directory is called build, then its parent + directory becomes the base directory.

FOP expects to find fop.jar in the - build subdirectory of the base directory, and - adds it to the classpath. Subsequently FOP adds all - jar files in the lib directory to the - classpath. The lib directory is either the lib - subdirectory of the base directory, or, if that does not - exist, the base directory itself.

+ build subdirectory of the base directory, and + adds it to the classpath. Subsequently FOP adds all + jar files in the lib directory to the + classpath. The lib directory is either the lib + subdirectory of the base directory, or, if that does not + exist, the base directory itself.

If the system property fop.optional.lib - contains the name of a directory, then all jar - files in that directory are also added to the classpath. See - the methods getJARList and - checkDependencies in - org.apache.fop.cli.Main.

+ contains the name of a directory, then all jar + files in that directory are also added to the classpath. See + the methods getJARList and + checkDependencies in + org.apache.fop.cli.Main.

-
+
Using Xalan to Check XSL-FO Input diff --git a/src/documentation/content/xdocs/0.93/upgrading.xml b/src/documentation/content/xdocs/0.93/upgrading.xml index 46c9cff3b..0f04e63b2 100644 --- a/src/documentation/content/xdocs/0.93/upgrading.xml +++ b/src/documentation/content/xdocs/0.93/upgrading.xml @@ -51,7 +51,7 @@ an example configuration file. A XML Schema file can be found under src/foschema/fop-configuration.xsd. -
  • +
  • If you are using font metrics files for version 0.20.5 or 0.92 or earlier, you have to regenerate them in the new format. The new format is characterized by a version diff --git a/src/documentation/content/xdocs/0.20.5/anttask.xml b/src/documentation/content/xdocs/0.94/anttask.xml similarity index 70% rename from src/documentation/content/xdocs/0.20.5/anttask.xml rename to src/documentation/content/xdocs/0.94/anttask.xml index 9bc3c59ee..44550c3d7 100644 --- a/src/documentation/content/xdocs/0.20.5/anttask.xml +++ b/src/documentation/content/xdocs/0.94/anttask.xml @@ -16,9 +16,7 @@ limitations under the License. --> - - +
    Ant task @@ -26,29 +24,36 @@

    - FOP provides an Ant task for automating the document build process.

    -
    Description -

    - The FOP Ant task will convert XSL-FO documents to PDF/PS/PCL/MIF/RTF output - (see Output formats for available formats).

    -

    - To call FOP tasks within Ant, first add a FOP task definition to your Ant build file. - One method of defining the task is as follows: -

    - + Apache FOP provides an Ant task for automating the document build process. +

    +
    + Description +

    + The FOP Ant task will convert XSL-FO documents to PDF, PS, PCL etc. output + (see Output formats for available formats). +

    +

    + To call FOP tasks within Ant, first add a FOP task definition to your Ant build file. + One method of defining the task is as follows: +

    + - - - - - + + + + + + + + + - ]]> + ]]>

    - Then create FOP tasks within your Ant build file, using the FOP task parameters listed below.

    + Then create FOP tasks within your Ant build file, using the FOP task parameters listed below.

    Parameters for FOP Ant task @@ -71,13 +76,24 @@ format Possible output formats:
    + application/X-fop-awt-preview
    + application/X-fop-print
    + application/X-fop-areatree
    application/pdf
    application/postscript
    - application/vnd.mif
    - application/rtf
    + application/mif
    + application/rtf, + text/richtext, + text/rtf
    + application/x-pcl, application/vnd.hp-PCL
    + application/x-afp, + application/vnd.ibm.modcap
    text/plain
    - text/xml
    + image/svg+xml
    + image/gif
    + image/png
    + image/tiff
    No, defaults to application/pdf @@ -117,24 +133,24 @@ userconfig - User configuration file (same as the FOP "-c" command line option) + User configuration file (same as the FOP "-c" command line option). No messagelevel Logging level
    - Possible values: error, warn, info, verbose, debug + Possible values: error, warn, info, verbose, debug. Currently doesn't work in FOP Trunk!!! No, defaults to verbose logFiles Controls whether the names of the files that are processed are logged - (true) or not (false) + (true) or not (false). Currently doesn't work in FOP Trunk!!! No, default is true -

    - +

    +

    Parameters specified as nested elements
    @@ -142,11 +158,11 @@ - + -
    Parameters specified as nested elements
    Attribute Description
    filesetFileSets - are used to specify multiple XSL-FO files to be rendered.FileSets + are used to specify multiple XSL-FO files to be rendered. Yes, if no fofile attribute is supplied
    +

    Examples diff --git a/src/documentation/content/xdocs/0.94/compiling.xml b/src/documentation/content/xdocs/0.94/compiling.xml new file mode 100644 index 000000000..c6c17a3c0 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/compiling.xml @@ -0,0 +1,141 @@ + + + + + +
    + Apache FOP: Building from Source Code + $Revision$ +
    + +
    + Do You Need To Build? +

    + FOP distributions are either pre-compiled binary or source. + If you are using a binary distribution, it is already built and there is no need to build it again. + See the Download Instructions for information about whether a + binary or source distribution is best for your needs. +

    +

    + If you got the source code from a repository snapshot or via Subversion you will need to build FOP + in any case. +

    +
    +
    + Set Up Your Environment +
    + JDK +

    + Building FOP requires a minimum Java Development Kit (JDK/SDK) of 1.3 + (A Java Runtime Environment is not sufficient). +

    +
    +
    + CLASSPATH +

    + There is generally no need to setup a classpath. All libraries needed to compile FOP are included + in the source distribution and are referenced by the build script. + You will only need to adjust the classpath if you build FOP in some other way. See the build + script build.xml for details. +

    +
    +
    + JAVA_HOME +

    + The build script uses Apache Ant, a popular + Java-based build tool, which usually requires that the environment variable JAVA_HOME point to + your local JDK root directory. This is true even if you use JDK 1.3 or above, which normally + does not need this setting. +

    +
    +
    + Apache Ant +

    + Apache Ant must be installed in order to + build FOP. Following best practices we don't include Ant with FOP anymore. You can find the + instructions to install Ant in the Ant manual on the web. +

    +
    +
    +
    + Run the Build Script +

    + Change to the FOP root directory and build FOP by executing the build script (build.xml) + using the "ant" command. +

    + + The "ant" command is only available on your system if you've properly + installed Apache Ant and added Ant's location to the PATH + environment variable. + +

    + The file build.xml in the FOP root directory is the blueprint that Ant uses for the build. It + contains information for numerous build targets, many of which are building blocks to more + useful target, and others which are primarily used by the FOP developers. + You may benefit from looking through this file to learn more about the various build targets. + To obtain a complete list of useful build targets: +

    + ant -projecthelp +

    The most useful targets are:

    +
      +
    • + package: Generates the JAR files (default). This is the normal build that + produces a jar file usable for running FOP. +
      • +
    • + clean : Cleans the build directory. This is useful for making sure that + any build errors are cleaned up before starting a new build. It should not ordinarily be + needed, but may be helpful if you are having problems with the build process itself. +
      • +
    • + javadocs: Creates the FOP API documentation. + A minimum JDK version of 1.4.2 is required for generating the javadocs. +
      • +
    +

    To run the build:

    + ant [target ...] +

    For example to do a normal build for the "all" target (which is the default):

    + ant +

    OR

    + ant all +

    To clean the build directory first:

    + ant clean all + + If you want to shorten the build time you can just call the "package" target which + doesn't perform any automated tests during the build. + +
    +
    + Troubleshooting +

    If you have problems building FOP, please try the following:

    +
      +
    • Run the build with the target of "clean", then rerun the build.
      • +
    • Delete the build directory completely, then rerun the build.
      • +
    • + Make sure you do not have a non-FOP version of xerces.jar, xalan.jar, batik.jar, + or another dependency product somewhere in your CLASSPATH. +
      • +
    • + If the build still fails, see the Getting Help + page for further help. +
      • +
    +
    + +     + diff --git a/src/documentation/content/xdocs/0.94/configuration.xml b/src/documentation/content/xdocs/0.94/configuration.xml new file mode 100644 index 000000000..656c3b706 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/configuration.xml @@ -0,0 +1,385 @@ + + + + + +
    + Apache FOP: Configuration + $Revision$ +
    + + +
    + Configuration File Basics +

    + The FOP configuration file is an XML file containing a variety of settings that are useful + for controlling FOP's behavior, and for helping it find resources that you wish it to use. +

    +

    + The easiest way to get started using a FOP configuration file is to copy the sample found + at {fop-dir}/conf/fop.xconf to a location of your choice, and then to + edit it according to your needs. + It contains templates for the various configuration options, most of which are commented + out. Remove the comments and change the settings for entries that you wish to use. + Be sure to follow any instructions, including comments which specify the value range. + Also, since the configuration file is XML, be sure to keep it well-formed. +

    +
    + Making Configuration Available to FOP +

    After creating your configuration file, you must tell FOP how to find it:

    + +

    + See Setting the Configuration Programmatically + for instructions on how to do so in an embedded environment. +

    +
    +
    +
    + Summary of the General Configuration Options + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ElementData Type (for the value)DescriptionDefault Value
    baseURL or directorySpecifies the base URL based on which relative URL will be resolved.current directory
    font-baseURL or directorySpecifies the base URL based on which relative font URLs will be resolved. + base URL/directory (above)
    hyphenation-baseURL or directorySpecifies the base URL based on which relative URLs to hyphenation pattern + files will be resolved. If not specified, support for user-supplied hyphenation + patterns remains disabled. + disabled
    source-resolutionInteger, dpi + Resolution in dpi (dots per inch) which is used internally to determine the pixel + size for SVG images and bitmap images without resolution information. + 72 dpi
    target-resolutionInteger, dpi + Resolution in dpi (dots per inch) used to specify the output resolution for bitmap + images generated by bitmap renderers (such as the TIFF renderer) and by bitmaps + generated by Apache Batik for filter effects and such. + 72 dpi
    strict-configurationBoolean (true, false) + Setting this option to 'true' will cause FOP to strictly verify the contents of the + FOP configuration file to ensure that defined resources (such as fonts and base + URLs/directories) are valid and available to FOP. Any errors found will cause FOP to + immediately raise an exception.false
    strict-validationBoolean (true, false) + Setting this option to 'false' causes FOP to be more forgiving about XSL-FO validity, + for example, you're allowed to specify a border on a region-body which is supported + by some FO implementations but is non-standard. Note that such a border would + currently have no effect in Apache FOP.true
    break-indent-inheritanceBoolean (true, false) + Setting this option to 'true' causes FOP to use an alternative rule set to determine + text indents specified through margins, start-indent and end-indent. Many commercial + FO implementations have chosen to break the XSL specification in this aspect. This + option tries to mimic their behaviour. Please note that Apache FOP may still not + behave exactly like those implementations either because FOP has not fully matched + the desired behaviour and because the behaviour among the commercial implementations + varies. The default for this option (i.e. false) is to behave exactly like the + specification describes.false
    default-page-settingsn/a + Specifies the default width and height of a page if "auto" is specified + for either or both values. Use "height" and "width" attributes on the + default-page-settings element to specify the two values."height" 11 inches, "width" 8.26 inches
    use-cacheboolean (true, false)All fonts information that has been gathered as a result of "directory" + or "auto-detect" font configurations will be cached for future rendering runs. + This setting should improve performance on systems where + fonts have been configured using the "directory" or "auto-detect" tag mechanisms. + By default this option is switched on.true
    cache-fileStringThis options specifies the file/directory path of the fop cache file. + This option can also be specified on the command-line using the -cache option. + This file is currently only used to cache font triplet information for future reference.${base}/conf/fop.cache
    renderers(see text below)Contains the configuration for each renderer. See below.N/A
    +

    + This is an excerpt from the example configuration file coming with FOP: +

    + + + + true + + + true + + + ./ + + + ./ + + + 72 + + 72 + + + + + +]]> +
    +
    + Renderer configuration +

    + Each Renderer has its own configuration section which is identified by the + MIME type the Renderer is written for, ex. "application/pdf" for the PDF Renderer. +

    +

    + The configuration for the PDF Renderer could look like this: +

    + + + + + flate + + + + + + + + + + + + + + + ]]> +

    + The details on the font configuration can be found on the separate Fonts page. + Note especially the section entitled Register Fonts with FOP. +

    +
    + Special Settings for the PDF Renderer +

    + The configuration element for the PDF renderer contains two elements. One is for the font configuration + (please follow the link above) and one is for the "filter list". The filter list controls how the + individual objects in a PDF file are encoded. By default, all objects get "flate" encoded (i.e. simply + compressed with the same algorithm that is also used in ZIP files). Most users don't need to change that + setting. For debugging purposes, it may be desired not to compress the internal objects at all so the + generated PDF commands can be read. In that case, you can simply use the following filter list. The + second filter list (type="image") ensures that all images still get compressed but also ASCII-85 encoded + so the produced PDF file is still easily readable in a text editor. +

    + + + null + + + flate + ascii-85 + + + ]]> +

    + Another (optional) setting specific to the PDF Renderer is an output color profile, an ICC + color profile which indicates the target color space the PDF file is generated for. This + setting is mainly used in conjunction with the PDF/X feature. + An example: +

    + + C:\FOP\Color\EuropeISOCoatedFOGRA27.icc + + ]]> +
    +
    + Special Settings for the PostScript Renderer +

    + Besides the normal font configuration (the same "fonts" element as for the PDF renderer) the PostScript + renderer has an additional setting to force landscape pages to be rotated to fit on a page inserted into + the printer in portrait mode. Set the value to "true" to activate this feature. The default is "false". + Example: +

    + + true + + + + + + + + + + + + ]]> +
    +
    + Special Settings for the PCL Renderer +

    + Non-standard fonts for the PCL renderer are made available through the Java2D subsystem which means that + you don't have to do any custom font configuration in this case but you have to use the font names + offered by Java. +

    +

    + Additionally, there are certain settings that control how the renderer handles various elements. +

    + + quality + bitmap +]]> +

    + The default value for the "rendering" setting is "speed" which causes borders + to be painted as plain rectangles. In this mode, no special borders (dotted, + dashed etc.) are available. If you want support for all border modes, set the + value to "quality" as indicated above. This will cause the borders to be painted + as bitmaps. +

    +

    + The default value for the "text-rendering" setting is "auto" which paints the + base fonts using PCL fonts. Non-base fonts are painted as bitmaps through Java2D. + If the mix of painting methods results in unwelcome output, you can set this + to "bitmap" which causes all text to be rendered as bitmaps. +

    +
    +
    +
    + Apache FOP Font Config +

    + Apache FOP has special Font configuration considerations, which are explained + in detail on the Fonts page. +

    +
    + +
    + When it does not work + +

    FOP searches the configuration file for the information it +expects, at the position it expects. When that information is not +present, FOP will not complain, it will just continue. When there is +other information in the file, FOP will not complain, it will just +ignore it. That means that when your configuration information is in +the file but in a different XML element, or in a different XML path, +than FOP expects, it will be silently ignored.

    + +

    Check the following possibilities:

    + +
      +
    • The format of the configuration file has changed +considerably between FOP 0.20.5 and FOP 1.0 and its beta versions. Did +you convert your file to the new format?
      • + +
    • The FOP distribution contains a schema for configuration +files, at src/foschema/fop-configuration.xsd. Did you validate your +configuration file against it? Add the following schema location to +the schema element: + +]]> + + +and run the configuration file through a validating schema +parser. Note that the schema cannot detect all errors, and that it is +stricter about the order of some elements than FOP itself is.
      • + +
    • Run FOP in debug mode (command line option +-d). This makes FOP report which configuration +information it finds. Check if FOP finds what you expect.
      • + +
    + +
    + +     + diff --git a/src/documentation/content/xdocs/0.94/embedding.xml b/src/documentation/content/xdocs/0.94/embedding.xml new file mode 100644 index 000000000..3e3c964f8 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/embedding.xml @@ -0,0 +1,689 @@ + + + + + + +
    + Apache FOP: Embedding + How to Embed FOP in a Java application + $Revision$ +
    + + +
    + Overview +

    + Review Running FOP for important information that applies + to embedded applications as well as command-line use, such as options and performance. +

    +

    + To embed Apache FOP in your application, first create a new + org.apache.fop.apps.FopFactory instance. This object can be used to launch multiple + rendering runs. For each run, create a new org.apache.fop.apps.Fop instance through + one of the factory methods of FopFactory. In the method call you specify which output + format (i.e. Renderer) to use and, if the selected renderer requires an OutputStream, + which OutputStream to use for the results of the rendering. You can customize FOP's + behaviour in a rendering run by supplying your own FOUserAgent instance. The + FOUserAgent can, for example, be used to set your own Renderer instance (details + below). Finally, you retrieve a SAX DefaultHandler instance from the Fop object and + use that as the SAXResult of your transformation. +

    + + We recently changed FOP's outer API to what we consider the final API. This might require + some changes in your application. The main reasons for these changes were performance + improvements due to better reuse of reusable objects and reduced use of static variables + for added flexibility in complex environments. + +
    +
    + Basic Usage Pattern +

    + Apache FOP relies heavily on JAXP. It uses SAX events exclusively to receive the XSL-FO + input document. It is therefore a good idea that you know a few things about JAXP (which + is a good skill anyway). Let's look at the basic usage pattern for FOP... +

    +

    Here is the basic pattern to render an XSL-FO file to PDF: +

    + +

    + Let's discuss these 5 steps in detail: +

    +
      +
    • + Step 1: You create a new FopFactory instance. The FopFactory instance holds + references to configuration information and cached data. It's important to reuse this + instance if you plan to render multiple documents during a JVM's lifetime. +
      • +
    • + Step 2: You set up an OutputStream that the generated document + will be written to. It's a good idea to buffer the OutputStream as demonstrated + to improve performance. +
      • +
    • + Step 3: You create a new Fop instance through one of the factory + methods on the FopFactory. You tell the FopFactory what your desired output format + is. This is done by using the MIME type of the desired output format (ex. "application/pdf"). + You can use one of the MimeConstants.* constants. The second parameter is the + OutputStream you've setup up in step 2. +
      • +
    • + Step 4 We recommend that you use JAXP Transformers even + if you don't do XSLT transformations to generate the XSL-FO file. This way + you can always use the same basic pattern. The example here sets up an + "identity transformer" which just passes the input (Source) unchanged to the + output (Result). You don't have to work with a SAXParser if you don't do any + XSLT transformations. +
      • +
    • + Step 5: Here you set up the input and output for the XSLT + transformation. The Source object is set up to load the "myfile.fo" file. + The Result is set up so the output of the XSLT transformation is sent to FOP. + The FO file is sent to FOP in the form of SAX events which is the most efficient + way. Please always avoid saving intermediate results to a file or a memory buffer + because that affects performance negatively. +
      • +
    • + Step 6: Finally, we start the XSLT transformation by starting + the JAXP Transformer. As soon as the JAXP Transformer starts to send its output + to FOP, FOP itself starts its processing in the background. When the + transform() method returns FOP will also have finished converting + the FO file to a PDF file and you can close the OutputStream. + + It's a good idea to enclose the whole conversion in a try..finally statement. If + you close the OutputStream in the finally section, this will make sure that the + OutputStream is properly closed even if an exception occurs during the conversion. + +
      • +
    +

    + If you're not totally familiar with JAXP Transformers, please have a look at the + Embedding examples below. The section contains examples + for all sorts of use cases. If you look at all of them in turn you should be able + to see the patterns in use and the flexibility this approach offers without adding + too much complexity. +

    +

    + This may look complicated at first, but it's really just the combination of an + XSL transformation and a FOP run. It's also easy to comment out the FOP part + for debugging purposes, for example when you're tracking down a bug in your + stylesheet. You can easily write the XSL-FO output from the XSL transformation + to a file to check if that part generates the expected output. An example for that + can be found in the Embedding examples (See "ExampleXML2FO"). +

    +
    + Logging +

    + Logging is now a little different than it was in FOP 0.20.5. We've switched from + Avalon Logging to Jakarta Commons Logging. + While with Avalon Logging the loggers were directly given to FOP, FOP now retrieves + its logger(s) through a statically available LogFactory. This is similar to the + general pattern that you use when you work with Apache Log4J directly, for example. + We call this "static logging" (Commons Logging, Log4J) as opposed to "instance logging" + (Avalon Logging). This has a consequence: You can't give FOP a logger for each + processing run anymore. The log output of multiple, simultaneously running FOP instances + is sent to the same logger. +

    + + We know this may be an issue in multi-threaded server environments if you'd like to + know what's going on in every single FOP processing run. We're planning to add an + additional feedback facility to FOP which can be used to obtain all sorts of specific + feedback (validation messages, layout problems etc.). "Static logging" is mainly + interesting for a developer working on FOP and for advanced users who are debugging + FOP. We don't consider the logging output to be useful to normal FOP users. Please + have some patience until we can add this feature or jump in and help us build it. We've + set up a Wiki page + which documents what we're going to build. + +

    + By default, Jakarta Commons Logging uses + JDK logging (available in JDKs 1.4 or higher) as its backend. You can configure Commons + Logging to use an alternative backend, for example Log4J. Please consult the + documentation for Jakarta Commons Logging on + how to configure alternative backends. +

    +
    + +
    + Processing XSL-FO +

    + Once the Fop instance is set up, call getDefaultHandler() to obtain a SAX + DefaultHandler instance to which you can send the SAX events making up the XSL-FO + document you'd like to render. FOP processing starts as soon as the DefaultHandler's + startDocument() method is called. Processing stops again when the + DefaultHandler's endDocument() method is called. Please refer to the basic + usage pattern shown above to render a simple XSL-FO document. +

    +
    + +
    + Processing XSL-FO generated from XML+XSLT +

    + If you want to process XSL-FO generated from XML using XSLT we recommend + again using standard JAXP to do the XSLT part and piping the generated SAX + events directly through to FOP. The only thing you'd change to do that + on the basic usage pattern above is to set up the Transformer differently: +

    + +
    +
    +
    + Input Sources +

    + The input XSL-FO document is always received by FOP as a SAX stream (see the + Parsing Design Document for the rationale). +

    +

    + However, you may not always have your input document available as a SAX stream. + But with JAXP it's easy to convert different input sources to a SAX stream so you + can pipe it into FOP. That sounds more difficult than it is. You simply have + to set up the right Source instance as input for the JAXP transformation. + A few examples: +

    +
      +
    • + URL: Source src = new StreamSource("http://localhost:8080/testfile.xml"); +
      • +
    • + File: Source src = new StreamSource(new File("C:/Temp/myinputfile.xml")); +
      • +
    • + String: Source src = new StreamSource(new StringReader(myString)); // myString is a String +
      • +
    • + InputStream: Source src = new StreamSource(new MyInputStream(something)); +
      • +
    • + Byte Array: Source src = new StreamSource(new ByteArrayInputStream(myBuffer)); // myBuffer is a byte[] here +
      • +
    • + DOM: Source src = new DOMSource(myDocument); // myDocument is a Document or a Node +
      • +
    • + Java Objects: Please have a look at the Embedding examples which contain an example for this. +
      • +
    +

    + There are a variety of upstream data manipulations possible. + For example, you may have a DOM and an XSL stylesheet; or you may want to + set variables in the stylesheet. Interface documentation and some cookbook + solutions to these situations are provided in + Xalan Basic Usage Patterns. +

    +
    +
    + Configuring Apache FOP Programmatically +

    + Apache FOP provides two levels on which you can customize FOP's + behaviour: the FopFactory and the user agent. +

    +
    + Customizing the FopFactory +

    + The FopFactory holds configuration data and references to objects which are reusable over + multiple rendering runs. It's important to instantiate it only once (except in special + environments) and reuse it every time to create new FOUserAgent and Fop instances. +

    +

    + You can set all sorts of things on the FopFactory: +

    +
      +
    • +

      + The font base URL to use when resolving relative URLs for fonts. Example: +

      + fopFactory.setFontBaseURL("file:///C:/Temp/fonts"); +
      • +
    • +

      + The hyphenation base URL to use when resolving relative URLs for + hyphenation patterns. Example: +

      + fopFactory.setHyphenBaseURL("file:///C:/Temp/hyph"); +
      • +
    • +

      + Disable strict validation. When disabled FOP is less strict about the rules + established by the XSL-FO specification. Example: +

      + fopFactory.setStrictValidation(false); +
      • +
    • +

      + Enable an alternative set of rules for text indents that tries to mimic the behaviour of many commercial + FO implementations, that chose to break the specification in this respect. The default of this option is + 'false', which causes Apache FOP to behave exactly as described in the specification. To enable the + alternative behaviour, call: +

      + fopFactory.setBreakIndentInheritanceOnReferenceAreaBoundary(true); +
      • +
    • +

      + Set the source resolution for the document. This is used internally to determine the pixel + size for SVG images and bitmap images without resolution information. Default: 72 dpi. Example: +

      + fopFactory.setSourceResolution(96); // =96dpi (dots/pixels per Inch) +
      • +
    • +

      + Manually add an ElementMapping instance. If you want to supply a special FOP extension + you can give the instance to the FOUserAgent. Normally, the FOP extensions can be automatically detected + (see the documentation on extension for more info). Example: +

      + fopFactory.addElementMapping(myElementMapping); // myElementMapping is a org.apache.fop.fo.ElementMapping +
      • +
    • +

      + Set a URIResolver for custom URI resolution. By supplying a JAXP URIResolver you can add + custom URI resolution functionality to FOP. For example, you can use + Apache XML Commons Resolver to make use of XCatalogs. Example: +

      + fopFactory.setURIResolver(myResolver); // myResolver is a javax.xml.transform.URIResolver + + Both the FopFactory and the FOUserAgent have a method to set a URIResolver. The URIResolver on the FopFactory + is primarily used to resolve URIs on factory-level (hyphenation patterns, for example) and it is always used + if no other URIResolver (for example on the FOUserAgent) resolved the URI first. + +
      • +
    +
    +
    + Customizing the User Agent +

    + The user agent is the entity that allows you to interact with a single rendering run, i.e. the processing of a single + document. If you wish to customize the user agent's behaviour, the first step is to create your own instance + of FOUserAgent using the appropriate factory method on FopFactory and pass that + to the factory method that will create a new Fop instance: +

    + +

    + You can do all sorts of things on the user agent: +

    +
      +
    • +

      + The base URL to use when resolving relative URLs. Example: +

      + userAgent.setBaseURL("file:///C:/Temp/"); +
      • +
    • +

      + Set the producer of the document. This is metadata information that can be used for certain output formats such as PDF. The default producer is "Apache FOP". Example: +

      + userAgent.setProducer("MyKillerApplication"); +
      • +
    • +

      + Set the creating user of the document. This is metadata information that can be used for certain output formats such as PDF. Example: +

      + userAgent.setCreator("John Doe"); +
      • +
    • +

      + Set the author of the document. This is metadata information that can be used for certain output formats such as PDF. Example: +

      + userAgent.setAuthor("John Doe"); +
      • +
    • +

      + Override the creation date and time of the document. This is metadata information that can be used for certain output formats such as PDF. Example: +

      + userAgent.setCreationDate(new Date()); +
      • +
    • +

      + Set the title of the document. This is metadata information that can be used for certain output formats such as PDF. Example: +

      + userAgent.setTitle("Invoice No 138716847"); +
      • +
    • +

      + Set the keywords of the document. This is metadata information that can be used for certain output formats such as PDF. Example: +

      + userAgent.setKeywords("XML XSL-FO"); +
      • +
    • +

      + Set the target resolution for the document. This is used to + specify the output resolution for bitmap images generated by bitmap renderers + (such as the TIFF renderer) and by bitmaps generated by Apache Batik for filter + effects and such. Default: 72 dpi. Example: +

      + userAgent.setTargetResolution(300); // =300dpi (dots/pixels per Inch) +
      • +
    • +

      + Set your own Renderer instance. If you want to supply your own renderer or + configure a Renderer in a special way you can give the instance to the FOUserAgent. Normally, + the Renderer instance is created by FOP. Example: +

      + userAgent.setRendererOverride(myRenderer); // myRenderer is an org.apache.fop.render.Renderer +
      • +
    • +

      + Set your own FOEventHandler instance. If you want to supply your own FOEventHandler or + configure an FOEventHandler subclass in a special way you can give the instance to the FOUserAgent. Normally, + the FOEventHandler instance is created by FOP. Example: +

      + userAgent.setFOEventHandlerOverride(myFOEventHandler); // myFOEventHandler is an org.apache.fop.fo.FOEventHandler +
      • +
    • +

      + Set a URIResolver for custom URI resolution. By supplying a JAXP URIResolver you can add + custom URI resolution functionality to FOP. For example, you can use + Apache XML Commons Resolver to make use of XCatalogs. Example: +

      + userAgent.setURIResolver(myResolver); // myResolver is a javax.xml.transform.URIResolver + + Both the FopFactory and the FOUserAgent have a method to set a URIResolver. The URIResolver on the FOUserAgent is + used for resolving URIs which are document-related. If it's not set or cannot resolve a URI, the URIResolver + from the FopFactory is used. + +
      • +
    + + You should not reuse an FOUserAgent instance between FOP rendering runs although you can. Especially + in multi-threaded environment, this is a bad idea. + +
    +
    +
    + Using a Configuration File +

    + Instead of setting the parameters manually in code as shown above you can also set + many values from an XML configuration file: +

    + +

    + The layout of the configuration file is described on the Configuration page. +

    +
    +
    + Hints +
    + Object reuse +

    + Fop instances shouldn't (and can't) be reused. Please recreate + Fop and FOUserAgent instances for each rendering run using the FopFactory. + This is a cheap operation as all reusable information is held in the + FopFactory. That's why it's so important to reuse the FopFactory instance. +

    +
    +
    + AWT issues +

    + If your XSL-FO files contain SVG then Apache Batik will be used. When Batik is + initialised it uses certain classes in java.awt that + intialise the Java AWT classes. This means that a daemon thread + is created by the JVM and on Unix it will need to connect to a + DISPLAY. +

    +

    + The thread means that the Java application may not automatically quit + when finished, you will need to call System.exit(). These + issues should be fixed in the JDK 1.4. +

    +

    + If you run into trouble running FOP on a head-less server, please see the + notes on Batik. +

    +
    +
    + Getting information on the rendering process +

    + To get the number of pages that were rendered by FOP you can call + Fop.getResults(). This returns a FormattingResults object + where you can look up the number of pages produced. It also gives you the + page-sequences that were produced along with their id attribute and their + numbers 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. +

    +
    +
    +
    + Improving performance +

    + There are several options to consider: +

    +
      +
    • + Whenever possible, try to use SAX to couple the individual components involved + (parser, XSL transformer, SQL datasource etc.). +
      • +
    • + Depending on the target OutputStream (in case of a FileOutputStream, but not + for a ByteArrayOutputStream, for example) it may improve performance considerably + if you buffer the OutputStream using a BufferedOutputStream: + out = new java.io.BufferedOutputStream(out); +
      + Make sure you properly close the OutputStream when FOP is finished. +
      • +
    • + Cache the stylesheet. If you use the same stylesheet multiple times + you can set up a JAXP Templates object and reuse it each time you do + the XSL transformation. (More information can be found + here.) +
      • +
    • + Use an XSLT compiler like XSLTC + that comes with Xalan-J. +
      • +
    • + Fine-tune your stylesheet to make the XSLT process more efficient and to create XSL-FO that can + be processed by FOP more efficiently. Less is more: Try to make use of property inheritance where possible. +
      • +
    +
    +
    + Multithreading FOP +

    + Apache FOP may currently not be completely thread safe. + The code has not been fully tested for multi-threading issues, yet. + If you encounter any suspicious behaviour, please notify us. +

    +

    + There is also a known issue with fonts being jumbled between threads when using + the Java2D/AWT renderer (which is used by the -awt and -print output options). + In general, you cannot safely run multiple threads through the AWT renderer. +

    +
    +
    + Examples +

    + The directory "{fop-dir}/examples/embedding" contains several working examples. +

    +
    + ExampleFO2PDF.java +

    This + + example +demonstrates the basic usage pattern to transform an XSL-FO +file to PDF using FOP. +

    +
    +
    +
    + ExampleXML2FO.java +

    This + + example +has nothing to do with FOP. It is there to show you how an XML +file can be converted to XSL-FO using XSLT. The JAXP API is used to do the +transformation. Make sure you've got a JAXP-compliant XSLT processor in your +classpath (ex. Xalan). +

    +
    +
    +
    + ExampleXML2PDF.java +

    This + + example +demonstrates how you can convert an arbitrary XML file to PDF +using XSLT and XSL-FO/FOP. It is a combination of the first two examples +above. The example uses JAXP to transform the XML file to XSL-FO and FOP to +transform the XSL-FO to PDF. +

    +
    +

    +The output (XSL-FO) from the XSL transformation is piped through to FOP using +SAX events. This is the most efficient way to do this because the +intermediate result doesn't have to be saved somewhere. Often, novice users +save the intermediate result in a file, a byte array or a DOM tree. We +strongly discourage you to do this if it isn't absolutely necessary. The +performance is significantly higher with SAX. +

    +
    +
    + ExampleObj2XML.java +

    This + + example +is a preparatory example for the next one. It's an example that +shows how an arbitrary Java object can be converted to XML. It's an often +needed task to do this. Often people create a DOM tree from a Java object and +use that. This is pretty straightforward. The example here, however, shows how +to do this using SAX, which will probably be faster and not even more +complicated once you know how this works. +

    +
    +

    +For this example we've created two classes: ProjectTeam and ProjectMember +(found in xml-fop/examples/embedding/java/embedding/model). They represent +the same data structure found in +xml-fop/examples/embedding/xml/xml/projectteam.xml. We want to serialize to XML a +project team with several members which exist as Java objects. +Therefore we created the two classes: ProjectTeamInputSource and +ProjectTeamXMLReader (in the same place as ProjectTeam above). +

    +

    +The XMLReader implementation (regard it as a special kind of XML parser) is +responsible for creating SAX events from the Java object. The InputSource +class is only used to hold the ProjectTeam object to be used. +

    +

    +Have a look at the source of ExampleObj2XML.java to find out how this is +used. For more detailed information see other resources on JAXP (ex. +An older JAXP tutorial). +

    +
    +
    + ExampleObj2PDF.java +

    This + + example +combines the previous and the third to demonstrate +how you can transform a Java object to a PDF directly in one smooth run +by generating SAX events from the Java object that get fed to an XSL +transformation. The result of the transformation is then converted to PDF +using FOP as before. +

    +
    +
    +
    + ExampleDOM2PDF.java +

    This + + example +has FOP use a DOMSource instead of a StreamSource in order to +use a DOM tree as input for an XSL transformation. +

    +
    +
    + ExampleSVG2PDF.java (PDF Transcoder example) +

    This + + example +shows the usage of the PDF Transcoder, a sub-application within FOP. +It is used to generate a PDF document from an SVG file. +

    +
    +
    + Final notes +

    +These examples should give you an idea of what's possible. It should be easy +to adjust these examples to your needs. Also, if you have other examples that you +think should be added here, please let us know via either the fop-users or fop-dev +mailing lists. Finally, for more help please send your questions to the fop-users +mailing list. +

    +
    +
    + +     + diff --git a/src/documentation/content/xdocs/0.20.5/extensions.xml b/src/documentation/content/xdocs/0.94/extensions.xml similarity index 50% rename from src/documentation/content/xdocs/0.20.5/extensions.xml rename to src/documentation/content/xdocs/0.94/extensions.xml index 07b98da89..dd4a79535 100644 --- a/src/documentation/content/xdocs/0.20.5/extensions.xml +++ b/src/documentation/content/xdocs/0.94/extensions.xml @@ -16,60 +16,55 @@ limitations under the License. --> - - +
    Standard FOP Extensions $Revision$
    -

    By "extension", we mean any data that can be placed in the input XML document that is not addressed by the XSL-FO standard. -By having a mechanism for supporting extensions, FOP is able to add features that are not covered in the specification.

    -

    The extensions documented here are included with FOP, and are automatically available to you. If you wish to add an extension of your own to FOP, please see the Developers' Extension Page.

    - All extensions required the correct use of an appropriate namespace in your input document. -
    - SVG -

    -Please see the SVG documentation for more details. -

    -
    +

    + By "extension", we mean any data that can be placed in the input XML document that + is not addressed by the XSL-FO standard. + By having a mechanism for supporting extensions, FOP is able to add features that + are not covered in the specification. +

    +

    + The extensions documented here are included with FOP, and are automatically available + to you. If you wish to add an extension of your own to FOP, please see the + Developers' Extension Page. +

    + All extensions require the correct use of an appropriate namespace in your input document. +
    + SVG +

    + Please see the SVG documentation for more details. +

    +
    FO Extensions
    Namespace -

    By convention, FO extensions in FOP use the "fox:" namespace identifier. -To use any of the FO extensions, add a namespace entry for http://xml.apache.org/fop/extensions -to the root element:

    -]]> +

    + By convention, FO extensions in FOP use the "fox" namespace prefix. + To use any of the FO extensions, add a namespace entry for + http://xml.apache.org/fop/extensions to the root element: +

    + ]]>
    PDF Bookmarks

    -You can provide outlines inside the root object (but outside any -page-sequences or other formatting objects). Here's an example of an outline -entry: -

    - - - Running FOP - - - Prerequisites - - -]]> -

    -It works similarly to a basic-link. There is also an external-destination -property, but it isn't supported currently. See the pdfoutline.fo file in -examples/fo/basic for a more complete example. + In previous versions of Apache FOP there was a fox:outline element + which was used to create outlines in PDF files. The redesigned code makes use + of the new bookmark feature defined in the latest XSL 1.1 working draft.

    Anchors or Named Destinations -

    Use the fox:destination element to define "named destinations" inside a PDF document. +

    This extension element hasn't been reimplemented for the redesigned code, yet.

    +
    Table Continuation Label -

    Use the fox:continued-label element to create content in table-header and +

    This extension element hasn't been reimplemented for the redesigned code, yet.

    + +
    +
    + fox:orphan-content-limit and fox:widow-content-limit +

    + The two proprietary extension properties, fox:orphan-content-limit and + fox:widow-content-limit, are used to improve the layout of list-blocks and tables. + If you have a table with many entries, you don't want a single row to be left over + on a page. You will want to make sure that at least two or three lines are kept + together. The properties take an absolute length which specifies the area at the + beginning (fox:widow-content-limit) or at the end (fox:orphan-content-limit) of a + table or list-block. The properties are inherited and only have an effect on fo:table + and fo:list-block. An example: fox:widow-content-limit="3 * 1.2em" would make sure + the you'll have at least three lines (assuming line-height="1.2") together on a table + or list-block. +

    diff --git a/src/documentation/content/xdocs/0.20.5/fonts.xml b/src/documentation/content/xdocs/0.94/fonts.xml similarity index 54% rename from src/documentation/content/xdocs/0.20.5/fonts.xml rename to src/documentation/content/xdocs/0.94/fonts.xml index 9b5991626..f60dad000 100644 --- a/src/documentation/content/xdocs/0.20.5/fonts.xml +++ b/src/documentation/content/xdocs/0.94/fonts.xml @@ -16,20 +16,25 @@ limitations under the License. --> - +
    - FOP: Fonts + Apache FOP: Fonts $Revision$ +
    Summary + The FOP Font subsystem is currently undergoing a significant change. + The details provided here especially related to the generation of FOP Font + Metrics files and the FOP Font configuration are likely to change substantially + in the future. +

    The following table summarizes the font capabilities of the various FOP renderers:

    @@ -51,15 +56,15 @@ - + - + @@ -124,21 +129,26 @@

    Support for custom fonts is added by creating font metric files (written in XML) from the actual font files, and registering them with FOP. Currently only Type 1 and TrueType fonts can be added. More information about fonts can be found at:

    Type 1 Font Metrics

    FOP includes PFMReader, which reads the PFM file that normally comes with a Type 1 font, and generates an appropriate font metrics file for it. To use it, run the class org.apache.fop.fonts.apps.PFMReader:

    -

    Windows:

    - java -cp build\fop.jar;lib\avalon-framework.jar;lib\xml-apis.jar; - lib\xercesImpl.jar;lib\xalan.jar +

    Windows (on JDK 1.4 and later):

    + java -cp build\fop.jar;lib\avalon-framework.jar;lib\commons-logging.jar;lib\commons-io.jar + org.apache.fop.fonts.apps.PFMReader [options] pfm-file xml-file +

    Windows (on JDK 1.3.x):

    + java -cp build\fop.jar;lib\avalon-framework.jar;lib\commons-logging.jar;lib\commons-io.jar;lib\xml-apis.jar; + lib\xercesImpl.jar;lib\xalan.jar;lib\serializer.jar + org.apache.fop.fonts.apps.PFMReader [options] pfm-file xml-file +

    Unix (on JDK 1.4 and later):

    + java -cp build/fop.jar:lib/avalon-framework.jar:lib/commons-logging.jar:lib/commons-io.jar org.apache.fop.fonts.apps.PFMReader [options] pfm-file xml-file -

    Unix:

    - java -cp build/fop.jar:lib/avalon-framework.jar:lib/xml-apis.jar: - lib/xercesImpl.jar:lib/xalan.jar +

    Unix (on JDK 1.3.1):

    + java -cp build/fop.jar:lib/avalon-framework.jar:lib/commons-logging.jar:lib/commons-io.jar:lib/xml-apis.jar: + lib/xercesImpl.jar:lib/xalan.jar:lib/serializer.jar org.apache.fop.fonts.apps.PFMReader [options] pfm-file xml-file

    PFMReader [options]:

      @@ -150,8 +160,7 @@ name.
    The classpath in the above example has been simplified for readability. You will have to adjust the classpath to the names of the actual JAR files in the lib directory. -avalon-framework.jar is necessary only for versions 0.20.5 or later. -xml-apis.jar, xercesImpl.jar and xalan.jar are not necessary for JDK version 1.4 or later. +xml-apis.jar, xercesImpl.jar, xalan.jar and serializer.jar are not necessary for JDK version 1.4 or later. The tool will construct some values (FontBBox, StemV and ItalicAngle) based on assumptions and calculations which are only an approximation to the real values. FontBBox and Italic Angle can be found in the human-readable part of the PFB file or in the AFM file. The PFMReader tool does not yet interpret PFB or AFM files, so if you want to be correct, you may have to adjust the values in the XML file manually. @@ -162,8 +171,7 @@ The constructed values however appear to have no visible influence.

    FOP includes TTFReader, which reads the TTF file and generates an appropriate font metrics file for it. Use it in a similar manner to PFMReader. For example, to create such a metrics file in Windows from the TrueType font at c:\myfonts\cmr10.ttf:

    - java -cp build\fop.jar;lib\avalon-framework.jar;lib\xml-apis.jar; - lib\xercesImpl.jar;lib\xalan.jar + java -cp build\fop.jar;lib\avalon-framework.jar;lib\commons-logging.jar;lib\commons-io.jar org.apache.fop.fonts.apps.TTFReader [options] C:\myfonts\cmr10.ttf ttfcm.xml

    TTFReader [options]:

    @@ -201,16 +209,18 @@ will produce incorrect results.
    - + + + + + +
    yes no yesnoyes
    TXT yes (used for layout but not for output)
    Character Display Correct.Correct if and only if the font is embedded in the output. (This is possible -because, although the underlying characters are encoded incorrectly, the embedded font is -also encoded incorrectly).Correct, but copy/paste won't work in Acrobat Reader. (FOP currently doesn't emit the /ToUnicode table which is necessary for copy/paste to work.)
    Embedding the FontOptional.Mandatory. Not embedding the font produces invalid PDF documents.
    - As shown in the above table, regardless of -whether the font is embedded or not, text generated from a CID-keyed font metrics file -will never be encoded properly. -Further, if the related font is not embedded, it cannot even be displayed properly. -Obviously, this behavior is not desirable, and we hope to correct it in upcoming releases. + + You may experience failures with certain TrueType fonts, especially if they don't contain + the so-called "cmap" table. TTFReader can currently not deal with font like this. +
    TrueType Collections Font Metrics @@ -219,44 +229,105 @@ To create metrics files for these fonts, you must specify which font in the coll

    To get a list of the fonts in a collection, just start the TTFReader as if it were a normal TrueType file (without the -ttcname option). It will display all of the font names and exit with an Exception.

    Here is an example of generating a metrics file for a .ttc file:

    - java -cp build\fop.jar;lib\avalon-framework.jar;lib\xml-apis.jar; - lib\xercesImpl.jar;lib\xalan.jar + java -cp build\fop.jar;lib\avalon-framework.jar;lib\commons-logging.jar;lib\commons-io.jar org.apache.fop.fonts.apps.TTFReader -ttcname "MS Mincho" msmincho.ttc msminch.xml
    - Register Fonts with FOP -

    You must tell FOP how to find and use the font metrics files by registering them in the FOP Configuration. Add entries for your custom fonts, regardless of font type, to the configuration file in a manner similar to the following:

    - - -]]> - Review the documentation for FOP Configuration for instructions on making the FOP configuration available to FOP when it runs. Otherwise, FOP has no way of finding your custom font information. + Register Fonts with FOP - Auto-Detect Fonts +

    You must tell FOP how to find and use the font metrics files by registering them in the FOP Configuration. Add entries for your custom fonts, regardless of font type, to the configuration file in a manner similar to the following:

    + + + + + + + + C:\MyFonts1 + + + C:\MyFonts2 + + + +]]> + + Review the documentation for FOP Configuration for + instructions on making the FOP configuration available to FOP when it runs. Otherwise, + FOP has no way of finding your custom font information. + + The Unix autodetect feature looks in the following locations for fonts it can use:
      -
    • Starting with FOP version 0.20.5 you can use URLs for the paths to the font files. -Relative URLs are resolved relative to the fontBaseDir property (or baseDir) if available. See FOP: Configuration for more information.
      • -
    • The "kerning" and "embed-file" attributes are optional. Kerning is currently not used at all. If embedding is off, the output will position the text correctly (from the metrics file), but it will not be displayed or printed correctly unless the viewer has the applicable font available to their local system.
      • -
    • When setting the embed-file attribute for Type 1 fonts, be sure to specify the PFB (actual font data), not PFM (font metrics) file that you used to generate the XML font metrics file.
      • +
    • java user.home + "/.fonts"
      • +
    • "/usr/local/fonts"
      • +
    • "/usr/share/fonts"
      • +
    • "/usr/X11R6/lib/X11/fonts"
    - Cocoon users will need to setup the config, see FOPSerializer for more information. +
      +
    • + URLs are used to access the font metric and font files. + Relative URLs are resolved relative to the font-base property (or base) if available. + See FOP: Configuration for more information. +
      • +
    • Either an "embed-url" or a "metrics-url" must be specified for font tag configurations.
      • +
    • The font "kerning" attribute is optional.
      • +
    • If embedding is off, the output will position the text correctly (from the metrics file), but it will not be displayed or printed correctly unless the viewer has the applicable font available to their local system.
      • +
    • When setting the "embed-url" attribute for Type 1 fonts, be sure to specify the PFB (actual font data), not PFM (font metrics) file that you used to generate the XML font metrics file.
      • +
    • The fonts "directory" tag can be used to register fonts contained within a single or list of directory paths. The "recursive" attribute can be specified to recursively add fonts from all sub directories.
      • +
    • The fonts "auto-detect" tag can be used to automatically register fonts that are found to be installed on the native operating system.
      • +
    • Fonts registered with "font" tag configurations override fonts found by means of "directory" tag definitions.
      • +
    • Fonts found as a result of a "directory" tag configuration override fonts found as a result of the "auto-detect" tag being specified.
      • +
    • + If relative URLs are specified, they are evaluated relative to the value of the + "font-base" setting. If there is no "font-base" setting, the fonts are evaluated + relative to the base directory. +
      • +
    +
    Embedding - The PostScript renderer does not yet support font embedding. + The PostScript renderer does not yet support TrueType fonts, but can embed Type 1 fonts. The font is simply embedded into the PDF file, it is not converted. -

    Font embedding is enabled in the userconfig.xml file and controlled by the embed-file attribute. -If you don't specify the embed-file attribute the font will not be embedded, but will only be referenced.

    +

    Font embedding is enabled in the userconfig.xml file and controlled by the embed-url attribute. +If you don't specify the embed-url attribute the font will not be embedded, but will only be referenced.

    + + Omitting the embed-url attribute for CID-encoded TrueType fonts will currently produce invalid + PDF files! If you create the XML font metric file using the "-enc ansi" option, you can omit + the embed-url attribute for TrueType fonts but you're restricted to the WinAnsi character set. +

    When FOP embeds a font, it adds a prefix to the fontname to ensure that the name will not match the fontname of an installed font. This is helpful with older versions of Acrobat Reader that preferred installed fonts over embedded fonts.

    When embedding PostScript fonts, the entire font is always embedded.

    -

    When embedding TrueType fonts (ttf) or TrueType Collections (ttc), a subset of the original font, containing only the glyphs used, is embedded in the output document. -Currently, this embedded font contains only the minimum data needed to be embedded in a pdf document, and does not contain any codepage information. -The PDF document contains indexes to the glyphs in the font instead of to encoded characters. -While the document will be displayed correctly, the net effect of this is that searching, indexing, and cut-and-paste will not work properly.

    -

    One workaround for this behavior is to use the "-enc ansi" option when generating metrics with TTFReader. -This will cause the whole font to be embedded in the pdf document. -Characters will be WinAnsi encoded (as specified in the PDF spec), so you lose the ability to use characters from other character sets. -See Table of TTF Encoding Options for more details.

    +

    When embedding TrueType fonts (ttf) or TrueType Collections (ttc), a subset of the + original font, containing only the glyphs used, is embedded in the output document.

    +
    +
    + Explicitly embedding the base 14 fonts +

    + There are cases where you might want to force the embedding of one or more of the base 14 fonts that + can normally be considered available on the target platform (viewer, printer). One of these cases is + PDF/A which mandates the embedding of even the base 14 fonts. Embedding a font such as Helvetica or + Courier is straight-forward. The "Symbol" and "ZapfDingbats" fonts, however, currently present a + problem because FOP cannot correctly determine the encoding of these two single-byte fonts through + the PFM file. FOP now correctly interprets the "encoding" value in the XML font metrics file, but the + PFMReader application writes "UnknownEncoding" to the generated XML file. In order to embed "Symbol" + and "ZapfDingbats" you have to manually change the XML font metrics file and specify "SymbolEncoding" + or "ZapfdingbatsEncoding" encoding respectively as the value for the "encoding" element. +

    +

    Example:

    + + + Symbol + + SymbolEncoding + 673 + 766 + [..]]]>
    diff --git a/src/documentation/content/xdocs/0.94/fotree/disabled-testcases.xml b/src/documentation/content/xdocs/0.94/fotree/disabled-testcases.xml new file mode 100644 index 000000000..196eafcc4 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/fotree/disabled-testcases.xml @@ -0,0 +1,31 @@ + + + + + + demo test failure + demo-test-failure.fo + + + + Markers and core function evaluation + from-table-column_marker.fo + The code currently evaluates this function according to the column in which the + marker appears in the source document, rather than the column it is retrieved in. + + diff --git a/src/documentation/content/xdocs/0.94/graphics.xml b/src/documentation/content/xdocs/0.94/graphics.xml new file mode 100644 index 000000000..164069733 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/graphics.xml @@ -0,0 +1,401 @@ + + + + + +
    + Apache FOP: Graphics Formats + $Revision$ +
    + +
    + Overview of Graphics Support +

    + The table below summarizes the theoretical support for graphical formats within FOP. In other words, within the constraints of the limitations listed here, these formats should work. However, many of them have not been tested, and there may be limitations that have not yet been discovered or documented. The packages needed to support some formats are not included in the FOP distribution and must be installed separately. Follow the links in the "Support Thru" column for more details. +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FormatTypeFOP native supportBatik SVGBatik codecsImage I/OJAIJIMI
    BMP (Microsoft Windows Bitmap)bitmapX
    EPS (Encapsulated PostScript)metafile (both bitmap and vector), probably most frequently used for vector drawings(X)
    GIF (Graphics Interchange Format)bitmapXXXX
    JPEG (Joint Photographic Experts Group)bitmap(X)X
    PNG (Portable Network Graphic)bitmapXX
    SVG (Scalable Vector Graphics)vector (with embedded bitmaps)X
    TIFF (Tag Image Format File)bitmap(X)XXX
    EMF (Windows Enhanced Metafile)vector (with embedded bitmaps)(X)
    + "(X)" means restricted support. Please see the details below. +
    +
    + Graphics Packages +
    + FOP Native +

    + FOP has native ability to handle some graphic file formats. +

    +
    +
    + "Internal" codecs +

    + Apache XML Graphics Commons contains codecs for PNG and TIFF access. FOP can use these. +

    +
    +
    + Image I/O (JDK 1.4 or higher) +

    + For JDKs 1.4 or higher, FOP provides a wrapper to load images through the + JDK's Image I/O API (JSR 015). + Image I/O allows to dynamically add additional image codecs. An example of such an add-on library are the + JAI Image I/O Tools available from Sun. +

    +
    +
    + JIMI +

    + Because of licensing issues, the JIMI image library is not included in the FOP distribution. First, download and install it. +Then, copy the file "JimiProClasses.zip" from the archive to {fop-install-dir}/lib/jimi-1.0.jar. Please note that FOP binary distributions are compiled with JIMI support, so there is no need for you to build FOP to add the support. If jimi-1.0.jar is installed in the right place, it will automatically be used by FOP, otherwise it will not. +

    +
    +
    + JAI (Java Advanced Imaging API) +

    + FOP has been compiled with JAI support, but JAI is not included in the FOP distribution. +To use it, install JAI, then copy the jai_core.jar and the jai_codec.jar files to {fop-install-dir}/lib. +JAI is much faster than JIMI, but is not available for all platforms. See What platforms are supported? on the JAI FAQ page for more details. +

    +
    +
    + Apache Batik +

    Current FOP distributions include a distribution of the Apache Batik version 1.6. +It is automatically installed with FOP. +Because Batik's API changes frequently, it is highly recommended that you use the version that ships with FOP, at least when running FOP.

    + Batik must be run in a graphical environment. +

    Batik must be run in a graphical environment. +It uses AWT classes for rendering SVG, which in turn require an X server on Unixish systems. +If you run a server without X, or if you can't connect to the X server due to security restrictions or policies (a so-called "headless" environment), SVG rendering will fail.

    +

    Here are some workarounds:

    +
      +
    • If you are using JDK 1.4, start it with the -Djava.awt.headless=true command line option.
      • +
    • Install an X server which provides an in-memory framebuffer without actually using a screen device or any display hardware. One example is Xvfb.
      • +
    • Install a toolkit which emulates AWT without the need for an underlying X server. One example is the PJA toolkit, which is free and comes with detailed installation instructions.
      • +
    +
    +
    +
    + BMP +

    FOP native support for BMP images is limited to the RGB color-space.

    +
    +
    + EPS +

    FOP provides support for two output targets:

    +
      +
    • PostScript (full support).
      • +
    • + PDF (partial support). Due to the lack of a built-in PostScript interpreter, FOP + can only embed the EPS file into the PDF. Acrobat Reader will not currently display + the EPS (it doesn't have a PostScript interpreter, either) but it will be shown + correctly when you print the PDF on a PostScript-capable printer. PostScript devices + (including GhostScript) will render the EPS correctly. +
      • +
    + + Please note that the EPS embedding feature has been deprecated in the + PDF specification version 1.4. You should not use this feature anymore, especially + since newer PDF tools don't support embedded EPS files anymore. + +

    + Other output targets can't be supported at the moment because + FOP lacks a PostScript interpreter. Furthermore, FOP is not able + to parse the preview bitmaps sometimes contained in EPS files. +

    +
    +
    + JPEG +

    + FOP native support of JPEG does not include all variants, especially those containing + unusual color lookup tables and color profiles. + If you have trouble with a JPEG image in FOP, try opening it with an image processing + program (such as Photoshop or Gimp) and then saving it. Specifying 24-bit color output + may also help. For the PDF and PostScript renderers most JPEG images can be passed + through without decompression. User reports indicate that grayscale, RGB, and + CMYK color-spaces are all rendered properly. +

    +
    +
    + PNG +

    + If using JAI for PNG support, only RGB and RGBA color-spaces are supported for + FOP rendering. +

    +

    + Transparency is supported but not guaranteed to work with every output format. +

    +
    +
    + SVG +
    + Introduction +

    FOP uses Apache Batik for SVG support. +This format can be handled as an fo:instream-foreign-object or in a separate +file referenced with fo:external-graphic.

    + +Batik's SVG Rasterizer utility may also be used to convert standalone SVG +documents into PDF. For more information please see the +SVG Rasterizer documentation +on the Batik site. + +
    +
    + Placing SVG Graphics into PDF +

    +The SVG is rendered into PDF by using PDF commands to draw and fill +lines and curves. This means that the graphical objects created with +this remain as vector graphics. The same applies to PostScript output. +For other output formats the SVG graphic will be converted to a bitmap +image. +

    +

    +There are a number of SVG things that cannot be converted directly into +PDF. Parts of the graphic such as effects, patterns and images are inserted +into the PDF as a raster graphic. The resolution of these raster images can + be controlled through the "target resolution" setting in the + configuration.

    +

    +Currently transparency is limited in PDF so many svg images that +contain effects or graphics with transparent areas may not be displayed +correctly. +

    +
    +
    + Placing SVG Text into PDF and PostScript +

    If possible, Batik will use normal PDF or PostScript text when inserting text. It does +this by checking if the text can be drawn normally and the font is +supported. This example svg text.svg / +text.pdf +shows how various types and effects with text are handled. +Note that tspan and outlined text are not yet implemented.

    +

    +Otherwise, text is converted and drawn as a set of shapes by Batik, using the stroking text painter. +This means that a typical character will +have about 10 curves (each curve consists of at least 20 characters). +This can make the output files large and when it is viewed the +viewer may not normally draw those fine curves very well (In Adobe Acrobat, turning on +"Smooth Line Art" in the preferences will fix this). +If the text is inserted into the output file using the inbuilt text commands +it will use a single character. +

    +

    + Note that because SVG text can be rendered as either text or a vector graphic, you + may need to consider settings in your viewer for both. The Acrobat viewer has both + "smooth line art" and "smooth text" settings that may need to be set for SVG images + to be displayed nicely on your screen (see Edit / Preferences / Display). + This setting will not affect the printing of your document, which should be OK in + any case, but will only affect the quality of the screen display.

    +
    +
    + Scaling +

    + Currently, SVG images are rendered with the dimensions specified in the SVG + file, within the viewport specified in the fo:external-graphic element. + For everything to work properly, the two should be equal. The SVG standard leaves + this issue as an implementation detail. FOP will probably implement a scaling + mechanism in the future. +

    +

    + If you use pixels to specify the size of an SVG graphic the "source resolution" setting + in the configuration will be used to determine the + size of a pixel. The use of pixels to specify sizes is discouraged as they may + be interpreted differently in different environments. +

    +
    +
    + Known Problems +
      +
    • +Soft mask transparency is combined with white so that it looks better +on pdf 1.3 viewers but this causes the soft mask to be slightly lighter +or darker on pdf 1.4 viewers. +
      • +
    • +There is some problem with a gradient inside a pattern causing a PDF +error when viewed in acrobat 5. +
      • +
    • +Text is not always handled correctly, it may select the wrong font +especially if characters have multiple fonts in the font list. +
      • +
    • +More PDF text handling could be implemented. +It could draw the string using the attributed character iterator +to handle tspans and other simple changes of text. +
      • +
    • +JPEG images are not inserted directly into the pdf document. +This area has not been implemented yet since the appropriate +method in batik is static. +
      • +
    • +Uniform transparency for images and other svg elements that are converted +into a raster graphic are not drawn properly in PDF. The image is opaque. +
      • +
    +
    +
    +
    + TIFF +

    + FOP-native TIFF support is limited to PDF and PostScript output only. Also, + according to user reports, FOP's native support for TIFF is limited to images with the + following characteristics (all must be true for successful rendering): +

    +
      +
    • single channel images (i.e., bi-level and grayscale only)
      • +
    • uncompressed images, or images using CCITT T.4, CCITT T.6, or JPEG compression
      • +
    • images using white-is-zero encoding in the TIFF PhotometricInterpretation tag
      • +
    + + Native support in this case means that the images can be embedded into the output format + without decoding it. + +

    JAI: Supports RGB and RGBA only for FOP rendering.

    +
    +
    + EMF +

    Windows Enhanced Metafiles (EMF) are only supported in RTF output.

    +
    +
    + Graphics Resolution +

    + Some bitmapped image file formats store a dots-per-inch (dpi) or other resolution + values. FOP tries to use this resolution information whenever possible to determine + the image's intrinsic size. This size is used during the layout process when it is not + superceeded by an explicit size on fo:external-graphic (content-width and content-height + properties). +

    +

    + Please note that not all images contain resolution information. If it's not available + 72 dpi is assumed (the default resolution of PDF and PostScript). +

    +

    + Bitmap images are generally embedded into the output format at their original resolution + (as is). No resampling of the image is performed. Explicit resampling is on our wishlist, + but hasn't been implemented, yet. Bitmaps included in SVG graphics may be resampled to + the resolution specified in the "target resolution" setting in the + configuration if SVG filters are applied. This can be + used as a work-around to resample images in FO documents. +

    +
    +
    + Image caching +

    + FOP caches images between runs. There is one cache per FopFactory instance. The URI is + used as a key to identify images which means that when a particular URI appears again, + the image is taken from the cache. If you have a servlet that generates a different + image each time it is called with the same URL you need to use a constantly + changing dummy parameter on the URL to avoid caching. +

    +

    + The image cache has been improved considerably in the redesigned code. Therefore, a + resetCache() method like in earlier versions of FOP has become unnecessary. If you + still experience OutOfMemoryErrors, please notify us. +

    +
    + +     diff --git a/src/documentation/content/xdocs/0.20.5/hyphenation.xml b/src/documentation/content/xdocs/0.94/hyphenation.xml similarity index 68% rename from src/documentation/content/xdocs/0.20.5/hyphenation.xml rename to src/documentation/content/xdocs/0.94/hyphenation.xml index d18f50961..ed97c6868 100644 --- a/src/documentation/content/xdocs/0.20.5/hyphenation.xml +++ b/src/documentation/content/xdocs/0.94/hyphenation.xml @@ -16,11 +16,10 @@ limitations under the License. --> - +
    - FOP: Hyphenation + Apache FOP: Hyphenation $Revision$
    @@ -29,95 +28,22 @@
    Introduction

    FOP uses Liang's hyphenation algorithm, well known from TeX. It needs - language specific patterns and other data for operation.

    -

    Because of licensing issues (and for + language specific pattern and other data for operation.

    +

    Because of licensing issues (and for convenience), all hyphenation patterns for FOP are made available through - the Objects For - Formatting Objects project.

    + the Objects For + Formatting Objects project.

    If you have made improvements to an existing FOP hyphenation pattern, or if you have created one from scratch, please consider contributing these to OFFO so that they can benefit other FOP users as well. - Please inquire on the FOP User - mailing list. -
    -
    - Using Hyphenation -

    - In order to get words hyphenated, hyphenation has to be - enabled explicitely (set property hyphenation="true") and a - language has to be defined (e.g. language="en"). Optionally, a - country can be specified (e.g. country="GB"). -

    -

    - If hyphenation is requested, at first a serialized instance - containing precompiled hyphenation patterns is looked up in - the classpath. If only a language is specified, a ressource - named hyph/<language>.hyp is loaded. If both - language and country are specified, the ressource - hyph/<language>_<country>.hyp is looked up, - and if this fails, the loader looks also for - hyph/<language>.hyp. -

    -

    - If no precompiled patterns are found, FOP tries to load raw - patterns from the an XML file name - /hyph/<language>.xml respective - /hyph/<language>_<country>.xml . The /hyph - prefix is hardcoded and can't be configured. Note that this - usually constitues an absolute file path. FOP can't load raw - patterns from other sources than files. -

    -

    - If you think hyphenation is enabled but words aren't - hyphenated, check whether FOP finds the relevant hyphenation - patterns: -

    -
      -
    1. Did you download and install the hyphenation patterns - properly? In case you downloaded the files from OFFO, check - whether you have downloaded the patterns for the correct FOP - version (0.20.5 or the development version), and check whether - you followed the installation instructions.
      2. -
    2. Check whether you have spelled the language code and - optionally the country code correctly. Note that the country - codes are in uppercase, by convention. This matters.
      3. -
    -

    - If hyphenation works in general, but specific words aren't - hyphenated, or aren't hyphenated as expected, you may have one - of the following problems: -

    -
      -
    1. The patters contain a bug, or simply wont do as you - expect. In order to reduce the amount of patters, they are - usually cut some slack.
      2. -
    2. The patterns may be for an unexpected, unofficial or - outdated dialect of the language. For example, the turkish - patterns were (and maybe still are) made for 17c Osman rather - than modern turkish.
      3. -
    3. The word may contain invisible characters which prevent it - from being parsed properly from the content stream, or from - being properly matched. Examples of such characters are the - soft hyphen (U+00AD) and the zero width joiner (U+200D). You - have to remove them in order to get the words hyphenated - properly. OTOH, you can use them in order to prevent certain - (unwanted, spurious or incorrect) hyphenations
      4. -
    4. If the word contains characters which can be composed from - other Unicode characters, or vice versa (e.g. U+00E4 "latin - small a with diaresis" and U+0061 U+0308 "latin small a" - "combining diaresis"), the patterns may just contain the - opposite form. FOP doesn't run Unicode - normalization on either the content nor on the - patterns. You have no choice but to check which form the - patterns use and adapt your FO source.
      5. -
    + Please inquire on the FOP User + mailing list.
    License Issues

    Many of the hyphenation files distributed with TeX and its offspring are - licenced under the LaTeX - Project Public License (LPPL), which prevents them from being + licenced under the LaTeX + Project Public License (LPPL), which prevents them from being distributed with Apache software. The LPPL puts restrictions on file names in redistributed derived works which we feel can't guarantee. Some hyphenation pattern files have other or additional restrictions, for @@ -133,8 +59,8 @@

    Sources of Custom Hyphenation Pattern Files

    The most important source of hyphenation pattern files is the - CTAN TeX - Archive.

    + CTAN TeX + Archive.

    Installing Custom Hyphenation Patterns @@ -153,9 +79,9 @@ hyphenation patterns.
    • The language and country codes must match the XSL-FO input, which - follows ISO - 639 (languages) and ISO - 3166 (countries). NOTE: The ISO 639/ISO 3166 convention is that + follows ISO + 639 (languages) and ISO + 3166 (countries). NOTE: The ISO 639/ISO 3166 convention is that language names are written in lower case, while country codes are written in upper case. FOP does not check whether the language and country specified in the FO source are actually from the current standard, but it relies @@ -165,12 +91,12 @@
  • There are basically three ways to make the FOP-compatible hyphenation pattern file(s) accessible to FOP:
      -
    • Download the precompiled JAR from OFFO - and place it either in the {fop-dir}/lib directory, or +
    • Download the precompiled JAR from OFFO + and place it either in the {fop-dir}/lib directory, or in a directory of your choice (and append the full path to the JAR to the environment variable FOP_HYPHENATION_PATH).
    • Download the desired FOP-compatible hyphenation pattern file(s) from - OFFO, + OFFO, and/or take your self created hyphenation pattern file(s),
      • place them in the directory {fop-dir}/hyph,
        • @@ -188,7 +114,7 @@ be created from the supplied pattern(s)).
      • Put the pattern source file(s) into a directory of your choice and configure FOP to look for custom patterns in this directory, by setting the - <hyphenation-dir> + <hyphenation-base> configuration option.
      • @@ -197,7 +123,7 @@ Either of these three options will ensure hyphenation is working when using FOP from the command-line. If FOP is being embedded, remember to add the location(s) of the hyphenation JAR(s) to the CLASSPATH (option 1 and 2) or to set the - <hyphenation-dir> + <hyphenation-dir> configuration option programmatically (option 3).
    • @@ -207,15 +133,15 @@

    If you would like to build your own hyphenation pattern files, or modify existing ones, this section will help you understand how to do so. Even when creating a pattern file from scratch, it may be beneficial to start - with an existing file and modify it. See - OFFO's Hyphenation page for examples. + with an existing file and modify it. See + OFFO's Hyphenation page for examples. Here is a brief explanation of the contents of FOP's hyphenation patterns:

    The remaining content of this section should be considered "draft" quality. It was drafted from theoretical literature, and has not been tested against actual FOP behavior. It may contain errors or omissions. Do not rely on these instructions without testing everything stated here. If you use these instructions, please provide feedback on the - FOP User mailing list, either + FOP User mailing list, either confirming their accuracy, or raising specific problems that we can address.
      @@ -301,10 +227,10 @@ online. The original patgen.web source, included in the TeX source distributions, contains valuable comments, unfortunately technical details obscure often the high level issues. Another important source is - The - TeX Book, appendix H (either read the TeX source, or run it through + The + TeX Book, appendix H (either read the TeX source, or run it through TeX to typeset it). Secondary articles, for example the works by Petr Sojka, - may alos give some much needed insigth into problems arising in automated + may also give some much needed insight into problems arising in automated hyphenation.

      diff --git a/src/documentation/content/xdocs/0.20.5/index.xml b/src/documentation/content/xdocs/0.94/index.xml similarity index 52% rename from src/documentation/content/xdocs/0.20.5/index.xml rename to src/documentation/content/xdocs/0.94/index.xml index a99df5fb1..750047678 100644 --- a/src/documentation/content/xdocs/0.20.5/index.xml +++ b/src/documentation/content/xdocs/0.94/index.xml @@ -19,22 +19,34 @@
      - Apache FOP Version 0.20.5 + Apache FOP Version 0.94 $Revision: 201586 $
      Introduction

      - Version 0.20.5 represents Apache FOP's previous stable release. It is now - recommended that you use 0.93 instead. + The Apache FOP team is proud to present to you this production quality release. + We're still in the process of adding new features. We welcome any feedback you + might have and even more, any other form of help to get the project forward.

      - Please notice that, although we still provide support for 0.20.5, we won't fix any bugs or add any - new features to this branch of development anymore. - Instead, please help us with FOP Trunk by trying it out and - sending us your feedback. Of course, we especially appreciate any contributions in the form of - documentation updates and code patches. + This fifth release contains many bug fix release and new features compared + to 0.92beta. To see what has changed since the last release, please visit the + Changes Page and the Release Notes. +

      +
      +
      + Upgrading from an earlier version +

      + If you're upgrading to this version from an earlier version of FOP, please read the + information contained on the Upgrading page! +

      +
      +
      + Download +

      + To download this version, please visit the download page.

      diff --git a/src/documentation/content/xdocs/0.94/intermediate.xml b/src/documentation/content/xdocs/0.94/intermediate.xml new file mode 100644 index 000000000..4744185aa --- /dev/null +++ b/src/documentation/content/xdocs/0.94/intermediate.xml @@ -0,0 +1,146 @@ + + + + + +
      + Intermediate Format + $Revision$ +
      + + + Please note that the intermediate format is an advanced feature and can be ignored by most + users of Apache FOP. + +
      + Introduction +

      + The intermediate format (IF) is a proprietary XML format that represents the area tree + generated by the layout engine. The area tree is conceptually defined in the + XSL-FO specification in chapter 1.1.2. + The IF can be generated through the area tree XML Renderer (the XMLRenderer). +

      +

      + The intermediate format can be used to generate intermediate documents that are modified + before they are finally rendered to their ultimate output format. Modifications include + adjusting and changing trait values, adding or modifying area objects, inserting prefabricated + pages, overlays, imposition (n-up, rotation, scaling etc.). Multiple IF files can be combined + to a single output file. +

      +
      +
      + Usage of the Intermediate Format +

      + As already mentioned, the IF is generated by using the XMLRenderer (MIME type: + application/X-fop-areatree). So, you basically set the right MIME type for + the output format and process your FO files as if you would create a PDF file. However, there + is an important detail to consider: The various Renderers don't all use the same font sources. + To be able to create the right area tree for the ultimate output file, you need to create + the IF file using the right font setup. This is achieved by telling the XMLRenderer to mimic + another renderer. This is done by calling the XMLRenderer's mimicRenderer() method with an + instance of the ultimate target renderer as the single parameter. This has a consequence: An + IF file rendered with the Java2DRenderer may not look as expected when it was actually generated + for the PDF renderer. For renderers that use the same font setup, this restriction does not + apply (PDF and PS, for example). Generating the intermediate format file is the first step. +

      +

      + The second step is to reparse the IF file using the AreaTreeParser which is + found in the org.apache.fop.area package. The pages retrieved from the IF file are added to an + AreaTreeModel instance from where they are normally rendered using one of the available Renderer + implementations. You can find examples for the IF processing in the + examples/embedding + directory in the FOP distribution +

      +

      + The basic pattern to parse the IF format looks like this: +

      + +

      + This example simply reads an IF file and renders it to a PDF file. Please note, that in normal + FOP operation you're shielded from having to instantiate the FontInfo object yourself. This + is normally a task of the AreaTreeHandler which is not present in this scenario. The same + applies to the AreaTreeModel instance, in this case an instance of a subclass called + RenderPagesModel. RenderPagesModel is ideal in this case as it has very little overhead + processing the individual pages. An important line in the example is the call to + endDocument() on the AreaTreeModel. This lets the Renderer know that the processing + is now finished. +

      +

      + The intermediate format can also be used from the command-line + by using the "-atin" parameter for specifying the area tree XML as input file. You can also + specify a "mimic renderer" by inserting a MIME type between "-at" and the output file. +

      +
      + Concatenating Documents +

      + This initial example is obviously not very useful. It would be faster to create the PDF file + directly. As the ExampleConcat.java + example shows you can easily parse multiple IF files in a row and add the parsed pages to the + same AreaTreeModel instance which essentially concatenates all the input document to one single + output document. +

      +
      +
      + Modifying Documents +

      + One of the most important use cases for the intermediate format is obviously modifying the area + tree XML before finally rendering it to the target format. You can easily use XSLT to process + the IF file according to your needs. Please note, that we will currently not formally describe + the intermediate format. You need to have a good understanding its structure so you don't + create any non-parseable files. We may add an XML Schema and more detailed documentation at a + later time. You're invited to help us with that. +

      +
      +
      + Advanced Use +

      + The generation of the intermediate format as well as it parsing process has been designed to allow + for maximum flexibility and optimization. Please note that you can call setTransformerHandler() on + XMLRenderer to give the XMLRenderer your own TransformerHandler instance in case you would like to + do custom serialization (to a W3C DOM, for example) and/or to directly modify the area tree using + XSLT. The AreaTreeParser on the other side allows you to retrieve a ContentHandler instance where + you can manually send SAX events to to start the parsing process (see getContentHandler()). +

      +
      +
      + +       diff --git a/src/documentation/content/xdocs/0.94/known-issues.xml b/src/documentation/content/xdocs/0.94/known-issues.xml new file mode 100644 index 000000000..27ae55494 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/known-issues.xml @@ -0,0 +1,94 @@ + + + + + + MIF and SVG output support have not been restored, yet. + + + Java2D/AWT support has been improved, but some problems remain, + for example with block-containers. + + + Auto table layout is not implemented, yet. + + + Footnotes may overlap with text of the region-body in multi-column + documents. + + + Space resolution does not work between footnote regions. + + + There's a problem involving nested block-containers and + reference-orientation 180/-180 (Bugzilla #36391) + + + block-containers with no height currently don't create a fence for + spaces as they should (they behave like a normal block). + + + Preserved linefeeds in fo:character are not handled correctly. + + + An empty block currently produces a fence for stacking constraints + which it shouldn't. + + + There are several small problems around white space handling. + + + Images currently don't shrink so they fit on a page when they are + too big and shrinking is allowed to happen. + + + inline-container may not work as expected. + + + letter-spacing and word-spacing properties may not work as expected. + + + leaders with leader-pattern="use-content" may not work as expected. + + + keep-with-previous doesn't work inside tables and lists, yet. + + + If two consecutive pages don't have the same available width, the + content currently isn't properly fit into the available space on + the new page. + + + background-images on page-number-citations are not placed correctly. + + + Not all FO elements can be referenced by their "id", most notably: + table-body, table-header, table-footer and table-row. + + + The backgrounds of table-body, table-header, table-footer and + table-column are not painted, yet. + + + Border and padding conditionality are not supported on table-cells, yet. + + + Column balancing in multi-column documents may not work as expected + (Bugzilla #36356) + + diff --git a/src/documentation/content/xdocs/0.94/knownissues_overview.xml b/src/documentation/content/xdocs/0.94/knownissues_overview.xml new file mode 100644 index 000000000..5720424b7 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/knownissues_overview.xml @@ -0,0 +1,70 @@ + + + + + +
      + Apache FOP: Known Issues + $Revision$ +
      + +
      + Known issues +

      + This page lists currently known issues in the current release. +

      + +

      + For additional information on known issues in Apache FOP, please have a look at the following pages, too: +

      + +       +

      + Apache FOP has an extensive automated testing infrastructure. Parts of this infrastructure are several + sets of test cases. When a test case is listed in disabled-testcases.xml it is disabled in the JUnit + tests during the normal build process. This indicates a problem in the current codebase. When a bug is + fixed or a missing feature is added the entry for the relevant test case(s) are removed. +

      +
      + FO Tree +

      + This section lists disabled test cases in the test suite for the FO tree tests, at the time + of the release. +

      + +
      +
      + Layout Engine +

      + This section lists disabled test cases in the test suite for the layout engine tests, at the + time of the release. +

      + +
      +
      + Other known issues +

      This section lists other known issues.

      + +
      +
      + +       + diff --git a/src/documentation/content/xdocs/0.94/layoutengine/disabled-testcases.xml b/src/documentation/content/xdocs/0.94/layoutengine/disabled-testcases.xml new file mode 100644 index 000000000..d81c0dc27 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/layoutengine/disabled-testcases.xml @@ -0,0 +1,327 @@ + + + + + + + + External link around an SVG not properly sized + basic-link_external-destination_2.xml + The bpd trait of the inlineparent area for the basic-link + is not sized correctly if it wraps an image that is higher than the + nominal line. + + + Bugzilla #36391: reference-orientation + block-container_reference-orientation_bug36391.xml + There's a problem involving nested block-containers + and reference-orientation 180/-180. + http://issues.apache.org/bugzilla/show_bug.cgi?id=36391 + + + Auto-height block-containers produce fences + block-container_space-before_space-after_3.xml + Block-containers with no height currently don't + create a fence for spaces as they should (they behave like a + normal block). + + + font-stretch NYI + block_font-stretch.xml + Font-stretch is not implemented, yet. + + + Hyphenation with preserved linefeeds + block_hyphenation_linefeed_preserve.xml + When hyphenation is enabled and linefeeds are preserved linefeeds + are painted as '#' and the text is output multiple times. + + + linefeed-treatment + block_linefeed-treatment.xml + Preserved linefeeds in a fo:character are not handled + correctly. + + + white-space-treatment + block_white-space-treatment_3.xml + White space handling incorrectly stops at fo:inline + boundaries when it comes to formatter generated line breaks. + + + Empty blocks produce fences + block_space-before_space-after_8.xml + An empty block currently produces a fence for + stacking constraints which it shouldn't. + + + block white-space nbsp 2 + block_white-space_nbsp_2.xml + The nbsp given as an fo:character is not adjustable and therefore + the justification does not work in this case. + + + block word-spacing + block_word-spacing.xml + Word-spacing may not work as expected. + + + block word-spacing text-align justify + block_word-spacing_text-align_justify.xml + Word-spacing may not work as expected. + + + external-graphic don't shrink + external-graphic_oversized.xml + Images currently don't shrink so they fit on a page + when they are too big and shrinking is allowed to + happen (min/opt/max). + + + Test case with HTTP URL + external-graphic_src_uri.xml + Doesn't work behind a proxy which requires + authorization. + + + Space Resolution in foot note area + footnote_space-resolution.xml + Space resolution does not work between footnote + regions. + + + Footnotes swallowed in lists + footnote_in_list.xml + Element lists for lists are created by combining the + element lists from list-item-label and list-item-body. The + footnotes contained in the KnuthBlockBoxes are not propagated to + the combined element list. + http://issues.apache.org/bugzilla/show_bug.cgi?id=37579 + + + Footnotes swallowed in tables + footnote_in_table.xml + Element lists for tables are created by combining the + element lists from the individual table-cells. The footnotes + contained in the KnuthBlockBoxes are not propagated to the combined + element list. + http://issues.apache.org/bugzilla/show_bug.cgi?id=37579 + + + keeps on inlines NYI + inline_keep-together.xml + Keeps are not implemented in inline-level elements, yet. + + + NPE for table inside an inline + inline_block_nested_3.xml + Placing a table as a child of an fo:inline produces a + NullPointerException. + + + inline-container is not implemented, yet. + inline-container_block_nested.xml + inline-container is not implemented, yet. Content of an + inline-container will get swallowed. The test case contains no checks. + + + inline-container is not implemented, yet. + inline-container_border_padding.xml + inline-container is not implemented, yet. Content of an + inline-container will get swallowed. + + + inline letter-spacing + inline_letter-spacing.xml + Letter-spacing may not work as + expected within fo:inline. + + + inline word-spacing + inline_word-spacing.xml + Word-spacing may not work as expected within + fo:inline. + + + inline word-spacing text-align justify + inline_word-spacing_text-align_justify.xml + + + + leader-alignment NYI + leader-alignment.xml + Leader-alignment is not yet + implemented. + + + leader-pattern="use-content": Problem with line height + leader_leader-pattern_use-content_bug.xml + Line height is not correctly calculated for + use-content leaders whose height is larger than the rest of the + line. + http://www.nabble.com/leaders-with-leader-pattern%3D%22use-content%22-t546244.html + + + keep-with-previous doesn't work in lists + list-block_keep-with-previous.xml + Keep-with-previous doesn't work inside tables and + lists, yet. + + + keep-with-previous doesn't work in lists + list-item_block_keep-with-previous.xml + Keep-with-previous doesn't work inside tables and + lists, yet. + + + Page breaking doesn't deal with IPD changes + page-breaking_4.xml + Page breaking currently doesn't support changing available IPD + between pages of a single page-sequence. Element list generation has to be reset to + redetermine line breaks in this case. + + + Overflow handing is incomplete + page-breaking_6.xml + Line breaking is not 100% correct when there's too little space. + Overflows are not detected and warned. + + + Indefinite page height handling is imcomplete + page-height_indefinite_simple.xml + A RuntimeException is thrown for a page of indefinite height. Lots of warnings. + + + page-number-citation: Problem with background-image + page-number-citation_background-image.xml + Background-images on page-number-citations are not + placed correctly. + + + page-number-citation-last: FOs spanning multiple pages are not properly handled. + page-number-citation-last_basic.xml + Resolution of forward references does not wait until an FO is fully finished when an FO spans multiple pages. + + + IDs are not working on all FO elements + page-number-citation_complex_1.xml + The "id" attributes are not properly handled for all block-level FO elements. + + + IDs are not working on all FO elements + page-number-citation_complex_2.xml + The "id" attributes are not properly handled for all inline-level FO elements. + + + Footnotes in multi-column documents + region-body_column-count_footnote.xml + Footnotes may overlap with text of the region-body in + multi-column documents. + + + Column Balancing problems + region-body_column-count_balance_4col.xml + Situation in a 4-column document where the column balancing doesn't work and even causes some + content to disappear. + + + Column Balancing problems + region-body_column-count_bug36356.xml + Column balancing doesn't work as expected. + + + No background-images on table-body + table-body_background-image.xml + The backgrounds of table-body, table-header, + table-footer and table-column are not painted, yet. + + + Collapsing Border Model NYI + table_border-collapse_collapse_1.xml + Border-collapse="collapse" is not yet + implemented. + + + Collapsing Border Model NYI + table_border-collapse_collapse_2.xml + Border-collapse="collapse" is not yet + implemented. + + + Problems with border and padding on tables + table_border_padding.xml + The element list seems to not be fully correct, yet, causing + the layout to look odd. + + + keep-with-previous doesn't work inside tables + table-cell_block_keep-with-previous.xml + Keep-with-previous doesn't work inside tables and + lists, yet. + + + Border and padding conditionality is NYI on table-cells + table-cell_border_padding_conditionality.xml + Border and padding conditionality are not supported + on table-cells, yet. + + + No background-images on table-header + table-header_background-image.xml + The backgrounds of table-body, table-header, + table-footer and table-column are not painted, yet. + + + keep-with-previous doesn't work on table-rows + table-row_keep-with-previous.xml + Keep-with-previous doesn't work inside tables and + lists, yet. + + + table-cell empty area with marker.xml + table-cell_empty_area_with_marker.xml + A table-cell producing an empty area does currently not add any markers to a page. + See TODO entry in AreaAdditionUtil. + + + Border conditionality on table + table_border-width_conditionality.xml + The code should be ok, but the test case uses shorthands and therefore + is probably not expressing the indended outcome according to the spec. The test + case should be revisited. + + + fo:wrapper around block-level content (with id) + wrapper_block_id.xml + "id" attributes on fo:wrapper around block-level content don't get + added to the area tree. + + + Bugzilla #40230: invalid extra page break + block_break-after_bug40230.xml + Currently an extra page is created even if there is nothing + after a block with break-after="page" + http://issues.apache.org/bugzilla/show_bug.cgi?id=40230 + + + Soft hyphen with normal hyphenation enabled + block_shy_linebreaking_hyph.xml + A soft hyphen should be a preferred as break compared to a + normal hyphenation point but is not. + + diff --git a/src/documentation/content/xdocs/0.94/output.xml b/src/documentation/content/xdocs/0.94/output.xml new file mode 100644 index 000000000..998a5e1ce --- /dev/null +++ b/src/documentation/content/xdocs/0.94/output.xml @@ -0,0 +1,805 @@ + + + + + + +
      + Apache FOP Output Formats + $Revision$ + + + + +
      + + +

      + FOP supports multiple output formats by using a different renderer for each format. + The renderers do not all have the same set of capabilities, sometimes because of + the output format itself, sometimes because some renderers get more development + attention than others. +

      +
      + General Information +
      + Fonts +

      + Most FOP renderers use a FOP-specific system for font registration. + However, the Java2D/AWT and print renderers use the Java AWT package, which gets its + font information from the operating system registration. + This can result in several differences, including actually using different fonts, + and having different font metrics for the same font. + The net effect is that the layout of a given FO document can be quite different between + renderers that do not use the same font information. +

      +
      +
      + Output to a Printer or Other Device +

      + The most obvious way to print your document is to use the FOP + print renderer, which uses the Java2D API (AWT). + However, you can also send output from the Postscript renderer directly to a Postscript + device, or output from the PCL renderer directly to a PCL device. +

      +

      + Here are Windows command-line examples for Postscript and PCL: +

      + + +

      + Here is some Java code to accomplish the task in UNIX: +

      + +

      + Set the output MIME type to "application/x-pcl" (MimeConstants.MIME_PCL) and + it happily sends the PCL to the UNIX printer queue. +

      +
      +
      +
      + PDF +

      + PDF is the best supported output format. It is also the most accurate + with text and layout. This creates a PDF document that is streamed out + as each page is rendered. This means that the internal page index + information is stored near the end of the document. + The PDF version supported is 1.4. PDF versions are forwards/backwards + compatible. +

      +

      + Note that FOP does not currently support "tagged PDF" or PDF/A-1a. + Support for PDF/A-1b and PDF/X has recently been added, however. +

      +
      + Fonts +

      + PDF has a set of fonts that are always available to all PDF viewers; + to quote from the PDF Specification: + + "PDF prescribes a set of 14 standard fonts that can be used without prior + definition. + These include four faces each of three Latin text typefaces (Courier, + Helvetica, and Times), as well as two symbolic fonts (Symbol and ITC Zapf + Dingbats). These fonts, or suitable substitute fonts with the same metrics, are + guaranteed to be available in all PDF viewer applications." +

      +
      +
      + Post-processing +

      + FOP does not currently support several desirable PDF features: XMP metadata and watermarks. + One workaround is to use Adobe Acrobat (the full version, not the Reader) to process + the file manually or with scripting that it supports. +

      +

      + Another popular post-processing tool is iText, + which has tools for adding security features, document properties, watermarks, and many + other features to PDF files. +

      + + Caveat: iText may swallow PDF bookmarks. But + Jens Stavnstrup tells us + that this doesn't happen if you use iText's PDFStamper. + +

      + Here is some sample code that uses iText to encrypt a FOP-generated PDF. (Note that FOP now + supports PDF encryption. However the principles for using + iText for other PDF features are similar.) +

      + +

      + Check the iText tutorial and documentation for setting access flags, password, + encryption strength and other parameters. +

      +
      +
      + Watermarks +

      + In addition to the PDF Post-processing options, consider the following workarounds: +

      +
        +
      • + Use a background image for the body region. +
        • +
      • + (submitted by Trevor Campbell) Place an image in a + region that overlaps the flowing text. For example, make + region-before large enough to contain your image. Then include a + block (if necessary, use an absolutely positioned block-container) + containing the watermark image in the static-content for the + region-before. Note that the image will be drawn on top of the + normal content. +
        • +
      +
      +
      +
      + PostScript +

      + The PostScript renderer has been brought up to a similar quality as the + PDF renderer, but may still be missing certain 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 features used are the FlateDecode and DCTDecode + filter (the latter is used for 1:1 embedding of JPEG images), everything + else is Level 2. +

      +
      + Configuration +

      + The PostScript renderer configuration currently allows the following settings: +

      + + false + 3 + false +]]> +

      + The default value for the "auto-rotate-landscape" setting is "false". Setting it + to "true" will automatically rotate landscape pages and will mark them as landscape. +

      +

      + The default value for the "language-level" setting is "3". This setting specifies + the PostScript language level which should be used by FOP. Set this to "2" + only if you don't have a Level 3 capable interpreter. +

      +

      + The default value for the "optimize-resources" setting is "false". Setting it + to "true" will produce the PostScript file in two steps. A temporary file will be + written first which will then be processed to add only the fonts which were really + used and images are added to the stream only once as PostScript forms. This will + reduce file size but can potentially increase the memory needed in the interpreter + to process. +

      +
      +
      + Limitations +
        +
      • Images and SVG may not be displayed correctly. SVG support is far from being complete. No image transparency is available.
        • +
      • Only Type 1 fonts are supported.
        • +
      • Multibyte characters are not supported.
        • +
      • PPD support is still missing.
        • +
      +
      +
      +
      + PCL +

      + This format is for the Hewlett-Packard PCL printers and other printers + supporting PCL. It should produce output as close to identical as possible + to the printed output of the PDFRenderer within the limitations of the + renderer, and output device. +

      +

      + The output created by the PCLRenderer is generic PCL 5, HP GL/2 and PJL. + This should allow any device fully supporting PCL 5 to be able to + print the output generated by the PCLRenderer. PJL is used to control the + print job and switch to the PCL language. PCL 5 is used for text, raster + graphics and rectangular fill graphics. HP GL/2 is used for more complex + painting operations. Certain painting operations are done off-screen and + rendered to PCL as bitmaps because of limitations in PCL 5. +

      +
      + References + +
      +
      + Limitations +
        +
      • + Text or graphics outside the left or top of the printable area are not + rendered properly. This is a limitation of PCL, not FOP. In general, + things that should print to the left of the printable area are shifted + to the right so that they start at the left edge of the printable area. +
        • +
      • + The Helvetica and Times fonts are not well supported among PCL printers + so Helvetica is mapped to Arial and Times is mapped to Times New. This + is done in the PCLRenderer, no changes are required in the FO's. The + metrics and appearance for Helvetica/Arial and Times/Times New are + nearly identical, so this has not been a problem so far. +
        • +
      • For the non-symbol fonts, the ISO 8859-1 symbol set is used (PCL set "0N").
        • +
      • + All fonts available to the Java2D subsystem are usable. The texts are + painted as bitmap much like the Windows PCL drivers do. +
        • +
      • Multibyte characters are not supported.
        • +
      • + At the moment, only monochrome output is supported. PCL5c color extensions + will only be implemented on demand. Color and grayscale images are converted + to monochrome bitmaps (1-bit). Dithering only occurs if the JAI image library + is available. +
        • +
      • + Images are scaled up to the next resolution level supported by PCL (75, + 100, 150, 200, 300, 600 dpi). For color and grayscale images an even + higher PCL resolution is selected to give the dithering algorithm a chance + to improve the bitmap quality. +
        • +
      • + Currently, there's no support for clipping and image transparency, largely + because PCL 5 has certain limitations. +
        • +
      +
      +
      + Configuration +

      + The PCL renderer configuration currently allows the following settings: +

      + + quality + bitmap +]]> +

      + The default value for the "rendering" setting is "speed" which causes borders + to be painted as plain rectangles. In this mode, no special borders (dotted, + dashed etc.) are available. If you want support for all border modes, set the + value to "quality" as indicated above. This will cause the borders to be painted + as bitmaps. +

      +

      + The default value for the "text-rendering" setting is "auto" which paints the + base fonts using PCL fonts. Non-base fonts are painted as bitmaps through Java2D. + If the mix of painting methods results in unwelcome output, you can set this + to "bitmap" which causes all text to be rendered as bitmaps. +

      +

      + You can control the output resolution for the PCL using the "target resolution" + setting on the FOUserAgent. The actual value will be rounded up to the next + supported PCL resolution. Currently, only 300 and 600 dpi are supported which + should be enough for most use cases. Note that this setting directly affects + the size of the output file and the print quality. +

      +
      +
      + Extensions +

      The PCL Renderer supports some PCL specific extensions which can be embedded + into the input FO document. To use the extensions the appropriate namespace must + be declared in the fo:root element like this:

      + +]]> +
      + Page Source (Tray selection) +

      + The page-source extension attribute on fo:simple-page-master allows to + select the paper tray the sheet for a particular simple-page-master is + to be taken from. Example: +

      + + + ... + + +]]> +

      + Note: the tray number is a positive integer and the value depends on + the target printer. Not all PCL printers support the same paper trays. + Usually, + "1" is the default tray, + "2" is the manual paper feed, + "3" is the manual envelope feed, + "4" is the "lower" tray and + "7" is "auto-select". + Consult the technical reference for your printer for all available values. +

      +
      +
      +
      +
      + AFP + The AFP Renderer is a new addition (27-Apr-2006) to the sandbox and as such not yet fully tested or feature complete. +

      + The FOP AFP Renderer deals with creating documents conforming to the IBM AFP document architecture + also refered to as MO:DCA (Mixed Object Document Content Architecture). +

      +
      + References + +
      +
      + Limitations +

      This list is most likely badly incomplete.

      +
        +
      • + Clipping of text and graphics is not supported. +
        • +
      • + Only IBM outline and raster fonts and to a limited extend the original fonts built into FOP are supported. + Support for TrueType fonts may be added later. +
        • +
      +
      +
      + Configuration +
      + Fonts +

      The AFP Renderer requires special configuration particularly related to fonts. + AFP Render configuration is done through the normal FOP configuration file. The MIME type + for the AFP Renderer is application/x-afp which means the AFP Renderer section in the FOP configuration file + looks like:

      + + + ... +]]> +

      There are 3 font configuration variants supported:

      +
        +
      1. IBM Raster fonts
        2. +
      2. IBM Outline fonts
        3. +
      3. FOP built-in Base14 fonts
        4. +
      +

      A typical raster font configuration looks like:

      + + + + + + + + + + + + + + + + + + + + + + + + ]]> +

      An outline font configuration is simpler as the individual font size entries are not required. + However, the characterset definition is now required within the afp-font element.

      + + + + + + +]]> +

      Experimentation has shown that the font metrics for the FOP built-in Base14 fonts are actually + very similar to some of the IBM outline and raster fonts. In cases were the IBM font files are not + available the path attribute in the afp-font element can be replaced by a base14-font attribute + giving the name of the matching Base14 font. In this case the AFP Renderer will take the + font metrics from the built-in font.

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ]]> +
      +
      + Images +

      By default the AFP Renderer converts all images to 8 bit grey level. + This can be overridden by the <images> configuration element. Example:

      + +]]> +

      This will put images as RGB images into the AFP output stream. The default setting is:

      + +]]> +

      Only the values "color" and "b+w" are allowed for the mode attribute. The bits-per-pixel + attribute is ignored if mode is "color". For "b+w" mode is must be 1, 4, or 8.

      +
      +
      +
      + Extensions +

      The AFP Renderer supports some AFP specific extensions which can be embedded into the input + fo document. To use the extensions the appropriate namespace must be declared in the fo:root element like this:

      + +]]> +
      + Page Overlay Extension +

      The include-page-overlay extension element allows to define on a per simple-page-master basis a page overlay resource. Example:

      + + + + ... + + +]]> +

      The mandatory name attribute must refer to an 8 character (space padded) resource name that + must be known in the AFP processing environment.

      +
      +
      + Page Segment Extension +

      The include-page-segment extension element allows to define resource substitution for fo:external-graphics elements. + Example:

      + + + + + + + +]]> +

      The include-page-segment extension element can only occur within a simple-page-master. + Multiple include-page-segment extension elements within a simple-page-master are allowed. + The mandatory name attribute must refer to an 8 character + (space padded) resource name that must be known in the AFP processing environment. + The value of the mandatory src attribute is compared against the value of the src attribute in + fo:external-graphic elements and if it is identical (string matching is used) in the generated + AFP the external graphic is replaced by a reference to the given resource. +

      +
      +
      + Tag Logical Element Extension +

      The tag-logical-element extension element allows to injects TLEs into the AFP output stream. Example: + Example:

      + + + + + + + +]]> +

      The tag-logical-element extension element can only occur within a simple-page-master. + Multiple tag-logical-element extension elements within a simple-page-master are allowed. + The name and value attributes are mandatory. +

      +
      +
      +
      +
      + RTF +

      + JFOR, an open source XSL-FO to RTF converter has been integrated into Apache FOP. + This will create an RTF (rich text format) document that will + attempt to contain as much information from the fo document as + possible. The RTF output follows Microsoft's RTF specifications + and produces best results on Microsoft Word. +

      + RTF output is currently unmaintained and lacks many features compared to other output + formats. Using other editable formats like Open Document Format, instead of producing XSL-FO + then RTF through FOP, might give better results. +
      +
      + XML (Area Tree XML) +

      + This is primarily for testing and verification. The XML created is simply + a representation of the internal area tree put into XML. We use that to verify + the functionality of FOP's layout engine. +

      +

      + The other use case of the Area Tree XML is as FOP's "intermediate format". More information + on that can be found on the page dedicated to the Intermediate Format. +

      +
      +
      + Java2D/AWT +

      + The Java2DRenderer provides the basic functionality for all + Java2D-based output formats (AWT viewer, direct print, PNG, TIFF). +

      +

      + The AWT viewer shows a window with the pages displayed inside a + Java graphic. It displays one page at a time. + The fonts used for the formatting and viewing depend on the fonts + available to your JRE. +

      +
      +
      + Print +

      + It is possible to directly print the document from the command line. + This is done with the same code that renders to the Java2D/AWT renderer. +

      +
      +
      + Bitmap (TIFF/PNG) +

      + It is possible to directly create bitmap images from the individual + pages generated by the layout engine. + This is done with the same code that renders to the Java2D/AWT renderer. +

      +

      + Currently, two output formats are supported: PNG and TIFF. TIFF produces + one file with multiple pages, while PNG output produces one file per + page. The quality of the bitmap depends on the target resolution setting + on the FOUserAgent. +

      +
      + Configuration +

      + The TIFF and PNG renderer configuration currently allows the following settings: +

      + + true + +]]> +

      + The default value for the "transparent-page-background" setting is "false" which + paints an opaque, white background for the whole image. If you set this to true, + no such background will be painted and you will get a transparent image if + an alpha channel is available in the output format. +

      +
      +
      + TIFF-specific Configuration +

      + In addition to the above values the TIFF renderer configuration allows some additional + settings: +

      + + true + CCITT T.6 + +]]> +

      + The default value for the "compression" setting is "PackBits" which + which is a widely supported RLE compression scheme for TIFF. The set of compression + names to be used here matches the set that the Image I/O API uses. Note that + not all compression schemes may be available during runtime. This depends on the + actual codecs being available. Here is a list of possible values: +

      +
        +
      • NONE (no compression)
        • +
      • PackBits (RLE, run-length encoding)
        • +
      • JPEG
        • +
      • Deflate
        • +
      • LZW
        • +
      • ZLib
        • +
      • CCITT T.4 (Fax Group 3)
        • +
      • CCITT T.6 (Fax Group 4)
        • +
      + + If you want to use CCITT compression, please make sure you've got a J2SE 1.4 or later and + + Java Advanced Imaging Image I/O Tools + + in your classpath. The Sun JRE doesn't come with a TIFF codec built in, so it has to be + added separately. The internal TIFF codec from XML Graphics Commons only supports PackBits, + Deflate and JPEG compression for writing. + +
      +
      +
      + TXT +

      + The text renderer produces plain ASCII text output + that attempts to match the output of the PDFRenderer as closely as + possible. This was originally developed to accommodate an archive system + that could only accept plain text files, and is primarily useful for getting + a quick-and-dirty view of the document text. The renderer is very limited, + so do not be surprised if it gives unsatisfactory results. +

      +

      + The Text renderer works with a fixed size page buffer. The size of this + buffer is controlled with the textCPI and textLPI public variables. + The textCPI is the effective horizontal characters per inch to use. + The textLPI is the vertical lines per inch to use. From these values + and the page width and height the size of the buffer is calculated. + The formatting objects to be rendered are then mapped to this grid. + Graphic elements (lines, borders, etc) are assigned a lower priority + than text, so text will overwrite any graphic element representations. +

      +

      + Because FOP lays the text onto a grid during layout, there are frequently + extra or missing spaces between characters and lines, which is generally + unsatisfactory. + Users have reported that the optimal settings to avoid such spacing problems are: +

      +
        +
      • font-family="Courier"
        • +
      • font-size="7.3pt"
        • +
      • line-height="10.5pt"
        • +
      +
      +
      + Output Formats in the Sandbox +

      + Due to the state of certain renderers we moved some of them to a "sandbox" area until + they are ready for more serious use. The renderers and FOEventHandlers in the sandbox + can be found under src/sandbox and are compiled into build/fop-sandbox.jar during the + main build. The output formats in the sandbox are marked as such below. +

      +
      + MIF + The MIF handler is in the sandbox and not yet functional in FOP Trunk!!! Please help us ressurrect this feature. +

      + This format is the Maker Interchange Format which is used by + Adobe Framemaker. +

      +
      +
      + SVG + The SVG renderer is in the sandbox and may not work as expected in FOP Trunk!!! Please help us improve this feature. +

      + This format creates an SVG document that has links between the pages. + This is primarily for slides and creating svg images of pages. + Large documents will create SVG files that are far too large for + an SVG viewer to handle. Since FO documents usually have text the + SVG document will have a large number of text elements. + The font information for the text is obtained from the JVM in the + same way as for the AWT viewer. If the SVG is viewed on a + system where the fonts are different, such as another platform, + then the page may look wrong. +

      +
      +
      +
      + Wish list +

      + Apache FOP is easily extensible and allows you to add new output formats to enhance FOP's functionality. There's a number of output formats + which are on our wish list. We're looking for volunteers to help us implement them. +

      + +
      + + +       + diff --git a/src/documentation/content/xdocs/0.94/pdfa.xml b/src/documentation/content/xdocs/0.94/pdfa.xml new file mode 100644 index 000000000..49ffbeb71 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/pdfa.xml @@ -0,0 +1,159 @@ + + + + + +
      + PDF/A (ISO 19005) + $Revision: 389563 $ + + + +
      + +
      + Overview + + Support for PDF/A is available beginning with version 0.92. + +

      + PDF/A is a standard which turns PDF into an "electronic document file + format for long-term preservation". PDF/A-1 is the first part of the + standard and is documented in + ISO 19005-1:2005(E). + Work on PDF/A-2 is in progress at + AIIM. +

      +

      + Design documentation on PDF/A can be found on FOP's Wiki on the + PDFA1ConformanceNotes page. +

      +
      +
      + Implementation Status +

      + PDF/A-1b is implemented to the degree that FOP supports + the creation of the elements described in ISO 19005-1. +

      +

      + Tests have been performed against jHove and Adobe Acrobat 7.0.7 (Preflight function). + FOP does not validate completely against Apago's PDF Appraiser. Reasons unknown due to + lack of a full license to get a detailed error protocol. +

      +

      + PDF/A-1a is not implemented, yet. This is mostly because of the requirement + for tagged PDF which is not available in FOP, yet. +

      +
      +
      + Usage (command line) +

      + To activate PDF/A-1b from the command-line, specify "-pdfprofile PDF/A-1b" + as a parameter. If there is a violation of one of the validation rules for + PDF/A, an error message is presented and the processing stops. +

      +
      +
      + Usage (embedded) +

      + When FOP is embedded in another Java application you can set a special option + on the renderer options in the user agent to activate the PDF/A-1b profile. + Here's an example: +

      + +

      + If one of the validation rules of PDF/A is violated, an PDFConformanceException + (descendant of RuntimeException) is thrown. +

      +
      +
      + PDF/A in Action +

      + There are a number of things that must be looked after if you activate a PDF/A + profile. If you receive a PDFConformanceException, have a look at the following + list (not necessarily comprehensive): +

      +
        +
      • + Make sure all (!) fonts are embedded. If you use base 14 fonts (like Helvetica) + you need to obtain a license for them and embed them like any other font. +
        • +
      • + Don't use PDF encryption. PDF/A doesn't allow it. +
        • +
      • + Don't use CMYK images without an ICC color profile. PDF/A doesn't allow mixing + color spaces and FOP currently only properly supports the sRGB color space. Please + note that FOP embeds a standard sRGB ICC profile (sRGB IEC61966-2.1) as the + primary output intent for the PDF if no other output intent has been specified + in the configuration. +
        • +
      • + Don't use non-RGB colors in SVG images. Same issue as with CMYK images. +
        • +
      • + Don't use EPS graphics with fo:external-graphic. Embedding EPS graphics in PDF + is deprecated since PDF 1.4 and prohibited by PDF/A. +
        • +
      • + PDF is forced to version 1.4 if PDF/A-1 is activated. +
        • +
      • + No filter must be specified explicitely for metadata objects. Metadata must be + embedded in clear text so non-PDF-aware applications can extract the XMP metadata. +
        • +
      +
      +
      + PDF profile compatibility +

      + The PDF profiles "PDF/X-3:2003" and "PDF/A-1b" are compatible and can both be + activated at the same time. +

      +
      +
      + Interoperability +

      + There has been some confusion about the namespace for the PDF/A indicator in the XMP + metadata. At least three variants have been seen in the wild: +

      + + + + + + + + + + + + + +
      http://www.aiim.org/pdfa/ns/id.htmlobsolete, from an early draft of ISO-19005-1, used by Adobe Acrobat 7.x
      http://www.aiim.org/pdfa/ns/idobsolete, found in the original ISO 19005-1:2005 document
      http://www.aiim.org/pdfa/ns/id/correct, found in the technical corrigendum 1 of ISO 19005-1:2005
      +

      + If you get an error validating a PDF/A file in Adobe Acrobat 7.x it doesn't mean that + FOP did something wrong. It's Acrobat that is at fault. This is fixed in Adobe Acrobat 8.x + which uses the correct namespace as described in the technical corrigendum 1. +

      +
      + +       diff --git a/src/documentation/content/xdocs/0.20.5/pdfencryption.xml b/src/documentation/content/xdocs/0.94/pdfencryption.xml similarity index 79% rename from src/documentation/content/xdocs/0.20.5/pdfencryption.xml rename to src/documentation/content/xdocs/0.94/pdfencryption.xml index 030c022b1..c8cdbb29c 100644 --- a/src/documentation/content/xdocs/0.20.5/pdfencryption.xml +++ b/src/documentation/content/xdocs/0.94/pdfencryption.xml @@ -16,9 +16,7 @@ limitations under the License. --> - - +
      PDF encryption. @@ -31,7 +29,6 @@
      Overview - PDF Encryption is available in Release 0.20.5 and later. The comments on this page do not apply to releases earlier than 0.20.5.

      FOP supports encryption of PDF output, thanks to Patrick C. Lankswert. This feature is commonly used to prevent @@ -135,22 +132,45 @@ An example to enable PDF encryption in Java code:

      +import org.apache.fop.pdf.PDFEncryptionParams; + +[..] + +FOUserAgent userAgent = fopFactory.newFOUserAgent(); +useragent.getRendererOptions().put("encryption-params", new PDFEncryptionParams( + null, "password", false, false, true, true)); +Fop fop = fopFactory.newFop(MimeConstants.MIME_PDF, userAgent); +[..]]]> +

      + The parameters for the constructor of PDFEncryptionParams are: +

      +
        +
      1. userPassword: String, may be null
        2. +
      2. ownerPassword: String, may be null
        3. +
      3. allowPrint: true if printing is allowed
        4. +
      4. allowCopyContent: true if copying content is allowed
        5. +
      5. allowEditContent: true if editing content is allowed
        6. +
      6. allowEditAnnotations: true if editing annotations is allowed
        7. +
      +

      + Alternatively, you can set each value separately in the Map provided by + FOUserAgent.getRendererOptions() by using the following keys: +

      +
        +
      1. user-password: String
        2. +
      2. owner-password: String
        3. +
      3. noprint: Boolean or "true"/"false"
        4. +
      4. nocopy: Boolean or "true"/"false"
        5. +
      5. noedit: Boolean or "true"/"false"
        6. +
      6. noannotations: Boolean or "true"/"false"
        7. +
      Environment

      In order to use PDF encryption, FOP has to be compiled with - cryptography support. Currently, only JCE + cryptography support. Currently, only JCE is supported. JCE is part of JDK 1.4. For earlier JDKs, it can be installed separately. The build process automatically detects JCE presence and installs PDF encryption support if @@ -168,18 +188,18 @@ driver.setOutputStream(...]]>

      There are several commercial and a few Open Source packages which - provide RC4. A pure Java implementation is produced by The Legion of the Bouncy - Castle. . Mozilla - JSS is an interface to a native implementation. + JSS is an interface to a native implementation.

      Installing a crypto provider

      - The pure Java implementation from Bouncy Castle is easy to + The pure Java implementation from Bouncy Castle is easy to install.

        @@ -198,7 +218,7 @@ driver.setOutputStream(...]]> Open the java.security file and add
        security.provider.6=org.bouncycastle.jce.provider.BouncyCastleProvider,
        preferably at the end of the block defining the other crypto - providers. For JDK 1.4 this is detailed on Sun's web site. + providers. For JDK 1.4 this is detailed on Sun's web site.

      diff --git a/src/documentation/content/xdocs/0.94/pdfx.xml b/src/documentation/content/xdocs/0.94/pdfx.xml new file mode 100644 index 000000000..342a0ca4c --- /dev/null +++ b/src/documentation/content/xdocs/0.94/pdfx.xml @@ -0,0 +1,136 @@ + + + + + +

      + PDF/X (ISO 15930) + $Revision$ + + + +
      + +
      + Overview + + Support for PDF/X was made available beginning with version 0.93. + This feature is new and may not be 100% complete, yet. Feedback is welcome. + +

      + PDF/X is a standard which faciliates prepress digital data exchange using PDF. + Currently, only PDF/X-3:2003 is implemented out of the many different flavours of PDF/X + profiles. PDF/X-3:2003 is documented in + ISO 15930-6:2003(E). + More info on PDF/X can be found on the + PDF/X info site. +

      +
      +
      + Implementation Status +

      + PDF/X-3:2003 is implemented to the degree that FOP supports + the creation of the elements described in ISO 15930-6. +

      +

      + An important restriction of the current implementation is that all normal + RGB colors specified in XSL-FO and SVG are left unchanged in the sRGB color + space (XSL-FO and SVG both use sRGB as their default color space). + There's no conversion to a CMYK color space. Although sRGB is a + calibrated color space, its color space has a different size than a CMYK + color space which makes the conversion a lossy conversion and can lead to + unwanted results. Although the use of the calibrated sRGB has been promoted + for years, print shops usually prefer to convert an sRGB PDF to CMYK prior + to production. Until there's full CMYK support in FOP you will have to + work closely with your print service provider to make sure you get the + intended result. +

      +

      + Tests have been performed against Adobe Acrobat 7.0.7 (Preflight function). + Note that there are bugs in Adobe Acrobat which cause false alarms if both + PDF/A-1b and PDF/X-3:2003 are activated at the same time. +

      +
      +
      + Usage (command line) +

      + To activate PDF/X-3:2003 from the command-line, specify "-pdfprofile PDF/X-3:2003" + as a parameter. If there is a violation of one of the validation rules for + PDF/X, an error message is presented and the processing stops. +

      +
      +
      + Usage (embedded) +

      + When FOP is embedded in another Java application you can set a special option + on the renderer options in the user agent to activate the PDF/A-1b profile. + Here's an example: +

      + +

      + If one of the validation rules of PDF/X is violated, an PDFConformanceException + (descendant of RuntimeException) is thrown. +

      +
      +
      + PDF/X in Action +

      + There are a number of things that must be looked after if you activate a PDF/X + profile. If you receive a PDFConformanceException, have a look at the following + list (not necessarily comprehensive): +

      +
        +
      • + Make sure all (!) fonts are embedded. If you use base 14 fonts (like Helvetica) + you need to obtain a license for them and embed them like any other font. +
        • +
      • + Don't use PDF encryption. PDF/X doesn't allow it. +
        • +
      • + Don't use CMYK images without an ICC color profile. PDF/X doesn't allow mixing + color spaces and FOP currently only properly supports the sRGB color space. However, + you will need to specify an + output device profile + (usually a CMYK profile) in the configuration. sRGB won't work here since it's a + display device profile, not an output device profile. +
        • +
      • + Don't use non-RGB colors in SVG images. Same issue as with CMYK images. +
        • +
      • + Don't use EPS graphics with fo:external-graphic. Embedding EPS graphics in PDF + is deprecated since PDF 1.4 and prohibited by PDF/X-3:2003. +
        • +
      • + PDF is forced to version 1.4 if PDF/X-3:2003 is activated. +
        • +
      +
      +
      + PDF profile compatibility +

      + The PDF profiles "PDF/X-3:2003" and "PDF/A-1b" are compatible and can both be + activated at the same time. +

      +
      + + diff --git a/src/documentation/content/xdocs/0.94/running.xml b/src/documentation/content/xdocs/0.94/running.xml new file mode 100644 index 000000000..c09f35fee --- /dev/null +++ b/src/documentation/content/xdocs/0.94/running.xml @@ -0,0 +1,348 @@ + + + + + +
      + Running Apache FOP + $Revision$ +
      + + +
      + System Requirements +

      The following software must be installed:

      + +

      The following software is optional, depending on your needs:

      +
        +
      • + Graphics libraries. Generally, FOP contains direct support for the most important + bitmap image formats (including PNG, TIFF, JPEG and GIF). If you're using JDK 1.3, + you may need additional packages to get GIF images to work. See + FOP: Graphics Formats for details. +
        • +
      • + PDF encryption. See FOP: PDF Encryption for details. +
        • +
      +

      In addition, the following system requirements apply:

      +
        +
      • + If you will be using FOP to process SVG, you must do so in a graphical environment. + See FOP: Graphics (Batik) for details. +
        • +
      +
      +
      + Installation +
      + Instructions +

      + Basic FOP installation consists of first unzipping the .gz file that is the + distribution medium, then unarchiving the resulting .tar file in a + directory/folder that is convenient on your system. Please consult your operating system + documentation or Zip application software documentation for instructions specific to your + site. +

      +
      +
      + Problems +

      + Some Mac OSX users have experienced filename truncation problems using Stuffit to unzip + and unarchive their distribution media. This is a legacy of older Mac operating systems, + which had a 31-character pathname limit. Several Mac OSX users have recommended that + Mac OSX users use the shell command tar -xzf instead. +

      +
      +
      +
      + Starting FOP as a Standalone Application +
      + Using the fop script or batch file +

      + The usual and recommended practice for starting FOP from the command line is to run the + batch file fop.bat (Windows) or the shell script fop (Unix/Linux). + These scripts require that the environment variable JAVA_HOME be + set to a path pointing to the appropriate Java installation on your system. Macintosh OSX + includes a Java environment as part of its distribution. We are told by Mac OSX users that + the path to use in this case is /Library/Java/Home. Caveat: + We suspect that, as Apple releases new Java environments and as FOP upgrades the minimum + Java requirements, the two will inevitably not match on some systems. Please see + Java on Mac OSX FAQ for information as + it becomes available. +

      + + [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 + -r relaxed/less strict validation (where available) + -dpi xxx target resolution in dots per inch (dpi) where xxx is a number + -s for area tree XML, down to block areas only + -v to show FOP version being used + + -o [password] PDF file will be encrypted with option owner password + -u [password] PDF file will be encrypted with option user password + -noprint PDF file will be encrypted without printing permission + -nocopy PDF file will be encrypted without copy content permission + -noedit PDF file will be encrypted without edit content permission + -noannotations PDF file will be encrypted without edit annotation permission + -pdfprofile prof PDF file will be generated with the specified profile + (Examples for prof: PDF/A-1b or PDF/X-3:2003) + + [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 + -atin infile area tree input file + -xsl stylesheet xslt stylesheet + + -param name value to use for parameter in xslt stylesheet + (repeat '-param name value' for each parameter) + + [OUTPUT] + outfile input will be rendered as PDF into outfile + -pdf outfile input will be rendered as PDF (outfile req'd) + -pdfa1b outfile input will be rendered as PDF/A-1b compliant PDF + (outfile req'd, same as "-pdf outfile -pdfprofile PDF/A-1b") + -awt input will be displayed on screen + -rtf outfile input will be rendered as RTF (outfile req'd) + -pcl outfile input will be rendered as PCL (outfile req'd) + -ps outfile input will be rendered as PostScript (outfile req'd) + -afp outfile input will be rendered as AFP (outfile req'd) + -tiff outfile input will be rendered as TIFF (outfile req'd) + -png outfile input will be rendered as PNG (outfile req'd) + -txt outfile input will be rendered as plain text (outfile req'd) + -at [mime] out representation of area tree as XML (outfile req'd) + specify optional mime output to allow AT to be converted + to final format later + -print input file will be rendered and sent to the printer + see options with "-print help" + -out mime outfile input will be rendered using the given MIME type + (outfile req'd) Example: "-out application/pdf D:\out.pdf" + (Tip: "-out list" prints the list of supported MIME types) + -mif outfile input will be rendered as MIF (FrameMaker) (outfile req'd) + Experimental feature - requires additional fop-sandbox.jar. + -svg outfile input will be rendered as an SVG slides file (outfile req'd) + Experimental feature - requires additional fop-sandbox.jar. + + -foout outfile input will only be XSL transformed. The intermediate + XSL-FO file is saved and no rendering is performed. + (Only available if you use -xml and -xsl parameters) + + + [Examples] + Fop foo.fo foo.pdf + Fop -fo foo.fo -pdf foo.pdf (does the same as the previous line) + Fop -xml foo.xml -xsl foo.xsl -pdf foo.pdf + Fop -xml foo.xml -xsl foo.xsl -foout foo.fo + Fop foo.fo -mif foo.mif + Fop foo.fo -rtf foo.rtf + Fop foo.fo -print or Fop -print foo.fo + Fop foo.fo -awt]]> +

      + PDF encryption is only available if FOP was compiled with encryption support + and if compatible encryption support is available at run time. + Currently, only the JCE is supported. Check the Details. +

      +
      +
      + Writing your own script +

      FOP's entry point for your own scripts is the class +org.apache.fop.cli.Main. The general pattern for the + command line is: java -classpath <CLASSPATH> + org.apache.fop.cli.Main <arguments>. The arguments + consist of the options and infile and outfile specifications + as shown above for the standard scripts. You may wish to review + the standard scripts to make sure that + you get your environment properly configured. +

      +
      +
      + Running with java's <code>-jar</code> option +

      + As an alternative to the start scripts you can run java + -jar path/to/build/fop.jar <arguments>, relying on + FOP to build the classpath for running FOP dynamically, see below. If you use hyphenation, + you must put fop-hyph.jar in the lib + directory. +

      + +

      You can also run java -jar path/to/fop.jar + <arguments>, relying on the Class-Path + entry in the manifest file. This works if you put + fop.jar and all jar files from the lib + directory in a single directory. If you use hyphenation, you + must also put fop-hyph.jar in that directory.

      + +

      In both cases the arguments consist of the options and + infile and outfile specifications as shown above for the + standard scripts.

      +
      +
      + FOP's dynamical classpath construction + +

      If FOP is started without a proper classpath, it tries to + add its dependencies dynamically. If the system property + fop.home contains the name of a directory, then + FOP uses that directory as the base directory for its + search. Otherwise the current working directory is the base + directory. If the base directory is called build, + then its parent directory becomes the base directory.

      + +

      FOP expects to find fop.jar in the + build subdirectory of the base directory, and + adds it to the classpath. Subsequently FOP adds all + jar files in the lib directory to the + classpath. The lib directory is either the lib + subdirectory of the base directory, or, if that does not + exist, the base directory itself.

      + +

      If the system property fop.optional.lib + contains the name of a directory, then all jar + files in that directory are also added to the classpath. See + the methods getJARList and + checkDependencies in + org.apache.fop.cli.Main.

      + +
      +
      +
      + Using Xalan to Check XSL-FO Input +

      + FOP sessions that use -xml and -xsl input instead of -fo input are actually + controlling two distinct conversions: Tranforming XML to XSL-FO, then formatting + the XSL-FO to PDF (or another FOP output format). + Although FOP controls both of these processes, the first is included merely as + a convenience and for performance reasons. + Only the second is part of FOP's core processing. + If a user has a problem running FOP, it is important to determine which of these + two processes is causing the problem. + If the problem is in the first process, the user's stylesheet is likely the cause. + The FOP development team does not have resources to help with stylesheet issues, + although we have included links to some useful + Specifications and + Books/Articles. + If the problem is in the second process, FOP may have a bug or an unimplemented + feature that does require attention from the FOP development team. +

      + The user is always responsible to provide correct XSL-FO code to FOP. +

      + In the case of using -xml and -xsl input, although the user is responsible for + the XSL-FO code that is FOP's input, it is not visible to the user. To make the + intermediate FO file visible, the FOP distribution includes the "-foout" option + which causes FOP to run only the first (transformation) step, and write the + results to a file. (See also the Xalan command-line below) +

      + + When asking for help on the FOP mailing lists, never attach XML and + XSL to illustrate the issue. Always run the XSLT step (-foout) and send the + resulting XSL-FO file instead. Of course, be sure that the XSL-FO file is + correct before sending it. + +

      + The -foout option works the same way as if you would call the + Xalan command-line: +

      +

      + java org.apache.xalan.xslt.Process -IN xmlfile -XSL file -OUT outfile +

      +

      + Note that there are some subtle differences between the FOP and Xalan command-lines. +

      +
      +
      + Memory Usage +

      + FOP can consume quite a bit of memory, even though this has been continually improved. + This is partly inherent to the formatting process and partly caused by implementation choices. + All FO processors currently on the market have memory problems with certain layouts. +

      +

      + If you are running out of memory when using FOP, here are some ideas that may help: +

      +
        +
      • + Increase memory available to the JVM. See + the -Xmx option + for more information. + + It is usually unwise to increase the memory allocated to the JVM beyond the amount of + physical RAM, as this will generally cause significantly slower performance. + +
        • +
      • + Avoid forward references. + Forward references are references to some later part of a document. + Examples include page number citations which refer to pages which follow the citation, + tables of contents at the beginning of a document, and page numbering schemes that + include the total number of pages in the document + ("page N of TOTAL"). + Forward references cause all subsequent pages to be held in memory until the reference + can be resolved, i.e. until the page with the referenced element is encountered. + Forward references may be required by the task, but if you are getting a memory + overflow, at least consider the possibility of eliminating them. + A table of contents could be replaced by PDF bookmarks instead or moved to the end of + the document (reshuffle the paper could after printing). +
        • +
      • + Avoid large images, especially if they are scaled down. + If they need to be scaled, scale them in another application upstream from FOP. + For many image formats, memory consumption is driven mainly by the size of the image + file itself, not its dimensions (width*height), so increasing the compression rate + may help. +
        • +
      • + Use multiple page sequences. + FOP starts rendering after the end of a page sequence is encountered. + While the actual rendering is done page-by-page, some additional memory is + freed after the page sequence has been rendered. + This can be substantial if the page sequence contains lots of FO elements. +
        • +
      +
      +
      + Problems +

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

      +
      + +       diff --git a/src/documentation/content/xdocs/0.20.5/servlets.xml b/src/documentation/content/xdocs/0.94/servlets.xml similarity index 63% rename from src/documentation/content/xdocs/0.20.5/servlets.xml rename to src/documentation/content/xdocs/0.94/servlets.xml index 1a7514c1e..119ac701e 100644 --- a/src/documentation/content/xdocs/0.20.5/servlets.xml +++ b/src/documentation/content/xdocs/0.94/servlets.xml @@ -16,30 +16,29 @@ limitations under the License. --> - +
      Servlets - How to use FOP in a Servlet + How to use Apache FOP in a Servlet $Revision$
      Overview

      - This page discusses topic all around using FOP in a servlet environment. + This page discusses topic all around using Apache FOP in a servlet environment.

      Example Servlets in the FOP distribution

      - In the directory {fop-dir}/examples/servlet, you'll find a working example + In the directory {fop-dir}/src/java/org/apache/fop/servlet, you'll find a working example of a FOP-enabled servlet.

      - You can build the servlet easily by using the supplied Ant script. After building - the servlet, drop fop.war into the webapps directory of Tomcat. Then, you can use + The servlet is automatically built when you build Apache FOP using the supplied Ant script. After building + the servlet, drop fop.war into the webapps directory of Apache Tomcat (or any other web container). Then, you can use URLs like the following to generate PDF files:

        @@ -47,26 +46,35 @@
      • http://localhost:8080/fop/fop?xml=/home/path/to/xmlfile.xml&xsl=/home/path/to/xslfile.xsl

      -

      The source code for the servlet can be found under {fop-dir}/examples/servlet/src/FopServlet.java.

      +

      The source code for the servlet can be found under {fop-dir}/src/java/org/apache/fop/servlet/FopServlet.java.

      + + This example servlet should not be used on a public web server connected to the Internet as it does not contain + any measures to prevent Denial-of-Service-Attacks. It is provided as an example and as a starting point for + your own servlet. +
      Create your own Servlet - This section assumes you are familiar with embedding FOP. + This section assumes you are familiar with embedding FOP.
      A minimal Servlet

      Here is a minimal code snippet to demonstrate the basics:

      - public void doGet(HttpServletRequest request, + private FopFactory fopFactory = FopFactory.newInstance(); +private TransformerFactory tFactory = TransformerFactory.newInstance(); + +public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException { try { response.setContentType("application/pdf"); - Driver driver = new Driver(new InputSource("foo.fo"), - response.getOutputStream()); - driver.setRenderer(Driver.RENDER_PDF); - driver.run(); + Fop fop = fopFactory.newFop(MimeConstants.MIME_PDF, response.getOutputStream()); + Transformer transformer = tFactory.newTransformer(); + Source src = new StreamSource("foo.fo"); + Result res = new SAXResult(fop.getDefaultHandler()); + transformer.transform(src, res); } catch (Exception ex) { throw new ServletException(ex); } @@ -80,37 +88,32 @@
      Adding XSL tranformation (XSLT)

      - A common requirement is the to transform an XML source to - XSLFO using an XSL transformation. It is recommended to use + A common requirement is to transform an XML source to + XSL-FO using an XSL transformation. It is recommended to use JAXP for this task. The following snippet shows the basic code:

      - -protected Logger log; -protected TransformerFactory transformerFactory; + private FopFactory fopFactory = FopFactory.newInstance(); +private TransformerFactory tFactory = TransformerFactory.newInstance(); public void init() throws ServletException { - this.log = new SimpleLog(SimpleLog.LOG_LEVEL_WARN); - this.transformerFactory = TransformerFactory.newInstance(); + //Optionally customize the FopFactory and TransformerFactory here } [..] - //Setup FOP - Driver driver = new Driver(); - driver.setLogger(this.log); - driver.setRenderer(Driver.RENDER_PDF); - //Setup a buffer to obtain the content length ByteArrayOutputStream out = new ByteArrayOutputStream(); - driver.setOutputStream(out); + + //Setup FOP + Fop fop = fopFactory.newFop(MimeConstants.MIME_PDF, out); //Setup Transformer Source xsltSrc = new StreamSource(new File("foo-xml2fo.xsl")); - Transformer transformer = this.transformerFactory.newTransformer(xsltSrc); + Transformer transformer = tFactory.newTransformer(xsltSrc); //Make sure the XSL transformation's result is piped through to FOP - Result res = new SAXResult(driver.getContentHandler()); + Result res = new SAXResult(fop.getDefaultHandler()); //Setup input Source src = new StreamSource(new File("foo.xml")); @@ -127,7 +130,7 @@ public void init() throws ServletException { response.getOutputStream().flush(); Buffering the generated PDF in a ByteArrayOutputStream is done to avoid potential - problems with the Acrobat Reader Plug-in in IEx. + problems with the Acrobat Reader Plug-in in Microsoft Internet Explorer.

      The Source instance used above is simply an @@ -141,21 +144,14 @@ public void init() throws ServletException {

      Because you have an explicit Transformer object, you can also use it to - explicitly set parameters for the transformation run. + explicitely set parameters for the transformation run.

      Custom configuration

      - If you need to supply a special configuration do this in the init() - method so it will only be done once and to avoid multithreading problems. + You can easily set up your own FOUserAgent as demonstrated on the Embedding page.

      - public void init() throws ServletException { - [..] - new Options(new File("userconfig.xml")); - //or - Configuration.put("baseDir", "/my/base/dir"); -}
      Improving performance @@ -165,7 +161,8 @@ public void init() throws ServletException {
      • Instead of java.io.ByteArrayOutputStream consider using the ByteArrayOutputStream - implementation from the Jakarta Commons IO project which allocates less memory. + implementation from the Jakarta Commons IO project which allocates less memory. + The full class name is: org.apache.commons.io.output.ByteArrayOutputStream
      • In certain cases it can help to write the generated PDF to a temporary file so @@ -176,10 +173,75 @@ public void init() throws ServletException {

      Of course, the - performance hints from the Embedding page + performance hints from the Embedding page apply here, too.

      +
      + Accessing resources in your web application +

      + Often, you will want to use resources (stylesheets, images etc.) which are bundled with + your web application. FOP provides a URIResolver implementation that lets you access + files via the Servlet's ServletContext. The class is called + org.apache.fop.servlet.ServletContextURIResolver. +

      +

      + Here's how to set it up in your servlet. Instantiate a new instance in the servlet's + init() method: +

      + +

      + The ServletContextURIResolver reacts on URIs beginning with "servlet-context:". If you + want to access an image in a subdirectory of your web application, you could, for + example, use: "servlet-context:/images/myimage.png". Don't forget the leading slash + after the colon! +

      +

      + Further down, you can use the URIResolver for various things: +

      +
        +
      • + With the Transformer (JAXP/XSLT) so things like document() functions can resolver + "servlet-context:" URIs. +
        • +
      • + With the FopFactory so every resource FOP loads can be loaded using a "servlet-context:" + URI. +
        • +
      • + You can the ServletContextURIResolver yourself in your servlet code to access + stylesheets or XML files bundled with your web application. +
        • +
      +

      + Here are some example snippets: +

      + +
      Notes on Microsoft Internet Explorer @@ -255,10 +317,9 @@ public void init() throws ServletException {

      Sometimes the requirements for a servlet get quite sophisticated: SQL data sources, multiple XSL transformations, merging of several datasources etc. In such a case - consider using Apache Cocoon instead + consider using Apache Cocoon instead of a custom servlet to accomplish your goal.

      - - + \ No newline at end of file diff --git a/src/documentation/content/xdocs/0.94/upgrading.xml b/src/documentation/content/xdocs/0.94/upgrading.xml new file mode 100644 index 000000000..b9bec0d66 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/upgrading.xml @@ -0,0 +1,132 @@ + + + + + +
      + Upgrading from an Earlier Version of Apache FOP + $Revision$ +
      + +
      + Important! +

      + If you're planning to upgrade to the latest FOP version there are a few very important things + to consider: +

      +
        +
      • + More than half of the codebase has been rewritten over the last three years. With version 0.93 the code has reached production level, and + the tradition continues with version 0.94. +
        • +
      • + The API of FOP has changed considerably and is not + backwards-compatible with versions 0.20.5 and + 0.91beta. Version 0.92 introduced the new stable + API. +
        • +
      • + Since version 0.92 some deprecated methods which were part + of the old API have been removed. If you upgrade from 0.91 + beta, you will need to adjust your Java code. Similarly if + you upgrade from 0.92 and use deprecated methods. +
        • +
      • + If you are using a configuration file for version 0.20.5, you have to rebuild it in the new format. The format + of the configuration files has changed since version 0.20.5. See conf/fop.xconf for + an example configuration file. A XML Schema file can be found under + src/foschema/fop-configuration.xsd. +
        • +
      • + If you are using font metrics files for version 0.20.5 or + 0.92 or earlier, you have to regenerate them in the new + format. The new format is characterized by a version + attribute on the top-level font-metrics element, whose value + is 2.0. The absence of a version attribute will be + interpreted as version 1.0, and such metrics files will no + longer be parsed. +
        • +
      • +

        + The new code is much more strict about the interpretation of the XSL-FO 1.0 specification. + Things that worked fine in version 0.20.5 might start to produce warnings or even errors + now. FOP 0.20.5 contains many bugs which have been corrected in the new code. +

        + + While FOP 0.20.5 allowed you to have empty fo:table-cell elements, the new code + will complain about that (unless relaxed validation is enabled via the -r switch via the command line) because the specification + demands at least one block-level element ((%block;)+, see + XSL-FO 1.0, 6.7.10) + inside an fo:table-cell element. + +
        • +
      • + Extensions and Renderers written for version 0.20.5 will not work with the new code! The new FOP + extension for Barcode4J is available since + January 2007. +
        • +
      • + The SVG Renderer and the MIF Handler have not been resurrected, yet! They are currently non-functional + and hope for someone to step up and reimplement them. +
        • +
      +
      +
      + What you need to know when you upgrade! +

      + When you use your existing FO files or XML/XSL files which work fine with FOP version + 0.20.5 against this FOP version some things may not work as expected. The following + list will hopefully help you to identify and correct those problems. +

      +
        +
      • + Check the Compliance page for the feature causing + trouble. It may contain the necessary information to understand and resolve the problem. +
        • +
      • + Not all 0.20.5 output formats are supported. PDF and Postscript should be fully supported. + See Output Targets for a more complete description. +
        • +
      • + As stated above empty table cells <fo:table-cell></fo:table-cell> + are not allowed by the specification. The same applies to empty static-content + and block-container elements, for example. +
        • +
      • + 0.20.5 is not XSL-FO compliant with respect to sizing images (external-graphic) + or instream-foreign-object + objects. If images or SVGs are sized differently in your outputs with the new FOP version + check Bug 37136 + as it contains some hints on what to do. The file + + "examples/fo/basic/images.fo" has + a number of good examples that show the new, more correct behaviour. +
        • +
      • + The fox:outline extension is not implemented in this version anymore. + It has been superseded by the new bookmark elements from XSL-FO 1.1. +
        • +
      • + The fox:destination extension is also not implemented in this version + although it may be added in the future. See also + Bug 37157. +
        • +
      +
      + +       diff --git a/src/documentation/content/xdocs/compliance.ihtml b/src/documentation/content/xdocs/compliance.ihtml index 4860eb5c7..2a2768457 100644 --- a/src/documentation/content/xdocs/compliance.ihtml +++ b/src/documentation/content/xdocs/compliance.ihtml @@ -190,8104 +190,5748 @@ + Object Name + XSL-FO Conformance Level - + Citation + + Comments + 0.20.5 (previous) + + 0.94 (stable) + develop- ment - + + root + Basic + §6.4.2 + yes + + yes - + yes + + declarations + Basic + §6.4.3 + no + + no - + no + + color-profile + Extended + §6.4.4 + no + + no - + no + + page-sequence + Basic + §6.4.5 + yes + + yes - + yes + + layout-master-set + Basic + §6.4.6 + yes + + yes - + yes + + page-sequence-master + Basic + §6.4.7 + yes + + yes - + yes + + single-page-master-reference + Basic + §6.4.8 + yes + + yes - + yes + + repeatable-page-master-reference + Basic + §6.4.9 + yes + + yes - + yes + + repeatable-page-master-alternatives + Extended + §6.4.10 + yes + + yes - + yes + + conditional-page-master-reference + Extended + §6.4.11 + yes + + yes - + yes + + simple-page-master + Basic + §6.4.12 + yes + + partial + partial + [0.93 and later] The page width may not change among pages of the same page-sequence + unless a forced break is inserted. + + region-body + Basic + §6.4.13 + yes + + yes - + yes + + region-before + Extended + §6.4.14 + yes + + yes - + yes + + region-after + Extended + §6.4.15 + yes + + yes - + yes + + region-start + Extended + §6.4.16 + yes + + yes - + yes + + region-end + Extended + §6.4.17 + yes + + yes - + yes + + flow + Basic + §6.4.18 + yes + + yes - + yes + + static-content + Extended + §6.4.19 + yes + + yes - + yes + + title + Extended + §6.4.20 + no + + no - + no + - + + block + Basic + §6.5.2 + yes + + yes - + yes + + block-container + Extended + §6.5.3 + partial + + partial + partial + [0.93 and later] No known restrictions. + - + + bidi-override + Extended + §6.6.2 + no + + no - + no + + character + Basic + §6.6.3 + yes + + yes - + yes + + initial-property-set + Extended + §6.6.4 + no + + no - + no + + external-graphic + Basic + §6.6.5 + yes + + yes - + yes + + instream-foreign-object + Extended + §6.6.6 + yes + + yes + yes + + inline + Basic + §6.6.7 + yes + + yes - + yes + + inline-container + Extended + §6.6.8 + no + + no - + no + + leader + Basic + §6.6.9 + partial + + yes - + yes + + page-number + Basic + §6.6.10 + yes + + yes - + yes + + page-number-citation + Extended + §6.6.11 + partial + + partial + partial + [0.93 and later] After the page number is known, no relayout is performed. The appearance may be suboptimal depending on the use case. + - + + table-and-caption + Basic + §6.7.2 + no + + no - + no + + table + Basic + §6.7.3 + partial + + partial + partial + table-column + Basic + §6.7.4 + partial + + yes + yes + [0.20.5] You must explicitly specify column widths. + + table-caption + Extended + §6.7.5 + no + + no - + no + + table-header + Basic + §6.7.6 + yes + + yes - + yes + + table-footer + Extended + §6.7.7 + yes + + yes - + yes + + table-body + Basic + §6.7.8 + yes + + yes - + yes + + table-row + Basic + §6.7.9 + yes + + yes - + yes + + table-cell + Basic + §6.7.10 + partial + + yes - + yes + - + + list-block + Basic + §6.8.2 + yes + + yes - + yes + + list-item + Basic + §6.8.3 + yes + + yes - + yes + + list-item-body + Basic + §6.8.4 + yes + + yes - + yes + + list-item-label + Extended + §6.8.5 + yes + + yes - + yes + - + + basic-link + Extended + §6.9.2 + yes + + yes + yes + both internal and external supported + + multi-switch + Extended + §6.9.3 + no + + no - + no + + multi-case + Basic + §6.9.4 + no + + no - + no + + multi-toggle + Extended + §6.9.5 + no + + no - + no + + multi-properties + Extended + §6.9.6 + no + + no - + no + + multi-property-set + Extended + §6.9.7 + no + + no - + no + - + + bookmark-tree (since XSL 1.1) + Extended + §6.11.1 in XSL 1.1 WD + no + + yes + yes + + bookmark (since XSL 1.1) + Extended + §6.11.2 in XSL 1.1 WD + no + + yes + yes + + bookmark-title (since XSL 1.1) + Extended + §6.11.3 in XSL 1.1 WD + no + + partial + partial +
    • [0.93 and later] color, font-style and font-weight are not supported, yet.
      • + - + + float + Extended + §6.10.2 + no + + no - + no + + footnote + Extended + §6.10.3 + yes + + partial + partial +
    • [0.20.5] Footnotes sometimes overlap with the main content
      • +
    • [0.93 and later] Restrictions with multi-column documents.
      • + + footnote-body + Extended + §6.10.4 + yes + + yes - + yes + - + + wrapper + Basic + §6.11.2 + yes + + partial + partial +
    • [0.93 and later] Only works as expected with inline-level content.
      • + + marker + Extended + §6.11.3 + yes + + yes - + yes + + retrieve-marker + Extended + §6.11.4 + yes + + yes - + yes +
      - Object Name - - XSL-FO Conformance Level - - Citation - - Support in FOP - + Support in FOP - Comments -
      - 0.20.5 (previous) - 0.93 (stable) - 0.93 (stable) - - develop- ment -
      - Declarations and Pagination and Layout Formatting Objects (§6.4) - + Declarations and Pagination and Layout Formatting Objects (§6.4)
      - root - - Basic - - §6.4.2 - - yes - yes - yes - - yes - -   -  
      - declarations - - Basic - - §6.4.3 - - no - no - no - - no - -   -  
      - color-profile - - Extended - - §6.4.4 - - no - no - no - - no - -   -  
      - page-sequence - - Basic - - §6.4.5 - - yes - yes - yes - - yes - -   -  
      - layout-master-set - - Basic - - §6.4.6 - - yes - yes - yes - - yes - -   -  
      - page-sequence-master - - Basic - - §6.4.7 - - yes - yes - yes - - yes - -   -  
      - single-page-master-reference - - Basic - - §6.4.8 - - yes - yes - yes - - yes - -   -  
      - repeatable-page-master-reference - - Basic - - §6.4.9 - - yes - yes - yes - - yes - -   -  
      - repeatable-page-master-alternatives - - Extended - - §6.4.10 - - yes - yes - yes - - yes - -   -  
      - conditional-page-master-reference - - Extended - - §6.4.11 - - yes - yes - yes - - yes - -   -  
      - simple-page-master - - Basic - - §6.4.12 - - yes - partial - partial - - partial -
      • - [0.93] The page width may not change among pages of the same page-sequence - unless a forced break is inserted. -
        • -
      -
      - region-body - - Basic - - §6.4.13 - - yes - yes - yes - - yes - -
      - region-before - - Extended - - §6.4.14 - - yes - yes - yes - - yes - -   -  
      - region-after - - Extended - - §6.4.15 - - yes - yes - yes - - yes - -   -  
      - region-start - - Extended - - §6.4.16 - - yes - yes - yes - - yes - -   -  
      - region-end - - Extended - - §6.4.17 - - yes - yes - yes - - yes - -   -  
      - flow - - Basic - - §6.4.18 - - yes - yes - yes - - yes - -   -  
      - static-content - - Extended - - §6.4.19 - - yes - yes - yes - - yes - -   -  
      - title - - Extended - - §6.4.20 - - no - no - no - - no - -   -  
      - Block Formatting Objects (§6.5) - + Block Formatting Objects (§6.5)
      - block - - Basic - - §6.5.2 - - yes - yes - yes - - yes - -   -  
      - block-container - - Extended - - §6.5.3 - - partial - partial - partial - - partial -
      • - [0.20.5] Currently only works as direct child of fo:flow. -
        • + [0.20.5] Currently only works as direct child of fo:flow.
      • - [0.20.5] For absolute positioning, use 'position="absolute"' (as 'absolute-position="absolute"' is not implemented), and specify all four of "left", "top", "width" and "height" -
        • + [0.20.5] For absolute positioning, use 'position="absolute"' (as 'absolute-position="absolute"' is not implemented), and specify all four of "left", "top", "width" and "height"
      • - [0.93] No known restrictions. -
        • -
      -
      - Inline Formatting Objects (§6.6) - + Inline Formatting Objects (§6.6)
      - bidi-override - - Extended - - §6.6.2 - - no - no - no - - no - -   -  
      - character - - Basic - - §6.6.3 - - yes - yes - yes - - yes - -   -  
      - initial-property-set - - Extended - - §6.6.4 - - no - no - no - - no - -   -  
      - external-graphic - - Basic - - §6.6.5 - - yes - yes - yes - - yes - -   -  
      - instream-foreign-object - - Extended - - §6.6.6 - - yes - yes - yes - - yes -
      • Built-in support for SVG only, additional namespaces through optional extensions.
        • -
      -
      - inline - - Basic - - §6.6.7 - - yes - yes - yes - - yes - -   -  
      - inline-container - - Extended - - §6.6.8 - - no - no - no - - no - -   -  
      - leader - - Basic - - §6.6.9 - - partial - yes - yes - - yes - -   -  
      - page-number - - Basic - - §6.6.10 - - yes - yes - yes - - yes - -   -  
      - page-number-citation - - Extended - - §6.6.11 - - partial - partial - partial - - partial -
      • - [0.20.5] Only works for table of contents without any problems. The case where the page number doesn't fit on a line isn't handled, and any text on the same line and after the page-number might not appear exactly where you want it to. -
        • + [0.20.5] Only works for table of contents without any problems. The case where the page number doesn't fit on a line isn't handled, and any text on the same line and after the page-number might not appear exactly where you want it to.
      • - [0.93] After the page number is known, no relayout is performed. The appearance may be suboptimal depending on the use case. -
        • -
      -
      - Table Formatting Objects (§6.7) - + Table Formatting Objects (§6.7)
      - table-and-caption - - Basic - - §6.7.2 - - no - no - no - - no - -   -  
      - table - - Basic - - §6.7.3 - - partial - partial - partial - - partial -
        -
      • - [0.93] Only border-collapse="separate" is supported and there's no support for automatic column widths. -
        • +
      • [0.20.5–0.93] Only border-collapse="separate"
        • +
      • [All] No support for auto layout yet
      - table-column - - Basic - - §6.7.4 - - partial - yes - yes - - yes -
      • - [0.20.5] You must explicitly specify column widths. -
        • -
      -
      - table-caption - - Extended - - §6.7.5 - - no - no - no - - no - -   -  
      - table-header - - Basic - - §6.7.6 - - yes - yes - yes - - yes - -   -  
      - table-footer - - Extended - - §6.7.7 - - yes - yes - yes - - yes - -   -  
      - table-body - - Basic - - §6.7.8 - - yes - yes - yes - - yes - -   -  
      - table-row - - Basic - - §6.7.9 - - yes - yes - yes - - yes - -   -  
      - table-cell - - Basic - - §6.7.10 - - partial - yes - yes - - yes - -   -  
      - List Formatting Objects (§6.8) - + List Formatting Objects (§6.8)
      - list-block - - Basic - - §6.8.2 - - yes - yes - yes - - yes - -   -  
      - list-item - - Basic - - §6.8.3 - - yes - yes - yes - - yes - -   -  
      - list-item-body - - Basic - - §6.8.4 - - yes - yes - yes - - yes - -   -  
      - list-item-label - - Extended - - §6.8.5 - - yes - yes - yes - - yes - -   -  
      - Link and Multi Formatting Objects (§6.9) - + Link and Multi Formatting Objects (§6.9)
      - basic-link - - Extended - - §6.9.2 - - yes - yes - yes - - yes -
      • - both internal and external supported -
        • -
      -
      - multi-switch - - Extended - - §6.9.3 - - no - no - no - - no - -   -  
      - multi-case - - Basic - - §6.9.4 - - no - no - no - - no - -   -  
      - multi-toggle - - Extended - - §6.9.5 - - no - no - no - - no - -   -  
      - multi-properties - - Extended - - §6.9.6 - - no - no - no - - no - -   -  
      - multi-property-set - - Extended - - §6.9.7 - - no - no - no - - no - -   -  
      - Formatting Objects for Bookmarks (§6.11 in XSL 1.1 WD) - + Formatting Objects for Bookmarks (§6.11 in XSL 1.1 WD)
      - bookmark-tree (since XSL 1.1) - - Extended - - §6.11.1 in XSL 1.1 WD - - no - yes - yes - - yes -
      • [0.20.5] Uses the proprietary fox:outline extension.
        • -
      -
      - bookmark (since XSL 1.1) - - Extended - - §6.11.2 in XSL 1.1 WD - - no - yes - yes - - yes -
      • [0.20.5] Uses the proprietary fox:outline extension.
        • -
      -
      - bookmark-title (since XSL 1.1) - - Extended - - §6.11.3 in XSL 1.1 WD - - no - partial - partial - - partial -
      • [0.20.5] Uses the proprietary fox:outline extension.
        • -
      • [0.93] color, font-style and font-weight are not supported, yet.
        • -
      -
      - Out-of-line Formatting Objects (§6.10) - + Out-of-line Formatting Objects (§6.10)
      - float - - Extended - - §6.10.2 - - no - no - no - - no - -   -  
      - footnote - - Extended - - §6.10.3 - - yes - partial - partial - - partial -
        -
      • [0.93] Restrictions with multi-column documents.
        • -
      -
      - footnote-body - - Extended - - §6.10.4 - - yes - yes - yes - - yes - -   -  
      - Other Formatting Objects (§6.11) - + Other Formatting Objects (§6.11)
      - wrapper - - Basic - - §6.11.2 - - yes - partial - partial - - partial -
        -
      • [0.93] Only works as expected with inline-level content.
        • -
      -
      - marker - - Extended - - §6.11.3 - - yes - yes - yes - - yes - -   -  
      - retrieve-marker - - Extended - - §6.11.4 - - yes - yes - yes - - yes - -   -  
      -

      XSL-FO Property Support Table (§7)

      +

      XSL-FO Property Support Table (§7)

      The following is a summary of FOP's current support for the standard XSL-FO properties.

      + Property Name + XSL-FO Conformance Level - + Citation + + Comments + 0.20.5 (previous) + + 0.94 (stable) + develop- ment - + + source-document + Basic + §7.4.1 + na + + na - + na + + role + Basic + §7.4.2 + na + + na - + na + - + + absolute-position + Complete + §7.5.1 + no + + yes + yes + [0.93 and later] No restrictions. The 0.20.5 work-around is not supported. + + top + Extended + §7.5.2 + yes + + yes - + yes + + right + Extended + §7.5.3 + yes + + yes - + yes + + bottom + Extended + §7.5.4 + yes + + yes - + yes + + left + Extended + §7.5.5 + yes + + yes - + yes + - + + azimuth + Basic + §7.6.1 + na + + na - + na + + cue-after + Basic + §7.6.2 + na + + na - + na + + cue-before + Basic + §7.6.3 + na + + na - + na + + elevation + Basic + §7.6.4 + na + + na - + na + + pause-after + Basic + §7.6.5 + na + + na - + na + + pause-before + Basic + §7.6.6 + na + + na - + na + + pitch + Basic + §7.6.7 + na + + na - + na + + pitch-range + Basic + §7.6.8 + na + + na - + na + + play-during + Basic + §7.6.9 + na + + na - + na + + richness + Basic + §7.6.10 + na + + na - + na + + speak + Basic + §7.6.11 + na + + na - + na + + speak-header + Basic + §7.6.12 + na + + na - + na + + speak-numeral + Basic + §7.6.13 + na + + na - + na + + speak-punctuation + Basic + §7.6.14 + na + + na - + na + + speech-rate + Basic + §7.6.15 + na + + na - + na + + stress + Basic + §7.6.16 + na + + na - + na + + voice-family + Basic + §7.6.17 + na + + na - + na + + volume + Basic + §7.6.18 + na + + na - + na + - + + background-attachment + Extended + §7.7.1 + no + + no - + no + + background-color + Basic + §7.7.2 + yes + + partial + partial + [0.93 and later] not yet implemented for table-column, table-body, table-header and table-footer. + + background-image + Extended + §7.7.3 + yes + + partial + partial + [0.93 and later] not yet implemented for table-column, table-body, table-header and table-footer. + + background-repeat + Extended + §7.7.4 + no + + yes - + yes + + background-position-horizontal + Extended + §7.7.5 + no + + yes - + yes + + background-position-vertical + Extended + §7.7.6 + no + + yes - + yes + + border-before-color + Basic + §7.7.7 + yes + + yes - + yes + + border-before-style + Basic + §7.7.8 + partial + + yes + yes + [0.20.5] only "solid" works + + border-before-width + Basic + §7.7.9 + yes + + yes - + yes + + border-after-color + Basic + §7.7.10 + yes + + yes - + yes + + border-after-style + Basic + §7.7.11 + partial + + yes + yes + [0.20.5] only "solid" works + + border-after-width + Basic + §7.7.12 + yes + + yes - + yes + + border-start-color + Basic + §7.7.13 + yes + + yes - + yes + + border-start-style + Basic + §7.7.14 + partial + + yes + yes + [0.20.5] only "solid" works + + border-start-width + Basic + §7.7.15 + yes + + yes - + yes + + border-end-color + Basic + §7.7.16 + yes + + yes - + yes + + border-end-style + Basic + §7.7.17 + partial + + yes + yes + [0.20.5] only "solid" works + + border-end-width + Basic + §7.7.18 + yes + + yes - + yes + + border-top-color + Basic + §7.7.19 + yes + + yes - + yes + + border-top-style + Basic + §7.7.20 + partial + + yes + yes + [0.20.5] only "solid" works + + border-top-width + Basic + §7.7.21 + yes + + yes - + yes + + border-bottom-color + Basic + §7.7.22 + yes + + yes - + yes + + border-bottom-style + Basic + §7.7.23 + partial + + yes + yes + [0.20.5] only "solid" works + + border-bottom-width + Basic + §7.7.24 + yes + + yes - + yes + + border-left-color + Basic + §7.7.25 + yes + + yes - + yes + + border-left-style + Basic + §7.7.26 + partial + + yes + yes + [0.20.5] only "solid" works + + border-left-width + Basic + §7.7.27 + yes + + yes - + yes + + border-right-color + Basic + §7.7.28 + yes + + yes - + yes + + border-right-style + Basic + §7.7.29 + partial + + yes + yes + [0.20.5] only "solid" works + + border-right-width + Basic + §7.7.30 + yes + + yes - + yes + + padding-before + Basic + §7.7.31 + partial + + yes + yes + [0.20.5] can be used to control how much the background-color extends beyond the content rectangle + + padding-after + Basic + §7.7.32 + partial + + yes + yes + [0.20.5] same limitations as padding-before + + padding-start + Basic + §7.7.33 + partial + + yes + yes + [0.20.5] same limitations as padding-before + + padding-end + Basic + §7.7.34 + partial + + yes + yes + [0.20.5] same limitations as padding-before + + padding-top + Basic + §7.7.35 + partial + + yes + yes + [0.20.5] same limitations as padding-before + + padding-bottom + Basic + §7.7.36 + partial + + yes + yes + [0.20.5] same limitations as padding-before + + padding-left + Basic + §7.7.37 + partial + + yes + yes + [0.20.5] same limitations as padding-before + + padding-right + Basic + §7.7.38 + partial + + yes + yes + [0.20.5] same limitations as padding-before + - + + font-family + Basic + §7.8.2 + partial + + partial + partial + [0.93 and later] font-family lists are allowed but glyph based font selection is not supported + + font-selection-strategy + Complete + §7.8.3 + no + + no - + no + + font-size + Basic + §7.8.4 + partial + + yes + yes + [0.20.5] "smaller" and "larger" not implemented + + font-stretch + Extended + §7.8.5 + no + + no - + no + + font-size-adjust + Extended + §7.8.6 + no + + no - + no + + font-style + Basic + §7.8.7 + partial + + yes + yes + [0.20.5] "normal" is not supported + + font-variant + Basic + §7.8.8 + yes + + no - + no + + font-weight + Basic + §7.8.9 + partial + + partial + partial + [0.93 and later] TODO <relative> font weights + - + + country + Extended + §7.9.1 + yes + + yes - + yes + + language + Extended + §7.9.2 + yes + + yes - + yes + + script + Extended + §7.9.3 + no + + no - + no + + hyphenate + Extended + §7.9.4 + yes + + yes - + yes + + hyphenation-character + Extended + §7.9.5 + yes + + yes - + yes + + hyphenation-push-character-count + Extended + §7.9.6 + yes + + yes - + yes + + hyphenation-remain-character-count + Extended + §7.9.7 + yes + + yes - + yes + - + + margin-top + Basic + §7.10.1 + partial + + yes + yes + [0.20.5] only on pages and regions + + margin-bottom + Basic + §7.10.2 + partial + + yes + yes + [0.20.5] only on pages and regions + + margin-left + Basic + §7.10.3 + partial + + yes + yes + [0.20.5] only on pages and regions + + margin-right + Basic + §7.10.4 + partial + + yes + yes + [0.20.5] only on pages and regions + + space-before + Basic + §7.10.5 + partial + + partial + partial + [0.93 and later] Space adjustment may not fully work everywhere, yet. + + space-after + Basic + §7.10.6 + partial + + partial + partial + [0.93 and later] Space adjustment may not fully work everywhere, yet. + + start-indent + Basic + §7.10.7 + yes + + yes - + yes + + end-indent + Basic + §7.10.8 + yes + + yes - + yes + - + + space-end + Basic + §7.11.1 + no + + no - + no + + space-start + Basic + §7.11.2 + no + + no - + no + - + + relative-position + Extended + §7.12.1 + no + + no - + no + - + + alignment-adjust + Basic + §7.13.1 + no + + yes - + yes + + alignment-baseline + Basic + §7.13.2 + no + + yes - + yes + + baseline-shift + Basic + §7.13.3 + partial + + yes + yes + [0.20.5] Only values "super" and "sub" have been implemented. + + display-align + Extended + §7.13.4 + partial + + partial + partial + [0.93 and later] TODO Check e-g, i-f-o. + + dominant-baseline + Basic + §7.13.5 + no + + yes - + yes + + relative-align + Extended + §7.13.6 + no + + no - + no + - + + block-progression-dimension + Basic + §7.14.1 + no + + yes - + yes + + content-height + Extended + §7.14.2 + no + + yes - + yes + + content-width + Extended + §7.14.3 + no + + yes - + yes + + height + Basic + §7.14.4 + yes + + yes - + yes + + inline-progression-dimension + Basic + §7.14.5 + no + + yes - + yes + + max-height + Complete + §7.14.6 + no + + no - + no + + max-width + Complete + §7.14.7 + no + + no - + no + + min-height + Complete + §7.14.8 + no + + no - + no + + min-width + Complete + §7.14.9 + no + + no - + no + + scaling + Extended + §7.14.10 + no + + yes - + yes + + scaling-method + Extended + §7.14.11 + no + + no - + no + + width + Basic + §7.14.12 + yes + + yes - + yes + - + + hyphenation-keep + Extended + §7.15.1 + no + + no - + no + + hyphenation-ladder-count + Extended + §7.15.2 + no + + yes - + yes + + last-line-end-indent + Extended + §7.15.3 + no + + yes - + yes + + line-height + Basic + §7.15.4 + yes + + yes - + yes + + line-height-shift-adjustment + Extended + §7.15.5 + no + + no - + yes + + line-stacking-strategy + Basic + §7.15.6 + no + + partial + partial + [0.93 and later] value "line-height" not supported + + linefeed-treatment + Extended + §7.15.7 + no + + yes - + yes + + white-space-treatment + Extended + §7.15.8 + no + + partial + partial + [0.93 and later] inline elements may interfere with correct handling of this property + in some cases + + text-align + Basic + §7.15.9 + partial + + partial + partial + Only start, end, center and justify are supported + + text-align-last + Extended + §7.15.10 + partial + + partial + partial + Only start, end, center and justify are supported + + text-indent + Basic + §7.15.11 + yes + + yes - + yes + + white-space-collapse + Extended + §7.15.12 + yes + + yes - + yes + + wrap-option + Basic + §7.15.13 + yes + + partial + partial + [0.93 and later] Only supported on fo:block. + - + + character + Basic + §7.16.1 + yes + + yes - + yes + + letter-spacing + Extended + §7.16.2 + yes + + yes - + yes + + suppress-at-line-break + Extended + §7.16.3 + no + + no - + no + + text-decoration + Extended + §7.16.4 + yes + + yes - + yes + + text-shadow + Extended + §7.16.5 + no + + no - + no + + text-transform + Extended + §7.16.6 + no + + yes - + yes + + treat-as-word-space + Extended + §7.16.7 + no + + no - + no + + word-spacing + Extended + §7.16.8 + no + + yes - + yes + - + + color + Basic + §7.17.1 + yes + + yes - + yes + + color-profile-name + Extended + §7.17.2 + no + + no - + no + + rendering-intent + Extended + §7.17.3 + no + + no - + no + - + + clear + Extended + §7.18.1 + no + + no - + no + + float + Extended + §7.18.2 + no + + no - + no + + intrusion-displace + Extended + §7.18.3 + no + + no - + no + - + + break-after + Basic + §7.19.1 + yes + + yes - + yes + + break-before + Basic + §7.19.2 + yes + + yes - + yes + + keep-together + Extended + §7.19.3 + partial + + partial + partial + keep-with-next + Basic + §7.19.4 + partial + + partial + partial + [0.93 and later] <integer> values are not supported. + + keep-with-previous + Basic + §7.19.5 + partial + + partial + partial +
    • [0.20.5] works only in table rows
      • +
    • [0.93 and later] works on all implemented FOs, except list- and + table-related and inline-level FOs.
      • +
    • [0.93 and later] <integer> values are not supported.
      • + + orphans + Basic + §7.19.6 + no + + yes - + yes + + widows + Basic + §7.19.7 + no + + yes - + yes + - + + clip + Extended + §7.20.1 + no + + no - + no + + overflow + Basic + §7.20.2 + no + + yes - + yes + + reference-orientation + Extended + §7.20.3 + no + + yes + yes + [0.20.5] Workaround for block-container is to use SVG. + + span + Extended + §7.20.4 + yes + + yes - + yes + - + + leader-alignment + Extended + §7.21.1 + partial + + no + no + [0.93 and later] Not supported + + leader-pattern + Basic + §7.21.2 + partial + + yes + yes + [0.93 and later] Value "use-content" does not work in all circumstances. + + leader-pattern-width + Extended + §7.21.3 + yes + + yes - + yes + + leader-length + Basic + §7.21.4 + partial + + yes + yes + [0.20.5] leader-length.minimum is not used at all + + rule-style + Basic + §7.21.5 + yes + + yes - + yes + + rule-thickness + Basic + §7.21.6 + yes + + yes - + yes + - + + active-state + Extended + §7.22.1 + no + + no - + no + + auto-restore + Extended + §7.22.2 + no + + no - + no + + case-name + Extended + §7.22.3 + no + + no - + no + + case-title + Extended + §7.22.4 + no + + no - + no + + destination-placement-offset + Extended + §7.22.5 + no + + no - + no + + external-destination + Basic + §7.22.6 + yes + + yes - + yes + + indicate-destination + Extended + §7.22.7 + no + + no - + no + + internal-destination + Extended + §7.22.8 + yes + + yes - + yes + + show-destination + Extended + §7.22.9 + no + + no - + no + + starting-state + Extended + §7.22.10 + no + + partial + partial + + switch-to + Extended + §7.22.11 + no + + no - + no + + target-presentation-context + Extended + §7.22.12 + no + + no - + no + + target-processing-context + Extended + §7.22.13 + no + + no - + no + + target-stylesheet + Extended + §7.22.14 + no + + no - + no + - + + marker-class-name + Extended + §7.23.1 + no + + yes - + yes + + retrieve-class-name + Extended + §7.23.2 + no + + yes - + yes + + retrieve-position + Extended + §7.23.3 + no + + yes - + yes + + retrieve-boundary + Extended + §7.23.4 + no + + yes - + yes + - + + format + Basic + §7.24.1 + no + + yes - + yes + + grouping-separator + Extended + §7.24.2 + no + + no - + no + + grouping-size + Extended + §7.24.3 + no + + no - + no + + letter-value + Basic + §7.24.4 + no + + no - + no + - + + blank-or-not-blank + Extended + §7.25.1 + yes + + yes - + yes + + column-count + Extended + §7.25.2 + yes + + yes - + yes + + column-gap + Extended + §7.25.3 + yes + + yes - + yes + + extent + Extended + §7.25.4 + yes + + yes - + yes + + flow-name + Basic + §7.25.5 + yes + + yes - + yes + + force-page-count + Extended + §7.25.6 + no + + yes - + yes + + initial-page-number + Basic + §7.25.7 + yes + + yes - + yes + + master-name + Basic + §7.25.8 + yes + + yes - + yes + + master-reference + Basic + §7.25.9 + yes + + yes - + yes + + maximum-repeats + Extended + §7.25.10 + yes + + yes - + yes + + media-usage + Extended + §7.25.11 + no + + no - + no + + odd-or-even + Extended + §7.25.12 + yes + + yes - + yes + + page-height + Basic + §7.25.13 + yes + + yes - + yes + + page-position + Extended + §7.25.14 + partial + + yes + yes + [0.20.5] "last" isn't implemented! + + page-width + Basic + §7.25.15 + yes + + yes - + yes + + precedence + Extended + §7.25.16 + no + + yes - + yes + + region-name + Basic + §7.25.17 + yes + + yes - + yes + - + + border-after-precedence + Basic + §7.26.1 + no + + no - + no + + border-before-precedence + Basic + §7.26.2 + no + + no - + no + + border-collapse + Extended - - - + §7.26.3 + + + + + border-end-precedence + Basic + §7.26.4 + no + + no - + no + + border-separation + Extended + §7.26.5 + no + + yes - + yes + + border-start-precedence + Basic + §7.26.6 + no + + no - + no + + caption-side + Complete + §7.26.7 + no + + no - + no + + column-number + Basic + §7.26.8 + no + + yes - + yes + + column-width + Basic + §7.26.9 + partial + + yes + yes + [0.20.5] "percentage" not implemented. Workaround is to use the XSL-FO "proportional-column-width" function. + + empty-cells + Extended + §7.26.10 + no + + yes - + yes + + ends-row + Extended + §7.26.11 + no + + yes - + yes + + number-columns-repeated + Basic + §7.26.12 + no + + yes - + yes + + number-columns-spanned + Basic + §7.26.13 + yes + + yes - + yes + + number-rows-spanned + Basic + §7.26.14 + yes + + yes - + yes + + starts-row + Extended + §7.26.15 + no + + yes - + yes + + table-layout + Extended + §7.26.16 + no + + no - + no + + table-omit-footer-at-break + Extended + §7.26.17 + yes + + yes - + yes + + table-omit-header-at-break + Extended + §7.26.18 + yes + + yes - + yes + - + + direction + Basic + §7.27.1 + no + + no - + no + + glyph-orientation-horizontal + Extended + §7.27.2 + no + + no - + no + + glyph-orientation-vertical + Extended + §7.27.3 + no + + no - + no + + text-altitude + Extended + §7.27.4 + no + + no - + no + + text-depth + Extended + §7.27.5 + no + + no - + no + + unicode-bidi + Extended + §7.27.6 + no + + no - + no + + writing-mode + Basic + §7.27.7 + no + + no - + no + - + + content-type + Extended + §7.28.1 + no + + no - + no + + id + Basic + §7.28.2 + yes + + partial + partial +
    • [0.93 and later] IDs on table-header, table-footer, table-body, table-row, table-and-caption, table-caption, inline-container and bidi-override are not available, yet.
      • + + provisional-label-separation + Basic + §7.28.3 + yes + + yes - + yes + + provisional-distance-between-starts + Basic + §7.28.4 + yes + + yes - + yes + + ref-id + Extended + §7.28.5 + yes + + yes - + yes + + score-spaces + Extended + §7.28.6 + no + + no - + no + + src + Basic + §7.28.7 + yes + + yes - + yes + + visibility + Extended + §7.28.8 + no + + no - + no + + z-index + Extended + §7.28.9 + no + + no - + no + - + + background + Complete + §7.29.1 + no + + no - + no + + background-position + Complete + §7.29.2 + no + + yes - + yes + + border + Complete + §7.29.3 + no + + yes - + yes + + border-bottom + Complete + §7.29.4 + yes + + yes - + yes + + border-color + Complete + §7.29.5 + partial + + yes + yes + [0.20.5] only one value allowed + + border-left + Complete + §7.29.6 + yes + + yes - + yes + + border-right + Complete + §7.29.7 + yes + + yes - + yes + + border-style + Complete + §7.29.8 + partial + + yes + yes + [0.20.5] only "solid" works + + border-spacing + Complete + §7.29.9 + no + + yes - + yes + + border-top + Complete + §7.29.10 + yes + + yes - + yes + + border-width + Complete + §7.29.11 + yes + + yes - + yes + + cue + Complete + §7.29.12 + na + + na - + na + + font + Complete + §7.29.13 + no + + partial + partial + [0.93 and later] Enum values other than "inherit" not yet supported. + + margin + Complete + §7.29.14 + partial + + yes + yes + [0.20.5] only on pages and regions + + padding + Complete + §7.29.15 + partial + + yes + yes + [0.20.5] can be used to control how much the background-color extends beyond the content rectangle + + page-break-after + Complete + §7.29.16 + no + + yes - + yes + + page-break-before + Complete + §7.29.17 + no + + yes - + yes + + page-break-inside + Complete + §7.29.18 + no + + yes - + yes + + pause + Complete + §7.29.19 + na + + na - + na + + position + Complete + §7.29.20 + partial + + yes + yes + [0.20.5] "inherit" not handled + + size + Complete + §7.29.21 + no + + no - + no + + vertical-align + Complete + §7.29.22 + partial + + partial + partial + [0.93 and later] Percentages are not supported, yet. + + white-space + Complete + §7.29.23 + no + + yes - + yes + + xml:lang + Complete + §7.29.24 + no + + no - + no +
      - Property Name - - XSL-FO Conformance Level - - Citation - - Support in FOP - + Support in FOP - Comments -
      - 0.20.5 (previous) - 0.93 (stable) - 0.93 (stable) - - develop- ment -
      - Common Accessibility Properties (§7.4) - + Common Accessibility Properties (§7.4)
      - source-document - - Basic - - §7.4.1 - - na - na - na - - na - -   -  
      - role - - Basic - - §7.4.2 - - na - na - na - - na - -   -  
      - Common Absolute Position Properties (§7.5) - + Common Absolute Position Properties (§7.5)
      - absolute-position - - Complete - - §7.5.1 - - no - yes - yes - - yes -
      • - [0.20.5] Use shorthand position="absolute" as a workaround. -
        • + [0.20.5] Use shorthand position="absolute" as a workaround.
      • - [0.93] No restrictions. The 0.20.5 work-around is not supported. -
        • -
      -
      - top - - Extended - - §7.5.2 - - yes - yes - yes - - yes - -   -  
      - right - - Extended - - §7.5.3 - - yes - yes - yes - - yes - -   -  
      - bottom - - Extended - - §7.5.4 - - yes - yes - yes - - yes - -   -  
      - left - - Extended - - §7.5.5 - - yes - yes - yes - - yes - -   -  
      - Common Aural Properties (§7.6) - + Common Aural Properties (§7.6)
      - azimuth - - Basic - - §7.6.1 - - na - na - na - - na - -   -  
      - cue-after - - Basic - - §7.6.2 - - na - na - na - - na - -   -  
      - cue-before - - Basic - - §7.6.3 - - na - na - na - - na - -   -  
      - elevation - - Basic - - §7.6.4 - - na - na - na - - na - -   -  
      - pause-after - - Basic - - §7.6.5 - - na - na - na - - na - -   -  
      - pause-before - - Basic - - §7.6.6 - - na - na - na - - na - -   -  
      - pitch - - Basic - - §7.6.7 - - na - na - na - - na - -   -  
      - pitch-range - - Basic - - §7.6.8 - - na - na - na - - na - -   -  
      - play-during - - Basic - - §7.6.9 - - na - na - na - - na - -   -  
      - richness - - Basic - - §7.6.10 - - na - na - na - - na - -   -  
      - speak - - Basic - - §7.6.11 - - na - na - na - - na - -   -  
      - speak-header - - Basic - - §7.6.12 - - na - na - na - - na - -   -  
      - speak-numeral - - Basic - - §7.6.13 - - na - na - na - - na - -   -  
      - speak-punctuation - - Basic - - §7.6.14 - - na - na - na - - na - -   -  
      - speech-rate - - Basic - - §7.6.15 - - na - na - na - - na - -   -  
      - stress - - Basic - - §7.6.16 - - na - na - na - - na - -   -  
      - voice-family - - Basic - - §7.6.17 - - na - na - na - - na - -   -  
      - volume - - Basic - - §7.6.18 - - na - na - na - - na - -   -  
      - Common Border, Padding, and Background Properties (§7.7) - + Common Border, Padding, and Background Properties (§7.7)
      - background-attachment - - Extended - - §7.7.1 - - no - no - no - - no - -   -  
      - background-color - - Basic - - §7.7.2 - - yes - partial - partial - - partial -
      • - [0.93] not yet implemented for table-column, table-body, table-header and table-footer. -
        • -
      -
      - background-image - - Extended - - §7.7.3 - - yes - partial - partial - - partial -
      • - [0.93] not yet implemented for table-column, table-body, table-header and table-footer. -
        • -
      -
      - background-repeat - - Extended - - §7.7.4 - - no - yes - yes - - yes - -   -  
      - background-position-horizontal - - Extended - - §7.7.5 - - no - yes - yes - - yes - -   -  
      - background-position-vertical - - Extended - - §7.7.6 - - no - yes - yes - - yes - -   -  
      - border-before-color - - Basic - - §7.7.7 - - yes - yes - yes - - yes - -   -  
      - border-before-style - - Basic - - §7.7.8 - - partial - yes - yes - - yes -
      • - [0.20.5] only "solid" works -
        • -
      -
      - border-before-width - - Basic - - §7.7.9 - - yes - yes - yes - - yes - -   -  
      - border-after-color - - Basic - - §7.7.10 - - yes - yes - yes - - yes - -   -  
      - border-after-style - - Basic - - §7.7.11 - - partial - yes - yes - - yes -
      • - [0.20.5] only "solid" works -
        • -
      -
      - border-after-width - - Basic - - §7.7.12 - - yes - yes - yes - - yes - -   -  
      - border-start-color - - Basic - - §7.7.13 - - yes - yes - yes - - yes - -   -  
      - border-start-style - - Basic - - §7.7.14 - - partial - yes - yes - - yes -
      • - [0.20.5] only "solid" works -
        • -
      -
      - border-start-width - - Basic - - §7.7.15 - - yes - yes - yes - - yes - -   -  
      - border-end-color - - Basic - - §7.7.16 - - yes - yes - yes - - yes - -   -  
      - border-end-style - - Basic - - §7.7.17 - - partial - yes - yes - - yes -
      • - [0.20.5] only "solid" works -
        • -
      -
      - border-end-width - - Basic - - §7.7.18 - - yes - yes - yes - - yes - -   -  
      - border-top-color - - Basic - - §7.7.19 - - yes - yes - yes - - yes - -   -  
      - border-top-style - - Basic - - §7.7.20 - - partial - yes - yes - - yes -
      • - [0.20.5] only "solid" works -
        • -
      -
      - border-top-width - - Basic - - §7.7.21 - - yes - yes - yes - - yes - -   -  
      - border-bottom-color - - Basic - - §7.7.22 - - yes - yes - yes - - yes - -   -  
      - border-bottom-style - - Basic - - §7.7.23 - - partial - yes - yes - - yes -
      • - [0.20.5] only "solid" works -
        • -
      -
      - border-bottom-width - - Basic - - §7.7.24 - - yes - yes - yes - - yes - -   -  
      - border-left-color - - Basic - - §7.7.25 - - yes - yes - yes - - yes - -   -  
      - border-left-style - - Basic - - §7.7.26 - - partial - yes - yes - - yes -
      • - [0.20.5] only "solid" works -
        • -
      -
      - border-left-width - - Basic - - §7.7.27 - - yes - yes - yes - - yes - -   -  
      - border-right-color - - Basic - - §7.7.28 - - yes - yes - yes - - yes - -   -  
      - border-right-style - - Basic - - §7.7.29 - - partial - yes - yes - - yes -
      • - [0.20.5] only "solid" works -
        • -
      -
      - border-right-width - - Basic - - §7.7.30 - - yes - yes - yes - - yes - -   -  
      - padding-before - - Basic - - §7.7.31 - - partial - yes - yes - - yes -
      • - [0.20.5] only one value allowed -
        • + [0.20.5] only one value allowed
      • - [0.20.5] only implemented for blocks -
        • + [0.20.5] only implemented for blocks
      • - [0.20.5] can't be used to make extra space (use indents + spaces instead) -
        • + [0.20.5] can't be used to make extra space (use indents + spaces instead)
      • - [0.20.5] can be used to control how much the background-color extends beyond the content rectangle -
        • -
      -
      - padding-after - - Basic - - §7.7.32 - - partial - yes - yes - - yes -
      • - [0.20.5] same limitations as padding-before -
        • -
      -
      - padding-start - - Basic - - §7.7.33 - - partial - yes - yes - - yes -
      • - [0.20.5] same limitations as padding-before -
        • -
      -
      - padding-end - - Basic - - §7.7.34 - - partial - yes - yes - - yes -
      • - [0.20.5] same limitations as padding-before -
        • -
      -
      - padding-top - - Basic - - §7.7.35 - - partial - yes - yes - - yes -
      • - [0.20.5] same limitations as padding-before -
        • -
      -
      - padding-bottom - - Basic - - §7.7.36 - - partial - yes - yes - - yes -
      • - [0.20.5] same limitations as padding-before -
        • -
      -
      - padding-left - - Basic - - §7.7.37 - - partial - yes - yes - - yes -
      • - [0.20.5] same limitations as padding-before -
        • -
      -
      - padding-right - - Basic - - §7.7.38 - - partial - yes - yes - - yes -
      • - [0.20.5] same limitations as padding-before -
        • -
      -
      - Common Font Properties (§7.8) - + Common Font Properties (§7.8)
      - font-family - - Basic - - §7.8.2 - - partial - partial - partial - - partial -
      • - [0.20.5] font-family lists are not supported, use a single font-family name -
        • + [0.20.5] font-family lists are not supported, use a single font-family name
      • - [0.93] font-family lists are allowed but glyph based font selection is not supported -
        • -
      -
      - font-selection-strategy - - Complete - - §7.8.3 - - no - no - no - - no - -   -  
      - font-size - - Basic - - §7.8.4 - - partial - yes - yes - - yes -
      • - [0.20.5] "smaller" and "larger" not implemented -
        • -
      -
      - font-stretch - - Extended - - §7.8.5 - - no - no - no - - no - -   -  
      - font-size-adjust - - Extended - - §7.8.6 - - no - no - no - - no - -   -  
      - font-style - - Basic - - §7.8.7 - - partial - yes - yes - - yes -
      • - [0.20.5] "normal" is not supported -
        • -
      -
      - font-variant - - Basic - - §7.8.8 - - yes - no - no - - no - -   -  
      - font-weight - - Basic - - §7.8.9 - - partial - partial - partial - - partial -
      • - [0.20.5] "normal", "bolder" and "lighter" are not supported -
        • + [0.20.5] "normal", "bolder" and "lighter" are not supported
      • - [0.93] TODO <relative> font weights -
        • -
      -
      - Common Hyphenation Properties (§7.9) - + Common Hyphenation Properties (§7.9)
      - country - - Extended - - §7.9.1 - - yes - yes - yes - - yes - -   -  
      - language - - Extended - - §7.9.2 - - yes - yes - yes - - yes - -   -  
      - script - - Extended - - §7.9.3 - - no - no - no - - no - -   -  
      - hyphenate - - Extended - - §7.9.4 - - yes - yes - yes - - yes - -   -  
      - hyphenation-character - - Extended - - §7.9.5 - - yes - yes - yes - - yes - -   -  
      - hyphenation-push-character-count - - Extended - - §7.9.6 - - yes - yes - yes - - yes - -   -  
      - hyphenation-remain-character-count - - Extended - - §7.9.7 - - yes - yes - yes - - yes - -   -  
      - Common Margin Properties - Block (§7.10) - + Common Margin Properties - Block (§7.10)
      - margin-top - - Basic - - §7.10.1 - - partial - yes - yes - - yes -
      • - [0.20.5] only on pages and regions -
        • -
      -
      - margin-bottom - - Basic - - §7.10.2 - - partial - yes - yes - - yes -
      • - [0.20.5] only on pages and regions -
        • -
      -
      - margin-left - - Basic - - §7.10.3 - - partial - yes - yes - - yes -
      • - [0.20.5] only on pages and regions -
        • -
      -
      - margin-right - - Basic - - §7.10.4 - - partial - yes - yes - - yes -
      • - [0.20.5] only on pages and regions -
        • -
      -
      - space-before - - Basic - - §7.10.5 - - partial - partial - partial - - partial -
      • - [0.20.5] space-before.optimum supported -
        • + [0.20.5] space-before.optimum supported
      • - [0.93] Space adjustment may not fully work everywhere, yet. -
        • -
      -
      - space-after - - Basic - - §7.10.6 - - partial - partial - partial - - partial -
      • - [0.20.5] space-after.optimum supported -
        • + [0.20.5] space-after.optimum supported
      • - [0.93] Space adjustment may not fully work everywhere, yet. -
        • -
      -
      - start-indent - - Basic - - §7.10.7 - - yes - yes - yes - - yes - -   -  
      - end-indent - - Basic - - §7.10.8 - - yes - yes - yes - - yes - -   -  
      - Common Margin Properties - Inline (§7.11) - + Common Margin Properties - Inline (§7.11)
      - space-end - - Basic - - §7.11.1 - - no - no - no - - no - -   -  
      - space-start - - Basic - - §7.11.2 - - no - no - no - - no - -   -  
      - Common Relative Position Properties (§7.12) - + Common Relative Position Properties (§7.12)
      - relative-position - - Extended - - §7.12.1 - - no - no - no - - no - -   -  
      - Area Alignment Properties (§7.13) - + Area Alignment Properties (§7.13)
      - alignment-adjust - - Basic - - §7.13.1 - - no - yes - yes - - yes - -   -  
      - alignment-baseline - - Basic - - §7.13.2 - - no - yes - yes - - yes - -   -  
      - baseline-shift - - Basic - - §7.13.3 - - partial - yes - yes - - yes -
      • - [0.20.5] Only values "super" and "sub" have been implemented. -
        • -
      -
      - display-align - - Extended - - §7.13.4 - - partial - partial - partial - - partial -
      • - [0.20.5] Implemented only for table-cell and block-container. -
        • + [0.20.5] Implemented only for table-cell and block-container.
      • - [0.20.5] For table-cell, the "height" attribute must be set for the parent table-row; setting the height of the table or the table-cell results in vertical centering having no effect. -
        • + [0.20.5] For table-cell, the "height" attribute must be set for the parent table-row; setting the height of the table or the table-cell results in vertical centering having no effect.
      • - [0.93] TODO Check e-g, i-f-o. -
        • -
      -
      - dominant-baseline - - Basic - - §7.13.5 - - no - yes - yes - - yes - -   -  
      - relative-align - - Extended - - §7.13.6 - - no - no - no - - no - -   -  
      - Area Dimension Properties (§7.14) - + Area Dimension Properties (§7.14)
      - block-progression-dimension - - Basic - - §7.14.1 - - no - yes - yes - - yes - -   -  
      - content-height - - Extended - - §7.14.2 - - no - yes - yes - - yes - -   -  
      - content-width - - Extended - - §7.14.3 - - no - yes - yes - - yes - -   -  
      - height - - Basic - - §7.14.4 - - yes - yes - yes - - yes - -   -  
      - inline-progression-dimension - - Basic - - §7.14.5 - - no - yes - yes - - yes - -   -  
      - max-height - - Complete - - §7.14.6 - - no - no - no - - no - -   -  
      - max-width - - Complete - - §7.14.7 - - no - no - no - - no - -   -  
      - min-height - - Complete - - §7.14.8 - - no - no - no - - no - -   -  
      - min-width - - Complete - - §7.14.9 - - no - no - no - - no - -   -  
      - scaling - - Extended - - §7.14.10 - - no - yes - yes - - yes - -   -  
      - scaling-method - - Extended - - §7.14.11 - - no - no - no - - no - -   -  
      - width - - Basic - - §7.14.12 - - yes - yes - yes - - yes - -   -  
      - Block and Line-related Properties (§7.15) - + Block and Line-related Properties (§7.15)
      - hyphenation-keep - - Extended - - §7.15.1 - - no - no - no - - no - -   -  
      - hyphenation-ladder-count - - Extended - - §7.15.2 - - no - yes - yes - - yes - -   -  
      - last-line-end-indent - - Extended - - §7.15.3 - - no - yes - yes - - yes - -   -  
      - line-height - - Basic - - §7.15.4 - - yes - yes - yes - - yes - -   -  
      - line-height-shift-adjustment - - Extended - - §7.15.5 - - no - no - no - - yes - -   -  
      - line-stacking-strategy - - Basic - - §7.15.6 - - no - partial - partial - - partial -
      • - [0.93] value "line-height" not supported -
        • -
      -
      - linefeed-treatment - - Extended - - §7.15.7 - - no - yes - yes - - yes - -   -  
      - white-space-treatment - - Extended - - §7.15.8 - - no - partial - partial - - partial -
      • - [0.93] inline elements may interfere with correct handling of this property - in some cases -
        • -
      -
      - text-align - - Basic - - §7.15.9 - - partial - partial - partial - - partial -
      • - Only start, end, center and justify are supported -
        • -
      -
      - text-align-last - - Extended - - §7.15.10 - - partial - partial - partial - - partial -
      • - Only start, end, center and justify are supported -
        • -
      -
      - text-indent - - Basic - - §7.15.11 - - yes - yes - yes - - yes - -   -  
      - white-space-collapse - - Extended - - §7.15.12 - - yes - yes - yes - - yes - -   -  
      - wrap-option - - Basic - - §7.15.13 - - yes - partial - partial - - partial -
      • - [0.93] Only supported on fo:block. -
        • -
      -
      - Character Properties (§7.16) - + Character Properties (§7.16)
      - character - - Basic - - §7.16.1 - - yes - yes - yes - - yes - -   -  
      - letter-spacing - - Extended - - §7.16.2 - - yes - yes - yes - - yes - -   -  
      - suppress-at-line-break - - Extended - - §7.16.3 - - no - no - no - - no - -   -  
      - text-decoration - - Extended - - §7.16.4 - - yes - yes - yes - - yes - -   -  
      - text-shadow - - Extended - - §7.16.5 - - no - no - no - - no - -   -  
      - text-transform - - Extended - - §7.16.6 - - no - yes - yes - - yes - -   -  
      - treat-as-word-space - - Extended - - §7.16.7 - - no - no - no - - no - -   -  
      - word-spacing - - Extended - - §7.16.8 - - no - yes - yes - - yes - -   -  
      - Color-related Properties (§7.17) - + Color-related Properties (§7.17)
      - color - - Basic - - §7.17.1 - - yes - yes - yes - - yes - -   -  
      - color-profile-name - - Extended - - §7.17.2 - - no - no - no - - no - -   -  
      - rendering-intent - - Extended - - §7.17.3 - - no - no - no - - no - -   -  
      - Float-related Properties (§7.18) - + Float-related Properties (§7.18)
      - clear - - Extended - - §7.18.1 - - no - no - no - - no - -   -  
      - float - - Extended - - §7.18.2 - - no - no - no - - no - -   -  
      - intrusion-displace - - Extended - - §7.18.3 - - no - no - no - - no - -   -  
      - Keeps and Breaks Properties (§7.19) - + Keeps and Breaks Properties (§7.19)
      - break-after - - Basic - - §7.19.1 - - yes - yes - yes - - yes - -   -  
      - break-before - - Basic - - §7.19.2 - - yes - yes - yes - - yes - -   -  
      - keep-together - - Extended - - §7.19.3 - - partial - partial - partial - - partial -
      • - [0.20.5] works only in table rows -
        • -
      • - [0.93] works on all implemented block-level FOs, but not on inline-level FOs. -
        • + [0.20.5] works only in table rows
      • - [0.93] <integer> values are not supported. -
        • + [0.93] works on all implemented block-level FOs, but not on inline-level FOs.
      • - [Dev] <integer> values are not supported. + [0.93 and later] <integer> values are not supported.
      - keep-with-next - - Basic - - §7.19.4 - - partial - partial - partial - - partial -
      • - [0.20.5] works only in table rows -
        • + [0.20.5] works only in table rows
      • - [0.93] works on all implemented block-level FOs, but not on inline-level FOs. -
        • + [0.93 and later] works on all implemented block-level FOs, but not on inline-level FOs.
      • - [0.93] <integer> values are not supported. -
        • -
      -
      - keep-with-previous - - Basic - - §7.19.5 - - partial - partial - partial - - partial -
        -
      • - [0.20.5] works only in table rows -
        • -
      • - [0.93] works on all implemented FOs, except list- and table-related and inline-level FOs. -
        • -
      • - [0.93] <integer> values are not supported. -
        • -
      -
      - orphans - - Basic - - §7.19.6 - - no - yes - yes - - yes - -   -  
      - widows - - Basic - - §7.19.7 - - no - yes - yes - - yes - -   -  
      - Layout-related Properties (§7.20) - + Layout-related Properties (§7.20)
      - clip - - Extended - - §7.20.1 - - no - no - no - - no - -   -  
      - overflow - - Basic - - §7.20.2 - - no - yes - yes - - yes - -   -  
      - reference-orientation - - Extended - - §7.20.3 - - no - yes - yes - - yes -
      • - [0.20.5] Workaround for page-orientation (portrait vs. landscape) is to swap the page-width and page-height properties. -
        • + [0.20.5] Workaround for page-orientation (portrait vs. landscape) is to swap the page-width and page-height properties.
      • - [0.20.5] Workaround for block-container is to use SVG. -
        • -
      -
      - span - - Extended - - §7.20.4 - - yes - yes - yes - - yes - -   -  
      - Leader and Rule Properties (§7.21) - + Leader and Rule Properties (§7.21)
      - leader-alignment - - Extended - - §7.21.1 - - partial - no - no - - no -
      • - [0.20.5] not value "page" -
        • + [0.20.5] not value "page"
      • - [0.93] Not supported -
        • -
      -
      - leader-pattern - - Basic - - §7.21.2 - - partial - yes - yes - - yes -
      • - [0.20.5] not value "use-content" -
        • + [0.20.5] not value "use-content"
      • - [0.93] Value "use-content" does not work in all circumstances. -
        • -
      -
      - leader-pattern-width - - Extended - - §7.21.3 - - yes - yes - yes - - yes - -   -  
      - leader-length - - Basic - - §7.21.4 - - partial - yes - yes - - yes -
      • - [0.20.5] leader-length.minimum is not used at all -
        • -
      -
      - rule-style - - Basic - - §7.21.5 - - yes - yes - yes - - yes - -   -  
      - rule-thickness - - Basic - - §7.21.6 - - yes - yes - yes - - yes - -   -  
      - Properties for Dynamic Effects Formatting Objects (§7.22) - + Properties for Dynamic Effects Formatting Objects (§7.22)
      - active-state - - Extended - - §7.22.1 - - no - no - no - - no - -   -  
      - auto-restore - - Extended - - §7.22.2 - - no - no - no - - no - -   -  
      - case-name - - Extended - - §7.22.3 - - no - no - no - - no - -   -  
      - case-title - - Extended - - §7.22.4 - - no - no - no - - no - -   -  
      - destination-placement-offset - - Extended - - §7.22.5 - - no - no - no - - no - -   -  
      - external-destination - - Basic - - §7.22.6 - - yes - yes - yes - - yes - -   -  
      - indicate-destination - - Extended - - §7.22.7 - - no - no - no - - no - -   -  
      - internal-destination - - Extended - - §7.22.8 - - yes - yes - yes - - yes - -   -  
      - show-destination - - Extended - - §7.22.9 - - no - no - no - - no - -   -  
      - starting-state - - Extended - - §7.22.10 - - no - partial - partial - - partial -
      • [0.93 and later] support for starting-state on fo:bookmark
        • -
      -
      - switch-to - - Extended - - §7.22.11 - - no - no - no - - no - -   -  
      - target-presentation-context - - Extended - - §7.22.12 - - no - no - no - - no - -   -  
      - target-processing-context - - Extended - - §7.22.13 - - no - no - no - - no - -   -  
      - target-stylesheet - - Extended - - §7.22.14 - - no - no - no - - no - -   -  
      - Properties for Markers (§7.23) - + Properties for Markers (§7.23)
      - marker-class-name - - Extended - - §7.23.1 - - no - yes - yes - - yes - -   -  
      - retrieve-class-name - - Extended - - §7.23.2 - - no - yes - yes - - yes - -   -  
      - retrieve-position - - Extended - - §7.23.3 - - no - yes - yes - - yes - -   -  
      - retrieve-boundary - - Extended - - §7.23.4 - - no - yes - yes - - yes - -   -  
      - Properties for Number to String Conversion (§7.24) - + Properties for Number to String Conversion (§7.24)
      - format - - Basic - - §7.24.1 - - no - yes - yes - - yes - -   -  
      - grouping-separator - - Extended - - §7.24.2 - - no - no - no - - no - -   -  
      - grouping-size - - Extended - - §7.24.3 - - no - no - no - - no - -   -  
      - letter-value - - Basic - - §7.24.4 - - no - no - no - - no - -   -  
      - Pagination and Layout Properties (§7.25) - + Pagination and Layout Properties (§7.25)
      - blank-or-not-blank - - Extended - - §7.25.1 - - yes - yes - yes - - yes - -   -  
      - column-count - - Extended - - §7.25.2 - - yes - yes - yes - - yes - -   -  
      - column-gap - - Extended - - §7.25.3 - - yes - yes - yes - - yes - -   -  
      - extent - - Extended - - §7.25.4 - - yes - yes - yes - - yes - -   -  
      - flow-name - - Basic - - §7.25.5 - - yes - yes - yes - - yes - -   -  
      - force-page-count - - Extended - - §7.25.6 - - no - yes - yes - - yes - -   -  
      - initial-page-number - - Basic - - §7.25.7 - - yes - yes - yes - - yes - -   -  
      - master-name - - Basic - - §7.25.8 - - yes - yes - yes - - yes - -   -  
      - master-reference - - Basic - - §7.25.9 - - yes - yes - yes - - yes - -   -  
      - maximum-repeats - - Extended - - §7.25.10 - - yes - yes - yes - - yes - -   -  
      - media-usage - - Extended - - §7.25.11 - - no - no - no - - no - -   -  
      - odd-or-even - - Extended - - §7.25.12 - - yes - yes - yes - - yes - -   -  
      - page-height - - Basic - - §7.25.13 - - yes - yes - yes - - yes - -   -  
      - page-position - - Extended - - §7.25.14 - - partial - yes - yes - - yes -
      • - [0.20.5] "last" isn't implemented! -
        • -
      -
      - page-width - - Basic - - §7.25.15 - - yes - yes - yes - - yes - -   -  
      - precedence - - Extended - - §7.25.16 - - no - yes - yes - - yes - -   -  
      - region-name - - Basic - - §7.25.17 - - yes - yes - yes - - yes - -   -  
      - Table Properties (§7.26) - + Table Properties (§7.26)
      - border-after-precedence - - Basic - - §7.26.1 - - no - no - no - - no - -   -  
      - border-before-precedence - - Basic - - §7.26.2 - - no - no - no - - no - -   -  
      - border-collapse - - Extended - - §7.26.3 - - partial - - partial - - partial - partialnoyesyes
        -
      • - Implementation of collapsed table model not complete. -
        • +
      • [0.94 and later] Some small limitations
      - border-end-precedence - - Basic - - §7.26.4 - - no - no - no - - no - -   -  
      - border-separation - - Extended - - §7.26.5 - - no - yes - yes - - yes - -   -  
      - border-start-precedence - - Basic - - §7.26.6 - - no - no - no - - no - -   -  
      - caption-side - - Complete - - §7.26.7 - - no - no - no - - no - -   -  
      - column-number - - Basic - - §7.26.8 - - no - yes - yes - - yes - -   -  
      - column-width - - Basic - - §7.26.9 - - partial - yes - yes - - yes -
      • - [0.20.5] "percentage" not implemented. Workaround is to use the XSL-FO "proportional-column-width" function. -
        • -
      -
      - empty-cells - - Extended - - §7.26.10 - - no - yes - yes - - yes - -   -  
      - ends-row - - Extended - - §7.26.11 - - no - yes - yes - - yes - -   -  
      - number-columns-repeated - - Basic - - §7.26.12 - - no - yes - yes - - yes - -   -  
      - number-columns-spanned - - Basic - - §7.26.13 - - yes - yes - yes - - yes - -   -  
      - number-rows-spanned - - Basic - - §7.26.14 - - yes - yes - yes - - yes - -   -  
      - starts-row - - Extended - - §7.26.15 - - no - yes - yes - - yes - -   -  
      - table-layout - - Extended - - §7.26.16 - - no - no - no - - no - -   -  
      - table-omit-footer-at-break - - Extended - - §7.26.17 - - yes - yes - yes - - yes - -   -  
      - table-omit-header-at-break - - Extended - - §7.26.18 - - yes - yes - yes - - yes - -   -  
      - Writing-mode-related Properties (§7.27) - + Writing-mode-related Properties (§7.27)
      - direction - - Basic - - §7.27.1 - - no - no - no - - no - -   -  
      - glyph-orientation-horizontal - - Extended - - §7.27.2 - - no - no - no - - no - -   -  
      - glyph-orientation-vertical - - Extended - - §7.27.3 - - no - no - no - - no - -   -  
      - text-altitude - - Extended - - §7.27.4 - - no - no - no - - no - -   -  
      - text-depth - - Extended - - §7.27.5 - - no - no - no - - no - -   -  
      - unicode-bidi - - Extended - - §7.27.6 - - no - no - no - - no - -   -  
      - writing-mode - - Basic - - §7.27.7 - - no - no - no - - no - -   -  
      - Miscellaneous Properties (§7.28) - + Miscellaneous Properties (§7.28)
      - content-type - - Extended - - §7.28.1 - - no - no - no - - no - -   -  
      - id - - Basic - - §7.28.2 - - yes - partial - partial - - partial -
        -
      • [0.93] IDs on table-header, table-footer, table-body, table-row, table-and-caption, table-caption, inline-container and bidi-override are not available, yet.
        • -
      -
      - provisional-label-separation - - Basic - - §7.28.3 - - yes - yes - yes - - yes - -   -  
      - provisional-distance-between-starts - - Basic - - §7.28.4 - - yes - yes - yes - - yes - -   -  
      - ref-id - - Extended - - §7.28.5 - - yes - yes - yes - - yes - -   -  
      - score-spaces - - Extended - - §7.28.6 - - no - no - no - - no - -   -  
      - src - - Basic - - §7.28.7 - - yes - yes - yes - - yes - -   -  
      - visibility - - Extended - - §7.28.8 - - no - no - no - - no - -   -  
      - z-index - - Extended - - §7.28.9 - - no - no - no - - no - -   -  
      - Shorthand Properties (§7.29) - + Shorthand Properties (§7.29)
      - background - - Complete - - §7.29.1 - - no - no - no - - no - -   -  
      - background-position - - Complete - - §7.29.2 - - no - yes - yes - - yes - -   -  
      - border - - Complete - - §7.29.3 - - no - yes - yes - - yes - -   -  
      - border-bottom - - Complete - - §7.29.4 - - yes - yes - yes - - yes - -   -  
      - border-color - - Complete - - §7.29.5 - - partial - yes - yes - - yes -
      • - [0.20.5] only one value allowed -
        • -
      -
      - border-left - - Complete - - §7.29.6 - - yes - yes - yes - - yes - -   -  
      - border-right - - Complete - - §7.29.7 - - yes - yes - yes - - yes - -   -  
      - border-style - - Complete - - §7.29.8 - - partial - yes - yes - - yes -
      • - [0.20.5] only "solid" works -
        • -
      -
      - border-spacing - - Complete - - §7.29.9 - - no - yes - yes - - yes - -   -  
      - border-top - - Complete - - §7.29.10 - - yes - yes - yes - - yes - -   -  
      - border-width - - Complete - - §7.29.11 - - yes - yes - yes - - yes - -   -  
      - cue - - Complete - - §7.29.12 - - na - na - na - - na - -   -  
      - font - - Complete - - §7.29.13 - - no - partial - partial - - partial -
      • - [0.93] Enum values other than "inherit" not yet supported. -
        • -
      -
      - margin - - Complete - - §7.29.14 - - partial - yes - yes - - yes -
      • - [0.20.5] only on pages and regions -
        • -
      -
      - padding - - Complete - - §7.29.15 - - partial - yes - yes - - yes -
      • - [0.20.5] only one value allowed -
        • + [0.20.5] only one value allowed
      • - [0.20.5] only implemented for blocks -
        • + [0.20.5] only implemented for blocks
      • - [0.20.5] can't be used to make extra space (use indents + spaces instead) -
        • + [0.20.5] can't be used to make extra space (use indents + spaces instead)
      • - [0.20.5] can be used to control how much the background-color extends beyond the content rectangle -
        • -
      -
      - page-break-after - - Complete - - §7.29.16 - - no - yes - yes - - yes - -   -  
      - page-break-before - - Complete - - §7.29.17 - - no - yes - yes - - yes - -   -  
      - page-break-inside - - Complete - - §7.29.18 - - no - yes - yes - - yes - -   -  
      - pause - - Complete - - §7.29.19 - - na - na - na - - na - -   -  
      - position - - Complete - - §7.29.20 - - partial - yes - yes - - yes -
      • - [0.20.5] "inherit" not handled -
        • -
      -
      - size - - Complete - - §7.29.21 - - no - no - no - - no - -   -  
      - vertical-align - - Complete - - §7.29.22 - - partial - partial - partial - - partial -
      • - [0.20.5] Only works as a shorthand for baseline-shift property. -
        • + [0.20.5] Only works as a shorthand for baseline-shift property.
      • - [0.93] Percentages are not supported, yet. -
        • -
      -
      - white-space - - Complete - - §7.29.23 - - no - yes - yes - - yes - -   -  
      - xml:lang - - Complete - - §7.29.24 - - no - no - no - - no - -   -  
      -

      XSL-FO Core Function Library Support Table (§5.10)

      +

      XSL-FO Core Function Library Support Table (§5.10)

      The following is a summary of FOP's current support for the XSL-FO Core Function Library.

      + Function Name + XSL-FO Conformance Level - + Citation + + Comments + 0.20.5 (previous) + 0.93 (stable) + + develop- ment - + + floor + Basic + §5.10.1 + yes + yes + - + yes + + ceiling + Basic + §5.10.1 + yes + yes + - + yes + + round + Basic + §5.10.1 + yes + yes + - + yes + + min + Basic + §5.10.1 + yes + yes + - + yes + + max + Basic + §5.10.1 + yes + yes + - + yes + + abs + Basic + §5.10.1 + yes + yes + - + yes + - + + rgb + Basic + §5.10.2 + yes + yes + - + yes + + rgb-icc + Basic + §5.10.2 + no + yes + - + yes + + system-color + Basic + §5.10.2 + no + yes + - + yes + - + + system-font + Basic + §5.10.3 + no + no + - + no + - + + inherited-property-value + Basic + §5.10.4 + yes + yes + - + yes + + label-end + Basic + §5.10.4 + yes + yes + - + yes + + body-start + Basic + §5.10.4 + yes + yes + - + yes + + from-parent + Basic + §5.10.4 + yes + yes + - + yes + + from-nearest-specified-value + Basic + §5.10.4 + yes + yes + - + yes + + from-table-column + Basic + §5.10.4 + no + yes + - + yes + + proportional-column-width + Basic + §5.10.4 + yes + yes + - + yes + + merge-property-values + Basic + §5.10.4 + no + no + - + no +
      - Function Name - - XSL-FO Conformance Level - - Citation - - Support in FOP - + Support in FOP - Comments -
      - 0.20.5 (previous) - - 0.93 (stable) - 0.94 (stable) - develop- ment -
      - Number Functions (§5.10.1) - + Number Functions (§5.10.1)
      - floor - - Basic - - §5.10.1 - - yes - - yes - yes - yes - -   -  
      - ceiling - - Basic - - §5.10.1 - - yes - - yes - yes - yes - -   -  
      - round - - Basic - - §5.10.1 - - yes - - yes - yes - yes - -   -  
      - min - - Basic - - §5.10.1 - - yes - - yes - yes - yes - -   -  
      - max - - Basic - - §5.10.1 - - yes - - yes - yes - yes - -   -  
      - abs - - Basic - - §5.10.1 - - yes - - yes - yes - yes - -   -  
      - Color Functions (§5.10.2) - + Color Functions (§5.10.2)
      - rgb - - Basic - - §5.10.2 - - yes - - yes - yes - yes - -   -  
      - rgb-icc - - Basic - - §5.10.2 - - no - - yes - yes - yes - -   -  
      - system-color - - Basic - - §5.10.2 - - no - - yes - yes - yes - -   -  
      - Font Functions (§5.10.3) - + Font Functions (§5.10.3)
      - system-font - - Basic - - §5.10.3 - - no - - no - no - no - -   -  
      - Property Value Functions (§5.10.4) - + Property Value Functions (§5.10.4)
      - inherited-property-value - - Basic - - §5.10.4 - - yes - - yes - yes - yes - -   -  
      - label-end - - Basic - - §5.10.4 - - yes - - yes - yes - yes - -   -  
      - body-start - - Basic - - §5.10.4 - - yes - - yes - yes - yes - -   -  
      - from-parent - - Basic - - §5.10.4 - - yes - - yes - yes - yes - -   -  
      - from-nearest-specified-value - - Basic - - §5.10.4 - - yes - - yes - yes - yes - -   -  
      - from-table-column - - Basic - - §5.10.4 - - no - - yes - yes - yes - -   -  
      - proportional-column-width - - Basic - - §5.10.4 - - yes - - yes - yes - yes - -   -  
      - merge-property-values - - Basic - - §5.10.4 - - no - - no - no - no - -   -  
      diff --git a/src/documentation/content/xdocs/dev/design/configuration.xml b/src/documentation/content/xdocs/dev/design/configuration.xml index 886a2fdde..43d8ebe61 100644 --- a/src/documentation/content/xdocs/dev/design/configuration.xml +++ b/src/documentation/content/xdocs/dev/design/configuration.xml @@ -47,30 +47,30 @@ settings for entries that you wish to use. Be sure to follow any instructions, including comments which specify the value range. Also, since the configuration file is XML, be sure to keep it well-formed.

      -
      +
      -
      - Making Configuration Available to FOP -

      After creating your configuration file, you must tell FOP how +

      + Making Configuration Available to FOP +

      After creating your configuration file, you must tell FOP how to find it.

      -
      - From the Command Line -

      When you run FOP from the command-line, use the +

      + From the Command Line +

      When you run FOP from the command-line, use the “-c” command-line option with the path to the configuration file as the option value.

      -
      +
      -
      - A Configuration File in an Embedded Application -

      FOP uses the Avalon framework configuration package +

      + A Configuration File in an Embedded Application +

      FOP uses the Avalon framework configuration package org.apache.avalon.framework.configuration. For detailed information, see the documentation of the package.

      -

      If you want to use a user configuration file with your +

      If you want to use a user configuration file with your embedded program, you need to build an Avalon configuration object from it, and register that with the user agent:

      - FOUserAgent foUserAgent; + FOUserAgent foUserAgent; XMLReader parser; DefaultConfigurationBuilder configBuilder; File userConfigFile; @@ -81,81 +81,81 @@ userConfigFile = new File("YourConfigFile.xml"); userConfig = configBuilder.buildFromFile(userConfigFile); foUserAgent.setUserConfig(userConfig); -

      You can find example code in FOP's +

      You can find example code in FOP's apps.CommandLine class, method createUserConfig.

      -
      +
      -
      - Programmatically Building the Configuration -

      You can also build the configuration object programmatically, +

      + Programmatically Building the Configuration +

      You can also build the configuration object programmatically, instead of building it from an external file. Make sure that the configuration object is equivalent to a configuration object that would be obtained from a correct configuration file. Register the configuration object with the user agent as described above.

      -
      +
      -
      +
      -
      - The Configuration File -

      The top-level element is arbitrary. You may give it any name +

      + The Configuration File +

      The top-level element is arbitrary. You may give it any name that is useful for you, e.g. <fop-configuration version="2">.

      -

      Inside the top-level element the configuration may contain +

      Inside the top-level element the configuration may contain three sections: userAgent, renderers, and hyphenation. At the moment of this writing the userAgent and hyphenation sections are not used by FOP.

      -

      The renderers section has subsections called +

      The renderers section has subsections called renderer. There may be one subsection for each type of renderer. The renderers are identified by their MIME type, which is given in the mime attribute. For example: <renderer mime="application/pdf">. The content of each renderer subsection depends on the type of renderer.

      -

      The PDF renderer (MIME type application/pdf) has +

      The PDF renderer (MIME type application/pdf) has several options:

      -
      -
      filterList
      -
      Contains a number of value elements, whose +
      +
      filterList
      +
      Contains a number of value elements, whose content specify a filter which should be applied. Possible filters are: flate, ascii-85, ascii-hex. The flate filter is on by default.
      -
      fonts
      -
      Contains a number of font elements. Each +
      fonts
      +
      Contains a number of font elements. Each font element represents a font file, e.g. arial.ttf. It contains a number of font-triplet elements, defining the font triplets which are provided by this font file. See the example configuration file for details.
      -
      -

      The example configuration file provides for details about the +

      +

      The example configuration file provides for details about the other renderers.

      -
      +
      Hyphenation -

      When FOP needs to load a hyphenation file for a certain +

      When FOP needs to load a hyphenation file for a certain language and country combination, it follows these steps.

      -
        -
      1. FOP searches for the compiled hyphenation file (extension +
          +
        1. FOP searches for the compiled hyphenation file (extension hyp in the directory hyph in the class path.
          2. -
        2. FOP searches for the compiled or the XML hyphenation file +
        3. FOP searches for the compiled or the XML hyphenation file in a user directory. At the time of this writing FOP does not read the configuration file for the user directory. It always uses the directory /hyph.
          4. -
        -

        It is possible to add user hyphenation files to FOP's +

      +

      It is possible to add user hyphenation files to FOP's hyphenation directory when FOP is built. The directory containing user hyphenation files must be specified in the variable user.hyph.dir in the local build properties file. All hyphenation files in the directory are compiled, and the compiled files are added to the hyphenation directory in the build directory.

      -

      See FOP: Hyphenation for +

      See FOP: Hyphenation for more information on creating and modifying hyphenation within FOP.

      @@ -168,24 +168,24 @@ especially the section entitled Register Fonts with FOP.

      -
      - Logging -

      FOP uses the Jakarta Commons logging package +

      + Logging +

      FOP uses the Jakarta Commons logging package org.apache.commons.logging. For detailed information, see the documentation of the package.

      -

      Commons logging is entirely configured by the user, using +

      Commons logging is entirely configured by the user, using Java system properties. Configuration happens in two stages.

      -

      First you configure which logging implementation you want +

      First you configure which logging implementation you want to use. For example:

      - org.apache.commons.logging.Log + org.apache.commons.logging.Log =org.apache.commons.logging.impl.SimpleLog -

      SimpleLog is the default logging package on most Java +

      SimpleLog is the default logging package on most Java systems. On Java 1.4 systems JDK 1.4 is the default.

      -

      Secondly, you configure the selected logging package. How +

      Secondly, you configure the selected logging package. How this is done depends on the logging package. The most important feature is the log level. The default is level “info”. An example configuration file for SimpleLog is:

      - + # logging level for all loggers, default info org.apache.commons.logging.simplelog.defaultlog=info @@ -193,7 +193,7 @@ org.apache.commons.logging.simplelog.defaultlog=info org.apache.commons.logging.simplelog.log.xxxxx=debug org.apache.commons.logging.simplelog.log.org.apache.fop.pdf=trace -

      FOP uses several named loggers. When you set the logging level +

      FOP uses several named loggers. When you set the logging level for all loggers to “info”, you get a decent small amount of information about application progress. The debugging and especially the trace @@ -201,7 +201,7 @@ levels produce a lot of output. If you need these logging levels, it is wise to switch them on for one or several specific loggers. The names of the loggers can be found in the source files. Many loggers bear the name of their package, their class or of a superclass.

      -
      +
      diff --git a/src/documentation/content/xdocs/dev/faq.xml b/src/documentation/content/xdocs/dev/faq.xml index 2206f9f9d..bacc807ad 100644 --- a/src/documentation/content/xdocs/dev/faq.xml +++ b/src/documentation/content/xdocs/dev/faq.xml @@ -48,9 +48,9 @@ Where can I learn how the FOP docs and web site are built? -

      - See FOP Doc Management. ;-) -

      +

      + See FOP Doc Management. ;-) +

      diff --git a/src/documentation/content/xdocs/dev/release.xml b/src/documentation/content/xdocs/dev/release.xml index 8785d8789..fa4dbfa37 100644 --- a/src/documentation/content/xdocs/dev/release.xml +++ b/src/documentation/content/xdocs/dev/release.xml @@ -37,18 +37,18 @@ The purpose of documenting it here is to facilitate consistency, ensure that the
    • Determine whether this is a Release Candidate or a Release.
    • Determine whether further testing is required.
    • Commit any outstanding changes
      • -
    • Create a branch called branches/fop-v_vv
      • -
    • Edit release notes (README and status.xml in the root).
      • -
    • Update the index.xml and site.xml for the new version.
      • +
    • Create a branch called branches/fop-v_vv
      • +
    • Edit release notes (README and status.xml in the root).
      • +
    • Update the index.xml and site.xml for the new version.
    • Update the version numbers in the release column on the - compliance page; update the compliance in the release column + compliance page (compliance.xml); update the compliance in the release column to the current state (development column).
      • -
    • Update version number in build.xml (not to be merged back +
    • Update version number in build.xml (not to be merged back into trunk).
    • Copy trunk documentation directory to a new directory with the version number, and update any links and the .htaccess file for redirections.
      • -
    • Copy test/fotree/disabled-testcases.xml and +
    • Copy test/fotree/disabled-testcases.xml and test/layoutengine/disabled-testcases.xml to the new version directory <version>/fotree/disabled-testcases.xml and @@ -56,40 +56,40 @@ The purpose of documenting it here is to facilitate consistency, ensure that the Copy known-issues.xml to the new version directory. Copy knownissues-overview.xml from the previous to the new version directory.
      • -
    • Delete the previous version directory.
      • -
    • Build the dist files (build[.sh] dist) +
    • Delete the previous version directory.
      • +
    • Build the dist files (build[.sh] dist) and upload them to your web directory on people.apache.org
      • -
    • Ask on fop-dev to check the branch and the generated dist +
    • Ask on fop-dev to check the branch and the generated dist files for errors.
      • -
    • Tag the source tree with the release ID. For example, if the release is 0.93: - svn copy https://svn.apache.org/repos/asf/xmlgraphics/fop/branches/fop-0_93 https://svn.apache.org/repos/asf/xmlgraphics/fop/tags/fop-0_93
      • +
    • Tag the source tree with the release ID. For example, if the release is 0.94: + svn copy https://svn.apache.org/repos/asf/xmlgraphics/fop/branches/fop-0_94 https://svn.apache.org/repos/asf/xmlgraphics/fop/tags/fop-0_94
    • Make a fresh checkout with the just created tag: - svn co https://svn.apache.org/repos/asf/xmlgraphics/fop/tags/fop-0_93
      • + svn co https://svn.apache.org/repos/asf/xmlgraphics/fop/tags/fop-0_94
    • Copy jimi and jai to lib/ (jimi-1.0.jar, jai_core.jar, jai_codec.jar)
    • Copy jce-jdk13-119.jar from from http://www.bouncycastle.org/latest_releases.html to lib/
      • -
    • Copy the hyphenation patterns jar file +
    • Copy the hyphenation patterns jar file fop-hyph.jar to lib/ (e.g. from http://sourceforge.net/projects/offo
    • Alternatively, create a build-local.properties file that points to the above libs.
    • Run build[.sh] dist. Do this once using Sun JDK 1.3.1_15 or later and once with Sun JDK 1.4.2_08 or later. A Forrest installation is needed.
    • Create signatures. Don't forget to upload your KEY: - gpg -a -b --force-v3-sigs fop-0.93-src.tar.gz etc.
      • + gpg -a -b --force-v3-sigs fop-0.94-src.tar.gz etc.
    • Upload the dist and signature files to your web directory on people.apache.org (An account on minotaur is needed): - scp fop-0.93*.tar.gz* + scp fop-0.94*.tar.gz* chrisg@people.apache.org:public_html/
    • Check permissions: chmod 664 ... ; chgrp xmlgraphics ...
      • -
    • Add MD5 sums: md5 fop-0.93-src.tar.gz > - fop-0.93-src.tar.gz.md5 etc.
      • +
    • Add MD5 sums: md5 fop-0.94-src.tar.gz > + fop-0.94-src.tar.gz.md5 etc.
    • Make a test download.
      • -
    • Start a vote for the release on +
    • Start a vote for the release on general@xmlgraphics.a.o. The message should point to the release files and list the MD5 sums (cat *.md5). The vote is open for 72hrs.
      • -
    • When the release is accepted, copy the release files, +
    • When the release is accepted, copy the release files, their md5 sum files and the signature files to /www/www.apache.org/dist/xmlgraphics/fop/ in the subdirectories source and @@ -98,10 +98,10 @@ The purpose of documenting it here is to facilitate consistency, ensure that the the previous version.
    • Update HEADER.html and README.html in people.apache.org:/www/www.apache.org/dist/xmlgraphics/fop/
    • Wait 24 hours (for the mirrors to catch up).
      • -
    • Merge the changes of the subversion release branch back +
    • Merge the changes of the subversion release branch back into trunk (not the version number in the build file) and delete the branch.
      • -
    • Deploy the updated documentation to the FOP website.
      • +
    • Deploy the updated documentation to the FOP website.
    • Post announcements on fop-dev and fop-user and other related mailing lists.
    • Ask a Bugzilla admin (Christian Geisert) to add a bugzilla entry for the new release id, or create an issue at @@ -131,7 +131,7 @@ The purpose of documenting it here is to facilitate consistency, ensure that the
    • general@xmlgraphics.apache.org
    • general@xml.apache.org
    • announce@apache.org (from your apache.org address)
      • -
    • xsl-list@lists.mulberrytech.com (subscriber-only)
      • +
    • xsl-list@lists.mulberrytech.com (subscriber-only)
    • XSL-FO@yahoogroups.com (subscriber-only)
    • www-xsl-fo@w3.org
    • docbook-apps@lists.oasis-open.org (subscriber-only)
      • diff --git a/src/documentation/content/xdocs/download.xml b/src/documentation/content/xdocs/download.xml index 53b698854..40e42236b 100644 --- a/src/documentation/content/xdocs/download.xml +++ b/src/documentation/content/xdocs/download.xml @@ -55,13 +55,6 @@
      Source Download -

      - You must first determine which of the two main development branches you wish - to download, "maintenance" or "redesign". See - Development Introduction for more details - on the choices, and for the CVS tags to use when downloading the "maintenance" - branch. -

      There are several ways to obtain a source distribution. Please note that they are listed from least current to most current: @@ -70,8 +63,7 @@

    • Download a released version from a FOP Distribution mirror. - Source distributions include "-src" in their names. Please note that official - releases currently are only made from the "maintenance" branch. + Source distributions include "-src" in their names.
      • Release Notes, the FOP Standards Compliance document, and the remaining FAQ in this document. If not found there, look at the list of Bugs Already Reported. diff --git a/src/documentation/content/xdocs/fo.xml b/src/documentation/content/xdocs/fo.xml index 62d7a63df..5ab95fe8d 100644 --- a/src/documentation/content/xdocs/fo.xml +++ b/src/documentation/content/xdocs/fo.xml @@ -31,7 +31,7 @@ FOP uses XSL-FO as input. It is the responsibility of the user to make sure that the XSL-FO submitted to FOP is correct. The tutorial items presented here are not comprehensive, but are of the FAQ variety. Another -good FAQ is Dave Pawson's XSL FAQ. +good FAQ is Dave Pawson's XSL FAQ.

      @@ -92,7 +92,7 @@ It is not necessary everywhere, but it is wise to do so anyway, just to be sure.
      Encoding Issues

      - If the parser complains about illegal bytes or characters in the input, or there are unexpected characters in the output, this is usually is the result of a character encoding problem. + If the parser complains about illegal bytes or characters in the input, or there are unexpected characters in the output, this is usually the result of a character encoding problem. See the XSL FAQ for additional information. Many software packages that produce XML, including XSLT processors, use UTF-8 encoding as a default. If you view their output with something not aware of the encoding, like Notepad for Win95/98/ME/NT, funny characters are displayed. A Å is a giveaway. @@ -350,13 +350,14 @@ Omit your normal headers and footers, and use (for example) an extended header t

      Preformatting Content

      - Sometimes it is desirable to retain linebreaks and hard spaces, and to get preformatted text to pass through without being changed. -The XSL-FO specification provides some properties for this: white-space-collapse and linefeed-treatment. -In FOP, use white-space-collapse="false" on an enclosing block. + Sometimes it is desirable to retain linebreaks and hard spaces, and to get + preformatted text to pass through without being changed. The XSL-FO + specification provides some properties for this: white-space-collapse + and linefeed-treatment. + In FOP, use white-space-collapse="false" on an enclosing block.

      - - Due to a bug in FOP 0.20.5, setting white-space-collapse="false" will also preserve line breaks in the text. Do not rely on this behavior, as it is non-conformant and has changed in FOP 0.93. -
      Total Document Pages @@ -447,7 +448,7 @@ This applies similarly to the extent of the after region and the bottom margin o

      • - Horizontal lines can be drawn using fo:leader. + Horizontal lines can be drawn using fo:leader.
      • Use a solid border on a suitable fo:block. This will work for horizontal and vertical lines only. @@ -463,9 +464,12 @@ This applies similarly to the extent of the after region and the bottom margin o RenderX has provided an Unofficial DTD for FO Documents, which may be helpful in validating general FO issues.

        - FOP also maintains an Unofficial FOP Schema in the FOP CVS Repository. -This document can be used either to validate against the FO standard, or against the actual FOP implementation. -See the notes near the beginning of the document for instructions on how to use it. + FOP also maintains an Unofficial + FOP Schema in the FOP Subversion Repository. This document can be used + either to validate against the FO standard, or against the actual FOP + implementation. See the notes near the beginning of the document for + instructions on how to use it.

      @@ -484,8 +488,8 @@ See the notes near the beginning of the document for instructions on how to use
      External Resources -

      Resources needed by an XSL-FO file that are external to it (graphics, for example), are defined in the XSL-FO standard as being of type "uri-specification". This is defined in the standard at Section 5.11 Property Datatypes, which includes a link to the URI standard itself. Refer to the XSL-FO and URI standards themselves for more detailed instructions.

      -

      URIs may be either absolute or relative to a base URI. (See FOP: Configuration for information on setting the base URI for a FOP session). Here is an example referencing an external-graphic that is relative to the base URI:

      +

      Resources needed by an XSL-FO file that are external to it (graphics, for example), are defined in the XSL-FO standard as being of type "uri-specification". This is defined in the standard at Section 5.11 Property Datatypes, which includes a link to the URI standard itself. Refer to the XSL-FO and URI standards themselves for more detailed instructions.

      +

      URIs may be either absolute or relative to a base URI. (See FOP: Configuration for information on setting the base URI for a FOP session). Here is an example referencing an external-graphic that is relative to the base URI:

      ]]>

      Here is an example referencing an external-graphic that is an absolute URI on a local filesystem:

      ]]> diff --git a/src/documentation/content/xdocs/index.xml b/src/documentation/content/xdocs/index.xml index 72ff065f7..b0f44fac3 100644 --- a/src/documentation/content/xdocs/index.xml +++ b/src/documentation/content/xdocs/index.xml @@ -26,25 +26,19 @@
      Introduction -

      Apache FOP (Formatting Objects Processor) is the world's first print formatter driven by XSL formatting - objects (XSL-FO) and the world's first output independent formatter. It is a - Java application that reads a formatting object (FO) tree and - renders the resulting pages to a specified output. Output formats - currently supported include PDF, PCL, PS, SVG, XML (area tree representation), - Print, AWT, MIF and TXT. - The primary output target is PDF. -

      +

      Apache FOP (Formatting Objects Processor) is a print formatter driven by XSL + formatting objects (XSL-FO) and an output independent formatter. It is a Java + application that reads a formatting object (FO) tree and renders the resulting + pages to a specified output. Output formats + currently supported include PDF, PS, PCL, AFP, XML (area tree representation), + Print, AWT and PNG, and to a lesser extent, RTF and TXT. The primary output target is PDF. +

      - The previous version of FOP (0.20.5) is a partial implementation of the - XSL-FO Version 1.0 - W3C Recommendation. -

      -

      - The latest stable version of FOP (0.93) is the first stable release - after a large redesign effort and implements a larger subset than 0.20.5 of the - XSL-FO Version 1.0 W3C Recommendation - as well as some parts of the XSL-FO Version 1.1 Working Draft. + The latest stable version of FOP (0.94) is the second + stable release after a large redesign effort and implements a large subset of the + XSL-FO Version 1.1 W3C + Recommendation.

      Support for each of the standard's objects and properties is detailed in FOP Compliance. @@ -63,22 +57,21 @@ is formatted into the two pages on the right. The document contains static areas

      FOP uses the standard XSL-FO file format as input, lays the content out into pages, then renders it to the requested output. -One great advantage to using XSL-FO as input is that XSL-FO is itself an XML file, which means that it can be conveniently created from a variety of sources. +One great advantage of using XSL-FO as input is that XSL-FO is itself an XML file, which means that it can be conveniently created from a variety of sources. The most common method is to convert semantic XML to XSL-FO, using an XSLT transformation.

      FOP Objectives -

      The goals of the Apache FOP project are to deliver an XSL-FO to PDF formatter that is compliant to at least the Basic - conformance level described in the W3C Recommendation from 15 October 2001, and that complies with the 11 March 1999 Portable Document - Format Specification (Version 1.3) from Adobe Systems. +

      The goals of the Apache FOP project are to deliver an XSL-FO to PDF formatter that + is compliant to at least the Basic conformance level described in the W3C + Recommendation from 05 December 2006, and that complies with the November 2001 + Portable Document Format Specification (Version 1.4) 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.

      - -

      The FOP layout system is currently being rewritten to better support the XSL-FO standard.

      The PDF files on this site are created using Apache FOP. diff --git a/src/documentation/content/xdocs/maillist.xml b/src/documentation/content/xdocs/maillist.xml index ac98024a7..23cdad106 100644 --- a/src/documentation/content/xdocs/maillist.xml +++ b/src/documentation/content/xdocs/maillist.xml @@ -78,7 +78,11 @@ href="dev/index.html#mail-fop-dev">Development pages.
    • Have you read Mailing List General Information? If not please do so before proceeding.
    • Have you stated the version of FOP you are using? Please do so. Usually, it's a good idea to state the JDK/JRE version and the operating system you're using, too.
    • Have you included any detailed error messages? Please do so.
      • -
    • Does a proper understanding of your question require inclusion of XSLT code, DocBook source, or other semantic XML? If so, the question is almost certainly not appropriate to this list. In general, the only input documents that are appropriate on this list are XSL-FO snippets. See Running Xalan for instructions about capturing the XSL-FO document that is actually submitted to FOP. If you haven't examined the XSL-FO document yourself, then you are not yet prepared to formulate a FOP-specific question.
      • +
    • Does a proper understanding of your question require inclusion of XSLT code, DocBook + source, or other semantic XML? If so, the question is almost certainly not + appropriate to this list. In general, the only input documents that are + appropriate on this list are XSL-FO snippets. See Running Xalan for instructions about capturing the XSL-FO document that is actually submitted to FOP. If you haven't examined the XSL-FO document yourself, then you are not yet prepared to formulate a FOP-specific question.
    • If you are providing one or more XSL-FO snippets:
      • Have you reduced them to the shortest possible complete, self-contained document that demonstrates the problem? Please do so.
        • diff --git a/src/documentation/content/xdocs/news.xml b/src/documentation/content/xdocs/news.xml index efa380bb4..9f84de273 100644 --- a/src/documentation/content/xdocs/news.xml +++ b/src/documentation/content/xdocs/news.xml @@ -25,19 +25,27 @@ $Revision$
      • +
      + XX August 2007 - Apache FOP 0.94 Released +

      The Apache FOP team is pleased to present you the second production + grade release of the new FOP codebase. This release contains many bug + fixes and new features. See the Release Notes for a list of + the most important changes.

      +
      26 January 2007 - New Committer

      Welcome Jay Bryant!

      -
      - 9 January 2007 - Apache FOP 0.93 released +
      + 9 January 2007 - Apache FOP 0.93 released

      The Apache FOP team is proud to present to you the first production grade release of the new FOP codebase. This release has the new API first introduced in release 0.92 beta. It contains again many bug fixes and new features.

      -
      +
      16 October 2006 - New Committer

      Welcome Vincent Hennebert!

      @@ -71,8 +79,8 @@

      Please see also the - announcement - and the release notes. + announcement. +

      @@ -83,7 +91,7 @@ 20 October 2004 - Creation of the Apache XML Graphics project

      The Apache Board of Directors agreed to the creation of the - Apache XML Graphics + Apache XML Graphics project which will be comprised of Batik and FOP. Both former Apache XML subprojects are in this way complying with the Board's desire to improve project oversight. Both project teams also see additional @@ -137,7 +145,8 @@

      See also the full text of the - announcement and the release notes. + announcement. +

      diff --git a/src/documentation/content/xdocs/relnotes.xml b/src/documentation/content/xdocs/relnotes.xml index 8499d674b..0037817bd 100644 --- a/src/documentation/content/xdocs/relnotes.xml +++ b/src/documentation/content/xdocs/relnotes.xml @@ -44,11 +44,11 @@
    • The API has changed between 0.91beta this release. - Please consult the "Upgrading" page for details. + Please consult the "Upgrading" page for details.
    • You may experience different behaviour compared to version 0.20.5. - Please consult the "Upgrading" page for details. + Please consult the "Upgrading" page for details.

    Known Issues:

    @@ -177,7 +177,7 @@
  • You may experience different behaviour compared to version 0.20.5. - Please consult the "Upgrading" page indicated above for details. + Please consult the "Upgrading" page indicated above for details.

    • Known Issues:

    @@ -318,7 +318,7 @@
  • You may experience different behaviour compared to version 0.20.5. - Please consult the "Upgrading" page indicated above for details. + Please consult the "Upgrading" page indicated above for details.

    • Known Issues:

    @@ -430,7 +430,7 @@
    FOP 0.20.5 -

    This is the last planned release in the 0.20.x series (aka maintenance branch).

    +

    This was the last release in the 0.20.x series (aka maintenance branch).

    Important changes since the last release (0.20.4):

    • Some hyphenation patterns (cs, da, de, de_DR, el, en, en_US, fr, nl, @@ -461,7 +461,8 @@
    • Links in PDF won't generate multiple link rectangles anymore. If this causes a problem you can set the system property "links.merge" to "no".
      • -
    • FOP has been compiled with cryptography support. See +
    • FOP has been compiled with cryptography support. See + PDF encryption for details about installation and usage.
    • The behaviour of leader has changed. See @@ -496,7 +497,7 @@ support for additional truetype fonts in AWT Viewer.
    • Logging has been changed from LogKit to Avalon's Logger Interface. - (see Embedding for details). + (see Embedding for details).
    • Building under JDK 1.4: You need to add a method in diff --git a/src/documentation/content/xdocs/resources.xml b/src/documentation/content/xdocs/resources.xml index 44aef321c..f4bfc45f7 100644 --- a/src/documentation/content/xdocs/resources.xml +++ b/src/documentation/content/xdocs/resources.xml @@ -30,7 +30,7 @@
      XSL-FO
        -
      • XSL-FO Recommendation (15 October 2001)
        • +
      • XSL-FO Recommendation (05 December 2006)
      • Unofficial DTD for the XSL-FO Recommendation provided by N. Grigoriev from RenderX.
      @@ -87,7 +87,6 @@
    • [online article] Using XSL Formatting Objects, by J. David Eisenberg.
    • [online reference] XSL FO reference, by Miloslav Nic.
    • [online reference] Dave Pawson's XSL-FO FAQ.
      • -
    • [online book] An introduction to XSL Formatting Objects, by Dave Pawson. See hardcopy version below.
    • [book] XSL-FO, by Dave Pawson, O'Reilly & Associates, 2002, ISBN 0-596-00355-2. See online version above.
    • [book] Definitive XSL-FO, by G. Ken Holman, Prentice Hall PTR, 2003, ISBN 0-131-40374-5.
    • [book] XSL Formatting Objects Developer's Handbook, by Doug Lovell, Sams, 2002, ISBN 0-672-32281-1.
      • @@ -101,7 +100,7 @@
    • [book] XSLT Programmer's Reference, by Michael H. Kay, Wrox Press, ISBN 1-861-00506-7.
    • [book] XSLT, by Doug Tidwell, O'Reilly & Associates, 2001, ISBN 0-596-00053-7.
    • [book] XSLT Cookbook, by Sal Mangano, O'Reilly & Associates, 2002, ISBN 0-596-00372-2.
      • -
    • [article] Dave Pawson's XSL FAQ.
      • +
    • [article] Dave Pawson's XSL FAQ.
    • [book] XPath and XPointer: Locating Content in XML Documents, by John E. Simpson, O'Reilly & Associates, 2002, ISBN 0-596-00291-2.
    • [book] XSL Essentials, by Michael Fitzgerald, John Wiley & Sons, 2001, ISBN 0-471-41620-7.
    • [book] Java and XSLT, by Eric M. Burke, O'Reilly & Associates, 2001, ISBN 0-596-00143-6.
      • @@ -221,7 +220,6 @@
    • [software] Scriptura by Inventive Designers (commercial)
    • [software] XSLfast by jCatalog Software AG (commercial)
    • [software] Xultation Designer by Metafocus (commercial)
      • -
    • [software] Word FO Designer by CambridgeDocs (commercial)
    • [software] Assentis:DocDesign by Assentis Technologies (commercial)
    diff --git a/src/documentation/content/xdocs/site.xml b/src/documentation/content/xdocs/site.xml index f1e4c4960..a41b8a639 100644 --- a/src/documentation/content/xdocs/site.xml +++ b/src/documentation/content/xdocs/site.xml @@ -55,11 +55,15 @@ --> - + - + + + + + @@ -68,29 +72,31 @@ - + + + + - - + - + - - + + @@ -117,7 +123,7 @@ - true + false - true + false - true + false @@ -145,6 +145,10 @@ which will be used to configure the chosen Forrest skin. in the class attribute of a

    node. e.g.

    --> + + + #content { font-size: 100%; } + p.quote { margin-left: 2em; padding: .5em; diff --git a/status.xml b/status.xml index 7de903d8e..76c0c2451 100644 --- a/status.xml +++ b/status.xml @@ -28,6 +28,8 @@ + + AFP Renderer: Bugfix for 1 bit images where the width is not a multiple of 8. diff --git a/xmlgraphics-fop-pom-template.pom b/xmlgraphics-fop-pom-template.pom index 6fdf015a8..abebcc8fc 100644 --- a/xmlgraphics-fop-pom-template.pom +++ b/xmlgraphics-fop-pom-template.pom @@ -70,7 +70,7 @@ http://maven.apache.org/maven-v4_0_0.xsd"> org.apache.xmlgraphics xmlgraphics-commons - 1.1 + 1.2 batik -- 2.39.5