You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xmlgraphics.apache.org by bu...@apache.org on 2012/10/24 06:04:05 UTC
svn commit: r835960 [8/18] - in /websites/staging/xmlgraphics/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: websites/staging/xmlgraphics/trunk/content/fop/1.0/servlets.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/servlets.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/servlets.html Wed Oct 24 04:04:00 2012
@@ -330,10 +330,11 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/1.0/">1.0</a></div> -->
- <div class="section-content"><p><subtitle>How to use Apache™ FOP in a Servlet</subtitle><version>$Revision: 1298724 $</version></p>
-<h1 id="overview-wzxhzdk7wzxhzdk8">Overview <a id="overview"></a></h1>
+ <div class="section-content"><h1 id="apachetm-fop-servlets">Apache(tm) FOP: Servlets</h1>
+<p><subtitle>How to use Apache™ FOP in a Servlet</subtitle><version>$Revision: 1298724 $</version></p>
+<h2 id="overview-wzxhzdk7wzxhzdk8">Overview <a id="overview"></a></h2>
<p>This page discusses topic all around using Apache™ FOP in a servlet environment.</p>
-<h1 id="example-servlets-in-the-fop-distribution-wzxhzdk10wzxhzdk11">Example Servlets in the FOP distribution <a id="example-servlets"></a></h1>
+<h2 id="example-servlets-in-the-fop-distribution-wzxhzdk10wzxhzdk11">Example Servlets in the FOP distribution <a id="example-servlets"></a></h2>
<p>In the directory {fop-dir}/src/java/org/apache/fop/servlet, you'll find a working example of a FOP-enabled servlet.</p>
<p>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:</p>
<ul>
@@ -405,9 +406,9 @@ private TransformerFactory tFactory = Tr
<p>The <code>Source</code> instance used above is simply an example. If you have to read the XML from a string, supply a <code>new StreamSource(new
StringReader(xmlstring))</code> . Constructing and reparsing an XML string is generally less desirable than using a SAXSource if you generate your XML. You can alternatively supply a DOMSource as well. You may also use dynamically generated XSL if you like.</p>
<p>Because you have an explicit <code>Transformer</code> object, you can also use it to explicitely set parameters for the transformation run.</p>
-<h2 id="custom-configuration-wzxhzdk18wzxhzdk19">Custom configuration # <a id="cfg"></a></h2>
+<h3 id="custom-configuration-wzxhzdk18wzxhzdk19">Custom configuration # <a id="cfg"></a></h3>
<p>You can easily set up your own FOUserAgent as demonstrated on the <a href="embedding.html">Embedding page</a> .</p>
-<h2 id="improving-performance-wzxhzdk20wzxhzdk21">Improving performance # <a id="performance"></a></h2>
+<h3 id="improving-performance-wzxhzdk20wzxhzdk21">Improving performance # <a id="performance"></a></h3>
<p>There are several options to consider:</p>
<ul>
<li>
@@ -418,7 +419,7 @@ private TransformerFactory tFactory = Tr
</li>
</ul>
<p>Of course, the <a href="embedding.html#performance">performance hints from the Embedding page</a> apply here, too.</p>
-<h2 id="accessing-resources-in-your-web-application-wzxhzdk22wzxhzdk23">Accessing resources in your web application # <a id="uriresolver"></a></h2>
+<h3 id="accessing-resources-in-your-web-application-wzxhzdk22wzxhzdk23">Accessing resources in your web application # <a id="uriresolver"></a></h3>
<p>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 <code>org.apache.fop.servlet.ServletContextURIResolver</code> .</p>
<p>Here's how to set it up in your servlet. Instantiate a new instance in the servlet's init() method:</p>
<div class="codehilite"><pre><span class="sr">/** URIResolver for use by this servlet */</span>
@@ -473,13 +474,13 @@ transformer.setURIResolver(this.uriResol
<p>Cache in the server. It may help to include a parameter in the URL which has a timestamp as the value min order to decide whether a request is repeated. IEx is reported to retrieve a document up to three times, but never more often.</p>
</li>
</ul>
-<h1 id="servlet-engines-wzxhzdk26wzxhzdk27">Servlet Engines <a id="servlet-engine"></a></h1>
+<h2 id="servlet-engines-wzxhzdk26wzxhzdk27">Servlet Engines <a id="servlet-engine"></a></h2>
<p>When using a servlet engine, there are potential CLASSPATH issues, and potential conflicts with existing XML/XSLT libraries. Servlet containers also often use their own classloaders for loading webapps, which can cause bugs and security problems.</p>
-<h2 id="tomcat-wzxhzdk28wzxhzdk29">Tomcat # <a id="tomcat"></a></h2>
+<h3 id="tomcat-wzxhzdk28wzxhzdk29">Tomcat # <a id="tomcat"></a></h3>
<p>Check Tomcat's documentation for detailed instructions about installing FOP and Cocoon. There are known bugs that must be addressed, particularly for Tomcat 4.0.3.</p>
-<h2 id="websphere-35-wzxhzdk30wzxhzdk31">WebSphere 3.5 # <a id="websphere"></a></h2>
+<h3 id="websphere-35-wzxhzdk30wzxhzdk31">WebSphere 3.5 # <a id="websphere"></a></h3>
<p>Put a copy of a working parser in some directory where WebSphere can access it. For example, if /usr/webapps/yourapp/servlets is the CLASSPATH for your servlets, copy the Xerces jar into it (any other directory would also be fine). Do not add the jar to the servlet CLASSPATH, but add it to the CLASSPATH of the application server which contains your web application. In the WebSphere administration console, click on the "environment" button in the "general" tab. In the "variable name" box, enter "CLASSPATH". In the "value" box, enter the correct path to the parser jar file (/usr/webapps/yourapp/servlets/Xerces.jar in our example here). Press "OK", then apply the change and restart the application server.</p>
-<h1 id="handling-complex-use-cases-wzxhzdk32wzxhzdk33">Handling complex use cases <a id="complex-usecases"></a></h1>
+<h2 id="handling-complex-use-cases-wzxhzdk32wzxhzdk33">Handling complex use cases <a id="complex-usecases"></a></h2>
<p>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 <a href="http://cocoon.apache.org/">Apache Cocoon</a> instead of a custom servlet to accomplish your goal.</p></div>
</div>
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/upgrading.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/upgrading.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/upgrading.html Wed Oct 24 04:04:00 2012
@@ -330,8 +330,9 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/1.0/">1.0</a></div> -->
- <div class="section-content"><p><version>$Revision: 1298724 $</version></p>
-<h1 id="important-wzxhzdk2wzxhzdk3">Important! <a id="important"></a></h1>
+ <div class="section-content"><h1 id="upgrading-from-an-earlier-version-of-apachewzxhzdk0-fop">Upgrading from an Earlier Version of Apache™ FOP</h1>
+<p><version>$Revision: 1298724 $</version></p>
+<h2 id="important-wzxhzdk3wzxhzdk4">Important! <a id="important"></a></h2>
<p>If you're planning to upgrade to the latest Apache™ FOP version there are a few very important things to consider:</p>
<ul>
<li>
@@ -360,7 +361,7 @@ While FOP 0.20.5 allowed you to have emp
<p>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.</p>
</li>
</ul>
-<h1 id="what-you-need-to-know-when-you-upgrade-wzxhzdk5wzxhzdk6">What you need to know when you upgrade! <a id="issues"></a></h1>
+<h2 id="what-you-need-to-know-when-you-upgrade-wzxhzdk6wzxhzdk7">What you need to know when you upgrade! <a id="issues"></a></h2>
<p>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.</p>
<ul>
<li>
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.1/accessibility.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.1/accessibility.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.1/accessibility.html Wed Oct 24 04:04:00 2012
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html lang="en">
<head>
- <title>Apache&trade; FOP: Accessibility</title>
+ <title>Apache(tm) FOP: Accessibility</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta property="og:image" content="http://www.apache.org/images/asf_logo.gif" />
@@ -324,16 +324,17 @@ $(document).ready(function () {
<div id="bannertext" style="border-bottom: 2px dashed #666666; height: 70px;">
<a href="/fop/"><img src="/images/apache-fop-logo.jpg" alt="The Apache FOP Project" width="120" height="65" style="float:left; margin-right: 15px;" /></a>
<h2>The Apache™ FOP Project</h2>
- </div><!-- <h1>Apache&trade; FOP: Accessibility</h1> -->
+ </div><!-- <h1>Apache(tm) FOP: Accessibility</h1> -->
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/1.1/">1.1</a></div> -->
- <div class="section-content"><h1 id="overview-wzxhzdk0wzxhzdk1">Overview <a id="overview"></a></h1>
+ <div class="section-content"><h1 id="apachetm-fop-accessibility">Apache(tm) FOP: Accessibility</h1>
+<h2 id="overview-wzxhzdk0wzxhzdk1">Overview <a id="overview"></a></h2>
<p>This page describes the <a href="http://en.wikipedia.org/wiki/Accessibility">accessibility</a> features of Apache™ FOP. <a href="http://www.section508.gov/">Section 508</a> defines accessibility in the context of electronic documents for the USA but other countries have similar requirements.</p>
<p>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.</p>
-<h1 id="enabling-accessibility-wzxhzdk3wzxhzdk4">Enabling accessibility <a id="Enabling+accessibility"></a></h1>
+<h2 id="enabling-accessibility-wzxhzdk3wzxhzdk4">Enabling accessibility <a id="Enabling+accessibility"></a></h2>
<p>There are 3 ways to enable accessibility:</p>
<ol>
<li>
@@ -367,7 +368,7 @@ The processing of the logical structure
<p>Specify the natural language of the document using the language and country properties (or via the <code>xml:lang</code> shorthand property).</p>
</li>
</ul>
-<h1 id="customized-tagging-wzxhzdk7wzxhzdk8">Customized Tagging <a id="customTags"></a></h1>
+<h2 id="customized-tagging-wzxhzdk7wzxhzdk8">Customized Tagging <a id="customTags"></a></h2>
<p>The <a href="#PDFReference">PDF Reference</a> 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.</p>
<p>FOP provides a default mapping of Formatting Objects to elements from that standard set. For example, <code>fo:page-sequence</code> is mapped to âPartâ, <code>fo:block</code> is mapped to âPâ, <code>fo:list-block</code> to âLâ, etc.</p>
<p>You may want to customize that mapping to improve the accuracy of the tagging or deal with particular FO constructs. For example, you may want to make use of the âH1â to âH6â tags to make the hierarchical structure of the document appear in the PDF. This is achieved by using the <code>role</code> XSL-FO property:
@@ -376,9 +377,9 @@ The processing of the logical structure
<fo:block>This is the first paragraph of the first section...</fo:block>
...
If a non-standard structure type is specified, FOP will issue a warning and fall back to the default tag associated to the Formatting Object.</p>
-<h1 id="testing-wzxhzdk13wzxhzdk14">Testing <a id="testing"></a></h1>
+<h2 id="testing-wzxhzdk13wzxhzdk14">Testing <a id="testing"></a></h2>
<p>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.</p>
-<h1 id="limitations-wzxhzdk15wzxhzdk16">Limitations <a id="limitations"></a></h1>
+<h2 id="limitations-wzxhzdk15wzxhzdk16">Limitations <a id="limitations"></a></h2>
<p>Accessibility support in Apache FOP is relatively new, so there are certain limitations. Please help us identify and close any gaps.</p>
<ul>
<li>
@@ -394,7 +395,7 @@ If a non-standard structure type is spec
<p>The side regions (region-before, region-after etc.) are currently not specially identified. Screen readers may read their content at page changes.</p>
</li>
</ul>
-<h1 id="related-links-wzxhzdk17wzxhzdk18">Related Links <a id="links"></a></h1>
+<h2 id="related-links-wzxhzdk17wzxhzdk18">Related Links <a id="links"></a></h2>
<p>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:</p>
<ul>
<li>
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.1/anttask.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.1/anttask.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.1/anttask.html Wed Oct 24 04:04:00 2012
@@ -330,9 +330,10 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/1.1/">1.1</a></div> -->
- <div class="section-content"><p><version>$Revision: 1298724 $</version></p>
+ <div class="section-content"><h1 id="apachetm-fop-ant-task">Apache(tm) FOP: Ant task</h1>
+<p><version>$Revision: 1298724 $</version></p>
<p>Apache™ FOP provides an Ant task for automating the document build process.</p>
-<h1 id="description-wzxhzdk4wzxhzdk5">Description <a id="basics"></a></h1>
+<h2 id="description-wzxhzdk4wzxhzdk5">Description <a id="basics"></a></h2>
<p>The FOP Ant task will convert XSL-FO documents to PDF, PS, PCL etc. output (see <a href="output.html">Output formats</a> for available formats).</p>
<p>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:</p>
<property name="fop.home" value="....path to your FOP HOME directory..."/>
@@ -352,7 +353,7 @@ $(document).ready(function () {
Then create FOP tasks within your Ant build file, using the FOP task parameters listed below.
-# Parameters for FOP Ant task <a id="parameters"></a>
+## Parameters for FOP Ant task <a id="parameters"></a>
<caption>Parameters specified as attributes</caption>| Attribute | Description | Required |
|-----------|-------------|----------|
@@ -374,7 +375,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 <a id="examples"></a>
+## Examples <a id="examples"></a>
The following example converts a single XSL-FO file to a PDF document:
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.1/changes_1.1.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.1/changes_1.1.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.1/changes_1.1.html Wed Oct 24 04:04:00 2012
@@ -330,11 +330,12 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/1.1/">1.1</a></div> -->
- <div class="section-content"><p><a href="changes_1.1.rss"></a> </p>
-<h1 id="introduction-and-explanation-of-symbols-wzxhzdk0wzxhzdk1">Introduction and explanation of symbols <a id="introduction"></a></h1>
+ <div class="section-content"><h1 id="history-of-changes-11">History of Changes 1.1</h1>
+<p><a href="changes_1.1.rss"></a> </p>
+<h2 id="introduction-and-explanation-of-symbols-wzxhzdk0wzxhzdk1">Introduction and explanation of symbols <a id="introduction"></a></h2>
<p>Changes are sorted by "type" and then chronologically with the most recent at the top. These symbols denote the various action types:<icon alt="add" src="../images/add.jpg"></icon>=add,<icon alt="fix" src="../images/fix.jpg"></icon>=fix,<icon alt="remove" src="../images/remove.jpg"></icon>=remove,<icon alt="update" src="../images/update.jpg"></icon>=update</p>
-<h1 id="version-11-20-october-2012-wzxhzdk10wzxhzdk11">Version 1.1 (20 October 2012) <a id="version_1.1"></a></h1>
-<h2 id="changes-to-the-code-base-wzxhzdk12wzxhzdk13">Changes to the Code Base # <a id="Code_1.1"></a></h2>
+<h2 id="version-11-20-october-2012-wzxhzdk10wzxhzdk11">Version 1.1 (20 October 2012) <a id="version_1.1"></a></h2>
+<h3 id="changes-to-the-code-base-wzxhzdk12wzxhzdk13">Changes to the Code Base # <a id="Code_1.1"></a></h3>
<ul>
<li>
<p><icon alt="add" src="../images/add.jpg"></icon>Added support for the role property on fo:page-sequence, fo:flow and fo:static-content. This allows to change the mapping of those FOs to PDF structure types when enabling accessibility. Committed by VH.</p>
@@ -514,7 +515,7 @@ $(document).ready(function () {
<p><icon alt="update" src="../images/update.jpg"></icon>Add run target for embedded examples. Add increased JVM memory heap flag for example8 in case font cache is rebuilt. Committed by GA. See Issue <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=51617">51617</a> .</p>
</li>
</ul>
-<h2 id="changes-to-the-user-configuration-wzxhzdk14wzxhzdk15">Changes to the User Configuration # <a id="Config_1.1"></a></h2>
+<h3 id="changes-to-the-user-configuration-wzxhzdk14wzxhzdk15">Changes to the User Configuration # <a id="Config_1.1"></a></h3>
<ul>
<li>
<p><icon alt="add" src="../images/add.jpg"></icon>Added configuration option to set the version of the output PDF document. Committed by VH. Thanks to Mehdi Houshmand. See Issue <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=51385">51385</a> .</p>
@@ -529,7 +530,7 @@ $(document).ready(function () {
<p><icon alt="fix" src="../images/fix.jpg"></icon>Fix for relative URIs in the configuration file (base, font-base, hyphenation-base) are evaluated relative to the base URI of the configuration file. Committed by SP.</p>
</li>
</ul>
-<h2 id="changes-to-documentation-wzxhzdk16wzxhzdk17">Changes to Documentation # <a id="Docs_1.1"></a></h2>
+<h3 id="changes-to-documentation-wzxhzdk16wzxhzdk17">Changes to Documentation # <a id="Docs_1.1"></a></h3>
<ul>
<li>
<p><icon alt="fix" src="../images/fix.jpg"></icon>Fix renderer mime type for PCL output; should be application/x-pcl. Committed by GA. See Issue <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=53247">53247</a> .</p>
@@ -538,7 +539,7 @@ $(document).ready(function () {
<p><icon alt="update" src="../images/update.jpg"></icon>Update FAQ and New Bug documentation. Committed by GA.</p>
</li>
</ul>
-<h2 id="changes-to-the-font-subsystem-wzxhzdk18wzxhzdk19">Changes to the Font Subsystem # <a id="Fonts_1.1"></a></h2>
+<h3 id="changes-to-the-font-subsystem-wzxhzdk18wzxhzdk19">Changes to the Font Subsystem # <a id="Fonts_1.1"></a></h3>
<ul>
<li>
<p><icon alt="add" src="../images/add.jpg"></icon>Add support for OpenType advanced typographic tables (GDEF, GSUB, GPOS). Committed by GA.</p>
@@ -586,7 +587,7 @@ $(document).ready(function () {
<p><icon alt="update" src="../images/update.jpg"></icon>Removing experimental feature that violates XSL-FO and Unicode semantics by misinterpreting Basic Latin code points. Users must use private use codepoints to access font specific character mappings that have no assigned Unicode code point. See bug 50492. Committed by GA.</p>
</li>
</ul>
-<h2 id="changes-to-the-image-support-wzxhzdk20wzxhzdk21">Changes to the Image Support # <a id="Images_1.1"></a></h2>
+<h3 id="changes-to-the-image-support-wzxhzdk20wzxhzdk21">Changes to the Image Support # <a id="Images_1.1"></a></h3>
<ul>
<li>
<p><icon alt="fix" src="../images/fix.jpg"></icon>Fix incorrect SVG line dash pattern with PDF output format. Committed by GA. Thanks to Luis Bernardo. See Issue <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=53431">53431</a> .</p>
@@ -604,7 +605,7 @@ $(document).ready(function () {
<p><icon alt="update" src="../images/update.jpg"></icon>Fix newly introduced findbugs warnings. Committed by GA. Thanks to Luis Bernardo. See Issue <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=40676">40676</a> .</p>
</li>
</ul>
-<h2 id="changes-to-the-layout-engine-wzxhzdk22wzxhzdk23">Changes to the Layout Engine # <a id="Layout_1.1"></a></h2>
+<h3 id="changes-to-the-layout-engine-wzxhzdk22wzxhzdk23">Changes to the Layout Engine # <a id="Layout_1.1"></a></h3>
<ul>
<li>
<p><icon alt="add" src="../images/add.jpg"></icon>Add support for complex scripts, including: full bidi support, support for advanced typographic tables, advanced support for number conversion. Committed by GA. See Issue <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=32789">32789</a> , <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=49008">49008</a> , <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=49687">49687</a> .</p>
@@ -664,7 +665,7 @@ $(document).ready(function () {
<p><icon alt="fix" src="../images/fix.jpg"></icon>Fixed retrieval of available BPD for cases spanning columns and multiple pages with differing page masters. Committed by JM. See Issue <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=49885">49885</a> .</p>
</li>
</ul>
-<h2 id="changes-to-renderers-output-formats-wzxhzdk24wzxhzdk25">Changes to Renderers (Output Formats) # <a id="Renderers_1.1"></a></h2>
+<h3 id="changes-to-renderers-output-formats-wzxhzdk24wzxhzdk25">Changes to Renderers (Output Formats) # <a id="Renderers_1.1"></a></h3>
<ul>
<li>
<p><icon alt="add" src="../images/add.jpg"></icon>Added possibility to embed TrueType fonts in PostScript. Committed by VH. See Issue <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=52338">52338</a> .</p>
@@ -796,7 +797,7 @@ $(document).ready(function () {
<p><icon alt="remove" src="../images/remove.jpg"></icon>Removed old Renderer implementations for those output formats that have a version based on the new DocumentHandler architecture available (AFP, PCL, PDF, PS). Committed by VH.</p>
</li>
</ul>
-<h2 id="changes-to-unit-tests-or-other-test-code-wzxhzdk26wzxhzdk27">Changes to unit tests or other test code # <a id="Test_1.1"></a></h2>
+<h3 id="changes-to-unit-tests-or-other-test-code-wzxhzdk26wzxhzdk27">Changes to unit tests or other test code # <a id="Test_1.1"></a></h3>
<ul>
<li>
<p><icon alt="fix" src="../images/fix.jpg"></icon>Fix errors and warnings in example files. Add build.xml for documentation examples. Committed by GA.</p>
@@ -805,7 +806,7 @@ $(document).ready(function () {
<p><icon alt="update" src="../images/update.jpg"></icon>Add test for basic-link with padding. Committed by GA. Thanks to Matthias Reischenbacher. See Issue <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=50196">50196</a> .</p>
</li>
</ul>
-<h2 id="contributors-to-this-release-wzxhzdk28wzxhzdk29">Contributors to this release # <a id="contributors_1.1"></a></h2>
+<h3 id="contributors-to-this-release-wzxhzdk28wzxhzdk29">Contributors to this release # <a id="contributors_1.1"></a></h3>
<p>We thank the following people for their contributions to this release.</p>
<p>This is a list of all people who participated as committers:<br></br>Adrian Cumiskey (AC), Andreas Delmelle (AD), Chris Bowditch (CB), Glenn Adams (GA), Jeremias Märki (JM), Mehdi Houshmand (MH), Peter Hancock (PH), Simon Pepping (SP), Vincent Hennebert (VH).</p>
<p>This is a list of other contributors:<br></br>Adrian Buza, Alberto Simões, Alexandros Papadakis, Alexios Giotis, Andrejus Chaliapinas, Armin Haaf, Benjamin Riefenstahl, Carsten Pfeiffer, Dieter von Holten, Georg Datterl, Glenn Adams, Joshua Marquart, Julien Aymé, Luis Bernardo, Luis Bernardo, Matthias Reischenbacher, Martin Koegler, Matthias Reischenbacher, Max Aster, Mehdi Houshmand, Melanie Drake, Michael Rubin, Ognjen Blagojevic, Pascal Sancho, Patrick Jaromin, Paul Huemer, Peter Hancock, Robert Meyer, Sergey Vladimirov, Simon Pepping, Tassos Charoulis, Vincent Hennebert.</p></div>
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.1/compiling.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.1/compiling.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.1/compiling.html Wed Oct 24 04:04:00 2012
@@ -330,19 +330,20 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/1.1/">1.1</a></div> -->
- <div class="section-content"><p><version>$Revision$</version></p>
-<h1 id="do-you-need-to-build-wzxhzdk2wzxhzdk3">Do You Need To Build? <a id="build-needed"></a></h1>
+ <div class="section-content"><h1 id="apachetm-fop-building-from-source-code">Apache(tm) FOP: Building from Source Code</h1>
+<p><version>$Revision$</version></p>
+<h2 id="do-you-need-to-build-wzxhzdk2wzxhzdk3">Do You Need To Build? <a id="build-needed"></a></h2>
<p>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 <a href="../download.html">Download Instructions</a> for information about where to obtain binary or repository snapshots, and whether a binary or source snapshot is best for your needs.</p>
-<h1 id="set-up-your-environment-wzxhzdk5wzxhzdk6">Set Up Your Environment <a id="env"></a></h1>
-<h2 id="jdk-wzxhzdk7wzxhzdk8">JDK # <a id="env-jdk"></a></h2>
+<h2 id="set-up-your-environment-wzxhzdk5wzxhzdk6">Set Up Your Environment <a id="env"></a></h2>
+<h3 id="jdk-wzxhzdk7wzxhzdk8">JDK # <a id="env-jdk"></a></h3>
<p>Building FOP 1.1 requires a minimum Java Development Kit (JDK/SDK) of 1.5 (A Java Runtime Environment is not sufficient).</p>
-<h2 id="classpath-wzxhzdk9wzxhzdk10">CLASSPATH # <a id="env-classpath"></a></h2>
+<h3 id="classpath-wzxhzdk9wzxhzdk10">CLASSPATH # <a id="env-classpath"></a></h3>
<p>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.</p>
-<h2 id="java_home-wzxhzdk11wzxhzdk12">JAVA_HOME # <a id="env-java-home"></a></h2>
+<h3 id="java_home-wzxhzdk11wzxhzdk12">JAVA_HOME # <a id="env-java-home"></a></h3>
<p>The build script uses <a href="http://ant.apache.org/">Apache Ant</a> , 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.</p>
-<h2 id="apache-ant-wzxhzdk13wzxhzdk14">Apache Ant # <a id="env-ant"></a></h2>
+<h3 id="apache-ant-wzxhzdk13wzxhzdk14">Apache Ant # <a id="env-ant"></a></h3>
<p><a href="http://ant.apache.org/">Apache Ant</a> (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 <a href="http://ant.apache.org/manual/">instructions to install Ant in the Ant manual</a> on the web.</p>
-<h1 id="run-the-build-script-wzxhzdk15wzxhzdk16">Run the Build Script <a id="build-script"></a></h1>
+<h2 id="run-the-build-script-wzxhzdk15wzxhzdk16">Run the Build Script <a id="build-script"></a></h2>
<p>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 <a href="http://ant.apache.org/manual/">installed Apache Ant</a> 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:
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.1/complexscripts.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.1/complexscripts.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.1/complexscripts.html Wed Oct 24 04:04:00 2012
@@ -330,7 +330,8 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/1.1/">1.1</a></div> -->
- <div class="section-content"><h1 id="overview-wzxhzdk0wzxhzdk1">Overview <a id="overview"></a></h1>
+ <div class="section-content"><h1 id="apachetm-fop-complex-scripts">Apache(tm) FOP: Complex Scripts</h1>
+<h2 id="overview-wzxhzdk0wzxhzdk1">Overview <a id="overview"></a></h2>
<p>This page describes the <a href="http://en.wikipedia.org/wiki/Complex_scripts">complex scripts</a> features of Apache™ FOP, which include:</p>
<ul>
<li>
@@ -346,7 +347,7 @@ $(document).ready(function () {
<p>Support for advanced number to string formatting.</p>
</li>
</ul>
-<h1 id="disabling-complex-scripts-wzxhzdk3wzxhzdk4">Disabling complex scripts <a id="Disabling+complex+scripts"></a></h1>
+<h2 id="disabling-complex-scripts-wzxhzdk3wzxhzdk4">Disabling complex scripts <a id="Disabling+complex+scripts"></a></h2>
<p>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:</p>
<ol>
<li>
@@ -389,9 +390,9 @@ A document author need not make explicit
<p>Explicit join control characters: U+200C ZWNJ and U+200D ZWJ.</p>
</li>
</ul>
-<h1 id="authoring-details-wzxhzdk7wzxhzdk8">Authoring Details <a id="details"></a></h1>
+<h2 id="authoring-details-wzxhzdk7wzxhzdk8">Authoring Details <a id="details"></a></h2>
<p>The complex scripts related effects of the above enumerated XSL-FO constructs are more fully described in the following sub-sections.</p>
-<h2 id="script-property-wzxhzdk9wzxhzdk10">Script Property # <a id="script_property"></a></h2>
+<h3 id="script-property-wzxhzdk9wzxhzdk10">Script Property # <a id="script_property"></a></h3>
<p>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:</p>
<ol>
<li>
@@ -402,7 +403,7 @@ A document author need not make explicit
</li>
</ol>
<p>In case the automatic algorithm does not produce the desired results, an author may explicitly specify a <code>script</code> property with the desired script. If specified, it must be one of the four-letter script code specified in <a href="http://unicode.org/iso15924/iso15924-codes.html">ISO 15924 Code List</a> or in the <a href="#extended_script_codes">Extended Script Codes</a> 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.</p>
-<h3 id="standard-script-codes-wzxhzdk11wzxhzdk12">Standard Script Codes ## <a id="standard_script_codes"></a></h3>
+<h4 id="standard-script-codes-wzxhzdk11wzxhzdk12">Standard Script Codes ## <a id="standard_script_codes"></a></h4>
<p>The following table enumerates the standard ISO 15924 4-letter codes recognized by FOP.</p>
<table>
<thead>
@@ -542,7 +543,7 @@ A document author need not make explicit
</tr>
</tbody>
</table>
-<h3 id="extended-script-codes-wzxhzdk13wzxhzdk14">Extended Script Codes ## <a id="extended_script_codes"></a></h3>
+<h4 id="extended-script-codes-wzxhzdk13wzxhzdk14">Extended Script Codes ## <a id="extended_script_codes"></a></h4>
<p>The following table enumerates a number of non-standard extended script codes recognized by FOP.</p>
<table>
<thead>
@@ -636,7 +637,7 @@ A document author need not make explicit
</table>
<p>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 <a href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#language"></a> property.</p>
<p>When specifying the <code>language</code> property, the value of the property must be either an <a href="http://en.wikipedia.org/wiki/List_of_ISO_639-2_codes">ISO639-2 3-letter code</a> or an <a href="http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes">ISO639-1 2-letter code</a> . 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.</p>
-<h2 id="writing-mode-property-wzxhzdk15wzxhzdk16">Writing Mode Property # <a id="writing_mode_property"></a></h2>
+<h3 id="writing-mode-property-wzxhzdk15wzxhzdk16">Writing Mode Property # <a id="writing_mode_property"></a></h3>
<p>The <code>writing-mode</code> 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.</p>
<p>The <code>writing-mode</code> property is inherited, so it can appear on any XSL-FO element type; however, it applies (semantically) only to the following element types:</p>
<ul>
@@ -676,9 +677,9 @@ A document author need not make explicit
</li>
</ul>
<p>Writing modes that employ a vertical inline progression direction are not yet supported.</p>
-<h2 id="bidi-override-element-wzxhzdk17wzxhzdk18">Bidi Override Element # <a id="bidi_override_element"></a></h2>
+<h3 id="bidi-override-element-wzxhzdk17wzxhzdk18">Bidi Override Element # <a id="bidi_override_element"></a></h3>
<p>The <a href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#fo_bidi-override"></a> 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 <a href="#bidi_controls">Bidi Control Characters</a> , the default behavior prescribed by the <a href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#fo_bidi-override">Unicode Bidirectional Algorithm</a> applies.</p>
-<h2 id="bidi-control-characters-wzxhzdk19wzxhzdk20">Bidi Control Characters # <a id="bidi_controls"></a></h2>
+<h3 id="bidi-control-characters-wzxhzdk19wzxhzdk20">Bidi Control Characters # <a id="bidi_controls"></a></h3>
<p>In addition to the use of the <a href="#bidi_override_element">Bidi Override Element</a> , an author may make use of the following explicit Unicode Bidi Control Characters:</p>
<ul>
<li>
@@ -704,11 +705,11 @@ A document author need not make explicit
</li>
</ul>
<p>If an embedding or override is not terminated (using U+202C PDF) prior to the end of a <a href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#d0e4879">delimited text range</a> , then it is automatically terminated by FOP.</p>
-<h2 id="join-control-characters-wzxhzdk21wzxhzdk22">Join Control Characters # <a id="join_controls"></a></h2>
+<h3 id="join-control-characters-wzxhzdk21wzxhzdk22">Join Control Characters # <a id="join_controls"></a></h3>
<p>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).</p>
<p>Conversely, in order to force joining behavior in contexts where joining does not occur by default, for example, between U+0628 ARABIC LETTER BEH and U+0020 SPACE, an author may used a U+200D ZERO WIDTH JOINER (ZWJ).</p>
<p>The behavior of ZWNJ and ZWJ is script specific. See <a href="http://www.unicode.org/versions/Unicode6.1.0/ch08.pdf">The Unicode Standard, Chapter 8, Middle Eastern Scripts</a> for information on the use of these control characters with the Arabic script. See <a href="http://www.unicode.org/versions/Unicode6.1.0/ch09.pdf">The Unicode Standard, Chapter 9, South Asian Scripts - I</a> for information on the use of these control characters with common Indic scripts.</p>
-<h1 id="supported-scripts-wzxhzdk23wzxhzdk24">Supported Scripts <a id="supported_scripts"></a></h1>
+<h2 id="supported-scripts-wzxhzdk23wzxhzdk24">Supported Scripts <a id="supported_scripts"></a></h2>
<p>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.</p>
<table>
<thead>
@@ -860,9 +861,9 @@ A document author need not make explicit
</tr>
</tbody>
</table>
-<h1 id="supported-fonts-wzxhzdk25wzxhzdk26">Supported Fonts <a id="supported_fonts"></a></h1>
+<h2 id="supported-fonts-wzxhzdk25wzxhzdk26">Supported Fonts <a id="supported_fonts"></a></h2>
<p>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.</p>
-<h2 id="arabic-fonts-wzxhzdk27wzxhzdk28">Arabic Fonts # <a id="fonts_arabic"></a></h2>
+<h3 id="arabic-fonts-wzxhzdk27wzxhzdk28">Arabic Fonts # <a id="fonts_arabic"></a></h3>
<table>
<thead>
<tr>
@@ -949,7 +950,7 @@ A document author need not make explicit
</tr>
</tbody>
</table>
-<h2 id="devanagari-fonts-wzxhzdk29wzxhzdk30">Devanagari Fonts # <a id="devanagari_fonts"></a></h2>
+<h3 id="devanagari-fonts-wzxhzdk29wzxhzdk30">Devanagari Fonts # <a id="devanagari_fonts"></a></h3>
<table>
<thead>
<tr>
@@ -996,7 +997,7 @@ A document author need not make explicit
</tr>
</tbody>
</table>
-<h1 id="other-limitations-wzxhzdk31wzxhzdk32">Other Limitations <a id="limitations"></a></h1>
+<h2 id="other-limitations-wzxhzdk31wzxhzdk32">Other Limitations <a id="limitations"></a></h2>
<p>Complex scripts support in Apache FOP is relatively new, so there are certain limitations. Please help us identify and close any gaps.</p>
<ul>
<li>
@@ -1006,7 +1007,7 @@ A document author need not make explicit
<p>Shaping context does not extend across an element boundary. This limitation prevents the use of <code>fo:character</code> , <code>fo:inline</code> or <code>fo:wrapper</code> in order to colorize individual Arabic letters without affecting shaping behavior across the element boundary.</p>
</li>
</ul>
-<h1 id="related-links-wzxhzdk33wzxhzdk34">Related Links <a id="links"></a></h1>
+<h2 id="related-links-wzxhzdk33wzxhzdk34">Related Links <a id="links"></a></h2>
<p>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:</p>
<ul>
<li>
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.1/configuration.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.1/configuration.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.1/configuration.html Wed Oct 24 04:04:00 2012
@@ -330,11 +330,12 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/1.1/">1.1</a></div> -->
- <div class="section-content"><p><version>$Revision$</version></p>
-<h1 id="configuration-file-basics-wzxhzdk8wzxhzdk9">Configuration File Basics <a id="general"></a></h1>
+ <div class="section-content"><h1 id="apachetm-fop-configuration">Apache(tm) FOP: Configuration</h1>
+<p><version>$Revision$</version></p>
+<h2 id="configuration-file-basics-wzxhzdk8wzxhzdk9">Configuration File Basics <a id="general"></a></h2>
<p>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.</p>
<p>The easiest way to get started using a FOP configuration file is to copy the sample found at <code>{fop-dir}/conf/fop.xconf</code> 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.</p>
-<h2 id="making-configuration-available-to-fop-wzxhzdk11wzxhzdk12">Making Configuration Available to FOP # <a id="general-available"></a></h2>
+<h3 id="making-configuration-available-to-fop-wzxhzdk11wzxhzdk12">Making Configuration Available to FOP # <a id="general-available"></a></h3>
<p>After creating your configuration file, you must tell FOP how to find it:</p>
<ul>
<li>
@@ -345,7 +346,7 @@ $(document).ready(function () {
</li>
</ul>
<p>See <a href="embedding.html#config-internal">Setting the Configuration Programmatically</a> for instructions on how to do so in an embedded environment.</p>
-<h1 id="summary-of-the-general-configuration-options-wzxhzdk13wzxhzdk14">Summary of the General Configuration Options <a id="general-elements"></a></h1>
+<h2 id="summary-of-the-general-configuration-options-wzxhzdk13wzxhzdk14">Summary of the General Configuration Options <a id="general-elements"></a></h2>
<table>
<thead>
<tr>
@@ -474,7 +475,7 @@ $(document).ready(function () {
<fop version="1.0"></p>
<p>The second penalty element sets an "infinite" penalty for the TIFF loader using the internal TIFF codec. This practically disables that plug-in as it will never be chosen as a possible solution.</p>
<p>Negative penalties are possible to promote a plug-in but a negative penalty sum will be treated as zero penalty in most cases. For more details on the image loading framework, please consult the documentation there.</p>
-<h1 id="renderer-configuration-wzxhzdk44wzxhzdk45">Renderer configuration <a id="renderers"></a></h1>
+<h2 id="renderer-configuration-wzxhzdk44wzxhzdk45">Renderer configuration <a id="renderers"></a></h2>
<p>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.</p>
<p>The configuration for the PDF Renderer could look like this:</p>
<p><renderers>
@@ -500,7 +501,7 @@ $(document).ready(function () {
<p>The details on the font configuration can be found on the separate <a href="fonts.html">Fonts</a> page. Note especially the section entitled <a href="fonts.html#register">Register Fonts with FOP</a> .</p>
-<h2 id="special-settings-for-the-pdf-renderer-wzxhzdk64wzxhzdk65">Special Settings for the PDF Renderer # <a id="pdf-renderer"></a></h2>
+<h3 id="special-settings-for-the-pdf-renderer-wzxhzdk64wzxhzdk65">Special Settings for the PDF Renderer # <a id="pdf-renderer"></a></h3>
<p>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.</p>
<div class="codehilite"><pre><span class="nt"><renderer</span> <span class="na">mime=</span><span class="s">"application/pdf"</span><span class="nt">></span>
<span class="nt"><filterList></span>
@@ -562,7 +563,7 @@ $(document).ready(function () {
<version>1.5</version>
<!-- Versions 1.4, 1.5, 1.6 and 1.7 are accepted, all other values are invalid -->
</renderer></p>
-<h2 id="special-settings-for-the-postscript-renderer-wzxhzdk71wzxhzdk72">Special Settings for the PostScript Renderer # <a id="ps-renderer"></a></h2>
+<h3 id="special-settings-for-the-postscript-renderer-wzxhzdk71wzxhzdk72">Special Settings for the PostScript Renderer # <a id="ps-renderer"></a></h3>
<p>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:</p>
<div class="codehilite"><pre><span class="nt"><renderer</span> <span class="na">mime=</span><span class="s">"application/postscript"</span><span class="nt">></span>
<span class="nt"><auto-rotate-landscape></span>true<span class="nt"></auto-rotate-landscape></span>
@@ -590,7 +591,7 @@ $(document).ready(function () {
</renderer>
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.</p>
<p>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.</p>
-<h2 id="special-settings-for-the-afp-renderer-wzxhzdk81wzxhzdk82">Special Settings for the AFP Renderer # <a id="afp-renderer"></a></h2>
+<h3 id="special-settings-for-the-afp-renderer-wzxhzdk81wzxhzdk82">Special Settings for the AFP Renderer # <a id="afp-renderer"></a></h3>
<p>Additionally, there are certain settings that control how the renderer handles various elements.
<renderer mime="application/x-afp">
<images mode="b+w" bits-per-pixel="8" native="true"/>
@@ -603,7 +604,7 @@ The default value for the images "mode"
<p>The default value for the "renderer-resolution" is 240 dpi.</p>
<p>The default line width is device dependent and may need to be fine tuned so that the output matches the expected result. The default correction value is 2.5.</p>
<p>By default if there is no configuration definition for "resource-group-file", external resources will be placed in a file called resources.afp.</p>
-<h1 id="when-it-does-not-work-wzxhzdk93wzxhzdk94">When it does not work <a id="When+it+does+not+work"></a></h1>
+<h2 id="when-it-does-not-work-wzxhzdk93wzxhzdk94">When it does not work <a id="When+it+does+not+work"></a></h2>
<p>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.</p>
<p>Check the following possibilities:</p>
<ul>
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.1/embedding.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.1/embedding.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.1/embedding.html Wed Oct 24 04:04:00 2012
@@ -330,11 +330,12 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/1.1/">1.1</a></div> -->
- <div class="section-content"><p><subtitle>How to Embed FOP in a Java application</subtitle><version>$Revision$</version></p>
-<h1 id="overview-wzxhzdk4wzxhzdk5">Overview <a id="overview"></a></h1>
+ <div class="section-content"><h1 id="apachetm-fop-embedding">Apache(tm) FOP: Embedding</h1>
+<p><subtitle>How to Embed FOP in a Java application</subtitle><version>$Revision$</version></p>
+<h2 id="overview-wzxhzdk4wzxhzdk5">Overview <a id="overview"></a></h2>
<p>Review <a href="running.html">Running Apache™ FOP</a> for important information that applies to embedded applications as well as command-line use, such as options and performance.</p>
<p>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.</p>
-<h1 id="the-api-wzxhzdk8wzxhzdk9">The API <a id="API"></a></h1>
+<h2 id="the-api-wzxhzdk8wzxhzdk9">The API <a id="API"></a></h2>
<p>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:
org.apache.fop.apps.*
org.apache.fop.fo.FOEventHandler
@@ -352,7 +353,7 @@ org.apache.fop.render.intermediate.IFPar
org.apache.fop.render.intermediate.IFSerializer
org.apache.fop.render.intermediate.IFUtil
org.apache.fop.render.intermediate.util.IFConcatenator</p>
-<h1 id="basic-usage-pattern-wzxhzdk10wzxhzdk11">Basic Usage Pattern <a id="basics"></a></h1>
+<h2 id="basic-usage-pattern-wzxhzdk10wzxhzdk11">Basic Usage Pattern <a id="basics"></a></h2>
<p>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...</p>
<p>Here is the basic pattern to render an XSL-FO file to PDF:</p>
<p>import org.apache.fop.apps.FopFactory;
@@ -405,7 +406,7 @@ Let's discuss these 5 steps in detail:</
</ul>
<p>If you're not totally familiar with JAXP Transformers, please have a look at the <a href="#examples">Embedding examples</a> 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.</p>
<p>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 <a href="#examples">Embedding examples</a> (See "ExampleXML2FO").</p>
-<h2 id="logging-wzxhzdk12wzxhzdk13">Logging # <a id="basic-logging"></a></h2>
+<h3 id="logging-wzxhzdk12wzxhzdk13">Logging # <a id="basic-logging"></a></h3>
<p>Logging is now a little different than it was in FOP 0.20.5. We've switched from Avalon Logging to <a href="http://commons.apache.org/logging/">Jakarta Commons Logging</a> . 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.</p>
<p>By default, <a href="http://commons.apache.org/logging/">Jakarta Commons Logging</a> 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 <a href="http://commons.apache.org/logging/">documentation for Jakarta Commons Logging</a> on how to configure alternative backends.</p>
<p>As a result of the above we differentiate between two kinds of "logging":</p>
@@ -418,9 +419,9 @@ Let's discuss these 5 steps in detail:</
</li>
</ul>
<p>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 <code>event</code> package which can be used to receive feedback from the layout engine and other components within FOP <strong>per rendering run</strong> . 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 <a href="events.html">Events page</a> . 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 <a href="events.html">Events subsystem</a> is the right approach.</p>
-<h2 id="processing-xsl-fo-wzxhzdk14wzxhzdk15">Processing XSL-FO # <a id="render"></a></h2>
+<h3 id="processing-xsl-fo-wzxhzdk14wzxhzdk15">Processing XSL-FO # <a id="render"></a></h3>
<p>Once the Fop instance is set up, call <code>getDefaultHandler()</code> 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 <code>startDocument()</code> method is called. Processing stops again when the DefaultHandler's <code>endDocument()</code> method is called. Please refer to the basic usage pattern shown above to render a simple XSL-FO document.</p>
-<h2 id="processing-xsl-fo-generated-from-xmlxslt-wzxhzdk16wzxhzdk17">Processing XSL-FO generated from XML+XSLT # <a id="render-with-xslt"></a></h2>
+<h3 id="processing-xsl-fo-generated-from-xmlxslt-wzxhzdk16wzxhzdk17">Processing XSL-FO generated from XML+XSLT # <a id="render-with-xslt"></a></h3>
<p>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:</p>
<p>//without XSLT:
//Transformer transformer = factory.newTransformer(); // identity transformer</p>
@@ -454,9 +455,9 @@ Let's discuss these 5 steps in detail:</
</li>
</ul>
<p>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 <a href="http://xml.apache.org/xalan-j/usagepatterns.html">Xalan Basic Usage Patterns</a> .</p>
-<h1 id="configuring-apache-fop-programmatically-wzxhzdk20wzxhzdk21">Configuring Apache FOP Programmatically <a id="config-internal"></a></h1>
+<h2 id="configuring-apache-fop-programmatically-wzxhzdk20wzxhzdk21">Configuring Apache FOP Programmatically <a id="config-internal"></a></h2>
<p>Apache FOP provides two levels on which you can customize FOP's behaviour: the FopFactory and the user agent.</p>
-<h2 id="customizing-the-fopfactory-wzxhzdk22wzxhzdk23">Customizing the FopFactory # <a id="fop-factory"></a></h2>
+<h3 id="customizing-the-fopfactory-wzxhzdk22wzxhzdk23">Customizing the FopFactory # <a id="fop-factory"></a></h3>
<p>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.</p>
<p>You can set all sorts of things on the FopFactory:</p>
<ul>
@@ -489,7 +490,7 @@ fopFactory.addElementMapping(myElementMa
fopFactory.setURIResolver(myResolver); // myResolver is a javax.xml.transform.URIResolverBoth 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.</p>
</li>
</ul>
-<h2 id="customizing-the-user-agent-wzxhzdk24wzxhzdk25">Customizing the User Agent # <a id="user-agent"></a></h2>
+<h3 id="customizing-the-user-agent-wzxhzdk24wzxhzdk25">Customizing the User Agent # <a id="user-agent"></a></h3>
<p>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:</p>
<p>FopFactory fopFactory = FopFactory.newInstance(); // Reuse the FopFactory if possible!
// do the following for each new rendering run
@@ -555,7 +556,7 @@ fopFactory.setUserConfig(cfg);</p>
<p>/<em> ..or.. </em>/</p>
<p>fopFactory.setUserConfig(new File("C:/Temp/mycfg.xml"));
The layout of the configuration file is described on the <a href="configuration.html">Configuration page</a> .</p>
-<h1 id="document-handlers-wzxhzdk28wzxhzdk29">Document Handlers <a id="documenthandlers"></a></h1>
+<h2 id="document-handlers-wzxhzdk28wzxhzdk29">Document Handlers <a id="documenthandlers"></a></h2>
<p>The document handlers are classes that inherit from <code>org.apache.fop.render.intermediate.IFDocumentHandler</code> . 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.
IFDocumentHandler targetHandler = userAgent.getRendererFactory().createDocumentHandler(userAgent, MimeConstants.MIME_PDF);</p>
<p>IFSerializer ifSerializer = new IFSerializer(); //Create the IFSerializer to write the intermediate format
@@ -563,16 +564,16 @@ ifSerializer.setContext(new IFContext(us
ifSerializer.mimicDocumentHandler(targetHandler); //Tell the IFSerializer to mimic the target format</p>
<p>userAgent.setDocumentHandlerOverride(ifSerializer); //Make sure the prepared document handler is used
The rest of the code is the same as in <a href="#basics">Basic Usage Patterns</a> .</p>
-<h1 id="hints-wzxhzdk30wzxhzdk31">Hints <a id="hints"></a></h1>
-<h2 id="object-reuse-wzxhzdk32wzxhzdk33">Object reuse # <a id="object-reuse"></a></h2>
+<h2 id="hints-wzxhzdk30wzxhzdk31">Hints <a id="hints"></a></h2>
+<h3 id="object-reuse-wzxhzdk32wzxhzdk33">Object reuse # <a id="object-reuse"></a></h3>
<p>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.</p>
-<h2 id="awt-issues-wzxhzdk34wzxhzdk35">AWT issues # <a id="awt"></a></h2>
+<h3 id="awt-issues-wzxhzdk34wzxhzdk35">AWT issues # <a id="awt"></a></h3>
<p>If your XSL-FO files contain SVG then Apache Batik will be used. When Batik is initialised it uses certain classes in <code>java.awt</code> 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.</p>
<p>The thread means that the Java application may not automatically quit when finished, you will need to call <code>System.exit()</code> . These issues should be fixed in the JDK 1.4.</p>
<p>If you run into trouble running FOP on a head-less server, please see the <a href="graphics.html#batik">notes on Batik</a> .</p>
-<h2 id="getting-information-on-the-rendering-process-wzxhzdk36wzxhzdk37">Getting information on the rendering process # <a id="render-info"></a></h2>
+<h3 id="getting-information-on-the-rendering-process-wzxhzdk36wzxhzdk37">Getting information on the rendering process # <a id="render-info"></a></h3>
<p>To get the number of pages that were rendered by FOP you can call <code>Fop.getResults()</code> . This returns a <code>FormattingResults</code> 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.</p>
-<h1 id="improving-performance-wzxhzdk38wzxhzdk39">Improving performance <a id="performance"></a></h1>
+<h2 id="improving-performance-wzxhzdk38wzxhzdk39">Improving performance <a id="performance"></a></h2>
<p>There are several options to consider:</p>
<ul>
<li>
@@ -594,12 +595,12 @@ ifSerializer.mimicDocumentHandler(target
<p>You may also wish to consider trying to reduce <a href="http://xmlgraphics.apache.org/fop/trunk/running.html#memory">memory usage</a> .</p>
</li>
</ul>
-<h1 id="multithreading-fop-wzxhzdk40wzxhzdk41">Multithreading FOP <a id="multithreading"></a></h1>
+<h2 id="multithreading-fop-wzxhzdk40wzxhzdk41">Multithreading FOP <a id="multithreading"></a></h2>
<p>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.</p>
<p>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.</p>
-<h1 id="examples-wzxhzdk42wzxhzdk43">Examples <a id="examples"></a></h1>
+<h2 id="examples-wzxhzdk42wzxhzdk43">Examples <a id="examples"></a></h2>
<p>The directory "{fop-dir}/examples/embedding" contains several working examples.</p>
-<h2 id="examplefo2pdfjava-wzxhzdk44wzxhzdk45">ExampleFO2PDF.java # <a id="ExampleFO2PDF"></a></h2>
+<h3 id="examplefo2pdfjava-wzxhzdk44wzxhzdk45">ExampleFO2PDF.java # <a id="ExampleFO2PDF"></a></h3>
<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleFO2PDF.java?view=markup">example</a> demonstrates the basic usage pattern to transform an XSL-FO file to PDF using FOP.
<figure alt="Example XSL-FO to PDF" src="images/EmbeddingExampleFO2PDF.png"></figure></p>
<h2 id="examplexml2fojava-wzxhzdk48wzxhzdk49">ExampleXML2FO.java # <a id="ExampleXML2FO"></a></h2>
@@ -609,22 +610,22 @@ ifSerializer.mimicDocumentHandler(target
<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleXML2PDF.java?view=markup">example</a> 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.
<figure alt="Example XML to PDF (via XSL-FO)" src="images/EmbeddingExampleXML2PDF.png"></figure>
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.</p>
-<h2 id="exampleobj2xmljava-wzxhzdk56wzxhzdk57">ExampleObj2XML.java # <a id="ExampleObj2XML"></a></h2>
+<h3 id="exampleobj2xmljava-wzxhzdk56wzxhzdk57">ExampleObj2XML.java # <a id="ExampleObj2XML"></a></h3>
<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleObj2XML.java?view=markup">example</a> 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.
<figure alt="Example Java object to XML" src="images/EmbeddingExampleObj2XML.png"></figure>
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).</p>
<p>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.</p>
<p>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. <a href="http://java.sun.com/xml/jaxp/dist/1.1/docs/tutorial/xslt/3_generate.html">An older JAXP tutorial</a> ).</p>
-<h2 id="exampleobj2pdfjava-wzxhzdk60wzxhzdk61">ExampleObj2PDF.java # <a id="ExampleObj2PDF"></a></h2>
+<h3 id="exampleobj2pdfjava-wzxhzdk60wzxhzdk61">ExampleObj2PDF.java # <a id="ExampleObj2PDF"></a></h3>
<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleObj2PDF.java?view=markup">example</a> 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.
<figure alt="Example Java object to PDF (via XML and XSL-FO)" src="images/EmbeddingExampleObj2PDF.png"></figure></p>
<h2 id="exampledom2pdfjava-wzxhzdk64wzxhzdk65">ExampleDOM2PDF.java # <a id="ExampleDOM2PDF"></a></h2>
<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleDOM2PDF.java?view=markup">example</a> has FOP use a DOMSource instead of a StreamSource in order to use a DOM tree as input for an XSL transformation.</p>
-<h2 id="examplesvg2pdfjava-pdf-transcoder-example-wzxhzdk66wzxhzdk67">ExampleSVG2PDF.java (PDF Transcoder example) # <a id="ExampleSVG2PDF"></a></h2>
+<h3 id="examplesvg2pdfjava-pdf-transcoder-example-wzxhzdk66wzxhzdk67">ExampleSVG2PDF.java (PDF Transcoder example) # <a id="ExampleSVG2PDF"></a></h3>
<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleSVG2PDF.java?view=markup">example</a> shows the usage of the PDF Transcoder, a sub-application within FOP. It is used to generate a PDF document from an SVG file.</p>
-<h2 id="exampleconcatjava-if-concatenation-example-wzxhzdk68wzxhzdk69">ExampleConcat.java (IF Concatenation example) # <a id="ExampleConcat"></a></h2>
+<h3 id="exampleconcatjava-if-concatenation-example-wzxhzdk68wzxhzdk69">ExampleConcat.java (IF Concatenation example) # <a id="ExampleConcat"></a></h3>
<p>This can be found in the <code>embedding.intermediate</code> 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.</p>
-<h2 id="final-notes-wzxhzdk70wzxhzdk71">Final notes # <a id="example-notes"></a></h2>
+<h3 id="final-notes-wzxhzdk70wzxhzdk71">Final notes # <a id="example-notes"></a></h3>
<p>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.</p></div>
</div>
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.1/events.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.1/events.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.1/events.html Wed Oct 24 04:04:00 2012
@@ -330,12 +330,13 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/1.1/">1.1</a></div> -->
- <div class="section-content"><p><version>$Revision: 1298724 $</version></p>
-<h1 id="introduction-wzxhzdk6wzxhzdk7">Introduction <a id="introduction"></a></h1>
+ <div class="section-content"><h1 id="apachetm-fop-eventsprocessing-feedback">Apache(tm) FOP: Events/Processing Feedback</h1>
+<p><version>$Revision: 1298724 $</version></p>
+<h2 id="introduction-wzxhzdk6wzxhzdk7">Introduction <a id="introduction"></a></h2>
<p>In versions until 0.20.5, Apache™ FOP used <a href="http://excalibur.apache.org/framework/index.html">Avalon-style Logging</a> where it was possible to supply a logger per processing run. During the redesign the logging infrastructure was switched over to <a href="http://commons.apache.org/logging/">Commons Logging</a> 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.</p>
<p>With FOP's event subsystem, we'd like to close this gap again and even go further. The first point is to realize that we have two kinds of "logging". Firstly, we have the logging infrastructure for the (FOP) developer who needs to be able to enable finer log messages for certain parts of FOP to track down a certain problem. Secondly, we have the user who would like to be informed about missing images, overflowing lines or substituted fonts. These messages (or events) are targeted at less technical people and may ideally be localized (translated). Furthermore, tool and solution builders would like to integrate FOP into their own solutions. For example, an FO editor should be able to point the user to the right place where a particular problem occurred while developing a document template. Finally, some integrators would like to abort processing if a resource (an image or a font) has not been found, while others would simply continue. The event system allows to react on the
se events.</p>
<p>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).</p>
-<h1 id="the-consumer-side-wzxhzdk9wzxhzdk10">The consumer side <a id="consumer"></a></h1>
+<h2 id="the-consumer-side-wzxhzdk9wzxhzdk10">The consumer side <a id="consumer"></a></h2>
<p>The event subsystem is located in the <code>org.apache.fop.events</code> package and its base is the <code>Event</code> class. An instance is created for each event and is sent to a set of <code>EventListener</code> instances by the <code>EventBroadcaster</code> . An <code>Event</code> contains:</p>
<ul>
<li>
@@ -353,7 +354,7 @@ $(document).ready(function () {
</ul>
<p>The <code>EventFormatter</code> class can be used to translate the events into human-readable, localized messages.</p>
<p>A full example of what is shown here can be found in the <code>examples/embedding/java/embedding/events</code> directory in the FOP distribution. The example can also be accessed <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/examples/embedding/java/embedding/events/">via the web</a> .</p>
-<h2 id="writing-an-eventlistener-wzxhzdk11wzxhzdk12">Writing an EventListener # <a id="write-listener"></a></h2>
+<h3 id="writing-an-eventlistener-wzxhzdk11wzxhzdk12">Writing an EventListener # <a id="write-listener"></a></h3>
<p>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.
import org.apache.fop.events.Event;
import org.apache.fop.events.EventFormatter;
@@ -384,12 +385,12 @@ public class SysOutEventListener impleme
You can see that for every event the method <code>processEvent</code> of the <code>EventListener</code> will be called. Inside this method you can do whatever processing you would like including throwing a <code>RuntimeException</code> , if you want to abort the current processing run.</p>
<p>The code above also shows how you can turn an event into a human-readable, localized message that can be presented to a user. The <code>EventFormatter</code> class does this for you. It provides additional methods if you'd like to explicitly specify the locale.</p>
<p>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!</p>
-<h2 id="adding-an-eventlistener-wzxhzdk13wzxhzdk14">Adding an EventListener # <a id="add-listener"></a></h2>
+<h3 id="adding-an-eventlistener-wzxhzdk13wzxhzdk14">Adding an EventListener # <a id="add-listener"></a></h3>
<p>To register the event listener with FOP, get the <code>EventBroadcaster</code> which is associated with the user agent ( <code>FOUserAgent</code> ) and add it there:
FOUserAgent foUserAgent = fopFactory.newFOUserAgent();
foUserAgent.getEventBroadcaster().addEventListener(new SysOutEventListener());
Please note that this is done separately for each processing run, i.e. for each new user agent.</p>
-<h2 id="an-additional-listener-example-wzxhzdk15wzxhzdk16">An additional listener example # <a id="listener-example1"></a></h2>
+<h3 id="an-additional-listener-example-wzxhzdk15wzxhzdk16">An additional listener example # <a id="listener-example1"></a></h3>
<p>Here's an additional example of an event listener:</p>
<p>By default, FOP continues processing even if an image wasn't found. If you have more strict requirements and want FOP to stop if an image is not available, you can do something like the following in the simplest case:
public class MyEventListener implements EventListener {</p>
@@ -425,7 +426,7 @@ public class MyEventListener implements
<p>}
This throws a <code>RuntimeException</code> with the <code>FileNotFoundException</code> as the cause. Further processing effectively stops in FOP. You can catch the exception in your code and react as you see necessary.</p>
-<h1 id="the-producer-side-for-fop-developers-wzxhzdk17wzxhzdk18">The producer side (for FOP developers) <a id="producer"></a></h1>
+<h2 id="the-producer-side-for-fop-developers-wzxhzdk17wzxhzdk18">The producer side (for FOP developers) <a id="producer"></a></h2>
<p>This section is primarily for FOP and FOP plug-in developers. It describes how to use the event subsystem for producing events.
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 <a href="mailto:fop-dev@xmlgraphics.apache.org">us</a> .</p>
<h2 id="producing-and-sending-an-event-wzxhzdk19wzxhzdk20">Producing and sending an event # <a id="basic-event-production"></a></h2>
@@ -438,7 +439,7 @@ Event ev = new Event(this, "complain", E
EventBroadcaster broadcaster = [get it from somewhere];
broadcaster.broadcastEvent(ev);</p>
<p>The <code>Event.paramsBuilder()</code> is a <a href="http://en.wikipedia.org/wiki/Fluent_interface">fluent interface</a> to help with the build-up of the parameters. You could just as well instantiate a <code>Map</code> ( <code>Map<String, Object></code> ) and fill it with values.</p>
-<h2 id="the-eventproducer-interface-wzxhzdk21wzxhzdk22">The EventProducer interface # <a id="event-producer"></a></h2>
+<h3 id="the-eventproducer-interface-wzxhzdk21wzxhzdk22">The EventProducer interface # <a id="event-producer"></a></h3>
<p>To simplify event production, the event subsystem provides the <code>EventProducer</code> interface. You can create interfaces which extend <code>EventProducer</code> . 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.</p>
<p>The event producer interface does not need to have any implementation. The implementation is produced at runtime by a dynamic proxy created by <code>DefaultEventBroadcaster</code> . The dynamic proxy creates <code>Event</code> instances for each method call against the event producer interface. Each parameter (except "source") is added to the event's parameter map.</p>
<p>To simplify the code needed to get an instance of the event producer interface it is suggested to create a public inner provider class inside the interface.</p>
@@ -473,7 +474,7 @@ producer.complain(this, "I'm tired", 23)
<p>Primarily, the QDox-based collector task records the parameters' names and types. Furthermore, it extracts additional attributes embedded as Javadoc comments from the methods. At the moment, the only such attribute is "@event.severity" which indicates the default event severity (which can be changed by event listeners). The example event producer above shows the Javadocs for an event method.</p>
<p>There's one more information that is extracted from the event producer information for the event model: an optional primary exception. The first exception in the "throws" declaration of an event method is noted. It is used to throw an exception from the invocation handler if the event has an event severity of "FATAL" when all listeners have been called (listeners can update the event severity). Please note that an implementation of <code>org.apache.fop.events.EventExceptionManager$ExceptionFactory</code> has to be registered for the <code>EventExceptionManager</code> to be able to construct the exception from an event.</p>
<p>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 <code>EventModelFactory</code> . This interface is implemented for each event model and registered through the service provider mechanism (see the <a href="#plug-ins">plug-ins section</a> for details).</p>
-<h2 id="event-severity-wzxhzdk25wzxhzdk26">Event severity # <a id="event-severity"></a></h2>
+<h3 id="event-severity-wzxhzdk25wzxhzdk26">Event severity # <a id="event-severity"></a></h3>
<p>Four different levels of severity for events has been defined:</p>
<ol>
<li>
@@ -490,7 +491,7 @@ producer.complain(this, "I'm tired", 23)
</li>
</ol>
<p>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.</p>
-<h2 id="plug-ins-to-the-event-subsystem-wzxhzdk27wzxhzdk28">Plug-ins to the event subsystem # <a id="plug-ins"></a></h2>
+<h3 id="plug-ins-to-the-event-subsystem-wzxhzdk27wzxhzdk28">Plug-ins to the event subsystem # <a id="plug-ins"></a></h3>
<p>The event subsystem is extensible. There are a number of extension points:</p>
<ul>
<li>
@@ -501,7 +502,7 @@ producer.complain(this, "I'm tired", 23)
</li>
</ul>
<p>The names in bold above are used as filenames for the service provider files that are placed in the <code>META-INF/services</code> directory. That way, they are automatically detected. This is a mechanism defined by the <a href="http://java.sun.com/j2se/1.4.2/docs/guide/jar/jar.html#Service%20Provider">JAR file specification</a> .</p>
-<h2 id="localization-l10n-wzxhzdk29wzxhzdk30">Localization (L10n) # <a id="l10n"></a></h2>
+<h3 id="localization-l10n-wzxhzdk29wzxhzdk30">Localization (L10n) # <a id="l10n"></a></h3>
<p>One goal of the event subsystem was to have localized (translated) event messages. The <code>EventFormatter</code> class can be used to convert an event to a human-readable message. Each <code>EventProducer</code> 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 <code>EventFormatter</code> class).</p>
<p>The XML format used by the <code>EventFormatter</code> is the same as <a href="http://cocoon.apache.org/">Apache Cocoon's</a> catalog format. Here's an example:
<?xml version="1.0" encoding="UTF-8"?>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: commits-help@xmlgraphics.apache.org