You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xmlgraphics.apache.org by vh...@apache.org on 2014/07/24 18:21:24 UTC
svn commit: r1613173 [13/15] - in /xmlgraphics/site/trunk/content: ./ batik/
batik/dev/ batik/tools/ batik/using/ batik/using/scripting/ commons/ fop/
fop/0.95/ fop/1.0/ fop/1.1/ fop/dev/ fop/dev/design/ fop/trunk/
Modified: xmlgraphics/site/trunk/content/fop/knownissues.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/knownissues.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/knownissues.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/knownissues.mdtext Thu Jul 24 16:21:20 2014
@@ -3,7 +3,7 @@ Title: Apache(tm) FOP: Known Issues
#Apache™ FOP: Known Issues
-## Known issues {#Known-issues}
+## Known issues { #Known-issues}
This page lists currently known issues in the Apache™ FOP codebase. Please note that this list is generated from data in FOP's code repository (Trunk) and may not exactly represent the list of issues in the latest release.
@@ -16,7 +16,7 @@ For additional information on known issu
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 {#FO-Tree}
+### FO Tree { #FO-Tree}
This section lists currently disabled test cases in the test suite for the FO tree tests. The data for this section comes from [test/fotree/disabled-testcases.xml](http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/test/fotree/disabled-testcases.xml).
@@ -28,7 +28,7 @@ This section lists currently disabled te
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.
-### Layout Engine {#Layout-Engine}
+### Layout Engine { #Layout-Engine}
This section lists currently disabled test cases in the test suite for the layout engine tests. The data for this section comes from [test/layoutengine/disabled-testcases.xml](http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/test/layoutengine/disabled-testcases.xml).
@@ -172,7 +172,7 @@ Test erroneously depends upon incorrect
-### Other known issues {#Other-known-issues}
+### Other known issues { #Other-known-issues}
This section lists other known issues.
Modified: xmlgraphics/site/trunk/content/fop/license.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/license.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/license.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/license.mdtext Thu Jul 24 16:21:20 2014
@@ -3,7 +3,7 @@ Title: Apache(tm) FOP License
#Apache™ FOP License
-## License {#License}
+## License { #License}
All new Apache™ FOP releases will be licensed under the **Apache™ License, version 2.0**. Releases until version 0.20.5 are released under the Apache™ License, version 1.1.
Modified: xmlgraphics/site/trunk/content/fop/maillist.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/maillist.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/maillist.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/maillist.mdtext Thu Jul 24 16:21:20 2014
@@ -4,7 +4,7 @@ Title: Apache(tm) FOP: Mailing List Reso
#Apache™ FOP: Mailing List Resources
-## General Information {#general}
+## General Information { #general}
Before posting questions to any list:
@@ -18,11 +18,11 @@ Before posting questions to any list:
For help in understanding email acronyms, see the [Lingo2Word Acronym List](http://www.lingo2word.com/lists/acronym_listA.html), or the [Keno Internet Services Internet Glossary](http://www.keno.org/web_design/acronyms.htm).
-## Apache™ FOP Users Mailing List {#fop-user}
+## Apache™ FOP Users Mailing List { #fop-user}
Use this forum to discuss topics of interest to FOP users.
-### Archives {#fop-user-archive}
+### Archives { #fop-user-archive}
To review the archives, you have several options:
[nabbleLink]: http://apache-fop.1065347.n5.nabble.com/FOP-Users-f3.html
@@ -42,7 +42,7 @@ To review the archives, you have several
<note>If you don't like mailing lists and prefer a forum-like system, have a look at [GMANE][gmaneLink] or [Nabble][nabbleLink]. They allow you to post to the mailing list without having to subscribe.</note>
-### Subscription Information {#fop-user-subscribe}
+### Subscription Information { #fop-user-subscribe}
- See [Apache XML Graphics Mailing Lists](http://xmlgraphics.apache.org/mail.html) for detailed subscription information.
@@ -56,7 +56,7 @@ To review the archives, you have several
<note>You can find the developer mailing list on the [Development pages](dev/index.html#mail-fop-dev).</note>
-### Submitting a Question {#fop-user-policy}
+### Submitting a Question { #fop-user-policy}
FOP support is primarily *self-service* . The FOP User Mailing List serves as a backup to the self-service documentation for cases where either the documentation is deficient or where users have unusual circumstances. FOP developers and users are happy to help answer questions that are *appropriate to the forum* (i.e. FOP-specific), and that are *submitted after appropriate preparation*. To ensure that your question is not **abusive** of this policy, please use the following checklist:
@@ -90,7 +90,7 @@ FOP support is primarily *self-service*
- Are you attaching large PDF files or screen shots to your message? If so, please consider attaching a minimal, appropriate B&W GIF, JPG or PNG that conveys the necessary information instead. A good alternative is to put the files on a web server.
-## XSL-FO Mailing List (at W3C) {#w3c-xslfo}
+## XSL-FO Mailing List (at W3C) { #w3c-xslfo}
Use this forum to ask general XSL-FO questions.
@@ -101,7 +101,7 @@ Use this forum to ask general XSL-FO que
- Subscription administration information can be found at [W3C Mailing List Administrativia](http://www.w3.org/Mail/Request). After reviewing the instructions there, send your subscribe or unsubscribe request to [www-xsl-fo-request@w3.org](mailto:www-xsl-fo-request@w3.org).
-## XSL-FO Mailing List (at YahooGroups) {#yahoogroups-xslfo}
+## XSL-FO Mailing List (at YahooGroups) { #yahoogroups-xslfo}
Use this forum to ask general XSL-FO questions.
@@ -110,7 +110,7 @@ Use this forum to ask general XSL-FO que
- The home page for this groups is [XSL-FO - discussion of XSL Formatting Objects](http://groups.yahoo.com/group/XSL-FO).
-## XSLT List (Mulberry Tech) {#xslt-mulberry}
+## XSLT List (Mulberry Tech) { #xslt-mulberry}
- Before posting questions to any list, see "[General Information](#general)".
Modified: xmlgraphics/site/trunk/content/fop/news.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/news.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/news.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/news.mdtext Thu Jul 24 16:21:20 2014
@@ -5,121 +5,121 @@ Title: Apache(tm) FOP News
RSS Feed: [](subproject-news-feed.rss)
-## 20 Oct 2012: Apache™ FOP 1.1 Released {#news-2012-10-20}
+## 20 Oct 2012: Apache™ FOP 1.1 Released { #news-2012-10-20}
<item date="2012-10-20" title="Apache™ FOP 1.1 Released">
Apache™ FOP 1.1 contains bug fixes and a number of new features. See [Release Notes](1.1/releaseNotes_1.1.html) for a list of the most important changes.
</item>
-## 12 Oct 2012: New committer {#news-2012-10-12}
+## 12 Oct 2012: New committer { #news-2012-10-12}
<item date="2012-10-12" title="New committer">
Welcome Luis Bernardo!
</item>
-## 07 Jul 2012: Apache™ FOP 1.1-RC1 Available {#news-2012-07-02}
+## 07 Jul 2012: Apache™ FOP 1.1-RC1 Available { #news-2012-07-02}
<item date="2012-07-02" title="Apache™ FOP 1.1-RC1 Available">
This is a candidate release for an upcoming FOP Version 1.1 (stable) release. release of the new FOP codebase. This release contains bug fixes and new features.
</item>
-## 07 Feb 2012: PDF-images plugin donated to ASF {#news-2012-02-07}
+## 07 Feb 2012: PDF-images plugin donated to ASF { #news-2012-02-07}
<item date="2012-02-07" title="PDF-images plugin donated to ASF">
The PDF-images plugin, is donated by Jeremias Märki to ASF and becomes an XMLGraphics sub-project.
</item>
-## 24 Feb 2012: New committer {#news-2012-02-24}
+## 24 Feb 2012: New committer { #news-2012-02-24}
<item date="2012-02-24" title="New committer">
Welcome Glenn Adams!
</item>
-## 17 Nov 2011: New committer {#news-2011-11-17}
+## 17 Nov 2011: New committer { #news-2011-11-17}
<item date="2011-11-17" title="New committer">
Welcome Mehdi Houshmand!
</item>
-## 28 Apr 2011: New committer {#news-2011-04-28}
+## 28 Apr 2011: New committer { #news-2011-04-28}
<item date="2011-04-28" title="New committer">
Welcome Peter Hancock!
</item>
-## 21 Jul 2010: Apache™ FOP 1.0 Released {#news-2010-07-21}
+## 21 Jul 2010: Apache™ FOP 1.0 Released { #news-2010-07-21}
<item date="2010-07-21" title="Apache™ FOP 1.0 Released">
The Apache™ FOP team is delighted to present you a production grade release of the new FOP codebase. This release contains many bug fixes and new features. See the [Release Notes](1.0/releaseNotes_1.0.html) for a list of the most important changes.
</item>
-## 14 Dec 2009: New committer {#news-2009-12-14}
+## 14 Dec 2009: New committer { #news-2009-12-14}
<item date="2009-12-14" title="New committer">
Welcome Pascal Sancho!
</item>
-## 5 Aug 2008: Apache™ FOP 0.95 Released {#news-2008-08-05}
+## 5 Aug 2008: Apache™ FOP 0.95 Released { #news-2008-08-05}
<item date="2008-08-05" title="Apache™ FOP 0.95 Released">
The Apache™ FOP team is delighted to present you a production grade release of the new FOP codebase. This release contains many bug fixes and new features. See the [Release Notes](0.95/releaseNotes_0.95.html) for a list of the most important changes.
</item>
-## 16 Mar 2008: Apache™ FOP 0.95beta Released {#news-2008-03-16}
+## 16 Mar 2008: Apache™ FOP 0.95beta Released { #news-2008-03-16}
<item date="2008-03-16" title="Apache™ FOP 0.95beta Released">
The Apache™ FOP team is delighted to present you a beta version of the next production grade release of the new FOP codebase. This release contains many bug fixes and new features. See the [Release Notes](0.95/releaseNotes_0.95beta.html) for a list of the most important changes.
</item>
-## 30 Oct 2007: New committer {#news-2007-10-30}
+## 30 Oct 2007: New committer { #news-2007-10-30}
<item date="2007-10-30" title="New committer">
Welcome Max Berger!
</item>
-## 15 Oct 2007: New Committer {#news-2007-10-15}
+## 15 Oct 2007: New Committer { #news-2007-10-15}
<item date="2007-10-15" title="New Committer">
Welcome Adrian Cumiskey!
</item>
-## 24 Aug 2007: Apache™ FOP 0.94 Released {#news-2007-08-24}
+## 24 Aug 2007: Apache™ FOP 0.94 Released { #news-2007-08-24}
<item date="2007-08-24" title="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.
</item>
-## 26 Jan 2007: New Committer {#news-2007-01-26}
+## 26 Jan 2007: New Committer { #news-2007-01-26}
<item date="2007-01-26" title="New Committer">
Welcome Jay Bryant!
</item>
-## 9 Jan 2007: Apache™ FOP 0.93 released {#news-2007-01-09}
+## 9 Jan 2007: Apache™ FOP 0.93 released { #news-2007-01-09}
<item date="2007-01-09" title="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.
</item>
-## 16 Oct 2006: New Committer {#news-2006-10-16}
+## 16 Oct 2006: New Committer { #news-2006-10-16}
<item date="2006-10-16" title="New Committer">
Welcome Vincent Hennebert!
</item>
-## 18 Apr 2006: Apache™ FOP 0.92 beta released {#news-2006-04-18}
+## 18 Apr 2006: Apache™ FOP 0.92 beta released { #news-2006-04-18}
<item date="2006-04-18" title="Apache™ FOP 0.92 beta released">
A second "beta" grade release of the new FOP codebase with a modified and now considered stable API. The release contains many bug fixes as well as new features mainly related to even more extensive support of the XSL-FO specification. This is expected to be the last "beta" release before we go to a 1.0 release!
</item>
-## 23 Dec 2005: Apache™ FOP 0.91 beta released {#news-2005-12-23}
+## 23 Dec 2005: Apache™ FOP 0.91 beta released { #news-2005-12-23}
<item date="2005-12-23" title="Apache™ FOP 0.91 beta released">
One month after the initial release we're happy present a "beta" grade release of the new FOP codebase. It's mostly a bug fix release but also contains a few new features. Thanks to all those who sent us feedback on the initial release!
</item>
-## 22 Nov 2005: Apache™ FOP 0.90 alpha 1 released {#news-2005-11-22}
+## 22 Nov 2005: Apache™ FOP 0.90 alpha 1 released { #news-2005-11-22}
<item date="2005-11-22" title="Apache™ FOP 0.90 alpha 1 released">
The Apache™ FOP team is proud to present to you the largely rewritten codebase which is finally in a state where you can start to use it. It has taken over three years to get this far and over two years without a new release from the FOP project.
Please see also the [announcement](http://mail-archives.apache.org/mod_mbox/xmlgraphics-fop-users/200511.mbox/%3c20051123002157.0EB0.JEREMIAS@apache.org%3e).
</item>
-## 8 Sep 2005: New Committer {#news-2005-09-08}
+## 8 Sep 2005: New Committer { #news-2005-09-08}
<item date="2005-09-08" title="New Committer">
Welcome Manuel Mall!
</item>
-## 20 Oct 2004: Creation of the Apache™ XML Graphics project {#news-2004-10-20}
+## 20 Oct 2004: Creation of the Apache™ XML Graphics project { #news-2004-10-20}
<item date="2004-10-20" title="Creation of the Apache™ XML Graphics project">
The Apache Board of Directors agreed to the creation of the [Apache™ XML Graphics](http://xmlgraphics.apache.org) 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 benefits of working more closely together.
</item>
-## 8 Oct 2004: New Committer {#news-2004-10-08}
+## 8 Oct 2004: New Committer { #news-2004-10-08}
<item date="2004-10-08" title="New Committer">
Welcome Luca Furini!
</item>
-## 24 Apr 2004: New Committer {#news-2004-04-24}
+## 24 Apr 2004: New Committer { #news-2004-04-24}
<item date="2004-04-24" title="New Committer">
Welcome Simon Pepping!
</item>
-## 7 Mar 2004: New Committer {#news-2004-03-07}
+## 7 Mar 2004: New Committer { #news-2004-03-07}
<item date="2004-03-07" title="New Committer">
Welcome Web Maestro Clay Leeds!
</item>
-## 10 Jan 2004: New Committers {#news-2004-01-10}
+## 10 Jan 2004: New Committers { #news-2004-01-10}
<item date="2004-01-10" title="New Committers">
Welcome Chris Bowditch and Andreas Delmelle!
</item>
-## 4 Jan 2004: New Committer {#news-2004-01-04}
+## 4 Jan 2004: New Committer { #news-2004-01-04}
<item date="2004-01-04" title="New Committer">
Welcome Finn Bock!
</item>
-## 29 Nov 2003: New Committer {#news-2003-11-29}
+## 29 Nov 2003: New Committer { #news-2003-11-29}
<item date="2003-11-29" title="New Committer">
Welcome Peter Herweg!
</item>
-## 18 Jul 2003: Apache™ FOP 0.20.5 released {#news-2003-07-18}
+## 18 Jul 2003: Apache™ FOP 0.20.5 released { #news-2003-07-18}
<item date="2003-07-18" title="Apache™ FOP 0.20.5 released">
Changes since 0.20.4 include:
@@ -156,43 +156,43 @@ Changes since 0.20.4 include:
See also the full text of the [announcement](http://mail-archives.apache.org/eyebrowse/ReadMsg?listName=fop-dev@xml.apache.org&msgNo=6067).
</item>
-## 29 Jun 2003: New Committer {#news-2003-06-29}
+## 29 Jun 2003: New Committer { #news-2003-06-29}
<item date="2003-06-29" title="New Committer">
Welcome Glen Mazza!
</item>
-## 23 May 2003: Apache™ FOP 0.20.5 Release Candidate 3 available {#news-2003-05-23}
+## 23 May 2003: Apache™ FOP 0.20.5 Release Candidate 3 available { #news-2003-05-23}
<item date="2003-05-23" title="Apache™ FOP 0.20.5 Release Candidate 3 available">
See the full text of the [announcement](http://mail-archives.apache.org/eyebrowse/ReadMsg?listName=fop-dev@xml.apache.org&msgNo=5429).
</item>
-## 18 Feb 2003: Apache™ FOP 0.20.5 Release Candidate 2 available {#news-2003-02-18}
+## 18 Feb 2003: Apache™ FOP 0.20.5 Release Candidate 2 available { #news-2003-02-18}
<item date="2003-02-18" title="Apache™ FOP 0.20.5 Release Candidate 2 available">
See the full text of the [announcement](http://mail-archives.apache.org/eyebrowse/ReadMsg?listName=fop-dev@xml.apache.org&msgNo=4509).
</item>
-## 2 Feb 2003: New XML PMC {#news-2003-02-02}
+## 2 Feb 2003: New XML PMC { #news-2003-02-02}
<item date="2003-02-02" title="New XML PMC">
Jeremias Maerki and Peter B. West are now representing FOP on the XML PMC.
</item>
-## 28 Jan 2003: FOP logo contest {#news-2003-01-28}
+## 28 Jan 2003: FOP logo contest { #news-2003-01-28}
<item date="2003-01-28" title="FOP logo contest">
We are looking for a new logo. FOP logo contest is started!
</item>
-## 23 Dec 2002: Official FOP Wiki {#news-2002-12-23}
+## 23 Dec 2002: Official FOP Wiki { #news-2002-12-23}
<item date="2002-12-23" title="Official FOP Wiki">
See [FOP project pages](http://wiki.apache.org/xmlgraphics-fop/FOPProjectPages) at the ApacheWiki.
</item>
-## 10 Dec 2002: FOP 0.20.5 Release Candidate available {#news-2002-12-10}
+## 10 Dec 2002: FOP 0.20.5 Release Candidate available { #news-2002-12-10}
<item date="2002-12-10" title="FOP 0.20.5 Release Candidate available">
See the full text of the [announcement](http://marc.theaimsgroup.com/?l=fop-user&m=103954279712704&w=2).
</item>
-## 23 Nov 2002: EXLSFO project has been created {#news-2002-11-23}
+## 23 Nov 2002: EXLSFO project has been created { #news-2002-11-23}
<item date="2002-11-23" title="EXLSFO project has been created">
The EXSLFO project is a community effort to define functional extensions to thet XSL Formatting Objects specification. See the [EXSLFO website](http://exslfo.sourceforge.net) for details.
</item>
-## 22 Nov 2002: New Committer {#news-2002-11-22}
+## 22 Nov 2002: New Committer { #news-2002-11-22}
<item date="2002-11-22" title="New Committer">
Welcome Victor Mote!
</item>
-## 9 Nov 2002: New Committer {#news-2002-11-09}
+## 9 Nov 2002: New Committer { #news-2002-11-09}
<item date="2002-11-09" title="New Committer">
Welcome Oleg Tkachenko!
</item>
\ No newline at end of file
Modified: xmlgraphics/site/trunk/content/fop/quickstartguide.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/quickstartguide.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/quickstartguide.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/quickstartguide.mdtext Thu Jul 24 16:21:20 2014
@@ -11,7 +11,7 @@ Title: Apache(tm) FOP: Quick Start Guide
#Apache™ FOP: Quick Start Guide
<subtitle>Everything you need to start using and appreciating Apache™ FOP quickly.</subtitle>
-## Apache™ FOP Essentials {#essentials}
+## Apache™ FOP Essentials { #essentials}
The goal of this **Quick Start Guide** is to help novice users get Apache FOP up and running quickly. Typically, you'll need to:
@@ -43,7 +43,7 @@ Here are some links to help you find out
Once you've familiarized yourself with the basics, you can get more detailed information, in the detailed FOP [product documentation][currentFop_index].
-## Hello World with FOP {#hello-world}
+## Hello World with FOP { #hello-world}
This section walks you through a "Hello World!" page with Apache FOP. We're assuming you download the binary distribution and that you have a Java Runtime Environment (version 1.4 or later) installed.
Modified: xmlgraphics/site/trunk/content/fop/resources.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/resources.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/resources.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/resources.mdtext Thu Jul 24 16:21:20 2014
@@ -3,23 +3,23 @@ Title: Apache(tm) FOP: Other Resources
#Apache™ FOP: Other Resources
<subtitle>Resources useful for developing and using Apache™ FOP</subtitle>
-## Specifications {#specs}
+## Specifications { #specs}
-### XSL-FO {#specs-xslfo}
+### XSL-FO { #specs-xslfo}
- [XSL-FO Recommendation (05 December 2006)](http://www.w3.org/TR/xsl11/)
- [Unofficial DTD for the XSL-FO Recommendation](http://www.renderx.com/Tests/validator/fo.dtd.html) provided by N. Grigoriev from RenderX.
-### XSLT {#specs-xslt}
+### XSLT { #specs-xslt}
- [XSLT 1.0 Recommendation](http://www.w3.org/TR/xslt)
- [XSLT 2.0 Recommendation](http://www.w3.org/TR/xslt20)
-### XML {#specs-xml}
+### XML { #specs-xml}
- [XML 1.0](http://www.w3.org/TR/xml)
@@ -38,7 +38,7 @@ Title: Apache(tm) FOP: Other Resources
- [Namespaces in XML 1.1](http://www.w3.org/TR/xml-names11/)
-### Java {#specs-java}
+### Java { #specs-java}
- [Java 2 Platform, Standard Edition, v 1.4.2 API Specification](http://java.sun.com/j2se/1.4/docs/api/index.html)
@@ -47,24 +47,24 @@ Title: Apache(tm) FOP: Other Resources
- [Java Platform, Standard Edition 6 API Specification](http://java.sun.com/javase/6/docs/api/index.html)
-### PDF {#specs-pdf}
+### PDF { #specs-pdf}
- [Portable Document Format (PDF) Reference Manual](http://partners.adobe.com/asn/tech/pdf/specifications.jsp)
-### Unicode {#specs-unicode}
+### Unicode { #specs-unicode}
- [UTR-14 (Unicode Standard Annex #14: Line Breaking Properties)](http://www.unicode.org/reports/tr14)
-### Other {#specs-other}
+### Other { #specs-other}
- [Supported SVG Recommendation (04 September 2001)](http://www.w3.org/TR/SVG/)
-## Books, Tutorials, Articles {#documents}
+## Books, Tutorials, Articles { #documents}
-### XSL-FO {#documents-xslfo}
+### XSL-FO { #documents-xslfo}
- [online book] [The XML Bible](http://www.ibiblio.org/xml/books/bible2/chapters/ch18.html), by Elliotte Rusty Harold. Chapter 18 of XSL Formatting Objects
@@ -83,7 +83,7 @@ Title: Apache(tm) FOP: Other Resources
- [book] [Practical Formatting Using XSLFO](http://www.cranesoftwrights.com/training/index.htm#pfux), Crane Softwrights Ltd., 2003, ISBN 1-894049-11-X.
-### XSLT {#documents-xslt}
+### XSLT { #documents-xslt}
- [online resource] [Extensible Stylesheet Language Family (XSL)](http://www.w3.org/Style/XSL/), W3C XSL Family page.
@@ -104,7 +104,7 @@ Title: Apache(tm) FOP: Other Resources
- [book] [Java and XSLT](http://www.oreilly.com/catalog/javaxslt), by Eric M. Burke, O'Reilly & Associates, 2001, ISBN 0-596-00143-6.
-### XML {#documents-xml}
+### XML { #documents-xml}
- [online book] [The XML Bible](http://www.ibiblio.org/xml/books/bible2), by Elliotte Rusty Harold. See hardcopy version below.
@@ -113,12 +113,12 @@ Title: Apache(tm) FOP: Other Resources
- [online resource] A great number of additional XML-related books and articles can be found at the [O'Reilly XML Site](http://xml.oreilly.com).
-### Java {#documents-java}
+### Java { #documents-java}
- [online resource] A great number of Java-related books and articles can be found at the [O'Reilly Java Site](http://java.oreilly.com).
-### PDF {#documents-pdf}
+### PDF { #documents-pdf}
- [online resource] Links to the various PDF file format specifications and numerous other documents can be found at Adobe Solutions Network, Acrobat Resources, [Acrobat 5.0 SDK Documentation](http://partners.adobe.com/asn/acrobat/docs.jsp#filefmtspecs).
@@ -127,14 +127,14 @@ Title: Apache(tm) FOP: Other Resources
- [online resource] A list of Acrobat and PDF developer resources can be found at Adobe Solutions Network, Acrobat Resources, [Resources for Developers](http://partners.adobe.com/asn/acrobat).
-### PostScript {#documents-ps}
+### PostScript { #documents-ps}
- [online resource] A list of PostScript-related technical resources can be found at Adobe Solutions Network, [PostScript Language Technical Notes](http://partners.adobe.com/asn/tech/ps/technotes.jsp)
- [online resource] Additional PostScript-related developer resources can be found at Adobe Solutions Network, [PostScript SDK Archive](http://partners.adobe.com/asn/tech/ps/index.jsp).
-## Mailing Lists {#mailing-lists}
+## Mailing Lists { #mailing-lists}
Before posting questions to any list:
@@ -149,7 +149,7 @@ Before posting questions to any list:
For help in understanding email acronyms, see the [Lingo2Word Acronym List](http://www.lingo2word.com/lists/acronym_listA.html), or the [Keno Internet Services Internet Glossary](http://www.keno.org/web_design/acronyms.htm).
-### Apache FOP Mailing List {#Apache-FOP}
+### Apache FOP Mailing List { #Apache-FOP}
- [mailing list info] [http://xml.apache.org/fop/maillist.html](http://xml.apache.org/fop/maillist.html)
@@ -180,26 +180,26 @@ For help in understanding email acronyms
- [fop-dev-unsubscribe] [fop-dev-unsubscribe@xmlgraphics.apache.org](mailto:fop-dev-unsubscribe@xmlgraphics.apache.org)
-### XSL-FO Mailing List (at W3C) {#XSL-FO-at-W3C}
+### XSL-FO Mailing List (at W3C) { #XSL-FO-at-W3C}
- [mailing list info] [http://www.w3.org/Mail/Request](http://www.w3.org/Mail/Request)
- [mailing list archives] [http://lists.w3.org/Archives/Public/www-xsl-fo/](http://lists.w3.org/Archives/Public/www-xsl-fo/)
-### XSL-FO Mailing List (at YahooGroups) {#XSL-FO-at-YahooGroups}
+### XSL-FO Mailing List (at YahooGroups) { #XSL-FO-at-YahooGroups}
- [mailing list info & archives] [http://groups.yahoo.com/group/XSL-FO](http://groups.yahoo.com/group/XSL-FO)
-### XSLT List (Mulberry Tech) {#XSLT-at-Mulberry-Tech}
+### XSLT List (Mulberry Tech) { #XSLT-at-Mulberry-Tech}
- [mailing list info & archives] [http://www.mulberrytech.com/xsl/xsl-list](http://www.mulberrytech.com/xsl/xsl-list)
-## Related/Useful Products {#products}
+## Related/Useful Products { #products}
-### FOP add-ons {#products-fop-add-ons}
+### FOP add-ons { #products-fop-add-ons}
- [software] TIFFRenderer is a renderer for outputting multi-page TIFF: [http://www.tkachenko.com/fop/tiffrenderer.html](http://www.tkachenko.com/fop/tiffrenderer.html) (MPL)
@@ -214,7 +214,7 @@ For help in understanding email acronyms
- [software & tools] [Objects For Formatting Objects](http://offo.sourceforge.net/) hosts hyphenation patterns and (eventually) files other accessory data files & scripts.
-### PDF post-processors {#products-pdf}
+### PDF post-processors { #products-pdf}
- [software] [Apache PDFBox](http://pdfbox.apache.org) (Apache License V2.0)
@@ -225,7 +225,7 @@ For help in understanding email acronyms
- [software] [pdftk](http://www.accesspdf.com/pdftk/) the pdf toolkit
-### XSL-FO editors {#products-editors}
+### XSL-FO editors { #products-editors}
- [software] [FOA (Formatting Objects Authoring)](http://foa.sourceforge.net/) (MPL)
@@ -236,7 +236,7 @@ For help in understanding email acronyms
- [software] [DIGIFORMS Document Designer](http://www.digiforms.com/) by Metafocus (commercial)
-### Other products {#products-other}
+### Other products { #products-other}
- [software] [FOray](http://foray.sourceforge.net/) a renderer for converting XML files to PDF via XSL Formatting Object elements (FOP fork)
Modified: xmlgraphics/site/trunk/content/fop/status.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/status.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/status.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/status.mdtext Thu Jul 24 16:21:20 2014
@@ -3,13 +3,13 @@ Title: Apache(tm) FOP Status
#Apache™ FOP Status
<subtitle>Current Status of Apache™ FOP</subtitle>
-## Status {#Status}
+## Status { #Status}
[last updated 11 December 2012]
Apache™ FOP version 1.1 was released on 20 October 2012.
-## Development Status {#Development-Status}
+## Development Status { #Development-Status}
The FOP code base is gradually evolving, from Version 0.90 released on 22 November 2005, to Version 1.1, released on 20 October 2012. Further releases in the 1.x series and beyond are expected.
@@ -17,7 +17,7 @@ FOP releases before version 0.90 were ba
If you're looking for a long-term road-map we have to disappoint you. This is Open Source and we're mostly volunteers working in their free time. What we have is an idea where we want to go. How fast we get there depends on the available time, on how well our ideas work out while developing and on you! There's a [document in the Wiki](http://wiki.apache.org/xmlgraphics-fop/RoadMap) where ideas for new developments may be registered and documented.
-### Status of the individual components {#component-status}
+### Status of the individual components { #component-status}
Not all the components of FOP currently have the same quality. The following table tries to give you an overview:
Modified: xmlgraphics/site/trunk/content/fop/team.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/team.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/team.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/team.mdtext Thu Jul 24 16:21:20 2014
@@ -4,7 +4,7 @@ Title: Apache(tm) FOP: Development Team
All lists on this page are in alphabetical order. Some of them may be incomplete. If you know of an error or omission, please send a message to the [fop-dev](mailto:fop-dev@xmlgraphics.apache.org) mailing list.
-## Active Committers {#commit-active}
+## Active Committers { #commit-active}
<note>Please don't write to any developer directly if you need help on using FOP. Only if you submit questions to the [FOP User Mailing List](maillist.html#fop-user) will other FOP users be able to profit from answers given to your question. Another point is that a developer may have gone inactive or is on holidays in which case you may not get an answer in time.</note>
@@ -34,7 +34,7 @@ All lists on this page are in alphabetic
- [Pascal Sancho](mailto:tcho@club-internet.fr) (PS) is an XML developper from Aix-en-Provence (France). He works on software solutions for rendering various kind of documents on various supports, more specifically taking care of PDF generation with FOP.
-## Active Contributors {#contribute-active}
+## Active Contributors { #contribute-active}
- Georg Datterl is a software developer from Austria, currently working for Geneon media solutions gmbh in Nuremberg, Germany. He needs FOP to wrestle gigabytes of electronic data into thousands of printed pages.
@@ -46,11 +46,11 @@ All lists on this page are in alphabetic
- Simon Steiner is a Python/Java developer from England.
-## Founder {#founder}
+## Founder { #founder}
FOP was originally created and donated to the Apache Software Foundation by [James Tauber](mailto:jtauber@jtauber.com). Information about him can be found at [his website](http://www.jtauber.com).
-## Inactive Committers {#commit-inactive}
+## Inactive Committers { #commit-inactive}
- [Max Berger](mailto:max AT berger DOT name) (MB)
Modified: xmlgraphics/site/trunk/content/fop/trunk/accessibility.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/trunk/accessibility.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/trunk/accessibility.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/trunk/accessibility.mdtext Thu Jul 24 16:21:20 2014
@@ -2,13 +2,13 @@ Title: Apache(tm) FOP: Accessibility
#Apache™ FOP: Accessibility
-## Overview {#overview}
+## Overview { #overview}
This page describes the [accessibility](http://en.wikipedia.org/wiki/Accessibility) features of Apache™ FOP. [Section 508](http://www.section508.gov/) defines accessibility in the context of electronic documents for the USA but other countries have similar requirements.
Accessibility features are available only for the PDF output format and there are some implementation limitations. Also, certain actions must be undertaken by the content creator to ensure that FOP can create a truly accessible document.
-## Enabling accessibility {#Enabling-accessibility}
+## Enabling accessibility { #Enabling-accessibility}
There are 3 ways to enable accessibility:
@@ -34,7 +34,7 @@ When accessibility is enabled, additiona
<note>The processing of the logical structure is memory-hungry. You may need to adjust the Java heap size in order to process larger files.</note>
-## Changes to your XSL-FO input files {#source}
+## Changes to your XSL-FO input files { #source}
Apache FOP cannot automatically generate accessible PDFs. Some of the work can only be performed by the content provider. Following are some changes that may be necessary to your XSL-FO content in order to generate really accessible documents:
@@ -47,7 +47,7 @@ Apache FOP cannot automatically generate
- Specify the natural language of the document using the language and country properties (or via the `xml:lang` shorthand property).
-## Customized Tagging {#customTags}
+## Customized Tagging { #customTags}
The [PDF Reference](#PDFReference) defines a set of standard Structure Types to tag content. For example, âPâ is used for identifying paragraphs, âH1â to âH6â for headers, âLâ for lists, âDivâ for block-level groups of elements, etc. This standard set is aimed at improving interoperability between applications producing or consuming PDF.
@@ -78,7 +78,7 @@ This special value for the `role` proper
<fo:block>Page <fo:page-number/></fo:block>
</fo:static-content>
-## Scope of Header Table Cells {#fox:header}
+## Scope of Header Table Cells { #fox:header}
In XSL-FO, tables are inherently defined row by row. The `fo:table-header` element can be used to define âheader rowsâ, in which each cell is a header of the corresponding column (like `TH` cells in HTML). The cell is said to have a column *scope*.
@@ -165,11 +165,11 @@ Header Scope = Both | Header Scope =
**Header Scope = Row** | Cell 2.1 | Cell 2.2
Non-header | Cell 3.1 | Cell 3.2
-## Testing {#testing}
+## Testing { #testing}
Accessible PDFs can be tested, for example, using Adobe Acrobat Professional. Its Accessibility Check feature creates a report indicating any deficiencies with a PDF document. Alternatively, you can just let a screen reader read the document aloud.
-## Limitations {#limitations}
+## Limitations { #limitations}
Accessibility support in Apache FOP is relatively new, so there are certain limitations. Please help us identify and close any gaps.
@@ -182,7 +182,7 @@ Accessibility support in Apache FOP is r
- The side regions (region-before, region-after etc.) are currently not specially identified. Screen readers may read their content at page changes.
-## Related Links {#links}
+## Related Links { #links}
Many resources providing guidance about creating accessible documents can be found on the web. Here are a few links, along with additional resources around the topic:
Modified: xmlgraphics/site/trunk/content/fop/trunk/anttask.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/trunk/anttask.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/trunk/anttask.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/trunk/anttask.mdtext Thu Jul 24 16:21:20 2014
@@ -5,7 +5,7 @@ Title: Apache(tm) FOP: Ant task
Apache™ FOP provides an Ant task for automating the document build process.
-## Description {#basics}
+## Description { #basics}
The FOP Ant task will convert XSL-FO documents to PDF, PS, PCL etc. output (see [Output formats](output.html) for available formats).
@@ -29,7 +29,7 @@ To call FOP tasks within Ant, first add
Then create FOP tasks within your Ant build file, using the FOP task parameters listed below.
-## Parameters for FOP Ant task {#parameters}
+## Parameters for FOP Ant task { #parameters}
<caption>Parameters specified as attributes</caption>
@@ -55,7 +55,7 @@ Then create FOP tasks within your Ant bu
|-----------|-------------|----------|
| fileset | [FileSets](http://ant.apache.org/manual/CoreTypes/fileset.html) are used to specify multiple XSL-FO files to be rendered. | Yes, if no fofile attribute is supplied |
-## Examples {#examples}
+## Examples { #examples}
The following example converts a single XSL-FO file to a PDF document:
Modified: xmlgraphics/site/trunk/content/fop/trunk/compiling.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/trunk/compiling.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/trunk/compiling.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/trunk/compiling.mdtext Thu Jul 24 16:21:20 2014
@@ -3,29 +3,29 @@ Title: Apache(tm) FOP: Building from Sou
#Apache™ FOP: Building from Source Code
-## Do You Need To Build? {#build-needed}
+## Do You Need To Build? { #build-needed}
Apache™ FOP snapshots are either pre-compiled binary or source. If you are using a binary snapshot, it is already built and there is no need to build it again. If you got the source code from a repository snapshot or via Subversion you will need to build FOP. See the [Download Instructions](../download.html) for information about where to obtain binary or repository snapshots, and whether a binary or source snapshot is best for your needs.
-## Set Up Your Environment {#env}
+## Set Up Your Environment { #env}
-### JDK {#env-jdk}
+### JDK { #env-jdk}
Building FOP requires a minimum Java Development Kit (JDK/SDK) of 1.5 (A Java Runtime Environment is not sufficient).
-### CLASSPATH {#env-classpath}
+### CLASSPATH { #env-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 {#env-java-home}
+### JAVA_HOME { #env-java-home}
The build script uses [Apache Ant](http://ant.apache.org/), 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.5 or above, which normally does not need this setting.
-### Apache Ant {#env-ant}
+### Apache Ant { #env-ant}
[Apache Ant](http://ant.apache.org/) (Version 1.7 or later) 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](http://ant.apache.org/manual/) on the web.
-## Run the Build Script {#build-script}
+## Run the Build Script { #build-script}
Change to the FOP root directory and build FOP by executing the build script (build.xml) using the "ant" command.
@@ -61,7 +61,7 @@ To clean the build directory first:
<note>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.</note>
-## Troubleshooting {#problems}
+## Troubleshooting { #problems}
If you have problems building FOP, please try the following:
Modified: xmlgraphics/site/trunk/content/fop/trunk/complexscripts.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/trunk/complexscripts.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/trunk/complexscripts.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/trunk/complexscripts.mdtext Thu Jul 24 16:21:20 2014
@@ -3,7 +3,7 @@ Title: Apache(tm) FOP: Complex Scripts
#Apache™ FOP: Complex Scripts
-## Overview {#overview}
+## Overview { #overview}
This page describes the [complex scripts](http://en.wikipedia.org/wiki/Complex_scripts) features of Apache™ FOP, which include:
@@ -16,7 +16,7 @@ This page describes the [complex scripts
- Support for advanced number to string formatting.
-## Disabling complex scripts {#Disabling-complex-scripts}
+## Disabling complex scripts { #Disabling-complex-scripts}
Complex script features are enabled by default. If some application of FOP does not require this support, then it can be disabled in three ways:
@@ -43,7 +43,7 @@ When complex scripts features are enable
<note>A document author need not make explicit use of any complex scripts feature in order for this additional information to be created. For example, if the author makes use of a font that contains OpenType GSUB and/or GPOS tables, then those tables will be automatically used unless complex scripts features are disabled.</note>
-## Changes to your XSL-FO input files {#source}
+## Changes to your XSL-FO input files { #source}
In most circumstances, XSL-FO content does not need to change in order to make use of complex scripts features; however, in certain contexts, fully automatic processing is not sufficient. In these cases, an author may make use of the following XSL-FO constructs:
@@ -62,11 +62,11 @@ In most circumstances, XSL-FO content do
- Explicit join control characters: U+200C ZWNJ and U+200D ZWJ.
-## Authoring Details {#details}
+## Authoring Details { #details}
The complex scripts related effects of the above enumerated XSL-FO constructs are more fully described in the following sub-sections.
-### Script Property {#script_property}
+### Script Property { #script_property}
In order to apply font specific complex script features, it is necessary to know the script that applies to the text undergoing layout processing. This script is determined using the following algorithm:
@@ -77,7 +77,7 @@ In order to apply font specific complex
In case the automatic algorithm does not produce the desired results, an author may explicitly specify a `script` property with the desired script. If specified, it must be one of the four-letter script code specified in [ISO 15924 Code List](http://unicode.org/iso15924/iso15924-codes.html) or in the [Extended Script Codes](#extended_script_codes) table. Comparison of script codes is performed in a case-insensitive manner, so it does not matter what case is used when specifying these codes in an XSL-FO document.
-#### Standard Script Codes {#standard_script_codes}
+#### Standard Script Codes { #standard_script_codes}
The following table enumerates the standard ISO 15924 4-letter codes recognized by FOP.
@@ -116,7 +116,7 @@ The following table enumerates the stand
| `zyyy` | Undetermined |
| `zzzz` | Uncoded |
-#### Extended Script Codes {#extended_script_codes}
+#### Extended Script Codes { #extended_script_codes}
The following table enumerates a number of non-standard extended script codes recognized by FOP.
@@ -136,13 +136,13 @@ The following table enumerates a number
<note>When performing automatic script determination, FOP selects the OpenType Indic Version 2 script codes by default. If the author requires Version 1 behavior, then an explicit, non-extension script code should be specified in a governing `script` property.</note>
-### Language Property {#language_property}
+### Language Property { #language_property}
Certain fonts that support complex script features can make use of language information in order for language specific processing rules to be applied. For example, a font designed for the Arabic script may support typographic variations according to whether the written language is Arabic, Farsi (Persian), Sindhi, Urdu, or another language written with the Arabic script. In order to apply these language specific features, the author may explicitly mark the text with a [http://www.w3.org/TR/2006/REC-xsl11-20061205/#language](http://www.w3.org/TR/2006/REC-xsl11-20061205/#language) property.
When specifying the `language` property, the value of the property must be either an [ISO639-2 3-letter code](http://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) or an [ISO639-1 2-letter code](http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). Comparison of language codes is performed in a case-insensitive manner, so it does not matter what case is used when specifying these codes in an XSL-FO document.
-### Writing Mode Property {#writing_mode_property}
+### Writing Mode Property { #writing_mode_property}
The `writing-mode` property is used to determine the axes and direction of the inline progression direction, the block progression direction, the column progression direction (in tables and flows), the shift direction, region placement, the resolution of writing-mode relative property values (such as start, end, before, after), and the default block (paragraph) bidirectionality level.
@@ -176,13 +176,13 @@ At present, only the following values of
Writing modes that employ a vertical inline progression direction are not yet supported.
-### Number Conversion Properties {#number_conversion_properties}
+### Number Conversion Properties { #number_conversion_properties}
-### Bidi Override Element {#bidi_override_element}
+### Bidi Override Element { #bidi_override_element}
The [fo:bidi-override](http://www.w3.org/TR/2006/REC-xsl11-20061205/#fo_bidi-override) element may be used to override default bidirectional processing behavior, including default embedding levels and default character directionality. In the absence of either this element or use of explicit [Bidi Control Characters](#bidi_controls), the default behavior prescribed by the [Unicode Bidirectional Algorithm](http://www.w3.org/TR/2006/REC-xsl11-20061205/#fo_bidi-override) applies.
-### Bidi Control Characters {#bidi_controls}
+### Bidi Control Characters { #bidi_controls}
In addition to the use of the [Bidi Override Element](#bidi_override_element), an author may make use of the following explicit Unicode Bidi Control Characters:
@@ -203,7 +203,7 @@ In addition to the use of the [Bidi Over
If an embedding or override is not terminated (using U+202C PDF) prior to the end of a [delimited text range](http://www.w3.org/TR/2006/REC-xsl11-20061205/#d0e4879), then it is automatically terminated by FOP.
-### Join Control Characters {#join_controls}
+### Join Control Characters { #join_controls}
In order to prevent joining behavior in contexts where joining occurs by default, for example, between U+0628 ARABIC LETTER BEH and U+0646 ARABIC LETTER NOON, an author may used a U+200C ZERO WIDTH NON-JOINER (ZWNJ).
@@ -211,7 +211,7 @@ Conversely, in order to force joining be
The behavior of ZWNJ and ZWJ is script specific. See [The Unicode Standard, Chapter 8, Middle Eastern Scripts](http://www.unicode.org/versions/Unicode6.1.0/ch08.pdf) for information on the use of these control characters with the Arabic script. See [The Unicode Standard, Chapter 9, South Asian Scripts - I](http://www.unicode.org/versions/Unicode6.1.0/ch09.pdf) for information on the use of these control characters with common Indic scripts.
-## Supported Scripts {#supported_scripts}
+## Supported Scripts { #supported_scripts}
Support for specific complex scripts is enumerated in the following table. Support for those marked as not being supported is expected to be added in future revisions.
@@ -235,11 +235,11 @@ Support for specific complex scripts is
| [Tibetan](http://en.wikipedia.org/wiki/Tibetan_alphabet) | none | none | |
| [Thai](http://en.wikipedia.org/wiki/Thai_alphabet) | none | none | |
-## Supported Fonts {#supported_fonts}
+## Supported Fonts { #supported_fonts}
Support for specific fonts is enumerated in the following sub-sections. If a given font is not listed, then it has not been tested with these complex scripts features.
-### Arabic Fonts {#fonts_arabic}
+### Arabic Fonts { #fonts_arabic}
| Font | Version | Glyphs | Comments |
|------|---------|--------|----------|
@@ -253,7 +253,7 @@ Support for specific fonts is enumerated
| [Traditional Arabic](http://www.microsoft.com/typography/fonts/font.aspx?FID=264) | [5.00](http://www.microsoft.com/typography/fonts/font.aspx?FMID=1658) | 530 | lacks GPOS support |
| [Traditional Arabic](http://www.microsoft.com/typography/fonts/font.aspx?FID=264) | 5.92 | 589 | includes GPOS for advanced position adjustment |
-### Devanagari Fonts {#devanagari_fonts}
+### Devanagari Fonts { #devanagari_fonts}
| Font | Version | Glyphs | Comments |
|------|---------|--------|----------|
@@ -262,7 +262,7 @@ Support for specific fonts is enumerated
| [Mangal](http://www.microsoft.com/typography/fonts/family.aspx?FID=243) | [5.01](http://www.microsoft.com/typography/fonts/font.aspx?FMID=1759) | 885 | designed for use in user interfaces |
| [Utsaah](http://www.microsoft.com/typography/fonts/family.aspx?FID=384) | [1.00](http://www.microsoft.com/typography/fonts/font.aspx?FMID=1811) | 706 | |
-## Other Limitations {#limitations}
+## Other Limitations { #limitations}
Complex scripts support in Apache FOP is relatively new, so there are certain limitations. Please help us identify and close any gaps.
@@ -271,7 +271,7 @@ Complex scripts support in Apache FOP is
- Shaping context does not extend across an element boundary. This limitation prevents the use of `fo:character`, `fo:inline` or `fo:wrapper` in order to colorize individual Arabic letters without affecting shaping behavior across the element boundary.
-## Related Links {#links}
+## Related Links { #links}
In addition to the XSL-FO specification, a number of external resources provide guidance about authoring documents that employ complex scripts and the features described above:
Modified: xmlgraphics/site/trunk/content/fop/trunk/configuration.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/trunk/configuration.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/trunk/configuration.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/trunk/configuration.mdtext Thu Jul 24 16:21:20 2014
@@ -3,13 +3,13 @@ Title: Apache(tm) FOP: Configuration
#Apache™ FOP: Configuration
-## Configuration File Basics {#general}
+## Configuration File Basics { #general}
The Apache™ 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 {#general-available}
+### Making Configuration Available to FOP { #general-available}
After creating your configuration file, you must tell FOP how to find it:
@@ -20,7 +20,7 @@ After creating your configuration file,
See [Setting the Configuration Programmatically](embedding.html#config-internal) for instructions on how to do so in an embedded environment.
-## Summary of the General Configuration Options {#general-elements}
+## Summary of the General Configuration Options { #general-elements}
| Element | Data Type (for the value) | Description | Default Value |
|---------|---------------------------|-------------|---------------|
@@ -74,7 +74,7 @@ This is an excerpt from the example conf
<!-- etc. etc..... -->
</fop>
-## Image Loading Customization {#image-loading}
+## Image Loading Customization { #image-loading}
Apache FOP uses the image loading framework from [Apache XML Graphics Commons](http://xmlgraphics.apache.org/commons/) to load images using various plug-ins. Every image loader plug-in has a hard-coded usage penalty that influences which solution is chosen if there are multiple possibilities to load an image. Sometimes, though, these penalties need to be tweaked and this can be done in the FOP configuration. An example:
@@ -112,7 +112,7 @@ The ImageLoaderPNG and ImageLoaderRawPNG
<renderers....
</fop>
-## Renderer configuration {#renderers}
+## Renderer configuration { #renderers}
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.
@@ -142,7 +142,7 @@ The configuration for the PDF Renderer c
The details on the font configuration can be found on the separate [Fonts](fonts.html) page. Note especially the section entitled [Register Fonts with FOP](fonts.html#register).
-### Special Settings for the PDF Renderer {#pdf-renderer}
+### Special Settings for the PDF Renderer { #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.
@@ -208,7 +208,7 @@ By default FOP produces PDF files of ver
<!-- Versions 1.4, 1.5, 1.6 and 1.7 are accepted, all other values are invalid -->
</renderer>
-### Special Settings for the PostScript Renderer {#ps-renderer}
+### Special Settings for the PostScript Renderer { #ps-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:
@@ -228,7 +228,7 @@ Besides the normal font configuration (t
</fonts>
</renderer>
-### Special Settings for the PCL Renderer {#pcl-renderer}
+### Special Settings for the PCL Renderer { #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.
@@ -244,7 +244,7 @@ The default value for the "rendering" se
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.
-### Special Settings for the AFP Renderer {#afp-renderer}
+### Special Settings for the AFP Renderer { #afp-renderer}
@@ -268,7 +268,7 @@ The default line width is device depende
By default if there is no configuration definition for "resource-group-file", external resources will be placed in a file called resources.afp.
-## When it does not work {#When-it-does-not-work}
+## When it does not work { #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.
Modified: xmlgraphics/site/trunk/content/fop/trunk/embedding.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/trunk/embedding.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/trunk/embedding.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/trunk/embedding.mdtext Thu Jul 24 16:21:20 2014
@@ -3,13 +3,13 @@ Title: Apache(tm) FOP: Embedding
#Apache™ FOP: Embedding
<subtitle>How to Embed FOP in a Java application</subtitle>
-## Overview {#overview}
+## Overview { #overview}
Review [Running Apache™ FOP](running.html) 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. MIME type) to use and, if the selected output format 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 document handler instance (details below). Finally, you retrieve a SAX DefaultHandler instance from the Fop object and use that as the SAXResult of your transformation.
-## The API {#API}
+## The API { #API}
FOP has many classes which express the "public" access modifier, however, this is not indicative of their inclusion into the public API. Every attempt will be made to keep the public API static, to minimize regressions for existing users, however, since the API is not clearly defined, the list of classes below are the generally agreed public API:
@@ -30,7 +30,7 @@ FOP has many classes which express the "
- org.apache.fop.render.intermediate.IFUtil
- org.apache.fop.render.intermediate.util.IFConcatenator
-## Basic Usage Pattern {#basics}
+## Basic Usage Pattern { #basics}
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...
@@ -95,7 +95,7 @@ If you're not totally familiar with JAXP
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](#examples) (See "ExampleXML2FO").
-### Logging {#basic-logging}
+### Logging { #basic-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](http://commons.apache.org/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.
@@ -110,11 +110,11 @@ As a result of the above we differentiat
The use of "feedback" instead of "logging" is intentional. Most people were using log output as a means to get feedback from events within FOP. Therefore, FOP now includes an `event` package which can be used to receive feedback from the layout engine and other components within FOP **per rendering run**. This feedback is not just some text but event objects with parameters so these events can be interpreted by code. Of course, there is a facility to turn these events into normal human-readable messages. For details, please read on on the [Events page](events.html). This leaves normal logging to be mostly a thing used by the FOP developers although anyone can surely activate certain logging categories but the feedback from the loggers won't be separated by processing runs. If this is required, the [Events subsystem](events.html) is the right approach.
-### Processing XSL-FO {#render}
+### Processing XSL-FO { #render}
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 {#render-with-xslt}
+### Processing XSL-FO generated from XML+XSLT { #render-with-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:
@@ -126,7 +126,7 @@ If you want to process XSL-FO generated
Source xslt = new StreamSource(new File("mystylesheet.xsl"));
Transformer transformer = factory.newTransformer(xslt);
-## Input Sources {#input}
+## Input Sources { #input}
The input XSL-FO document is always received by FOP as a SAX stream (see the [Parsing Design Document](../dev/design/parsing.html) for the rationale).
@@ -167,11 +167,11 @@ However, you may not always have your in
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](http://xml.apache.org/xalan-j/usagepatterns.html).
-## Configuring Apache FOP Programmatically {#config-internal}
+## Configuring Apache FOP Programmatically { #config-internal}
Apache FOP provides two levels on which you can customize FOP's behaviour: the FopFactory and the user agent.
-### Customizing the FopFactory {#fop-factory}
+### Customizing the FopFactory { #fop-factory}
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.
@@ -213,7 +213,7 @@ Finally, there are several options which
:::java
fopFactory.addElementMapping(myElementMapping); // myElementMapping is a org.apache.fop.fo.ElementMapping
-### Customizing the User Agent {#user-agent}
+### Customizing the User Agent { #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:
@@ -273,7 +273,7 @@ You can do all sorts of things on the us
<note>You should not reuse an FOUserAgent instance between FOP rendering runs although you can. Especially in multi-threaded environment, this is a bad idea.</note>
-## Using a Configuration File {#config-external}
+## Using a Configuration File { #config-external}
Instead of setting the parameters manually in code as shown above you can also set many values from an XML configuration file:
@@ -289,7 +289,7 @@ Instead of setting the parameters manual
The layout of the configuration file is described on the [Configuration page](configuration.html).
-## Document Handlers {#documenthandlers}
+## Document Handlers { #documenthandlers}
The document handlers are classes that inherit from `org.apache.fop.render.intermediate.IFDocumentHandler`. This is an interface for which a MIME type specific implementation can be created. This same handler is used either when XSL-FO is used as the input or when Intermediate Format is used. Since IF is output format agnostic, if custom fonts or other configuration information that affect layout (specific to a particular MIME type) are given then FOP needs that contextual information. The document handler provides that context so that when the IF is rendered, it is more visually consistent with FO rendering. The code below shows an example of how a document handler can be used to provide PDF configuration data to the IFSerializer.
@@ -303,13 +303,13 @@ The document handlers are classes that i
The rest of the code is the same as in [Basic Usage Patterns](#basics).
-## Hints {#hints}
+## Hints { #hints}
-### Object reuse {#object-reuse}
+### Object reuse { #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 {#awt}
+### AWT issues { #awt}
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.
@@ -317,11 +317,11 @@ The thread means that the Java applicati
If you run into trouble running FOP on a head-less server, please see the [notes on Batik](graphics.html#batik).
-### Getting information on the rendering process {#render-info}
+### Getting information on the rendering process { #render-info}
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 {#performance}
+## Improving performance { #performance}
There are several options to consider:
@@ -342,29 +342,29 @@ There are several options to consider:
- You may also wish to consider trying to reduce [memory usage](http://xmlgraphics.apache.org/fop/trunk/running.html#memory).
-## Multithreading FOP {#multithreading}
+## Multithreading FOP { #multithreading}
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 {#examples}
+## Examples { #examples}
The directory "{fop-dir}/examples/embedding" contains several working examples.
-### ExampleFO2PDF.java {#ExampleFO2PDF}
+### ExampleFO2PDF.java { #ExampleFO2PDF}
This [example](http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleFO2PDF.java?view=markup) demonstrates the basic usage pattern to transform an XSL-FO file to PDF using FOP.
-### ExampleXML2FO.java {#ExampleXML2FO}
+### ExampleXML2FO.java { #ExampleXML2FO}
This [example](http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleXML2FO.java?view=markup) 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](http://xml.apache.org/xalan-j)).
-### ExampleXML2PDF.java {#ExampleXML2PDF}
+### ExampleXML2PDF.java { #ExampleXML2PDF}
This [example](http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleXML2PDF.java?view=markup) 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.
@@ -372,7 +372,7 @@ This [example](http://svn.apache.org/vie
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 {#ExampleObj2XML}
+### ExampleObj2XML.java { #ExampleObj2XML}
This [example](http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleObj2XML.java?view=markup) 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.
@@ -384,24 +384,24 @@ The XMLReader implementation (regard it
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](http://java.sun.com/xml/jaxp/dist/1.1/docs/tutorial/xslt/3_generate.html)).
-### ExampleObj2PDF.java {#ExampleObj2PDF}
+### ExampleObj2PDF.java { #ExampleObj2PDF}
This [example](http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleObj2PDF.java?view=markup) 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 {#ExampleDOM2PDF}
+### ExampleDOM2PDF.java { #ExampleDOM2PDF}
This [example](http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleDOM2PDF.java?view=markup) 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) {#ExampleSVG2PDF}
+### ExampleSVG2PDF.java (PDF Transcoder example) { #ExampleSVG2PDF}
This [example](http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleSVG2PDF.java?view=markup) shows the usage of the PDF Transcoder, a sub-application within FOP. It is used to generate a PDF document from an SVG file.
-### ExampleConcat.java (IF Concatenation example) {#ExampleConcat}
+### ExampleConcat.java (IF Concatenation example) { #ExampleConcat}
This can be found in the `embedding.intermediate` package within the examples and describes how IF can be concatenated to produce a document. Because IF has been through FOPs layout engine, it should be visually consistent with FO rendered documents while allowing the user to merge numerous documents together.
-### Final notes {#example-notes}
+### Final notes { #example-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.
Modified: xmlgraphics/site/trunk/content/fop/trunk/events.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/trunk/events.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/trunk/events.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/trunk/events.mdtext Thu Jul 24 16:21:20 2014
@@ -3,7 +3,7 @@ Title: Apache(tm) FOP: Events/Processing
#Apache™ FOP: Events/Processing Feedback
-## Introduction {#introduction}
+## Introduction { #introduction}
In versions until 0.20.5, Apache™ FOP used [Avalon-style Logging](http://excalibur.apache.org/framework/index.html) where it was possible to supply a logger per processing run. During the redesign the logging infrastructure was switched over to [Commons Logging](http://commons.apache.org/logging/) which is (like Log4J or java.util.logging) a "static" logging framework (the logger is accessed through static variables). This made it very difficult in a multi-threaded system to retrieve information for a single processing run.
@@ -11,7 +11,7 @@ With FOP's event subsystem, we'd like to
On this page, we won't discuss logging as such. We will show how the event subsystem can be used for various tasks. We'll first look at the event subsystem from the consumer side. Finally, the production of events inside FOP will be discussed (this is mostly interesting for FOP developers only).
-## The consumer side {#consumer}
+## The consumer side { #consumer}
The event subsystem is located in the `org.apache.fop.events` package and its base is the `Event` class. An instance is created for each event and is sent to a set of `EventListener` instances by the `EventBroadcaster`. An `Event` contains:
@@ -28,7 +28,7 @@ The `EventFormatter` class can be used t
A full example of what is shown here can be found in the `examples/embedding/java/embedding/events` directory in the FOP distribution. The example can also be accessed [via the web](http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/examples/embedding/java/embedding/events/).
-### Writing an EventListener {#write-listener}
+### Writing an EventListener { #write-listener}
The following code sample shows a very simple EventListener. It basically just sends all events to System.out (stdout) or System.err (stderr) depending on the event severity.
@@ -65,7 +65,7 @@ The code above also shows how you can tu
It is possible to gather all events for a whole processing run so they can be evaluated afterwards. However, care should be taken about memory consumption since the events provide references to objects inside FOP which may themselves have references to other objects. So holding on to these objects may mean that whole object trees cannot be released!
-### Adding an EventListener {#add-listener}
+### Adding an EventListener { #add-listener}
To register the event listener with FOP, get the `EventBroadcaster` which is associated with the user agent (`FOUserAgent`) and add it there:
@@ -75,7 +75,7 @@ To register the event listener with FOP,
Please note that this is done separately for each processing run, i.e. for each new user agent.
-### An additional listener example {#listener-example1}
+### An additional listener example { #listener-example1}
Here's an additional example of an event listener:
@@ -119,13 +119,13 @@ You can also customize the exception to
This throws a `RuntimeException` with the `FileNotFoundException` as the cause. Further processing effectively stops in FOP. You can catch the exception in your code and react as you see necessary.
-## The producer side (for FOP developers) {#producer}
+## The producer side (for FOP developers) { #producer}
This section is primarily for FOP and FOP plug-in developers. It describes how to use the event subsystem for producing events.
<note>The event package has been designed in order to be theoretically useful for use cases outside FOP. If you think this is interesting independently from FOP, please talk to [us](mailto:fop-dev@xmlgraphics.apache.org).</note>
-### Producing and sending an event {#basic-event-production}
+### Producing and sending an event { #basic-event-production}
The basics are very simple. Just instantiate an `Event` object and fill it with the necessary parameters. Then pass it to the `EventBroadcaster` which distributes the events to the interested listeneners. Here's a code example:
@@ -140,7 +140,7 @@ The basics are very simple. Just instant
The `Event.paramsBuilder()` is a [fluent interface](http://en.wikipedia.org/wiki/Fluent_interface) to help with the build-up of the parameters. You could just as well instantiate a `Map` (`Map<String, Object>`) and fill it with values.
-### The EventProducer interface {#event-producer}
+### The EventProducer interface { #event-producer}
To simplify event production, the event subsystem provides the `EventProducer` interface. You can create interfaces which extend `EventProducer`. These interfaces will contain one method per event to be generated. By contract, each event method must have as its first parameter a parameter named "source" (Type Object) which indicates the object that generated the event. After that come an arbitrary number of parameters of any type as needed by the event.
@@ -178,7 +178,7 @@ To produce the same event as in the firs
TestEventProducer producer = TestEventProducer.Provider.get(broadcaster);
producer.complain(this, "I'm tired", 23);
-### The event model {#event-model}
+### The event model { #event-model}
Inside an invocation handler for a dynamic proxy, there's no information about the names of each parameter. The JVM doesn't provide it. The only thing you know is the interface and method name. In order to properly fill the `Event` 's parameter map we need to know the parameter names. These are retrieved from an event object model. This is found in the `org.apache.fop.events.model` package. The data for the object model is retrieved from an XML representation of the event model that is loaded as a resource. The XML representation is generated using an Ant task at build time (`ant resourcegen`). The Ant task (found in `src/codegen/java/org/apache/fop/tools/EventProducerCollectorTask.java`) scans FOP's sources for descendants of the `EventProducer` interface and uses [QDox](http://qdox.codehaus.org/) to parse these interfaces.
@@ -190,7 +190,7 @@ There's one more information that is ext
For a given application, there can be multiple event models active at the same time. In FOP, each renderer is considered to be a plug-in and provides its own specific event model. The individual event models are provided through an `EventModelFactory`. This interface is implemented for each event model and registered through the service provider mechanism (see the [plug-ins section](#plug-ins) for details).
-### Event severity {#event-severity}
+### Event severity { #event-severity}
Four different levels of severity for events has been defined:
@@ -205,7 +205,7 @@ Four different levels of severity for ev
Event listeners can choose to ignore certain events based on their event severity. Please note that you may recieve an event "twice" in a specific case: if there is a fatal error an event is generated and sent to the listeners. After that an exception is thrown with the same information and processing stops. If the fatal event is shown to the user and the following exception is equally presented to the user it may appear that the event is duplicated. Of course, the same information is just published through two different channels.
-### Plug-ins to the event subsystem {#plug-ins}
+### Plug-ins to the event subsystem { #plug-ins}
The event subsystem is extensible. There are a number of extension points:
@@ -216,7 +216,7 @@ The event subsystem is extensible. There
The names in bold above are used as filenames for the service provider files that are placed in the `META-INF/services` directory. That way, they are automatically detected. This is a mechanism defined by the [JAR file specification](http://java.sun.com/j2se/1.4.2/docs/guide/jar/jar.html#Service%20Provider).
-### Localization (L10n) {#l10n}
+### Localization (L10n) { #l10n}
One goal of the event subsystem was to have localized (translated) event messages. The `EventFormatter` class can be used to convert an event to a human-readable message. Each `EventProducer` can provide its own XML-based translation file. If there is none, a central translation file is used, called "EventFormatter.xml" (found in the same directory as the `EventFormatter` class).
@@ -226,7 +226,7 @@ The XML format used by the `EventFormatt
<?xml version="1.0" encoding="UTF-8"?>
<catalogue xml:lang="en">
<message key="locator">
- [ (See position {loc})| (See {#gatherContextInfo})| (No context info available)]
+ [ (See position {loc})| (See { #gatherContextInfo})| (No context info available)]
</message>
<message key="org.apache.fop.render.rtf.RTFEventProducer.explicitTableColumnsRequired">
RTF output requires that all table-columns for a table are defined. Output will be incorrect.{{locator}}
@@ -248,4 +248,4 @@ Additional such modifiers can be added b
Square braces can be used to specify optional template sections. The whole section will be omitted if any of the variables used within are unavailable. Pipe (|) characters can be used to specify alternative sub-templates (see "locator" above for an example).
-Developers can also register a function (in the above example: `{#gatherContextInfo})` to do more complex information rendering. These functions are implementations of the `AdvancedMessageFormat$Function` interface. Please take care that this is done in a locale-independent way as there is no locale information available, yet.
+Developers can also register a function (in the above example: `{ #gatherContextInfo})` to do more complex information rendering. These functions are implementations of the `AdvancedMessageFormat$Function` interface. Please take care that this is done in a locale-independent way as there is no locale information available, yet.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: commits-help@xmlgraphics.apache.org