xmlgraphics-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r813018 [7/24] - in /websites/staging/xmlgraphics/trunk/content: ./ fop/ fop/0.95/ fop/0.95/images/ fop/1.0/ fop/1.0/images/ fop/dev/ fop/dev/design/ fop/dev/fo/ fop/dev/svg/ fop/fo/ fop/trunk/ fop/trunk/images/
Date Sun, 15 Apr 2012 05:39:54 GMT
Added: websites/staging/xmlgraphics/trunk/content/fop/1.0/embedding.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/embedding.html (added)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/embedding.html Sun Apr 15 05:39:50 2012
@@ -0,0 +1,345 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+  <head>
+    <title>Apache™ FOP: Embedding</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" />
+<!--
+    <link rel="stylesheet" type="text/css" media="screen" href="http://www.apache.org/css/style.css">
+    <link rel="stylesheet" type="text/css" media="screen" href="http://www.apache.org/css/code.css">
+-->
+    <link href="/css/xmlgraphics.css" rel="stylesheet" type="text/css">
+
+    </style>
+
+    
+
+    
+    
+  </head>
+
+  <body>
+	  <div id="banner">&nbsp;
+	  </div>
+
+	  <div id="navigation">
+	  <h1 id="xml-graphics">XML Graphics</h1>
+<ul>
+<li><a href="/">Overview</a></li>
+<li><a href="/team.html">Who We Are</a></li>
+<li><a href="/legal.html">Legal Stuff</a></li>
+<li><a href="/charter.html">Project Charter</a></li>
+<li><a href="/mail.html">Mailing Lists</a></li>
+<li><a href="/repo.html">Code Repositories</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">ASF Sponsorship Program</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">ASF Thanks</a></li>
+</ul>
+<h1 id="subprojects">Subprojects</h1>
+<ul>
+<li><a href="/batik/">Batik</a></li>
+<li><a href="/fop/">FOP</a></li>
+<li><a href="/commons/">Commons</a></li>
+</ul>
+<form name="search" id="search" action="http://www.google.com/search" method="get">
+  <input value="xmlgraphics.apache.org" name="sitesearch" type="hidden"/>
+  <input type="text" name="q" id="query" /><br />
+  <input type="submit" id="submit" value="Search" />
+</form>
+	  </div>
+	
+	  <div id="bannertext">
+        <a href="/"><img src="/images/apache-xml-graphics.gif" alt="The Apache XML Graphics Project" width="220" heigh="51" /></a>
+        <h1>Apache™ FOP: Embedding</h1>
+      </div>
+        <p><a href="/">Home</a>&nbsp;&raquo&nbsp;<a href="/fop/">Fop</a>&nbsp;&raquo&nbsp;<a href="/fop/1.0/">1.0</a></p>
+      </div>
+      <div id="content" class="grid_16"><div class="section-content"><p><subtitle>How to Embed Apache� FOP in a Java application</subtitle><version>$Revision: 1298724 $</version></p>
+<h1 id="overview">Overview</h1>
+<p>Review <a href="running.html">Running 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. Renderer) to use and, if the selected renderer requires an OutputStream, which OutputStream to use for the results of the rendering. You can customize FOP's behaviour in a rendering run by supplying your own FOUserAgent instance. The FOUserAgent can, for example, be used to set your own Renderer instance (details below). Finally, you retrieve a SAX DefaultHandler instance from the Fop object and use that as the SAXResult of your transformation.
+We recently changed FOP's outer API to what we consider the final API. This might require some changes in your application. The main reasons for these changes were performance improvements due to better reuse of reusable objects and reduced use of static variables for added flexibility in complex environments.</p>
+<h1 id="basics">Basic Usage Pattern</h1>
+<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;
+import org.apache.fop.apps.Fop;
+import org.apache.fop.apps.MimeConstants;</p>
+<p>/<em>..</em>/</p>
+<p>// Step 1: Construct a FopFactory
+// (reuse if you plan to render multiple documents!)
+FopFactory fopFactory = FopFactory.newInstance();</p>
+<p>// Step 2: Set up output stream.
+// Note: Using BufferedOutputStream for performance reasons (helpful with FileOutputStreams).
+OutputStream out = new BufferedOutputStream(new FileOutputStream(new File("C:/Temp/myfile.pdf")));</p>
+<p>try {
+  // Step 3: Construct fop with desired output format
+  Fop fop = fopFactory.newFop(MimeConstants.MIME_PDF, out);</p>
+<p>// Step 4: Setup JAXP using identity transformer
+  TransformerFactory factory = TransformerFactory.newInstance();
+  Transformer transformer = factory.newTransformer(); // identity transformer</p>
+<p>// Step 5: Setup input and output for XSLT transformation
+  // Setup input stream
+  Source src = new StreamSource(new File("C:/Temp/myfile.fo"));</p>
+<p>// Resulting SAX events (the generated FO) must be piped through to FOP
+  Result res = new SAXResult(fop.getDefaultHandler());</p>
+<p>// Step 6: Start XSLT transformation and FOP processing
+  transformer.transform(src, res);</p>
+<p>} finally {
+  //Clean-up
+  out.close();
+}
+Let's discuss these 5 steps in detail:</p>
+<ul>
+<li>
+<p><strong>Step 1:</strong> You create a new FopFactory instance. The FopFactory instance holds references to configuration information and cached data. It's important to reuse this instance if you plan to render multiple documents during a JVM's lifetime.</p>
+</li>
+<li>
+<p><strong>Step 2:</strong> You set up an OutputStream that the generated document will be written to. It's a good idea to buffer the OutputStream as demonstrated to improve performance.</p>
+</li>
+<li>
+<p><strong>Step 3:</strong> You create a new Fop instance through one of the factory methods on the FopFactory. You tell the FopFactory what your desired output format is. This is done by using the MIME type of the desired output format (ex. "application/pdf"). You can use one of the MimeConstants.* constants. The second parameter is the OutputStream you've setup up in step 2.</p>
+</li>
+<li>
+<p><strong>Step 4</strong> We recommend that you use JAXP Transformers even if you don't do XSLT transformations to generate the XSL-FO file. This way you can always use the same basic pattern. The example here sets up an "identity transformer" which just passes the input (Source) unchanged to the output (Result). You don't have to work with a SAXParser if you don't do any XSLT transformations.</p>
+</li>
+<li>
+<p><strong>Step 5:</strong> Here you set up the input and output for the XSLT transformation. The Source object is set up to load the "myfile.fo" file. The Result is set up so the output of the XSLT transformation is sent to FOP. The FO file is sent to FOP in the form of SAX events which is the most efficient way. Please always avoid saving intermediate results to a file or a memory buffer because that affects performance negatively.</p>
+</li>
+<li>
+<p><strong>Step 6:</strong> Finally, we start the XSLT transformation by starting the JAXP Transformer. As soon as the JAXP Transformer starts to send its output to FOP, FOP itself starts its processing in the background. When the <code>transform()</code> method returns FOP will also have finished converting the FO file to a PDF file and you can close the OutputStream.It's a good idea to enclose the whole conversion in a try..finally statement. If you close the OutputStream in the finally section, this will make sure that the OutputStream is properly closed even if an exception occurs during the conversion.</p>
+</li>
+</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="basic-logging">Logging</h2>
+<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>
+<ul>
+<li>
+<p>(FOP-)Developer-oriented logging</p>
+</li>
+<li>
+<p><a href="events.html">User/Integrator-oriented feedback</a> (NEW!)</p>
+</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="render">Processing XSL-FO</h2>
+<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="render-with-xslt">Processing XSL-FO generated from XML+XSLT</h2>
+<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>
+<p>//with XSLT:
+  Source xslt = new StreamSource(new File("mystylesheet.xsl"));
+  Transformer transformer = factory.newTransformer(xslt);</p>
+<h1 id="input">Input Sources</h1>
+<p>The input XSL-FO document is always received by FOP as a SAX stream (see the <a href="../dev/design/parsing.html">Parsing Design Document</a> for the rationale).</p>
+<p>However, you may not always have your input document available as a SAX stream. But with JAXP it's easy to convert different input sources to a SAX stream so you can pipe it into FOP. That sounds more difficult than it is. You simply have to set up the right Source instance as input for the JAXP transformation. A few examples:</p>
+<ul>
+<li>
+<p><strong>URL:</strong>  <code>Source src = new StreamSource("http://localhost:8080/testfile.xml");</code> </p>
+</li>
+<li>
+<p><strong>File:</strong>  <code>Source src = new StreamSource(new File("C:/Temp/myinputfile.xml"));</code> </p>
+</li>
+<li>
+<p><strong>String:</strong>  <code>Source src = new StreamSource(new StringReader(myString)); // myString is a String</code> </p>
+</li>
+<li>
+<p><strong>InputStream:</strong>  <code>Source src = new StreamSource(new MyInputStream(something));</code> </p>
+</li>
+<li>
+<p><strong>Byte Array:</strong>  <code>Source src = new StreamSource(new ByteArrayInputStream(myBuffer)); // myBuffer is a byte[] here</code> </p>
+</li>
+<li>
+<p><strong>DOM:</strong>  <code>Source src = new DOMSource(myDocument); // myDocument is a Document or a Node</code> </p>
+</li>
+<li>
+<p><strong>Java Objects:</strong> Please have a look at the <a href="#examples">Embedding examples</a> which contain an example for this.</p>
+</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="config-internal">Configuring Apache FOP Programmatically</h1>
+<p>Apache FOP provides two levels on which you can customize FOP's behaviour: the FopFactory and the user agent.</p>
+<h2 id="fop-factory">Customizing the FopFactory</h2>
+<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>
+<li>
+<p>The <strong>font base URL</strong> to use when resolving relative URLs for fonts. Example:
+fopFactory.getFontManager().setFontBaseURL("file:///C:/Temp/fonts");</p>
+</li>
+<li>
+<p>The <strong>hyphenation base URL</strong> to use when resolving relative URLs for hyphenation patterns. Example:
+fopFactory.setHyphenBaseURL("file:///C:/Temp/hyph");</p>
+</li>
+<li>
+<p>Disable <strong>strict validation</strong> . When disabled FOP is less strict about the rules established by the XSL-FO specification. Example:
+fopFactory.setStrictValidation(false);</p>
+</li>
+<li>
+<p>Enable an <strong>alternative set of rules for text indents</strong> that tries to mimic the behaviour of many commercial FO implementations, that chose to break the specification in this respect. The default of this option is 'false', which causes Apache FOP to behave exactly as described in the specification. To enable the alternative behaviour, call:
+fopFactory.setBreakIndentInheritanceOnReferenceAreaBoundary(true);</p>
+</li>
+<li>
+<p>Set the <strong>source resolution</strong> for the document. This is used internally to determine the pixel size for SVG images and bitmap images without resolution information. Default: 72 dpi. Example:
+fopFactory.setSourceResolution(96); // =96dpi (dots/pixels per Inch)</p>
+</li>
+<li>
+<p>Manually add an <strong>ElementMapping instance</strong> . If you want to supply a special FOP extension you can give the instance to the FOUserAgent. Normally, the FOP extensions can be automatically detected (see the documentation on extension for more info). Example:
+fopFactory.addElementMapping(myElementMapping); // myElementMapping is a org.apache.fop.fo.ElementMapping</p>
+</li>
+<li>
+<p>Set a <strong>URIResolver</strong> for custom URI resolution. By supplying a JAXP URIResolver you can add custom URI resolution functionality to FOP. For example, you can use <a href="http://xml.apache.org/commons/components/resolver/">Apache XML Commons Resolver</a> to make use of XCatalogs. Example:
+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="user-agent">Customizing the User Agent</h2>
+<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
+  FOUserAgent userAgent = fopFactory.newFOUserAgent();
+  // customize userAgent
+  Fop fop = fopFactory.newFop(MimeConstants.MIME_POSTSCRIPT, userAgent, out);
+You can do all sorts of things on the user agent:</p>
+<ul>
+<li>
+<p>The <strong>base URL</strong> to use when resolving relative URLs. Example:
+userAgent.setBaseURL("file:///C:/Temp/");</p>
+</li>
+<li>
+<p>Set the <strong>producer</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. The default producer is "Apache FOP". Example:
+userAgent.setProducer("MyKillerApplication");</p>
+</li>
+<li>
+<p>Set the <strong>creating user</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example:
+userAgent.setCreator("John Doe");</p>
+</li>
+<li>
+<p>Set the <strong>author</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example:
+userAgent.setAuthor("John Doe");</p>
+</li>
+<li>
+<p>Override the <strong>creation date and time</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example:
+userAgent.setCreationDate(new Date());</p>
+</li>
+<li>
+<p>Set the <strong>title</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example:
+userAgent.setTitle("Invoice No 138716847");</p>
+</li>
+<li>
+<p>Set the <strong>keywords</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example:
+userAgent.setKeywords("XML XSL-FO");</p>
+</li>
+<li>
+<p>Set the <strong>target resolution</strong> for the document. This is used to specify the output resolution for bitmap images generated by bitmap renderers (such as the TIFF renderer) and by bitmaps generated by Apache Batik for filter effects and such. Default: 72 dpi. Example:
+userAgent.setTargetResolution(300); // =300dpi (dots/pixels per Inch)</p>
+</li>
+<li>
+<p>Set <strong>your own Renderer instance</strong> . If you want to supply your own renderer or configure a Renderer in a special way you can give the instance to the FOUserAgent. Normally, the Renderer instance is created by FOP. Example:
+userAgent.setRendererOverride(myRenderer); // myRenderer is an org.apache.fop.render.Renderer</p>
+</li>
+<li>
+<p>Set <strong>your own FOEventHandler instance</strong> . If you want to supply your own FOEventHandler or configure an FOEventHandler subclass in a special way you can give the instance to the FOUserAgent. Normally, the FOEventHandler instance is created by FOP. Example:
+userAgent.setFOEventHandlerOverride(myFOEventHandler); // myFOEventHandler is an org.apache.fop.fo.FOEventHandler</p>
+</li>
+<li>
+<p>Set a <strong>URIResolver</strong> for custom URI resolution. By supplying a JAXP URIResolver you can add custom URI resolution functionality to FOP. For example, you can use <a href="http://xml.apache.org/commons/components/resolver/">Apache XML Commons Resolver</a> to make use of XCatalogs. Example:
+userAgent.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 FOUserAgent is used for resolving URIs which are document-related. If it's not set or cannot resolve a URI, the URIResolver from the FopFactory is used.
+You should not reuse an FOUserAgent instance between FOP rendering runs although you can. Especially in multi-threaded environment, this is a bad idea.</p>
+</li>
+</ul>
+<h1 id="config-external">Using a Configuration File</h1>
+<p>Instead of setting the parameters manually in code as shown above you can also set many values from an XML configuration file:</p>
+<p>import org.apache.avalon.framework.configuration.Configuration;
+import org.apache.avalon.framework.configuration.DefaultConfigurationBuilder;</p>
+<p>/<em>..</em>/</p>
+<p>DefaultConfigurationBuilder cfgBuilder = new DefaultConfigurationBuilder();
+Configuration cfg = cfgBuilder.buildFromFile(new File("C:/Temp/mycfg.xml"));
+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="hints">Hints</h1>
+<h2 id="object-reuse">Object reuse</h2>
+<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">AWT issues</h2>
+<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="render-info">Getting information on the rendering process</h2>
+<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="performance">Improving performance</h1>
+<p>There are several options to consider:</p>
+<ul>
+<li>
+<p>Whenever possible, try to use SAX to couple the individual components involved (parser, XSL transformer, SQL datasource etc.).</p>
+</li>
+<li>
+<p>Depending on the target OutputStream (in case of a FileOutputStream, but not for a ByteArrayOutputStream, for example) it may improve performance considerably if you buffer the OutputStream using a BufferedOutputStream: <code>out = new java.io.BufferedOutputStream(out);</code> <br></br>Make sure you properly close the OutputStream when FOP is finished.</p>
+</li>
+<li>
+<p>Cache the stylesheet. If you use the same stylesheet multiple times you can set up a JAXP <code>Templates</code> object and reuse it each time you do the XSL transformation. (More information can be found <a href="http://www.javaworld.com/javaworld/jw-05-2003/jw-0502-xsl.html">here</a> .)</p>
+</li>
+<li>
+<p>Use an XSLT compiler like <a href="http://xml.apache.org/xalan-j/xsltc_usage.html">XSLTC</a> that comes with Xalan-J.</p>
+</li>
+<li>
+<p>Fine-tune your stylesheet to make the XSLT process more efficient and to create XSL-FO that can be processed by FOP more efficiently. Less is more: Try to make use of property inheritance where possible.</p>
+</li>
+<li>
+<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">Multithreading FOP</h1>
+<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">Examples</h1>
+<p>The directory "{fop-dir}/examples/embedding" contains several working examples.</p>
+<h2 id="ExampleFO2PDF">ExampleFO2PDF.java</h2>
+<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="ExampleXML2FO">ExampleXML2FO.java</h2>
+<p>This <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleXML2FO.java?view=markup">example</a> 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. <a href="http://xml.apache.org/xalan-j">Xalan</a> ).
+<figure alt="Example XML to XSL-FO" src="images/EmbeddingExampleXML2FO.png"></figure></p>
+<h2 id="ExampleXML2PDF">ExampleXML2PDF.java</h2>
+<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="ExampleObj2XML">ExampleObj2XML.java</h2>
+<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="ExampleObj2PDF">ExampleObj2PDF.java</h2>
+<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="ExampleDOM2PDF">ExampleDOM2PDF.java</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="ExampleSVG2PDF">ExampleSVG2PDF.java (PDF Transcoder example)</h2>
+<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="example-notes">Final notes</h2>
+<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>
+      <div class="clear"></div>
+
+	  <div id="footer">
+		<a alt="Apache Software Foundation" href="http://www.apache.org">
+		  <img id="asf-logo" alt="Apache Software Foundation" src="/images/feather-small.gif"/ width="100">
+		</a>
+		<div class="copyright">
+		  <p>
+			Copyright &copy; 2011 The Apache Software Foundation, Licensed under
+			the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+			<br />
+			Apache, Apache XML Graphics, the Apache feather logo, and the Apache XML Graphics logos are
+			trademarks of <a href="http://www.apache.org">The Apache Software Foundation</a>. All other
+			marks mentioned may be trademarks or registered trademarks of their respective owners.
+			<br />
+		  </p>
+		</div> 
+	  </div>
+  </body>
+</html>

Added: websites/staging/xmlgraphics/trunk/content/fop/1.0/events.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/events.html (added)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/events.html Sun Apr 15 05:39:50 2012
@@ -0,0 +1,269 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+  <head>
+    <title>Apache™ FOP: Events/Processing Feedback</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" />
+<!--
+    <link rel="stylesheet" type="text/css" media="screen" href="http://www.apache.org/css/style.css">
+    <link rel="stylesheet" type="text/css" media="screen" href="http://www.apache.org/css/code.css">
+-->
+    <link href="/css/xmlgraphics.css" rel="stylesheet" type="text/css">
+
+    </style>
+
+    
+
+    
+    
+  </head>
+
+  <body>
+	  <div id="banner">&nbsp;
+	  </div>
+
+	  <div id="navigation">
+	  <h1 id="xml-graphics">XML Graphics</h1>
+<ul>
+<li><a href="/">Overview</a></li>
+<li><a href="/team.html">Who We Are</a></li>
+<li><a href="/legal.html">Legal Stuff</a></li>
+<li><a href="/charter.html">Project Charter</a></li>
+<li><a href="/mail.html">Mailing Lists</a></li>
+<li><a href="/repo.html">Code Repositories</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">ASF Sponsorship Program</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">ASF Thanks</a></li>
+</ul>
+<h1 id="subprojects">Subprojects</h1>
+<ul>
+<li><a href="/batik/">Batik</a></li>
+<li><a href="/fop/">FOP</a></li>
+<li><a href="/commons/">Commons</a></li>
+</ul>
+<form name="search" id="search" action="http://www.google.com/search" method="get">
+  <input value="xmlgraphics.apache.org" name="sitesearch" type="hidden"/>
+  <input type="text" name="q" id="query" /><br />
+  <input type="submit" id="submit" value="Search" />
+</form>
+	  </div>
+	
+	  <div id="bannertext">
+        <a href="/"><img src="/images/apache-xml-graphics.gif" alt="The Apache XML Graphics Project" width="220" heigh="51" /></a>
+        <h1>Apache™ FOP: Events/Processing Feedback</h1>
+      </div>
+        <p><a href="/">Home</a>&nbsp;&raquo&nbsp;<a href="/fop/">Fop</a>&nbsp;&raquo&nbsp;<a href="/fop/1.0/">1.0</a></p>
+      </div>
+      <div id="content" class="grid_16"><div class="section-content"><p><version>$Revision: 1298724 $</version></p>
+<h1 id="introduction">Introduction</h1>
+<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="consumer">The consumer side</h1>
+<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>
+<p>an event ID,</p>
+</li>
+<li>
+<p>a source object (which generated the event),</p>
+</li>
+<li>
+<p>a severity level (Info, Warning, Error and Fatal Error) and</p>
+</li>
+<li>
+<p>a map of named parameters.</p>
+</li>
+</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="write-listener">Writing an EventListener</h2>
+<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;
+import org.apache.fop.events.EventListener;
+import org.apache.fop.events.model.EventSeverity;</p>
+<p>/*<em> A simple event listener that writes the events to stdout and stderr. </em>/
+public class SysOutEventListener implements EventListener {</p>
+<div class="codehilite"><pre><span class="sr">/** {@inheritDoc} */</span>
+<span class="n">public</span> <span class="n">void</span> <span class="n">processEvent</span><span class="p">(</span><span class="n">Event</span> <span class="n">event</span><span class="p">)</span> <span class="p">{</span>
+    <span class="n">String</span> <span class="n">msg</span> <span class="o">=</span> <span class="n">EventFormatter</span><span class="o">.</span><span class="nb">format</span><span class="p">(</span><span class="n">event</span><span class="p">);</span>
+    <span class="n">EventSeverity</span> <span class="n">severity</span> <span class="o">=</span> <span class="n">event</span><span class="o">.</span><span class="n">getSeverity</span><span class="p">();</span>
+    <span class="k">if</span> <span class="p">(</span><span class="n">severity</span> <span class="o">==</span> <span class="n">EventSeverity</span><span class="o">.</span><span class="n">INFO</span><span class="p">)</span> <span class="p">{</span>
+        <span class="n">System</span><span class="o">.</span><span class="n">out</span><span class="o">.</span><span class="n">println</span><span class="p">(</span><span class="s">&quot;[INFO ] &quot;</span> <span class="o">+</span> <span class="n">msg</span><span class="p">);</span>
+    <span class="p">}</span> <span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="n">severity</span> <span class="o">==</span> <span class="n">EventSeverity</span><span class="o">.</span><span class="n">WARN</span><span class="p">)</span> <span class="p">{</span>
+        <span class="n">System</span><span class="o">.</span><span class="n">out</span><span class="o">.</span><span class="n">println</span><span class="p">(</span><span class="s">&quot;[WARN ] &quot;</span> <span class="o">+</span> <span class="n">msg</span><span class="p">);</span>
+    <span class="p">}</span> <span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="n">severity</span> <span class="o">==</span> <span class="n">EventSeverity</span><span class="o">.</span><span class="n">ERROR</span><span class="p">)</span> <span class="p">{</span>
+        <span class="n">System</span><span class="o">.</span><span class="n">err</span><span class="o">.</span><span class="n">println</span><span class="p">(</span><span class="s">&quot;[ERROR] &quot;</span> <span class="o">+</span> <span class="n">msg</span><span class="p">);</span>
+    <span class="p">}</span> <span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="n">severity</span> <span class="o">==</span> <span class="n">EventSeverity</span><span class="o">.</span><span class="n">FATAL</span><span class="p">)</span> <span class="p">{</span>
+        <span class="n">System</span><span class="o">.</span><span class="n">err</span><span class="o">.</span><span class="n">println</span><span class="p">(</span><span class="s">&quot;[FATAL] &quot;</span> <span class="o">+</span> <span class="n">msg</span><span class="p">);</span>
+    <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
+        <span class="n">assert</span> <span class="n">false</span><span class="p">;</span>
+    <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>}
+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="add-listener">Adding an EventListener</h2>
+<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="listener-example1">An additional listener example</h2>
+<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>
+<div class="codehilite"><pre><span class="n">public</span> <span class="n">void</span> <span class="n">processEvent</span><span class="p">(</span><span class="n">Event</span> <span class="n">event</span><span class="p">)</span> <span class="p">{</span>
+    <span class="k">if</span> <span class="p">(</span><span class="s">&quot;org.apache.fop.ResourceEventProducer&quot;</span><span class="o">.</span><span class="n">equals</span><span class="p">(</span>
+            <span class="n">event</span><span class="o">.</span><span class="n">getEventGroupID</span><span class="p">()))</span> <span class="p">{</span>
+        <span class="n">event</span><span class="o">.</span><span class="n">setSeverity</span><span class="p">(</span><span class="n">EventSeverity</span><span class="o">.</span><span class="n">FATAL</span><span class="p">);</span>
+    <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
+        <span class="sr">//ig</span><span class="n">nore</span> <span class="n">all</span> <span class="n">other</span> <span class="n">events</span> <span class="p">(</span><span class="ow">or</span> <span class="k">do</span> <span class="n">something</span> <span class="n">of</span> <span class="n">your</span> <span class="n">choice</span><span class="p">)</span>
+    <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>}
+Increasing the event severity to FATAL will signal the event broadcaster to throw an exception and stop further processing. In the above case, all resource-related events will cause FOP to stop processing.</p>
+<p>You can also customize the exception to throw (you can may throw a RuntimeException or subclass yourself) and/or which event to respond to:
+public class MyEventListener implements EventListener {</p>
+<div class="codehilite"><pre><span class="n">public</span> <span class="n">void</span> <span class="n">processEvent</span><span class="p">(</span><span class="n">Event</span> <span class="n">event</span><span class="p">)</span> <span class="p">{</span>
+    <span class="k">if</span> <span class="p">(</span><span class="s">&quot;org.apache.fop.ResourceEventProducer.imageNotFound&quot;</span>
+            <span class="o">.</span><span class="n">equals</span><span class="p">(</span><span class="n">event</span><span class="o">.</span><span class="n">getEventID</span><span class="p">()))</span> <span class="p">{</span>
+
+        <span class="sr">//</span><span class="n">Get</span> <span class="n">the</span> <span class="n">FileNotFoundException</span> <span class="n">that</span><span class="s">&#39;s part of the event&#39;</span><span class="n">s</span> <span class="n">parameters</span>
+        <span class="n">FileNotFoundException</span> <span class="n">fnfe</span> <span class="o">=</span> <span class="p">(</span><span class="n">FileNotFoundException</span><span class="p">)</span><span class="n">event</span><span class="o">.</span><span class="n">getParam</span><span class="p">(</span><span class="s">&quot;fnfe&quot;</span><span class="p">);</span>
+
+        <span class="n">throw</span> <span class="k">new</span> <span class="n">RuntimeException</span><span class="p">(</span><span class="n">EventFormatter</span><span class="o">.</span><span class="nb">format</span><span class="p">(</span><span class="n">event</span><span class="p">),</span> <span class="n">fnfe</span><span class="p">);</span>
+    <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
+        <span class="sr">//ig</span><span class="n">nore</span> <span class="n">all</span> <span class="n">other</span> <span class="n">events</span> <span class="p">(</span><span class="ow">or</span> <span class="k">do</span> <span class="n">something</span> <span class="n">of</span> <span class="n">your</span> <span class="n">choice</span><span class="p">)</span>
+    <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<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="producer">The producer side (for FOP developers)</h1>
+<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="basic-event-production">Producing and sending an event</h2>
+<p>The basics are very simple. Just instantiate an <code>Event</code> object and fill it with the necessary parameters. Then pass it to the <code>EventBroadcaster</code> which distributes the events to the interested listeneners. Here's a code example:
+Event ev = new Event(this, "complain", EventSeverity.WARN,
+        Event.paramsBuilder()
+            .param("reason", "I'm tired")
+            .param("blah", new Integer(23))
+            .build());
+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&lt;String, Object&gt;</code> ) and fill it with values.</p>
+<h2 id="event-producer">The EventProducer interface</h2>
+<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>
+<p>Here's an example of such an event producer interface:
+public interface MyEventProducer extends EventProducer {</p>
+<div class="codehilite"><pre><span class="n">public</span> <span class="n">class</span> <span class="n">Provider</span> <span class="p">{</span>
+
+    <span class="n">public</span> <span class="n">static</span> <span class="n">MyEventProducer</span> <span class="n">get</span><span class="p">(</span><span class="n">EventBroadcaster</span> <span class="n">broadcaster</span><span class="p">)</span> <span class="p">{</span>
+        <span class="k">return</span> <span class="p">(</span><span class="n">MyEventProducer</span><span class="p">)</span><span class="n">broadcaster</span><span class="o">.</span><span class="n">getEventProducerFor</span><span class="p">(</span><span class="n">MyEventProducer</span><span class="o">.</span><span class="n">class</span><span class="p">);</span>
+    <span class="p">}</span>
+<span class="p">}</span>
+
+<span class="o">/**</span>
+ <span class="o">*</span> <span class="n">Complain</span> <span class="n">about</span> <span class="n">something</span><span class="o">.</span>
+ <span class="o">*</span> <span class="nv">@param</span> <span class="n">source</span> <span class="n">the</span> <span class="n">event</span> <span class="n">source</span>
+ <span class="o">*</span> <span class="nv">@param</span> <span class="n">reason</span> <span class="n">the</span> <span class="n">reason</span> <span class="k">for</span> <span class="n">the</span> <span class="n">complaint</span>
+ <span class="o">*</span> <span class="nv">@param</span> <span class="n">blah</span> <span class="n">the</span> <span class="n">complaint</span>
+ <span class="o">*</span> <span class="nv">@event</span><span class="o">.</span><span class="n">severity</span> <span class="n">WARN</span>
+ <span class="o">*/</span>
+<span class="n">void</span> <span class="n">complain</span><span class="p">(</span><span class="n">Object</span> <span class="n">source</span><span class="p">,</span> <span class="n">String</span> <span class="n">reason</span><span class="p">,</span> <span class="nb">int</span> <span class="n">blah</span><span class="p">);</span>
+</pre></div>
+
+
+<p>}
+To produce the same event as in the first example above, you'd use the following code:
+EventBroadcaster broadcaster = [get it from somewhere];
+TestEventProducer producer = TestEventProducer.Provider.get(broadcaster);
+producer.complain(this, "I'm tired", 23);</p>
+<h2 id="event-model">The event model</h2>
+<p>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 <code>Event</code> 's parameter map we need to know the parameter names. These are retrieved from an event object model. This is found in the <code>org.apache.fop.events.model</code> 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 ( <code>ant resourcegen</code> ). The Ant task (found in <code>src/codegen/java/org/apache/fop/tools/EventProducerCollectorTask.java</code> ) scans FOP's sources for descendants of the <code>EventProducer</code> interface and uses <a href="http://qdox.codehaus.org/">QDox</a> to parse these interfaces.</p>
+<p>The event model XML files are generated during build by the Ant task mentioned above when running the "resourcegen" task. So just run <code>"ant resourcegen"</code> if you receive a <code>MissingResourceException</code> at runtime indicating that <code>"event-model.xml"</code> is missing.</p>
+<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">Event severity</h2>
+<p>Four different levels of severity for events has been defined:</p>
+<ol>
+<li>
+<p>INFO: informational only</p>
+</li>
+<li>
+<p>WARN: a Warning</p>
+</li>
+<li>
+<p>ERROR: an error condition from which FOP can recover. FOP will continue processing.</p>
+</li>
+<li>
+<p>FATAL: a fatal error which causes an exception in the end and FOP will stop processing.</p>
+</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">Plug-ins to the event subsystem</h2>
+<p>The event subsystem is extensible. There are a number of extension points:</p>
+<ul>
+<li>
+<p><strong> <code>org.apache.fop.events.model.EventModelFactory</code> :</strong> Provides an event model to the event subsystem.</p>
+</li>
+<li>
+<p><strong> <code>org.apache.fop.events.EventExceptionManager$ExceptionFactory</code> :</strong> Creates exceptions for events, i.e. turns an event into a specific exception.</p>
+</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="l10n">Localization (L10n)</h2>
+<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:
+&lt;?xml version="1.0" encoding="UTF-8"?&gt;
+<catalogue xml:lang="en">
+  <message key="locator">
+    [ (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}}
+  </message>
+  <message key="org.apache.fop.render.rtf.RTFEventProducer.ignoredDeferredEvent">
+    Ignored deferred event for {node} ({start,if,start,end}).{{locator}}
+  </message>
+</catalogue></p>
+<p>The example (extracted from the RTF handler's event producer) has message templates for two event methods. The class used to do variable replacement in the templates is <code>org.apache.fop.util.text.AdvancedMessageFormat</code> which is more powerful than the <code>MessageFormat</code> classes provided by the Java class library ( <code>java.util.text</code> package).</p>
+<p>"locator" is a template that is reused by the other message templates by referencing it through "{{locator}}". This is some kind of include command.</p>
+<p>Normal event parameters are accessed by name inside single curly braces, for example: "{node}". For objects, this format just uses the <code>toString()</code> method to turn the object into a string, unless there is an <code>ObjectFormatter</code> registered for that type (there's an example for <code>org.xml.sax.Locator</code> ).</p>
+<p>The single curly braces pattern supports additional features. For example, it is possible to do this: "{start,if,start,end}". "if" here is a special field modifier that evaluates "start" as a boolean and if that is true returns the text right after the second comma ("start"). Otherwise it returns the text after the third comma ("end"). The "equals" modifier is similar to "if" but it takes as an additional (comma-separated) parameter right after the "equals" modifier, a string that is compared to the value of the variable. An example: {severity,equals,EventSeverity:FATAL,,some text} (this adds "some text" if the severity is not FATAL).</p>
+<p>Additional such modifiers can be added by implementing the <code>AdvancedMessageFormat$Part</code> and <code>AdvancedMessageFormat$PartFactory</code> interfaces.</p>
+<p>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).</p>
+<p>Developers can also register a function (in the above example: <code>{#gatherContextInfo})</code> to do more complex information rendering. These functions are implementations of the <code>AdvancedMessageFormat$Function</code> interface. Please take care that this is done in a locale-independent way as there is no locale information available, yet.</p></div></div>
+      <div class="clear"></div>
+
+	  <div id="footer">
+		<a alt="Apache Software Foundation" href="http://www.apache.org">
+		  <img id="asf-logo" alt="Apache Software Foundation" src="/images/feather-small.gif"/ width="100">
+		</a>
+		<div class="copyright">
+		  <p>
+			Copyright &copy; 2011 The Apache Software Foundation, Licensed under
+			the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+			<br />
+			Apache, Apache XML Graphics, the Apache feather logo, and the Apache XML Graphics logos are
+			trademarks of <a href="http://www.apache.org">The Apache Software Foundation</a>. All other
+			marks mentioned may be trademarks or registered trademarks of their respective owners.
+			<br />
+		  </p>
+		</div> 
+	  </div>
+  </body>
+</html>

Added: websites/staging/xmlgraphics/trunk/content/fop/1.0/extensions.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/extensions.html (added)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/extensions.html Sun Apr 15 05:39:50 2012
@@ -0,0 +1,212 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+  <head>
+    <title>Standard Apache™ FOP Extensions</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" />
+<!--
+    <link rel="stylesheet" type="text/css" media="screen" href="http://www.apache.org/css/style.css">
+    <link rel="stylesheet" type="text/css" media="screen" href="http://www.apache.org/css/code.css">
+-->
+    <link href="/css/xmlgraphics.css" rel="stylesheet" type="text/css">
+
+    </style>
+
+    
+
+    
+    
+  </head>
+
+  <body>
+	  <div id="banner">&nbsp;
+	  </div>
+
+	  <div id="navigation">
+	  <h1 id="xml-graphics">XML Graphics</h1>
+<ul>
+<li><a href="/">Overview</a></li>
+<li><a href="/team.html">Who We Are</a></li>
+<li><a href="/legal.html">Legal Stuff</a></li>
+<li><a href="/charter.html">Project Charter</a></li>
+<li><a href="/mail.html">Mailing Lists</a></li>
+<li><a href="/repo.html">Code Repositories</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">ASF Sponsorship Program</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">ASF Thanks</a></li>
+</ul>
+<h1 id="subprojects">Subprojects</h1>
+<ul>
+<li><a href="/batik/">Batik</a></li>
+<li><a href="/fop/">FOP</a></li>
+<li><a href="/commons/">Commons</a></li>
+</ul>
+<form name="search" id="search" action="http://www.google.com/search" method="get">
+  <input value="xmlgraphics.apache.org" name="sitesearch" type="hidden"/>
+  <input type="text" name="q" id="query" /><br />
+  <input type="submit" id="submit" value="Search" />
+</form>
+	  </div>
+	
+	  <div id="bannertext">
+        <a href="/"><img src="/images/apache-xml-graphics.gif" alt="The Apache XML Graphics Project" width="220" heigh="51" /></a>
+        <h1>Standard Apache™ FOP Extensions</h1>
+      </div>
+        <p><a href="/">Home</a>&nbsp;&raquo&nbsp;<a href="/fop/">Fop</a>&nbsp;&raquo&nbsp;<a href="/fop/1.0/">1.0</a></p>
+      </div>
+      <div id="content" class="grid_16"><div class="section-content"><p><version>$Revision: 1298724 $</version></p>
+<p>By "extension", we mean any data that can be placed in the input XML document that is not addressed by the XSL-FO standard. By having a mechanism for supporting extensions, Apache™ FOP is able to add features that are not covered in the specification.</p>
+<p>The extensions documented here are included with FOP, and are automatically available to you. If you wish to add an extension of your own to FOP, please see the <a href="../dev/extensions.html">Developers' Extension Page</a> .
+All extensions require the correct use of an appropriate namespace in your input document.</p>
+<h1 id="svg">SVG</h1>
+<p>Please see the <a href="graphics.html#svg">SVG documentation</a> for more details.</p>
+<h1 id="fo-extensions">FO Extensions</h1>
+<h2 id="fox-namespace">Namespace</h2>
+<p>By convention, FO extensions in FOP use the "fox" namespace prefix. To use any of the FO extensions, add a namespace entry for <code>http://xmlgraphics.apache.org/fop/extensions</code> to the root element:
+<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format"
+               xmlns:fox="http://xmlgraphics.apache.org/fop/extensions"></p>
+<h2 id="bookmarks">PDF Bookmarks</h2>
+<p>In previous versions of Apache FOP there was a <code>fox:outline</code> element which was used to create outlines in PDF files. The redesigned code makes use of the new <a href="http://www.w3.org/TR/xsl11/#fo_bookmark-tree">bookmark feature defined in the latest XSL 1.1 working draft</a> .</p>
+<h2 id="named-destinations">Anchors or Named Destinations</h2>
+<p>Use the fox:destination element to define "named destinations" inside a PDF document. These are useful as fragment identifiers, e.g. "http://server/document.pdf#anchor-name". fox:destination elements can be placed almost anywhere in the fo document, including a child of root, a block-level element, or an inline-level element. For the destination to actually work, it must correspond to an "id" attribute on some fo element within the document. In other words, the "id" attribute actually creates the "view" within the PDF document. The fox:destination simply gives that view an independent name.
+<fox:destination internal-destination="table-of-contents"/>
+...
+<fo:block id="table-of-contents">Table of Contents</fo:block><warning>It is possible that in some future release of FOP, <em>all</em> elements with "id" attributes will generate named-destinations, which will eliminate the need for fox:destination.</warning></p>
+<h2 id="table-continue-label">Table Continuation Label</h2>
+<p>This extension element hasn't been reimplemented for the redesigned code, yet.</p>
+<h2 id="widow-orphan-content-limit">fox:orphan-content-limit and fox:widow-content-limit</h2>
+<p>The two proprietary extension properties, fox:orphan-content-limit and fox:widow-content-limit, are used to improve the layout of list-blocks and tables. If you have a table with many entries, you don't want a single row to be left over on a page. You will want to make sure that at least two or three lines are kept together. The properties take an absolute length which specifies the area at the beginning (fox:widow-content-limit) or at the end (fox:orphan-content-limit) of a table or list-block. The properties are inherited and only have an effect on fo:table and fo:list-block. An example: fox:widow-content-limit="3 * 1.2em" would make sure the you'll have at least three lines (assuming line-height="1.2") together on a table or list-block.</p>
+<h2 id="external-document">fox:external-document</h2>
+<p>This feature is incomplete. Support for multi-page documents will be added shortly. At the moment, only single-page images will work. And this will not work with RTF output.
+This is a proprietary extension element which allows to add whole images as pages to an FO document. For example, if you have a scanned document or a fax as multi-page TIFF file, you can append or insert this document using the <code>fox:external-document</code> element. Each page of the external document will create one full page in the target format.</p>
+<p>The <code>fox:external-document</code> element is structurally a peer to <code>fo:page-sequence</code> , so wherever you can put an <code>fo:page-sequence</code> you could also place a <code>fox:external-document</code> . Therefore, the specified contents for <code>fo:root</code> change to:</p>
+<p><code>(layout-master-set, declarations?, bookmark-tree?, (page-sequence|page-sequence-wrapper|fox:external-document|fox:destination)+)</code> </p>
+<h3 id="Specification">Specification</h3>
+<p>The <code>fox:external-document</code> extension formatting object is used to specify how to create a (sub-)sequence of pages within a document. The content of these pages comes from the individual subimages/pages of an image or paged document (for example: multi-page TIFF in the form of faxes or scanned documents, or PDF files). The formatting object creates the necessary areas to display one image per page.</p>
+<p>In terms of page numbers, the behaviour is the same as for <code>fo:page-sequence</code> . The placement of the image inside the page is similar to that of <code>fo:external-graphic</code> or <code>fo:instream-foreign-object</code> , i.e. the viewport (and therefore the page size) is defined by either the intrinsic size of the image or by the size properties that apply to this formatting object.</p>
+<p>Content: EMPTY</p>
+<p>The following properties apply to this formatting object:</p>
+<ul>
+<li>
+<p>(Common Accessibility Properties) (not implemented, yet)</p>
+</li>
+<li>
+<p>(Common Aural Properties) (not implemented, yet)</p>
+</li>
+<li>
+<p>block-progression-dimension</p>
+</li>
+<li>
+<p>content-height</p>
+</li>
+<li>
+<p>content-type</p>
+</li>
+<li>
+<p>content-width</p>
+</li>
+<li>
+<p>display-align</p>
+</li>
+<li>
+<p>height</p>
+</li>
+<li>
+<p>id</p>
+</li>
+<li>
+<p>inline-progression-dimension</p>
+</li>
+<li>
+<p>overflow</p>
+</li>
+<li>
+<p>pages: <page-set> (see below) (not implemented, yet)</p>
+</li>
+<li>
+<p>reference-orientation</p>
+</li>
+<li>
+<p>scaling</p>
+</li>
+<li>
+<p>scaling-method</p>
+</li>
+<li>
+<p>src</p>
+</li>
+<li>
+<p>text-align</p>
+</li>
+<li>
+<p>width</p>
+</li>
+</ul>
+<p>Datatype "page-set": Value: auto | <integer-range>, Default: "auto" which means all pages/subimages of the document. <integer-range> allows values such as "7" or "1-3"
+ <code>fox:external-document</code> is not suitable for concatenating FO documents. For this, XInclude is recommended.</p>
+<h2 id="transform">Free-form Transformation for fo:block-container</h2>
+<p>For <code>fo:block-container</code> elements whose <code>absolute-position</code> set to "absolute" or "fixed" you can use the extension attribute <code>fox:transform</code> to apply a free-form transformation to the whole block-container. The content of the <code>fox:transform</code> attribute is the same as for <a href="http://www.w3.org/TR/SVG/coords.html#TransformAttribute">SVG's transform attribute</a> . The transformation specified here is performed in addition to other implicit transformations of the block-container (resulting from top, left and other properties) and after them.</p>
+<p>Examples: <code>fox:transform="rotate(45)"</code> would rotate the block-container by 45 degrees clock-wise around its upper-left corner. <code>fox:transform="translate(10000,0)"</code> would move the block-container to the right by 10 points (=10000 millipoints, FOP uses millipoints internally!).
+This extension attribute doesn't work for all output formats! It's currently only supported for PDF, PS and Java2D-based renderers.</p>
+<h2 id="color-functions">Color functions</h2>
+<p>XSL-FO supports specifying color using the rgb(), rgb-icc() and system-color() functions. Apache FOP provides additional color functions for special use cases. Please note that using these functions compromises the interoperability of an FO document.</p>
+<h3 id="color-function-cmyk">cmyk()</h3>
+<p><code>color cmyk(numeric, numeric, numeric, numeric)</code> </p>
+<p>This function will construct a color in device-specific CMYK color space. The numbers must be between 0.0 and 1.0. For output formats that don't support device-specific color space the CMYK value is converted to an sRGB value.</p>
+<h3 id="pseudo-color-profiles">#CMYK pseudo-profile</h3>
+<p><code>color rgb-icc(numeric, numeric, numeric, #CMYK, numeric, numeric, numeric, numeric)</code> </p>
+<p>The <code>rgb-icc</code> function will respond to a pseudo-profile called "#CMYK" which indicates a device-specific CMYK color space. The "#CMYK" profile is implicitely available and doesn't have to be (and cannot be) defined through an <code>fo:color-profile</code> element. It is provided for compatibility with certain commercial XSL-FO implementations. Please note that this is not part of the official specification but rather a convention. The following two color specifications are equivalent:</p>
+<ul>
+<li>
+<p><code>cmyk(0%,0%,20%,40%)</code> </p>
+</li>
+<li>
+<p><code>rgb-icc(153, 153, 102, #CMYK, 0, 0, 0.2, 0.4)</code> </p>
+</li>
+</ul>
+<h2 id="prepress">Prepress Support</h2>
+<p>This section defines a number of extensions related to <a href="http://en.wikipedia.org/wiki/Prepress">prepress</a> support. <code>fox:scale</code> defines a general scale factor for the generated pages. <code>fox:bleed</code> defines the <a href="http://en.wikipedia.org/wiki/Bleed_%28printing%29">bleed area</a> for a page. <code>fox:crop-offset</code> defines the outer edges of the area in which crop marks, registration marks, color bars and page information are placed. For details, please read on below.
+Those extensions have been implemented in the PDF and Java2D renderers only.</p>
+<h3 id="scale">fox:scale</h3>
+<p>Value: <number>{1,2}</p>
+<p>Initial: 1</p>
+<p>Applies to: fo:simple-page-master</p>
+<p>This property specifies a scale factor along resp. the x and y axes. If only one number is provided it is used for both the x and y scales. A scale factor smaller than 1 shrinks the page. A scale factor greater than 1 enlarges the page.</p>
+<h3 id="bleed">fox:bleed</h3>
+<p>Value: <length>{1,4}</p>
+<p>Initial: 0pt</p>
+<p>Applies to: fo:simple-page-master</p>
+<p>If there is only one value, it applies to all sides. If there are two values, the top and bottom bleed widths are set to the first value and the right and left bleed widths are set to the second. If there are three values, the top is set to the first value, the left and right are set to the second, and the bottom is set to the third. If there are four values, they apply to the top, right, bottom, and left, respectively. (Corresponds to <a href="http://www.w3.org/TR/xsl11/#padding">the definition of padding</a> ).</p>
+<p>This extension indirectly defines the BleedBox and is calculated by expanding the TrimBox by the bleed widths. The lengths must be non-negative.</p>
+<h3 id="cropOffset">fox:crop-offset</h3>
+<p>Value: <length>{1,4}</p>
+<p>Initial: bleed (see below)</p>
+<p>Applies to: fo:simple-page-master</p>
+<p>Same behaviour as with fox:bleed. The initial value is set to the same values as the fox:bleed property.</p>
+<p>This extension indirectly defines the MediaBox and is calculated by expanding the TrimBox by the crop offsets. The lengths must be non-negative.</p>
+<h3 id="cropBox">fox:crop-box</h3>
+<p>Value: [trim-box | bleed-box | media-box]</p>
+<p>Initial: media-box</p>
+<p>Applies to: fo:simple-page-master</p>
+<p>The crop box controls how Acrobat displays the page (CropBox in PDF) or how the Java2DRenderer sizes the output media. The PDF specification defines that the CropBox defaults to the MediaBox. This extension follows that definition. To simplify usage and cover most use cases, the three supported enumeration values "trim-box", "bleed-box" and "media-box" set the CropBox to one of those three other boxes.</p>
+<p>If requested in the future, we could offer to specify the CropBox in absolute coordinates rather than just by referencing another box.</p></div></div>
+      <div class="clear"></div>
+
+	  <div id="footer">
+		<a alt="Apache Software Foundation" href="http://www.apache.org">
+		  <img id="asf-logo" alt="Apache Software Foundation" src="/images/feather-small.gif"/ width="100">
+		</a>
+		<div class="copyright">
+		  <p>
+			Copyright &copy; 2011 The Apache Software Foundation, Licensed under
+			the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+			<br />
+			Apache, Apache XML Graphics, the Apache feather logo, and the Apache XML Graphics logos are
+			trademarks of <a href="http://www.apache.org">The Apache Software Foundation</a>. All other
+			marks mentioned may be trademarks or registered trademarks of their respective owners.
+			<br />
+		  </p>
+		</div> 
+	  </div>
+  </body>
+</html>



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: commits-help@xmlgraphics.apache.org


Mime
View raw message