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:26:12 UTC
svn commit: r835978 [5/16] - 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/0.95/releaseNotes_0.95.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/0.95/releaseNotes_0.95.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/0.95/releaseNotes_0.95.html Wed Oct 24 04:26:06 2012
@@ -357,17 +357,17 @@ Besides the important changes listed bel
<p>If more flexibility is needed, then the fo:table-column elements may be just omitted. The final number of columns will then be set by the row that has the most cells.</p>
<p>The image libraries Jimi and JAI are no longer needed (and used) for image loading. Instead we rely completely on the Image I/O API that has been introduced with Java 1.4. If you still need support for bitmap image formats that do not work out-of-the-box, we recommend adding <a href="http://jai-imageio.dev.java.net/">JAI Image I/O Tools</a> (an Image I/O compatible image codec package) to the classpath. JAI is still required for building the FOP distribution but it is optional for normal builds and at run-time.
This final 0.95 release also includes all of the <a href="changes_0.95beta.html">changes made for Apache FOP 0.95beta</a> .</section></notes></p>
-<h1 id="major-changes-in-version-095-wzxhzdk4wzxhzdk5">Major Changes in Version 0.95 <a id="version_0.95"></a></h1>
+<h1 id="major-changes-in-version-095-wzxhzdk4wzxhzdk5">Major Changes in Version 0.95 <a id="version_0.95"></a></h1>
<p>This is not a complete list of changes, just some of the more important ones. A full list of changes in this release <a href="changes_0.95.html">is available</a> .</p>
-<h2 id="changes-to-the-code-base-wzxhzdk6wzxhzdk7">Changes to the Code Base # <a id="Changes+to+the+Code+Base"></a></h2>
+<h2 id="changes-to-the-code-base-wzxhzdk6wzxhzdk7">Changes to the Code Base <a id="Changes+to+the+Code+Base"></a></h2>
<ul>
<li><icon alt="fix" src="../images/fix.jpg"></icon>Fixed potential multi-threading problem concerning the use of DecimalFormat. Committed by JM. See Issue <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=44887">44887</a> .</li>
</ul>
-<h3 id="changes-to-the-layout-engine-wzxhzdk8wzxhzdk9">Changes to the Layout Engine # <a id="Changes+to+the+Layout+Engine"></a></h3>
+<h3 id="changes-to-the-layout-engine-wzxhzdk8wzxhzdk9">Changes to the Layout Engine <a id="Changes+to+the+Layout+Engine"></a></h3>
<ul>
<li><icon alt="fix" src="../images/fix.jpg"></icon>Various bugfixes for table layout. Committed by VH. See Issue <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=44621">44621</a> .</li>
</ul>
-<h3 id="changes-to-renderers-output-formats-wzxhzdk10wzxhzdk11">Changes to Renderers (Output Formats) # <a id="Changes+to+Renderers+%28Output+Formats%29"></a></h3>
+<h3 id="changes-to-renderers-output-formats-wzxhzdk10wzxhzdk11">Changes to Renderers (Output Formats) <a id="Changes+to+Renderers+%28Output+Formats%29"></a></h3>
<ul>
<li>
<p><icon alt="fix" src="../images/fix.jpg"></icon>Fixed positioning of absolutely positioned block-containers in multi-column documents. Committed by JM.</p>
Modified: websites/staging/xmlgraphics/trunk/content/fop/0.95/running.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/0.95/running.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/0.95/running.html Wed Oct 24 04:26:06 2012
@@ -332,7 +332,7 @@ $(document).ready(function () {
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/0.95/">0.95</a></div> -->
<div class="section-content"><h1 id="running-apachewzxhzdk0-fop">Running Apache™ FOP</h1>
<p><version>$Revision: 1298724 $</version></p>
-<h2 id="system-requirements-wzxhzdk3wzxhzdk4">System Requirements <a id="require"></a></h2>
+<h2 id="system-requirements-wzxhzdk3wzxhzdk4">System Requirements <a id="require"></a></h2>
<p>The following software must be installed:</p>
<ul>
<li>
@@ -375,13 +375,13 @@ $(document).ready(function () {
<ul>
<li>If you will be using FOP to process SVG, you must do so in a graphical environment. See <a href="graphics.html#batik">FOP: Graphics (Batik)</a> for details.</li>
</ul>
-<h2 id="installation-wzxhzdk5wzxhzdk6">Installation <a id="install"></a></h2>
-<h3 id="instructions-wzxhzdk7wzxhzdk8">Instructions # <a id="install-instruct"></a></h3>
+<h2 id="installation-wzxhzdk5wzxhzdk6">Installation <a id="install"></a></h2>
+<h3 id="instructions-wzxhzdk7wzxhzdk8">Instructions <a id="install-instruct"></a></h3>
<p>Basic FOP installation consists of first unzipping the <code>.gz</code> file that is the distribution medium, then unarchiving the resulting <code>.tar</code> file in a directory/folder that is convenient on your system. Please consult your operating system documentation or Zip application software documentation for instructions specific to your site.</p>
-<h3 id="problems-wzxhzdk9wzxhzdk10">Problems # <a id="install-problems"></a></h3>
+<h3 id="problems-wzxhzdk9wzxhzdk10">Problems <a id="install-problems"></a></h3>
<p>Some Mac OSX users have experienced filename truncation problems using Stuffit to unzip and unarchive their distribution media. This is a legacy of older Mac operating systems, which had a 31-character pathname limit. Several Mac OSX users have recommended that Mac OSX users use the shell command <code>tar -xzf</code> instead.</p>
-<h2 id="starting-fop-as-a-standalone-application-wzxhzdk11wzxhzdk12">Starting FOP as a Standalone Application <a id="standalone-start"></a></h2>
-<h3 id="using-the-fop-script-or-batch-file-wzxhzdk13wzxhzdk14">Using the fop script or batch file # <a id="fop-script"></a></h3>
+<h2 id="starting-fop-as-a-standalone-application-wzxhzdk11wzxhzdk12">Starting FOP as a Standalone Application <a id="standalone-start"></a></h2>
+<h3 id="using-the-fop-script-or-batch-file-wzxhzdk13wzxhzdk14">Using the fop script or batch file <a id="fop-script"></a></h3>
<p>The usual and recommended practice for starting FOP from the command line is to run the batch file fop.bat (Windows) or the shell script fop (Unix/Linux). These scripts require that the environment variable JAVA_HOME be set to a path pointing to the appropriate Java installation on your system. Macintosh OSX includes a Java environment as part of its distribution. We are told by Mac OSX users that the path to use in this case is <code>/Library/Java/Home</code> . <strong>Caveat:</strong> We suspect that, as Apple releases new Java environments and as FOP upgrades the minimum Java requirements, the two will inevitably not match on some systems. Please see <a href="http://developer.apple.com/java/faq">Java on Mac OSX FAQ</a> for information as it becomes available.</p>
<p>USAGE
Fop [options] [-fo|-xml] infile [-xsl file] [-awt|-pdf|-mif|-rtf|-tiff|-png|-pcl|-ps|-txt|-at [mime]|-print] <outfile>
@@ -449,20 +449,20 @@ Fop [options] [-fo|-xml] infile [-xsl fi
Fop foo.fo -print or Fop -print foo.fo
Fop foo.fo -awt
PDF encryption is only available if FOP was compiled with encryption support <strong>and</strong> if compatible encryption support is available at run time. Currently, only the JCE is supported. Check the <a href="pdfencryption.html">Details</a> .</p>
-<h3 id="writing-your-own-script-wzxhzdk18wzxhzdk19">Writing your own script # <a id="your-own-script"></a></h3>
+<h3 id="writing-your-own-script-wzxhzdk18wzxhzdk19">Writing your own script <a id="your-own-script"></a></h3>
<p>FOP's entry point for your own scripts is the class <code>org.apache.fop.cli.Main</code> . The general pattern for the command line is: <code>java -classpath <CLASSPATH>
org.apache.fop.cli.Main <arguments></code> . The arguments consist of the options and infile and outfile specifications as shown above for the standard scripts. You may wish to review the standard scripts to make sure that you get your environment properly configured.</p>
-<h3 id="running-with-javas-jar-option-wzxhzdk20wzxhzdk21">Running with java's -jar option # <a id="jar-option"></a></h3>
+<h3 id="running-with-javas-jar-option-wzxhzdk20wzxhzdk21">Running with java's -jar option <a id="jar-option"></a></h3>
<p>As an alternative to the start scripts you can run <code>java
-jar path/to/build/fop.jar <arguments></code> , relying on FOP to build the classpath for running FOP dynamically, see <a href="#dynamical-classpath">below</a> . If you use hyphenation, you must put <code>fop-hyph.jar</code> in the <code>lib</code> directory.</p>
<p>You can also run <code>java -jar path/to/fop.jar
<arguments></code> , relying on the <code>Class-Path</code> entry in the manifest file. This works if you put <code>fop.jar</code> and all jar files from the <code>lib</code> directory in a single directory. If you use hyphenation, you must also put <code>fop-hyph.jar</code> in that directory.</p>
<p>In both cases the arguments consist of the options and infile and outfile specifications as shown above for the standard scripts.</p>
-<h3 id="fops-dynamical-classpath-construction-wzxhzdk22wzxhzdk23">FOP's dynamical classpath construction # <a id="dynamical-classpath"></a></h3>
+<h3 id="fops-dynamical-classpath-construction-wzxhzdk22wzxhzdk23">FOP's dynamical classpath construction <a id="dynamical-classpath"></a></h3>
<p>If FOP is started without a proper classpath, it tries to add its dependencies dynamically. If the system property <code>fop.home</code> contains the name of a directory, then FOP uses that directory as the base directory for its search. Otherwise the current working directory is the base directory. If the base directory is called <code>build</code> , then its parent directory becomes the base directory.</p>
<p>FOP expects to find <code>fop.jar</code> in the <code>build</code> subdirectory of the base directory, and adds it to the classpath. Subsequently FOP adds all <code>jar</code> files in the lib directory to the classpath. The lib directory is either the <code>lib</code> subdirectory of the base directory, or, if that does not exist, the base directory itself.</p>
<p>If the system property <code>fop.optional.lib</code> contains the name of a directory, then all <code>jar</code> files in that directory are also added to the classpath. See the methods <code>getJARList</code> and <code>checkDependencies</code> in <code>org.apache.fop.cli.Main</code> .</p>
-<h2 id="using-xalan-to-check-xsl-fo-input-wzxhzdk24wzxhzdk25">Using Xalan to Check XSL-FO Input <a id="check-input"></a></h2>
+<h2 id="using-xalan-to-check-xsl-fo-input-wzxhzdk24wzxhzdk25">Using Xalan to Check XSL-FO Input <a id="check-input"></a></h2>
<p>FOP sessions that use -xml and -xsl input instead of -fo input are actually controlling two distinct conversions: Tranforming XML to XSL-FO, then formatting the XSL-FO to PDF (or another FOP output format). Although FOP controls both of these processes, the first is included merely as a convenience and for performance reasons. Only the second is part of FOP's core processing. If a user has a problem running FOP, it is important to determine which of these two processes is causing the problem. If the problem is in the first process, the user's stylesheet is likely the cause. The FOP development team does not have resources to help with stylesheet issues, although we have included links to some useful <a href="../resources.html#specs">Specifications</a> and <a href="../resources.html#articles">Books/Articles</a> . If the problem is in the second process, FOP may have a bug or an unimplemented feature that does require attention from the FOP development team.
The user is always responsible to provide correct XSL-FO code to FOP.
In the case of using -xml and -xsl input, although the user is responsible for the XSL-FO code that is FOP's input, it is not visible to the user. To make the intermediate FO file visible, the FOP distribution includes the "-foout" option which causes FOP to run only the first (transformation) step, and write the results to a file. (See also the Xalan command-line below)
@@ -470,7 +470,7 @@ When asking for help on the FOP mailing
The -foout option works the same way as if you would call the <a href="http://xml.apache.org/xalan-j/commandline.html">Xalan command-line</a> :</p>
<p><code>java org.apache.xalan.xslt.Process -IN xmlfile -XSL file -OUT outfile</code> </p>
<p>Note that there are some subtle differences between the FOP and Xalan command-lines.</p>
-<h2 id="memory-usage-wzxhzdk26wzxhzdk27">Memory Usage <a id="memory"></a></h2>
+<h2 id="memory-usage-wzxhzdk26wzxhzdk27">Memory Usage <a id="memory"></a></h2>
<p>FOP can consume quite a bit of memory, even though this has been continually improved. This is partly inherent to the formatting process and partly caused by implementation choices. All FO processors currently on the market have memory problems with certain layouts.</p>
<p>If you are running out of memory when using FOP, here are some ideas that may help:</p>
<ul>
@@ -487,7 +487,7 @@ The -foout option works the same way as
<p>Use multiple page sequences. FOP starts rendering after the end of a page sequence is encountered. While the actual rendering is done page-by-page, some additional memory is freed after the page sequence has been rendered. This can be substantial if the page sequence contains lots of FO elements.</p>
</li>
</ul>
-<h2 id="problems-wzxhzdk28wzxhzdk29">Problems <a id="problems"></a></h2>
+<h2 id="problems-wzxhzdk28wzxhzdk29">Problems <a id="problems"></a></h2>
<p>If you have problems running FOP, please see the <a href="../gethelp.html">"How to get Help" page</a> .</p></div>
</div>
Modified: websites/staging/xmlgraphics/trunk/content/fop/0.95/servlets.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/0.95/servlets.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/0.95/servlets.html Wed Oct 24 04:26:06 2012
@@ -332,9 +332,9 @@ $(document).ready(function () {
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/0.95/">0.95</a></div> -->
<div class="section-content"><h1 id="apachewzxhzdk2-fop-servlets">Apache™ 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>
+<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>
-<h2 id="example-servlets-in-the-fop-distribution-wzxhzdk10wzxhzdk11">Example Servlets in the FOP distribution <a id="example-servlets"></a></h2>
+<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>
@@ -347,9 +347,9 @@ $(document).ready(function () {
</ul>
<p>The source code for the servlet can be found under {fop-dir}/src/java/org/apache/fop/servlet/FopServlet.java.
This example servlet should not be used on a public web server connected to the Internet as it does not contain any measures to prevent Denial-of-Service-Attacks. It is provided as an example and as a starting point for your own servlet.</p>
-<h1 id="create-your-own-servlet-wzxhzdk12wzxhzdk13">Create your own Servlet <a id="servlet"></a></h1>
+<h1 id="create-your-own-servlet-wzxhzdk12wzxhzdk13">Create your own Servlet <a id="servlet"></a></h1>
<p>This section assumes you are familiar with <a href="embedding.html">embedding FOP</a> .</p>
-<h2 id="a-minimal-servlet-wzxhzdk14wzxhzdk15">A minimal Servlet # <a id="minimal-servlet"></a></h2>
+<h2 id="a-minimal-servlet-wzxhzdk14wzxhzdk15">A minimal Servlet <a id="minimal-servlet"></a></h2>
<p>Here is a minimal code snippet to demonstrate the basics:
private FopFactory fopFactory = FopFactory.newInstance();
private TransformerFactory tFactory = TransformerFactory.newInstance();</p>
@@ -366,7 +366,7 @@ private TransformerFactory tFactory = Tr
throw new ServletException(ex);
}
}There are numerous problems with the code snippet above. Its purpose is only to demonstrate the basic concepts. See below for details.</p>
-<h2 id="adding-xsl-tranformation-xslt-wzxhzdk16wzxhzdk17">Adding XSL tranformation (XSLT) # <a id="xslt"></a></h2>
+<h2 id="adding-xsl-tranformation-xslt-wzxhzdk16wzxhzdk17">Adding XSL tranformation (XSLT) <a id="xslt"></a></h2>
<p>A common requirement is to transform an XML source to XSL-FO using an XSL transformation. It is recommended to use JAXP for this task. The following snippet shows the basic code:
private FopFactory fopFactory = FopFactory.newInstance();
private TransformerFactory tFactory = TransformerFactory.newInstance();</p>
@@ -406,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>
-<h3 id="custom-configuration-wzxhzdk18wzxhzdk19">Custom configuration # <a id="cfg"></a></h3>
+<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>
-<h3 id="improving-performance-wzxhzdk20wzxhzdk21">Improving performance # <a id="performance"></a></h3>
+<h3 id="improving-performance-wzxhzdk20wzxhzdk21">Improving performance <a id="performance"></a></h3>
<p>There are several options to consider:</p>
<ul>
<li>
@@ -419,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>
-<h3 id="accessing-resources-in-your-web-application-wzxhzdk22wzxhzdk23">Accessing resources in your web application # <a id="uriresolver"></a></h3>
+<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>
@@ -459,7 +459,7 @@ Source xsltSrc = this.uriResolver.resolv
"servlet-context:/xslt/mystylesheet.xsl", null);
Transformer transformer = this.transFactory.newTransformer(xsltSrc);
transformer.setURIResolver(this.uriResolver);</p>
-<h1 id="notes-on-microsoft-internet-explorer-wzxhzdk24wzxhzdk25">Notes on Microsoft Internet Explorer <a id="ie"></a></h1>
+<h1 id="notes-on-microsoft-internet-explorer-wzxhzdk24wzxhzdk25">Notes on Microsoft Internet Explorer <a id="ie"></a></h1>
<p>Some versions of Internet Explorer will not automatically show the PDF or call the servlet multiple times. These are well-known limitations of Internet Explorer and are not a problem of the servlet. However, Internet Explorer can still be used to download the PDF so that it can be viewed later. Here are some suggestions in this context:</p>
<ul>
<li>
@@ -474,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>
-<h2 id="servlet-engines-wzxhzdk26wzxhzdk27">Servlet Engines <a id="servlet-engine"></a></h2>
+<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>
-<h3 id="tomcat-wzxhzdk28wzxhzdk29">Tomcat # <a id="tomcat"></a></h3>
+<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>
-<h3 id="websphere-35-wzxhzdk30wzxhzdk31">WebSphere 3.5 # <a id="websphere"></a></h3>
+<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>
-<h2 id="handling-complex-use-cases-wzxhzdk32wzxhzdk33">Handling complex use cases <a id="complex-usecases"></a></h2>
+<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/0.95/upgrading.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/0.95/upgrading.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/0.95/upgrading.html Wed Oct 24 04:26:06 2012
@@ -332,7 +332,7 @@ $(document).ready(function () {
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/0.95/">0.95</a></div> -->
<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>
+<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>
@@ -361,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>
-<h2 id="what-you-need-to-know-when-you-upgrade-wzxhzdk6wzxhzdk7">What you need to know when you upgrade! <a id="issues"></a></h2>
+<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. This does not mean that the new FOP is at fault. Quite the opposite actually! See below:</p>
<ul>
<li>
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/accessibility.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/accessibility.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/accessibility.html Wed Oct 24 04:26:06 2012
@@ -331,10 +331,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.0/">1.0</a></div> -->
<div class="section-content"><h1 id="apachewzxhzdk0-fop-accessibility">Apache™ FOP: Accessibility</h1>
-<h2 id="overview-wzxhzdk1wzxhzdk2">Overview <a id="overview"></a></h2>
+<h2 id="overview-wzxhzdk1wzxhzdk2">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>
-<h2 id="enabling-accessibility-wzxhzdk4wzxhzdk5">Enabling accessibility <a id="Enabling+accessibility"></a></h2>
+<h2 id="enabling-accessibility-wzxhzdk4wzxhzdk5">Enabling accessibility <a id="Enabling+accessibility"></a></h2>
<p>There are 3 ways to enable accessibility:</p>
<ol>
<li>
@@ -352,7 +352,7 @@ $(document).ready(function () {
</ol>
<p>When accessibility is enabled, additional information relating to the logical structure of the document is added to the PDF. That information allows the PDF viewer (or a text-to-speech application) to retrieve the natural reading order of the document.
The processing of the logical structure is memory-hungry. You may need to adjust the Java heap size in order to process larger files.</p>
-<h1 id="changes-to-your-xsl-fo-input-files-wzxhzdk6wzxhzdk7">Changes to your XSL-FO input files <a id="source"></a></h1>
+<h1 id="changes-to-your-xsl-fo-input-files-wzxhzdk6wzxhzdk7">Changes to your XSL-FO input files <a id="source"></a></h1>
<p>Apache FOP cannot automatically generate accessible PDFs. Some of the work can only be performed by the content provider. Following are some changes that may be necessary to your XSL-FO content in order to generate really accessible documents:</p>
<ul>
<li>
@@ -368,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>
-<h2 id="customized-tagging-wzxhzdk8wzxhzdk9">Customized Tagging <a id="customTags"></a></h2>
+<h2 id="customized-tagging-wzxhzdk8wzxhzdk9">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:
@@ -377,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>
-<h2 id="testing-wzxhzdk14wzxhzdk15">Testing <a id="testing"></a></h2>
+<h2 id="testing-wzxhzdk14wzxhzdk15">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>
-<h2 id="limitations-wzxhzdk16wzxhzdk17">Limitations <a id="limitations"></a></h2>
+<h2 id="limitations-wzxhzdk16wzxhzdk17">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>
@@ -395,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>
-<h2 id="related-links-wzxhzdk18wzxhzdk19">Related Links <a id="links"></a></h2>
+<h2 id="related-links-wzxhzdk18wzxhzdk19">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.0/anttask.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/anttask.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/anttask.html Wed Oct 24 04:26:06 2012
@@ -333,7 +333,7 @@ $(document).ready(function () {
<div class="section-content"><h1 id="apachewzxhzdk1-fop-ant-task">Apache™ FOP: Ant task</h1>
<p><version>$Revision: 1298724 $</version></p>
<p>Apache™ FOP provides an Ant task for automating the document build process.</p>
-<h2 id="description-wzxhzdk5wzxhzdk6">Description <a id="basics"></a></h2>
+<h2 id="description-wzxhzdk5wzxhzdk6">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..."/>
@@ -353,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 |
|-----------|-------------|----------|
@@ -375,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.0/changes_1.0.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/changes_1.0.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/changes_1.0.html Wed Oct 24 04:26:06 2012
@@ -332,14 +332,14 @@ $(document).ready(function () {
<!-- <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"><h1 id="history-of-changes-10">History of Changes 1.0</h1>
<p><a href="changes_1.0.rss"></a> </p>
-<h2 id="introduction-and-explanation-of-symbols-wzxhzdk0wzxhzdk1">Introduction and explanation of symbols <a id="introduction"></a></h2>
+<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>
-<h2 id="version-10-21-july-2010-wzxhzdk10wzxhzdk11">Version 1.0 (21 July 2010) <a id="version_1.0"></a></h2>
-<h3 id="changes-to-the-end-user-api-wzxhzdk12wzxhzdk13">Changes to the End-User API # <a id="API_1.0"></a></h3>
+<h2 id="version-10-21-july-2010-wzxhzdk10wzxhzdk11">Version 1.0 (21 July 2010) <a id="version_1.0"></a></h2>
+<h3 id="changes-to-the-end-user-api-wzxhzdk12wzxhzdk13">Changes to the End-User API <a id="API_1.0"></a></h3>
<ul>
<li><icon alt="add" src="../images/add.jpg"></icon>Added a command-line option '-catalog' to use a catalog resolver for the XML and XSLT files Committed by SP.</li>
</ul>
-<h3 id="changes-to-the-code-base-wzxhzdk14wzxhzdk15">Changes to the Code Base # <a id="Code_1.0"></a></h3>
+<h3 id="changes-to-the-code-base-wzxhzdk14wzxhzdk15">Changes to the Code Base <a id="Code_1.0"></a></h3>
<ul>
<li>
<p><icon alt="add" src="../images/add.jpg"></icon>Added support for xmlfile and xsltfile parameters in FOP's Ant Task. Committed by AC.</p>
@@ -408,11 +408,11 @@ Committed by AD. Thanks to rogov.AT.deve
<p><icon alt="update" src="../images/update.jpg"></icon>Changed FONode.addCharacters() parameter to closer match the signature of the standard SAX characters() event (reduces confusion and computations). <em>!! Implementors of extensions that subclass FONode directly, and offer an implementation for addCharacters() should take care to make similar modifications in their code !!</em> Committed by AD.</p>
</li>
</ul>
-<h3 id="changes-to-the-bundled-extensions-wzxhzdk16wzxhzdk17">Changes to the Bundled Extensions # <a id="Extensions_1.0"></a></h3>
+<h3 id="changes-to-the-bundled-extensions-wzxhzdk16wzxhzdk17">Changes to the Bundled Extensions <a id="Extensions_1.0"></a></h3>
<ul>
<li><icon alt="add" src="../images/add.jpg"></icon>Added support for the #CMYK pseudo-profile supported by some commercial XSL implementations on the rgb-icc() function. Committed by JM.</li>
</ul>
-<h3 id="changes-to-the-font-subsystem-wzxhzdk18wzxhzdk19">Changes to the Font Subsystem # <a id="Fonts_1.0"></a></h3>
+<h3 id="changes-to-the-font-subsystem-wzxhzdk18wzxhzdk19">Changes to the Font Subsystem <a id="Fonts_1.0"></a></h3>
<ul>
<li>
<p><icon alt="add" src="../images/add.jpg"></icon>Added support for TrueType fonts with symbol character maps (like "Wingdings" and "Symbol"). Character for these fonts are usually found in the 0xF020 to 0xF0FF range (a Unicode private use area). Committed by JM.</p>
@@ -466,7 +466,7 @@ Committed by AD. Thanks to rogov.AT.deve
<p><icon alt="fix" src="../images/fix.jpg"></icon>Fix for PFMReader after bug #43089 changed the behavior of PFMFile. Fixes baseline problems when Type 1 fonts are used in conjunction with XML font metric files. Committed by JM. Thanks to J. Frantzius. See Issue <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=45734">45734</a> .</p>
</li>
</ul>
-<h3 id="changes-to-the-image-support-wzxhzdk20wzxhzdk21">Changes to the Image Support # <a id="Images_1.0"></a></h3>
+<h3 id="changes-to-the-image-support-wzxhzdk20wzxhzdk21">Changes to the Image Support <a id="Images_1.0"></a></h3>
<ul>
<li>
<p><icon alt="add" src="../images/add.jpg"></icon>Added customization ability for the image loading framework from FOP's configuration file. Committed by JM.</p>
@@ -478,7 +478,7 @@ Committed by AD. Thanks to rogov.AT.deve
<p><icon alt="fix" src="../images/fix.jpg"></icon>Bugfix: use the effective color profile supplied by the ImageEncodingHelper, instead of the original one. Committed by JM.</p>
</li>
</ul>
-<h3 id="changes-to-the-layout-engine-wzxhzdk22wzxhzdk23">Changes to the Layout Engine # <a id="Layout_1.0"></a></h3>
+<h3 id="changes-to-the-layout-engine-wzxhzdk22wzxhzdk23">Changes to the Layout Engine <a id="Layout_1.0"></a></h3>
<ul>
<li>
<p><icon alt="add" src="../images/add.jpg"></icon>Implement internal character classes if the hyphenation pattern file does not contain them Committed by SP.</p>
@@ -574,7 +574,7 @@ Committed by AD. Thanks to rogov.AT.deve
<p><icon alt="fix" src="../images/fix.jpg"></icon>Activated min-height/max-height and min-width/max-width properties. Committed by AD. See Issue <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=43591">43591</a> .</p>
</li>
</ul>
-<h3 id="changes-to-renderers-output-formats-wzxhzdk24wzxhzdk25">Changes to Renderers (Output Formats) # <a id="Renderers_1.0"></a></h3>
+<h3 id="changes-to-renderers-output-formats-wzxhzdk24wzxhzdk25">Changes to Renderers (Output Formats) <a id="Renderers_1.0"></a></h3>
<ul>
<li>
<p><icon alt="add" src="../images/add.jpg"></icon>AFP Output: Added enhanced dithering functionality for images that are converted to bi-level images. Committed by JM.</p>
@@ -778,7 +778,7 @@ Committed by AD.</p>
<p><icon alt="update" src="../images/update.jpg"></icon>When a JPEG image is embedded, an optionally embedded color profile is filtered out as it's already embedded separately in the PDF file. Committed by JM.</p>
</li>
</ul>
-<h3 id="contributors-to-this-release-wzxhzdk26wzxhzdk27">Contributors to this release # <a id="contributors_1.0"></a></h3>
+<h3 id="contributors-to-this-release-wzxhzdk26wzxhzdk27">Contributors to this release <a id="contributors_1.0"></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), Jeremias Märki (JM), (JM,VH), Luca Furini (LF), Max Berger (MB), Simon Pepping (SP), Vincent Hennebert (VH).</p>
<p>This is a list of other contributors:<br></br>Alexander Stamenov, Alok Singh, Antti Karanta, Bharat Attaluri, Carsten Siedentop, D.W. Harks, Dario Laera, Emil Maskovsky, Francois Fernandes, Georg Datterl, Harald G. Henne, J. Frantzius, Jason Harrop, Jonathan Levinson, Jost Klopfstein, Martin Edge, Maxim Wirt, Nicolas Peninguy, Pavel Kysilka, Peter Coppens, Peter Hancock, Richard Wheeldon, rogov.AT.devexperts.com, Thomas Stieler, Tow Browder, Venkat Reddy, Yegor Kozlov.</p></div>
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/compiling.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/compiling.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/compiling.html Wed Oct 24 04:26:06 2012
@@ -332,19 +332,19 @@ $(document).ready(function () {
<!-- <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"><h1 id="apachewzxhzdk0-fop-building-from-source-code">Apache™ FOP: Building from Source Code</h1>
<p><version>$Revision: 1298724 $</version></p>
-<h2 id="do-you-need-to-build-wzxhzdk3wzxhzdk4">Do You Need To Build? <a id="build-needed"></a></h2>
+<h2 id="do-you-need-to-build-wzxhzdk3wzxhzdk4">Do You Need To Build? <a id="build-needed"></a></h2>
<p>Apache™ FOP distributions are either pre-compiled binary or source. If you are using a binary distribution, it is already built and there is no need to build it again. See the <a href="../download.html">Download Instructions</a> for information about whether a binary or source distribution is best for your needs.</p>
<p>If you got the source code from a repository snapshot or via Subversion you will need to build FOP in any case.</p>
-<h2 id="set-up-your-environment-wzxhzdk6wzxhzdk7">Set Up Your Environment <a id="env"></a></h2>
-<h3 id="jdk-wzxhzdk8wzxhzdk9">JDK # <a id="env-jdk"></a></h3>
+<h2 id="set-up-your-environment-wzxhzdk6wzxhzdk7">Set Up Your Environment <a id="env"></a></h2>
+<h3 id="jdk-wzxhzdk8wzxhzdk9">JDK <a id="env-jdk"></a></h3>
<p>Building FOP requires a minimum Java Development Kit (JDK/SDK) of 1.4 (A Java Runtime Environment is not sufficient).</p>
-<h3 id="classpath-wzxhzdk10wzxhzdk11">CLASSPATH # <a id="env-classpath"></a></h3>
+<h3 id="classpath-wzxhzdk10wzxhzdk11">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>
-<h3 id="java_home-wzxhzdk12wzxhzdk13">JAVA_HOME # <a id="env-java-home"></a></h3>
+<h3 id="java_home-wzxhzdk12wzxhzdk13">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.4 or above, which normally does not need this setting.</p>
-<h3 id="apache-ant-wzxhzdk14wzxhzdk15">Apache Ant # <a id="env-ant"></a></h3>
+<h3 id="apache-ant-wzxhzdk14wzxhzdk15">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>
-<h2 id="run-the-build-script-wzxhzdk16wzxhzdk17">Run the Build Script <a id="build-script"></a></h2>
+<h2 id="run-the-build-script-wzxhzdk16wzxhzdk17">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:
@@ -369,7 +369,7 @@ OR
ant all
To clean the build directory first:
ant clean allIf you want to shorten the build time you can just call the "package" target which doesn't perform any automated tests during the build.</p>
-<h1 id="troubleshooting-wzxhzdk18wzxhzdk19">Troubleshooting <a id="problems"></a></h1>
+<h1 id="troubleshooting-wzxhzdk18wzxhzdk19">Troubleshooting <a id="problems"></a></h1>
<p>If you have problems building FOP, please try the following:</p>
<ul>
<li>
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/configuration.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/configuration.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/configuration.html Wed Oct 24 04:26:06 2012
@@ -332,10 +332,10 @@ $(document).ready(function () {
<!-- <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"><h1 id="apachewzxhzdk6-fop-configuration">Apache™ FOP: Configuration</h1>
<p><version>$Revision: 1298724 $</version></p>
-<h2 id="configuration-file-basics-wzxhzdk9wzxhzdk10">Configuration File Basics <a id="general"></a></h2>
+<h2 id="configuration-file-basics-wzxhzdk9wzxhzdk10">Configuration File Basics <a id="general"></a></h2>
<p>The FOP configuration file is an XML file containing a variety of settings that are useful for controlling FOP's behavior, and for helping it find resources that you wish it to use.</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>
-<h3 id="making-configuration-available-to-fop-wzxhzdk11wzxhzdk12">Making Configuration Available to FOP # <a id="general-available"></a></h3>
+<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>
@@ -346,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>
-<h2 id="summary-of-the-general-configuration-options-wzxhzdk13wzxhzdk14">Summary of the General Configuration Options <a id="general-elements"></a></h2>
+<h2 id="summary-of-the-general-configuration-options-wzxhzdk13wzxhzdk14">Summary of the General Configuration Options <a id="general-elements"></a></h2>
<table>
<thead>
<tr>
@@ -456,12 +456,12 @@ $(document).ready(function () {
<default-page-settings height="11in" width="8.26in"/></p>
<p><!-- etc. etc..... -->
</fop></p>
-<h1 id="image-loading-customization-wzxhzdk38wzxhzdk39">Image Loading Customization <a id="image-loading"></a></h1>
+<h1 id="image-loading-customization-wzxhzdk38wzxhzdk39">Image Loading Customization <a id="image-loading"></a></h1>
<p class=".">Apache FOP uses the image loading framework from <a href="http://xmlgraphics.apache.org/commons/">Apache XML Graphics Commons</a> to load images using various plug-ins. Every image loader plug-in has a hard-coded usage penalty that influences which solution is chosen if there are multiple possibilities to load an image. Sometimes, though, these penalties need to be tweaked and this can be done in the FOP configuration. An example:
<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>
-<h2 id="renderer-configuration-wzxhzdk41wzxhzdk42">Renderer configuration <a id="renderers"></a></h2>
+<h2 id="renderer-configuration-wzxhzdk41wzxhzdk42">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>
@@ -487,7 +487,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>
-<h3 id="special-settings-for-the-pdf-renderer-wzxhzdk61wzxhzdk62">Special Settings for the PDF Renderer # <a id="pdf-renderer"></a></h3>
+<h3 id="special-settings-for-the-pdf-renderer-wzxhzdk61wzxhzdk62">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>
@@ -539,7 +539,7 @@ $(document).ready(function () {
</pre></div>
-<h2 id="special-settings-for-the-postscript-renderer-wzxhzdk63wzxhzdk64">Special Settings for the PostScript Renderer # <a id="ps-renderer"></a></h2>
+<h2 id="special-settings-for-the-postscript-renderer-wzxhzdk63wzxhzdk64">Special Settings for the PostScript Renderer <a id="ps-renderer"></a></h2>
<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>
@@ -558,7 +558,7 @@ $(document).ready(function () {
</pre></div>
-<h2 id="special-settings-for-the-pcl-renderer-wzxhzdk65wzxhzdk66">Special Settings for the PCL Renderer # <a id="pcl-renderer"></a></h2>
+<h2 id="special-settings-for-the-pcl-renderer-wzxhzdk65wzxhzdk66">Special Settings for the PCL Renderer <a id="pcl-renderer"></a></h2>
<p>Non-standard fonts for the PCL renderer are made available through the Java2D subsystem which means that you don't have to do any custom font configuration in this case but you have to use the font names offered by Java.</p>
<p>Additionally, there are certain settings that control how the renderer handles various elements.
<renderer mime="application/vnd.hp-PCL">
@@ -567,7 +567,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>
-<h3 id="special-settings-for-the-afp-renderer-wzxhzdk73wzxhzdk74">Special Settings for the AFP Renderer # <a id="afp-renderer"></a></h3>
+<h3 id="special-settings-for-the-afp-renderer-wzxhzdk73wzxhzdk74">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"/>
@@ -578,7 +578,7 @@ The default value for the "rendering" se
The default value for the images "mode" setting is "b+w" (black and white). When the images "mode" setting is "b+w" a "bits-per-pixel" setting can be provided to aid the grayscale conversion process. With this setting all images referenced in your source document are converted to an IOCA FS45 grayscale bitmap image form. When the setting is "color" all images are converted to an IOCA FS45 color bitmap image form. When "native" setting is "true", all images encountered (TIFF, GIF, JPEG and Encapsulated Postscript etc.) will be embedded directly in the datastream in their native form using a MO:DCA Object Container.</p>
<p>The default value for the "renderer-resolution" is 240 dpi.</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>
-<h2 id="when-it-does-not-work-wzxhzdk83wzxhzdk84">When it does not work <a id="When+it+does+not+work"></a></h2>
+<h2 id="when-it-does-not-work-wzxhzdk83wzxhzdk84">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.0/embedding.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/embedding.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/embedding.html Wed Oct 24 04:26:06 2012
@@ -332,11 +332,11 @@ $(document).ready(function () {
<!-- <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"><h1 id="apachewzxhzdk0-fop-embedding">Apache™ FOP: Embedding</h1>
<p><subtitle>How to Embed Apache� FOP in a Java application</subtitle><version>$Revision: 1298724 $</version></p>
-<h2 id="overview-wzxhzdk5wzxhzdk6">Overview <a id="overview"></a></h2>
+<h2 id="overview-wzxhzdk5wzxhzdk6">Overview <a id="overview"></a></h2>
<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="basic-usage-pattern-wzxhzdk8wzxhzdk9">Basic Usage Pattern <a id="basics"></a></h1>
+<h1 id="basic-usage-pattern-wzxhzdk8wzxhzdk9">Basic Usage Pattern <a id="basics"></a></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;
@@ -389,7 +389,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>
-<h3 id="logging-wzxhzdk10wzxhzdk11">Logging # <a id="basic-logging"></a></h3>
+<h3 id="logging-wzxhzdk10wzxhzdk11">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>
@@ -402,16 +402,16 @@ 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>
-<h3 id="processing-xsl-fo-wzxhzdk12wzxhzdk13">Processing XSL-FO # <a id="render"></a></h3>
+<h3 id="processing-xsl-fo-wzxhzdk12wzxhzdk13">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>
-<h3 id="processing-xsl-fo-generated-from-xmlxslt-wzxhzdk14wzxhzdk15">Processing XSL-FO generated from XML+XSLT # <a id="render-with-xslt"></a></h3>
+<h3 id="processing-xsl-fo-generated-from-xmlxslt-wzxhzdk14wzxhzdk15">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>
<p>//with XSLT:
Source xslt = new StreamSource(new File("mystylesheet.xsl"));
Transformer transformer = factory.newTransformer(xslt);</p>
-<h1 id="input-sources-wzxhzdk16wzxhzdk17">Input Sources <a id="input"></a></h1>
+<h1 id="input-sources-wzxhzdk16wzxhzdk17">Input Sources <a id="input"></a></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>
@@ -438,9 +438,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>
-<h2 id="configuring-apache-fop-programmatically-wzxhzdk18wzxhzdk19">Configuring Apache FOP Programmatically <a id="config-internal"></a></h2>
+<h2 id="configuring-apache-fop-programmatically-wzxhzdk18wzxhzdk19">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>
-<h3 id="customizing-the-fopfactory-wzxhzdk20wzxhzdk21">Customizing the FopFactory # <a id="fop-factory"></a></h3>
+<h3 id="customizing-the-fopfactory-wzxhzdk20wzxhzdk21">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>
@@ -473,7 +473,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>
-<h3 id="customizing-the-user-agent-wzxhzdk22wzxhzdk23">Customizing the User Agent # <a id="user-agent"></a></h3>
+<h3 id="customizing-the-user-agent-wzxhzdk22wzxhzdk23">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
@@ -528,7 +528,7 @@ userAgent.setURIResolver(myResolver); //
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="using-a-configuration-file-wzxhzdk24wzxhzdk25">Using a Configuration File <a id="config-external"></a></h1>
+<h1 id="using-a-configuration-file-wzxhzdk24wzxhzdk25">Using a Configuration File <a id="config-external"></a></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>
@@ -539,16 +539,16 @@ 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>
-<h2 id="hints-wzxhzdk26wzxhzdk27">Hints <a id="hints"></a></h2>
-<h3 id="object-reuse-wzxhzdk28wzxhzdk29">Object reuse # <a id="object-reuse"></a></h3>
+<h2 id="hints-wzxhzdk26wzxhzdk27">Hints <a id="hints"></a></h2>
+<h3 id="object-reuse-wzxhzdk28wzxhzdk29">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>
-<h3 id="awt-issues-wzxhzdk30wzxhzdk31">AWT issues # <a id="awt"></a></h3>
+<h3 id="awt-issues-wzxhzdk30wzxhzdk31">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>
-<h3 id="getting-information-on-the-rendering-process-wzxhzdk32wzxhzdk33">Getting information on the rendering process # <a id="render-info"></a></h3>
+<h3 id="getting-information-on-the-rendering-process-wzxhzdk32wzxhzdk33">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>
-<h2 id="improving-performance-wzxhzdk34wzxhzdk35">Improving performance <a id="performance"></a></h2>
+<h2 id="improving-performance-wzxhzdk34wzxhzdk35">Improving performance <a id="performance"></a></h2>
<p>There are several options to consider:</p>
<ul>
<li>
@@ -570,35 +570,35 @@ The layout of the configuration file is
<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>
-<h2 id="multithreading-fop-wzxhzdk36wzxhzdk37">Multithreading FOP <a id="multithreading"></a></h2>
+<h2 id="multithreading-fop-wzxhzdk36wzxhzdk37">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>
-<h2 id="examples-wzxhzdk38wzxhzdk39">Examples <a id="examples"></a></h2>
+<h2 id="examples-wzxhzdk38wzxhzdk39">Examples <a id="examples"></a></h2>
<p>The directory "{fop-dir}/examples/embedding" contains several working examples.</p>
-<h3 id="examplefo2pdfjava-wzxhzdk40wzxhzdk41">ExampleFO2PDF.java # <a id="ExampleFO2PDF"></a></h3>
+<h3 id="examplefo2pdfjava-wzxhzdk40wzxhzdk41">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-wzxhzdk44wzxhzdk45">ExampleXML2FO.java # <a id="ExampleXML2FO"></a></h2>
+<h2 id="examplexml2fojava-wzxhzdk44wzxhzdk45">ExampleXML2FO.java <a id="ExampleXML2FO"></a></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="examplexml2pdfjava-wzxhzdk48wzxhzdk49">ExampleXML2PDF.java # <a id="ExampleXML2PDF"></a></h2>
+<h2 id="examplexml2pdfjava-wzxhzdk48wzxhzdk49">ExampleXML2PDF.java <a id="ExampleXML2PDF"></a></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>
-<h3 id="exampleobj2xmljava-wzxhzdk52wzxhzdk53">ExampleObj2XML.java # <a id="ExampleObj2XML"></a></h3>
+<h3 id="exampleobj2xmljava-wzxhzdk52wzxhzdk53">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>
-<h3 id="exampleobj2pdfjava-wzxhzdk56wzxhzdk57">ExampleObj2PDF.java # <a id="ExampleObj2PDF"></a></h3>
+<h3 id="exampleobj2pdfjava-wzxhzdk56wzxhzdk57">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-wzxhzdk60wzxhzdk61">ExampleDOM2PDF.java # <a id="ExampleDOM2PDF"></a></h2>
+<h2 id="exampledom2pdfjava-wzxhzdk60wzxhzdk61">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>
-<h3 id="examplesvg2pdfjava-pdf-transcoder-example-wzxhzdk62wzxhzdk63">ExampleSVG2PDF.java (PDF Transcoder example) # <a id="ExampleSVG2PDF"></a></h3>
+<h3 id="examplesvg2pdfjava-pdf-transcoder-example-wzxhzdk62wzxhzdk63">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>
-<h3 id="final-notes-wzxhzdk64wzxhzdk65">Final notes # <a id="example-notes"></a></h3>
+<h3 id="final-notes-wzxhzdk64wzxhzdk65">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>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: commits-help@xmlgraphics.apache.org