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 [3/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/commons/image-loader.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/commons/image-loader.html (original)
+++ websites/staging/xmlgraphics/trunk/content/commons/image-loader.html Wed Oct 24 04:26:06 2012
@@ -129,7 +129,7 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/commons/">Commons</a></div> -->
<div class="section-content"><h1 id="apachewzxhzdk0-xml-graphics-commons-image-loader-framework">Apache™ XML Graphics Commons: Image Loader Framework</h1>
-<h2 id="overview-wzxhzdk1wzxhzdk2">Overview <a id="overview"></a></h2>
+<h2 id="overview-wzxhzdk1wzxhzdk2">Overview <a id="overview"></a></h2>
<p>Apache™ XML Graphics Commons contains a unified framework for loading and processing images (bitmap and vector). The package name is <code>org.apache.xmlgraphics.image.loader</code> . Key features:</p>
<ul>
<li>
@@ -171,8 +171,8 @@ $(document).ready(function () {
<p>An image cache speeds up the processing for images that are requested multiple times.</p>
</li>
</ul>
-<h2 id="tutorial-wzxhzdk4wzxhzdk5">Tutorial <a id="tutorial"></a></h2>
-<h3 id="setting-up-the-manager-wzxhzdk6wzxhzdk7">Setting up the manager # <a id="manager-setup"></a></h3>
+<h2 id="tutorial-wzxhzdk4wzxhzdk5">Tutorial <a id="tutorial"></a></h2>
+<h3 id="setting-up-the-manager-wzxhzdk6wzxhzdk7">Setting up the manager <a id="manager-setup"></a></h3>
<p>Before we can start to work with the package we need to set up the <code>ImageManager</code> . It provides convenience methods to load and convert images and holds the image cache.</p>
<p>The <code>ImageManager</code> needs an <code>ImageContext</code> . This interface provides the <code>ImageManager</code> with important context and configuration data. Currently this is only the source resolution. The <code>ImageManager</code> and <code>ImageContext</code> are intended to be shared within an application.</p>
<p>import org.apache.xmlgraphics.image.loader.ImageContext;
@@ -181,7 +181,7 @@ import org.apache.xmlgraphics.image.load
<p class="."></p>
<p>ImageManager imageManager = new ImageManager(new DefaultImageContext());
In this example, <code>DefaultImageContext</code> is used. You may need to write your own implementation of <code>ImageContext</code> for your use case.</p>
-<h2 id="preloading-an-image-wzxhzdk8wzxhzdk9">Preloading an image # <a id="preloading"></a></h2>
+<h2 id="preloading-an-image-wzxhzdk8wzxhzdk9">Preloading an image <a id="preloading"></a></h2>
<p>In order to load an image, it needs to be "preloaded" first, i.e. the image content type is detected and the intrinsic size of the image is determined. The result of this process is an <code>ImageInfo</code> instance which contains the URI, MIME type and intrinsic size. In most cases, this is done without loading the whole image (see SPI section below for information on exceptions to this rule).</p>
<p>Preloading is normally done through the <code>ImageManager</code> 's <code>getImageInfo()</code> method. For this operation an <code>ImageSessionContext</code> needs to be provided. It is responsible for supplying JAXP <code>Source</code> objects, URI resolution and providing other information needed for the image operations. In simple cases you can simply use <code>DefaultImageSessionContext</code> , but often you will want to write your own implementation of <code>ImageSessionContext</code> . In that case, it's recommended to subclass <code>AbstractImageSessionContext</code> which lets you avoid rewriting a lot of code for providing <code>Source</code> objects.</p>
<p>import org.apache.xmlgraphics.image.loader.ImageInfo;
@@ -189,7 +189,7 @@ import org.apache.xmlgraphics.image.load
import org.apache.xmlgraphics.image.loader.impl.DefaultImageSessionContext;</p>
<p class="."></p>
<p>ImageInfo info = imageManager.getImageInfo(uri, sessionContext);</p>
-<h2 id="loading-an-image-wzxhzdk10wzxhzdk11">Loading an image # <a id="loading"></a></h2>
+<h2 id="loading-an-image-wzxhzdk10wzxhzdk11">Loading an image <a id="loading"></a></h2>
<p>Once the image is "preloaded", it can be fully loaded in the form/flavor that is needed by the consuming application. The required flavor is indicated through the <code>ImageFlavor</code> class. If you want the image as a bitmap image in memory, you could request an <code>ImageFlavor.RENDERED_IMAGE</code> . Again, the <code>ImageSessionContext</code> will be needed.</p>
<p>import org.apache.xmlgraphics.image.loader.Image;
import org.apache.xmlgraphics.image.loader.ImageFlavor;</p>
@@ -214,10 +214,10 @@ import org.apache.xmlgraphics.image.load
throw new IllegalStateException("Unexpected flavor");
}
While each <code>BufferedImage</code> is also a <code>RenderedImage</code> , it can be more efficient to also specify <code>ImageFlavor.BUFFERED_IMAGE</code> in the flavor array.</p>
-<h1 id="tips-tricks-wzxhzdk12wzxhzdk13">Tips & Tricks <a id="tipsntricks"></a></h1>
+<h1 id="tips-tricks-wzxhzdk12wzxhzdk13">Tips & Tricks <a id="tipsntricks"></a></h1>
<p>If you are loading bitmap images and you get an error like <code>"Cannot load image (no suitable loader/converter combination available) for
myimage.tif (image/tiff)</code> , you maybe be missing the necessary ImageIO codec to decode the image. A number of well-written codecs can be found in <a href="https://jai-imageio.dev.java.net/">JAI Image I/O Tools Project</a> . Just download the distribution and add the JAR to the classpath. ImageIO will automatically pick up the new codecs and they will subsequently be available to the image framework.</p>
-<h2 id="service-provider-interface-spi-plug-ins-wzxhzdk14wzxhzdk15">Service Provider Interface (SPI, Plug-ins) <a id="spi"></a></h2>
+<h2 id="service-provider-interface-spi-plug-ins-wzxhzdk14wzxhzdk15">Service Provider Interface (SPI, Plug-ins) <a id="spi"></a></h2>
<p>The whole image framework is designed to be highly extensible. There are various extension points where new functionality can be added. The three main SPI interfaces are:</p>
<ul>
<li>
@@ -232,23 +232,23 @@ import org.apache.xmlgraphics.image.load
</ul>
<p>If you plan to write an implementation of one of the above interfaces, please also take a look at the existing implementations for reference.</p>
<p>Throughout the SPI, you'll find a <code>Map</code> parameter (hints) in the most important methods. That's a way to supply additional information to the implementation by the caller. For example, the source and target resolutions from the image (session) context is stored in the hints. The implementation should not rely on the presence of specialized information and should always have sensible defaults to rely on in this case.</p>
-<h3 id="imagepreloader-wzxhzdk16wzxhzdk17">ImagePreloader # <a id="ImagePreloader"></a></h3>
+<h3 id="imagepreloader-wzxhzdk16wzxhzdk17">ImagePreloader <a id="ImagePreloader"></a></h3>
<p>The first task is identifying whether the implementation supports the given image. If the image is loaded using an ImageInputStream it is important to always reset the stream position to the beginning of the file at the end of the <code>preloadImage()</code> method, because all registered preloaders are check in turn until one implementation signals that it supports the format. In that case, it has to extract only the minimal information from the image necessary to identify the image's intrinsic size. For most formats, this is doable without loading the whole image into memory.</p>
<p>However, for some formats (like MathML or WMF), loading the whole image at preloading time is hard to avoid since the image's size can only be determined that way. In such a case, the <code>ImagePreloader</code> implementations shall pass the loaded document to the respective <code>ImageLoader</code> through the custom objects that can be attached to the <code>ImageInfo</code> object. If the preloader loads the whole document, it shall close the given <code>Source</code> object (calling <code>ImageUtil.closeQuietly(Source)</code> ).</p>
<p>The priority the implementation reports is used to sort all registered implementations. This is to fine-tune the inner workings and to optimize performance since some formats are usually used more frequently than others.
Normally, if you implement an <code>ImagePreloader</code> you will also need to implement the respective <code>ImageLoader/ImageLoaderFactory</code> , or vice versa.</p>
-<h2 id="imageloader-and-imageloaderfactory-wzxhzdk18wzxhzdk19">ImageLoader and ImageLoaderFactory # <a id="ImageLoader"></a></h2>
+<h2 id="imageloader-and-imageloaderfactory-wzxhzdk18wzxhzdk19">ImageLoader and ImageLoaderFactory <a id="ImageLoader"></a></h2>
<p>The factory interface has been created to allow checking if some library that an implementation depends on is really in the classpath so it can report back that the <code>ImageLoader</code> is not funtional. The factory also reports what kind of image formats it supports and which image flavors it can return. There can be a complex relationship between the two. It is recommmended, however, to write smaller implementations rather than big, almighty ones.</p>
<p>The usage penalty is used when constructing image conversion pipelines. There can be multiple ways to provide an image in one of the supported flavors and this value helps to make the best decision.</p>
<p>While the factory basically just provides information and creates new <code>ImageLoader</code> instances, the image loaders are doing the actual leg work of decoding the images. The image flavor returned by the loader must match the flavor that is returned by <code>getTargetFlavor()</code> .</p>
-<h3 id="imageconverter-wzxhzdk20wzxhzdk21">ImageConverter # <a id="ImageConverter"></a></h3>
+<h3 id="imageconverter-wzxhzdk20wzxhzdk21">ImageConverter <a id="ImageConverter"></a></h3>
<p>The image converter is responsible to transform one image representation into another. Bundled implementations support these conversions: Java2D to bitmap, bitmap to Java2D and RenderedImage to "raw" PNG. Ideas for additional image converters could be: PDF to Java2D, EPS to Java2D or MathML to SVG or Java2D.</p>
<p>Each ImageConverter comes with a usage penalty which is used when constructing conversion pipelines so the pipeline with the least penalty value can be chosen. This is necessary as the consuming application my support multiple image flavors and there can be multiple ways to convert an image in one of the requested image flavors. Internally, <a href="http://en.wikipedia.org/wiki/Dijkstra%27s_algorithm">Dijkstra's shortest path algorithm</a> is used to find the best path using the penalties as "way lengths".</p>
-<h2 id="customization-wzxhzdk22wzxhzdk23">Customization <a id="customization"></a></h2>
-<h3 id="disabling-source-re-use-wzxhzdk24wzxhzdk25">Disabling Source Re-use # <a id="source-reuse"></a></h3>
+<h2 id="customization-wzxhzdk22wzxhzdk23">Customization <a id="customization"></a></h2>
+<h3 id="disabling-source-re-use-wzxhzdk24wzxhzdk25">Disabling Source Re-use <a id="source-reuse"></a></h3>
<p>By default, the Source object being used during the pre-loading stage is re-used when the image is fully loaded later (assuming an ImageSessionContext is used that descends from AbstractImageSessionContext). That means that a stream is only opened once and the image loading framework tries to re-wind the stream when it has to re-read portions of the stream when loading the complete image.</p>
<p>In some situations, this behavior may be undesired. Therefore, it can be disabled through a system property ( <code>org.apache.xmlgraphics.image.loader.impl.AbstractImageSessionContext.no-source-reuse</code> ). Set it to "true" and that feature will be disabled.</p>
-<h3 id="adjusting-plug-in-penalties-wzxhzdk26wzxhzdk27">Adjusting plug-in penalties # <a id="plugin-penalties"></a></h3>
+<h3 id="adjusting-plug-in-penalties-wzxhzdk26wzxhzdk27">Adjusting plug-in penalties <a id="plugin-penalties"></a></h3>
<p>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. The <code>ImageImplRegistry</code> (reachable through <code>ImageManager.getRegistry()</code> ) supports storing additional penalty values. An example:
ImageImplRegistry registry = imageManager.getRegistry();
registry.setAdditionalPenalty(
Modified: websites/staging/xmlgraphics/trunk/content/commons/index.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/commons/index.html (original)
+++ websites/staging/xmlgraphics/trunk/content/commons/index.html Wed Oct 24 04:26:06 2012
@@ -129,11 +129,11 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/commons/">Commons</a></div> -->
<div class="section-content"><h1 id="apachewzxhzdk0-xml-graphics-commons">Apache™ XML Graphics Commons</h1>
-<h2 id="overview-wzxhzdk1wzxhzdk2">Overview <a id="Overview"></a></h2>
+<h2 id="overview-wzxhzdk1wzxhzdk2">Overview <a id="Overview"></a></h2>
<p>Apache™ XML Graphics Commons is a library that consists of several reusable components used by <a href="http://xmlgraphics.apache.org/batik/">Apache Batik</a> and <a href="http://xmlgraphics.apache.org/fop/">Apache FOP</a> . Many of these components can easily be used separately outside the domains of SVG and XSL-FO. You will find components such as a PDF library, an RTF library, Graphics2D implementations that let you generate PDF & PostScript files, and much more.</p>
<p>The Apache™ XML Graphics Commons project is part of the <a href="http://www.apache.org">Apache™</a> Software Foundation, which is a wider community of users and developers of open source projects.</p>
<p>In the Wiki, we have a <a href="http://wiki.apache.org/xmlgraphics/XmlGraphicsCommonComponents">Roadmap for Apache XML Graphics Commons</a> . This roadmap is the place to describe new ideas for the project.</p>
-<h2 id="features-wzxhzdk6wzxhzdk7">Features <a id="features"></a></h2>
+<h2 id="features-wzxhzdk6wzxhzdk7">Features <a id="features"></a></h2>
<p>Components which have been ported from <a href="http://xmlgraphics.apache.org/batik/">Apache Batik</a> and <a href="http://xmlgraphics.apache.org/fop/">Apache FOP</a> include:</p>
<table>
<thead>
@@ -191,32 +191,32 @@ $(document).ready(function () {
</tr>
</tbody>
</table>
-<h2 id="news-wzxhzdk8wzxhzdk9">News <a id="News"></a></h2>
+<h2 id="news-wzxhzdk8wzxhzdk9">News <a id="News"></a></h2>
<p>RSS Feed: <a href="subproject-news-feed.rss"></a> </p>
-<h3 id="7-jul-2010-version-14-released-wzxhzdk10wzxhzdk11">7 Jul 2010: Version 1.4 Released # <a id="news-2010-07-07"></a></h3>
+<h3 id="7-jul-2010-version-14-released-wzxhzdk10wzxhzdk11">7 Jul 2010: Version 1.4 Released <a id="news-2010-07-07"></a></h3>
<p><item date="2010-07-07" title="Version 1.4 Released">
This release adds the option to generate smaller PostScript files, support for the AdobeStandardCyrillic encoding, RefinedImageFlavor, TexturePaint support for PSGraphics2D (PostScript tiling patterns), improvements to the XMP framework, optimization for PostScript state handling in (E)PSDocumentGraphics2D, and more. In addition it contains a number of bug fixes. For details, please see the <a href="changes.html#version_1.4">Changes</a> page.</p>
<p>We are pleased to note that many new features were contributed from outside the team of committers. Such broader interest ensures the healthy further development of the project.
</item></p>
-<h2 id="11-jun-2008-version-131-released-wzxhzdk14wzxhzdk15">11 Jun 2008: Version 1.3.1 Released # <a id="news-2008-06-11"></a></h2>
+<h2 id="11-jun-2008-version-131-released-wzxhzdk14wzxhzdk15">11 Jun 2008: Version 1.3.1 Released <a id="news-2008-06-11"></a></h2>
<p><item date="2008-06-11" title="Version 1.3.1 Released">
This release is mostly a bugfix release for the image loading framework that has been introduced in version 1.3. For details, please see the <a href="changes.html#version_1.3.1">Changes</a> page.
</item></p>
-<h2 id="7-mar-2008-version-13-released-wzxhzdk18wzxhzdk19">7 Mar 2008: Version 1.3 Released # <a id="news-2008-03-07"></a></h2>
+<h2 id="7-mar-2008-version-13-released-wzxhzdk18wzxhzdk19">7 Mar 2008: Version 1.3 Released <a id="news-2008-03-07"></a></h2>
<p><item date="2008-03-07" title="Version 1.3 Released">
The most important addition in this release is an image loading framework which supports all sorts of different image formats (bitmap and vector) and is highly extensible.</p>
<p>Besides that there were a larger number of smaller additions and bugfixes.</p>
<p>Support for Java 1.3 has been dropped. Java 1.4 or later is required now.
</item></p>
-<h2 id="21-jul-2007-version-12-released-wzxhzdk22wzxhzdk23">21 Jul 2007: Version 1.2 Released # <a id="news-2007-07-21"></a></h2>
+<h2 id="21-jul-2007-version-12-released-wzxhzdk22wzxhzdk23">21 Jul 2007: Version 1.2 Released <a id="news-2007-07-21"></a></h2>
<p><item date="2007-07-21" title="Version 1.2 Released">
This release mainly adds support for CMYK and GRAY color spaces for PSGenerator. For details about other fixes, please see the <a href="changes.html#version_1.2">Changes</a> page.
</item></p>
-<h2 id="22-dec-2006-version-11-released-wzxhzdk26wzxhzdk27">22 Dec 2006: Version 1.1 Released # <a id="news-2006-12-22"></a></h2>
+<h2 id="22-dec-2006-version-11-released-wzxhzdk26wzxhzdk27">22 Dec 2006: Version 1.1 Released <a id="news-2006-12-22"></a></h2>
<p><item date="2006-12-22" title="Version 1.1 Released">
This release adds an XMP metadata framework and brings improvements for the ImageWriter package plus some minor fixes mainly in the PostScript area.
</item></p>
-<h2 id="17-apr-2006-version-10-released-wzxhzdk30wzxhzdk31">17 Apr 2006: Version 1.0 Released # <a id="news-2006-04-17"></a></h2>
+<h2 id="17-apr-2006-version-10-released-wzxhzdk30wzxhzdk31">17 Apr 2006: Version 1.0 Released <a id="news-2006-04-17"></a></h2>
<p><item date="2006-04-17" title="Version 1.0 Released">
This is the first release of Apache XML Graphics Commons. There are currently no known issues with the code.
</item></p></div>
Modified: websites/staging/xmlgraphics/trunk/content/commons/postscript.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/commons/postscript.html (original)
+++ websites/staging/xmlgraphics/trunk/content/commons/postscript.html Wed Oct 24 04:26:06 2012
@@ -129,7 +129,7 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/commons/">Commons</a></div> -->
<div class="section-content"><h1 id="tools-for-adobe-postscript">Tools for Adobe PostScript</h1>
-<h2 id="overview-wzxhzdk0wzxhzdk1">Overview <a id="overview"></a></h2>
+<h2 id="overview-wzxhzdk0wzxhzdk1">Overview <a id="overview"></a></h2>
<p>Apache™ XML Graphics Commons contains various tools for writing and processing Adobe PostScript files. This includes:</p>
<ul>
<li>
@@ -143,12 +143,12 @@ $(document).ready(function () {
We don't currently include a PostScript interpreter though we would love to have one. A Java-based PostScript interpreter to keep an eye on is the one from the <a href="http://foray.sourceforge.net">FOray project</a> .</p>
</li>
</ul>
-<h1 id="the-postscript-generator-wzxhzdk3wzxhzdk4">The PostScript generator <a id="generator"></a></h1>
+<h1 id="the-postscript-generator-wzxhzdk3wzxhzdk4">The PostScript generator <a id="generator"></a></h1>
<p>The "PSGenerator" class can help writing PostScript files. It deals with things like escaping, saving/tracking/restoring graphics state, writing DSC comments and tracking of DSC resources.</p>
<p>You will rarely interact with the PS generator itself, as it is probably more interesting to generate a PostScript file using Java2D which is described in the following section.</p>
-<h2 id="java2d-graphics2d-implementation-for-generating-postscript-and-eps-wzxhzdk5wzxhzdk6">Java2D: Graphics2D implementation for generating PostScript and EPS <a id="java2d"></a></h2>
+<h2 id="java2d-graphics2d-implementation-for-generating-postscript-and-eps-wzxhzdk5wzxhzdk6">Java2D: Graphics2D implementation for generating PostScript and EPS <a id="java2d"></a></h2>
<p>We provide two classes (PSDocumentGraphics2D and EPSDocumentGraphics2D) which you can use to generated complete PostScript files using normal Java2D means. The difference between the two classes is that the EPS variant creates a fully compliant Encapsulated PostScript file while the PS variant simply creates a normal DSC-compliant level 2 PostScript file. It depends on your requirement which variant you choose. The PS variant is mostly for printing purposes while the EPS variant is better suited for inclusion in other documents.</p>
-<h3 id="creating-an-eps-file-wzxhzdk7wzxhzdk8">Creating an EPS file # <a id="creating-eps"></a></h3>
+<h3 id="creating-an-eps-file-wzxhzdk7wzxhzdk8">Creating an EPS file <a id="creating-eps"></a></h3>
<p>Creating an EPS file using the Graphics2D implementation is easy. Instantiate EPSDocumentGraphics2D, set a GraphicContext and set up the output document. Here's an example:</p>
<p>import org.apache.xmlgraphics.java2d.ps.EPSDocumentGraphics2D;</p>
<p class="."></p>
@@ -160,7 +160,7 @@ g2d.setupDocument(out, 400, 200); //400p
<p>g2d.drawRect(10, 10, 50, 50); //paint a rectangle using normal Java2D calls</p>
<p>g2d.finish(); //Wrap up and finalize the EPS file</p>
<p>A complete example for generating an EPS files can be found in the <a href="http://svn.apache.org/viewvc/xmlgraphics/commons/trunk/examples/java/java2d/ps/">"examples" directory</a> in the distribution.</p>
-<h2 id="dsc-parserprocessor-wzxhzdk9wzxhzdk10">DSC parser/processor <a id="dsc"></a></h2>
+<h2 id="dsc-parserprocessor-wzxhzdk9wzxhzdk10">DSC parser/processor <a id="dsc"></a></h2>
<p>Many PostScript files use special comments to structure a document. This allows manipulation of PostScript files without interpreting them. These special comments are defined in the <a href="http://partners.adobe.com/public/developer/en/ps/5001.DSC_Spec.pdf">Document Structuring Conventions</a> . The code in Commons is designed to work with DSC 3.0. For details on how DSC is used, please take a look at the DSC specification.</p>
<p>The DSC support in Commons was primarily developed to implement resource optimization features in <a href="http://xmlgraphics.apache.org/fop/">Apache FOP</a> 's PostScript output support. Resources like images which are used repeatedly in a document should not be written to the PostScript file each time it is used. Instead it is written once at the beginning of the file as a PostScript form. The form is then called whenever the image needs painting.</p>
<p>But the DSC parser could potentially be used for other purposes. The most obvious is extracting a subset of pages from a DSC-compliant file. Assume you want to print only page 45 to 57 of a particular document. There's an example that demonstrates exactly this. Check out the "examples" directory in the distribution. Other potential use cases for the DSC parser are:</p>
Modified: websites/staging/xmlgraphics/trunk/content/fop/0.95/anttask.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/0.95/anttask.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/0.95/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 |
|-----------|-------------|----------|
@@ -372,7 +372,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/0.95/changes_0.95.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/0.95/changes_0.95.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/0.95/changes_0.95.html Wed Oct 24 04:26:06 2012
@@ -332,18 +332,18 @@ $(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="history-of-changes-095">History of Changes 0.95</h1>
<p><a href="changes_0.95.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-095-05-august-2008-wzxhzdk10wzxhzdk11">Version 0.95 (05 August 2008) <a id="version_0.95"></a></h2>
-<h3 id="changes-to-the-end-user-api-wzxhzdk12wzxhzdk13">Changes to the End-User API # <a id="API_0.95"></a></h3>
+<h2 id="version-095-05-august-2008-wzxhzdk10wzxhzdk11">Version 0.95 (05 August 2008) <a id="version_0.95"></a></h2>
+<h3 id="changes-to-the-end-user-api-wzxhzdk12wzxhzdk13">Changes to the End-User API <a id="API_0.95"></a></h3>
<ul>
<li><icon alt="fix" src="../images/fix.jpg"></icon>Fixed the -imagein command-line option. Committed by JM.</li>
</ul>
-<h3 id="changes-to-the-code-base-wzxhzdk14wzxhzdk15">Changes to the Code Base # <a id="Code_0.95"></a></h3>
+<h3 id="changes-to-the-code-base-wzxhzdk14wzxhzdk15">Changes to the Code Base <a id="Code_0.95"></a></h3>
<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-font-subsystem-wzxhzdk16wzxhzdk17">Changes to the Font Subsystem # <a id="Fonts_0.95"></a></h3>
+<h3 id="changes-to-the-font-subsystem-wzxhzdk16wzxhzdk17">Changes to the Font Subsystem <a id="Fonts_0.95"></a></h3>
<ul>
<li>
<p><icon alt="fix" src="../images/fix.jpg"></icon>Fixed text extraction problem with ZapfDingbats and Symbol font in PDF output. Committed by JM.</p>
@@ -352,7 +352,7 @@ $(document).ready(function () {
<p><icon alt="fix" src="../images/fix.jpg"></icon>Fixed NullPointerException when loading a TrueType font using XML font metric files. Committed by JM.</p>
</li>
</ul>
-<h3 id="changes-to-the-image-support-wzxhzdk18wzxhzdk19">Changes to the Image Support # <a id="Images_0.95"></a></h3>
+<h3 id="changes-to-the-image-support-wzxhzdk18wzxhzdk19">Changes to the Image Support <a id="Images_0.95"></a></h3>
<ul>
<li>
<p><icon alt="fix" src="../images/fix.jpg"></icon>Fixed two bugs concerning resolution handling with SVG images and their conversion to bitmaps for RTF output. Committed by JM.</p>
@@ -361,7 +361,7 @@ $(document).ready(function () {
<p><icon alt="fix" src="../images/fix.jpg"></icon>Fixed a performance problem concerning image serialization. Committed by JM.</p>
</li>
</ul>
-<h3 id="changes-to-the-layout-engine-wzxhzdk20wzxhzdk21">Changes to the Layout Engine # <a id="Layout_0.95"></a></h3>
+<h3 id="changes-to-the-layout-engine-wzxhzdk20wzxhzdk21">Changes to the Layout Engine <a id="Layout_0.95"></a></h3>
<ul>
<li>
<p><icon alt="fix" src="../images/fix.jpg"></icon>Fixed NullPointerException when page-number-citations are used inside a marker. Committed by AD. See Issue <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=45295">45295</a> .</p>
@@ -373,7 +373,7 @@ $(document).ready(function () {
<p><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> .</p>
</li>
</ul>
-<h3 id="changes-to-renderers-output-formats-wzxhzdk22wzxhzdk23">Changes to Renderers (Output Formats) # <a id="Renderers_0.95"></a></h3>
+<h3 id="changes-to-renderers-output-formats-wzxhzdk22wzxhzdk23">Changes to Renderers (Output Formats) <a id="Renderers_0.95"></a></h3>
<ul>
<li>
<p><icon alt="add" src="../images/add.jpg"></icon>Added support for fo:leader for RTF output (no full support!). Fixes problems with empty leaders being used to force empty lines among other issues. Committed by JM. Thanks to Maximilian Aster. See Issue <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=43825">43825</a> .</p>
@@ -406,7 +406,7 @@ $(document).ready(function () {
<p><icon alt="fix" src="../images/fix.jpg"></icon>Fixed regression causing bad positioning of block-containers if used as descendant of a table-cell. Committed by JM.</p>
</li>
</ul>
-<h3 id="contributors-to-this-release-wzxhzdk24wzxhzdk25">Contributors to this release # <a id="contributors_0.95"></a></h3>
+<h3 id="contributors-to-this-release-wzxhzdk24wzxhzdk25">Contributors to this release <a id="contributors_0.95"></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>Andreas Delmelle (AD), Jeremias Märki (JM), Vincent Hennebert (VH).</p>
<p>This is a list of other contributors:<br></br>Maximilian Aster.</p></div>
Modified: websites/staging/xmlgraphics/trunk/content/fop/0.95/changes_0.95beta.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/0.95/changes_0.95beta.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/0.95/changes_0.95beta.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/0.95/">0.95</a></div> -->
<div class="section-content"><h1 id="history-of-changes-095beta">History of Changes 0.95beta</h1>
<p><a href="changes_0.95beta.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-095beta-26-march-2008-wzxhzdk10wzxhzdk11">Version 0.95beta (26 March 2008) <a id="version_0.95beta"></a></h2>
-<h3 id="changes-to-the-end-user-api-wzxhzdk12wzxhzdk13">Changes to the End-User API # <a id="API_0.95beta"></a></h3>
+<h2 id="version-095beta-26-march-2008-wzxhzdk10wzxhzdk11">Version 0.95beta (26 March 2008) <a id="version_0.95beta"></a></h2>
+<h3 id="changes-to-the-end-user-api-wzxhzdk12wzxhzdk13">Changes to the End-User API <a id="API_0.95beta"></a></h3>
<ul>
<li><icon alt="remove" src="../images/remove.jpg"></icon>Removed deprecated methods in the "apps" package that were left-overs from the API discussions. Committed by JM.</li>
</ul>
-<h3 id="changes-to-the-code-base-wzxhzdk14wzxhzdk15">Changes to the Code Base # <a id="Code_0.95beta"></a></h3>
+<h3 id="changes-to-the-code-base-wzxhzdk14wzxhzdk15">Changes to the Code Base <a id="Code_0.95beta"></a></h3>
<ul>
<li>
<p><icon alt="add" src="../images/add.jpg"></icon>Turned on XInclude processing for the main source given on the command line. Committed by MB.</p>
@@ -369,7 +369,7 @@ $(document).ready(function () {
<p><icon alt="fix" src="../images/fix.jpg"></icon>Avoid a NullPointerException in AreaTreeHandler.endDocument(). Committed by JM. Thanks to David Delbecq. See Issue <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=43910">43910</a> .</p>
</li>
</ul>
-<h3 id="changes-to-the-bundled-extensions-wzxhzdk16wzxhzdk17">Changes to the Bundled Extensions # <a id="Extensions_0.95beta"></a></h3>
+<h3 id="changes-to-the-bundled-extensions-wzxhzdk16wzxhzdk17">Changes to the Bundled Extensions <a id="Extensions_0.95beta"></a></h3>
<ul>
<li>
<p><icon alt="add" src="../images/add.jpg"></icon>New extension attribute fox:transform on fo:block-container allows free-form transformation (rotation, scaling etc.) of absolute and fixed block-containers. Supported only for PDF, PS and Java2D-based renderers. Committed by JM.</p>
@@ -378,7 +378,7 @@ $(document).ready(function () {
<p><icon alt="add" src="../images/add.jpg"></icon>Added new extension element: fox:external-document. It allows to add whole documents such as multi-page TIFF images to be inserted as peers to a page-sequence. Each image will make up an entire page. See the documentation for details. Committed by JM.</p>
</li>
</ul>
-<h3 id="changes-to-the-font-subsystem-wzxhzdk18wzxhzdk19">Changes to the Font Subsystem # <a id="Fonts_0.95beta"></a></h3>
+<h3 id="changes-to-the-font-subsystem-wzxhzdk18wzxhzdk19">Changes to the Font Subsystem <a id="Fonts_0.95beta"></a></h3>
<ul>
<li>
<p><icon alt="add" src="../images/add.jpg"></icon>Added support for unusual font encodings (like for Symbol or Cyrillic fonts) of Type 1 fonts in PDF and PostScript output. Committed by JM.</p>
@@ -411,11 +411,11 @@ $(document).ready(function () {
<p><icon alt="update" src="../images/update.jpg"></icon>Improved font auto-detection and handling of AWT-supplied fonts in order to achieve better results when using multiple output formats. Whenever possible, the font names appearing in the operating system can also be used in XSL-FO. Committed by JM.</p>
</li>
</ul>
-<h3 id="changes-to-the-image-support-wzxhzdk20wzxhzdk21">Changes to the Image Support # <a id="Images_0.95beta"></a></h3>
+<h3 id="changes-to-the-image-support-wzxhzdk20wzxhzdk21">Changes to the Image Support <a id="Images_0.95beta"></a></h3>
<ul>
<li><icon alt="fix" src="../images/fix.jpg"></icon>A new image loading framework has been introduced to fix various problems with external graphics and improve performance. Committed by JM.</li>
</ul>
-<h3 id="changes-to-the-layout-engine-wzxhzdk22wzxhzdk23">Changes to the Layout Engine # <a id="Layout_0.95beta"></a></h3>
+<h3 id="changes-to-the-layout-engine-wzxhzdk22wzxhzdk23">Changes to the Layout Engine <a id="Layout_0.95beta"></a></h3>
<ul>
<li>
<p><icon alt="add" src="../images/add.jpg"></icon>Added support for background on fo:table-column and fo:table-header/footer/body elements. Committed by VH.</p>
@@ -532,7 +532,7 @@ $(document).ready(function () {
<p><icon alt="update" src="../images/update.jpg"></icon>PropertyCache phase 2:<br></br>⢠improvement of the PropertyCache itself should now guarantee acceptable performance of the static caches in multi-session environments, which is a possible problem with synchronizedMap.<br></br>⢠changed CommonFont to use the cache: added CachedCommonFont to contain the properties that are always cacheable CommonFont itself is only cached if the remaining properties are absolutes.<br></br>⢠changed CommonHyphenation, KeepProperty, ColorProperty and FontFamilyProperty to use the cache.<br></br>Committed by AD.</p>
</li>
</ul>
-<h3 id="changes-to-renderers-output-formats-wzxhzdk24wzxhzdk25">Changes to Renderers (Output Formats) # <a id="Renderers_0.95beta"></a></h3>
+<h3 id="changes-to-renderers-output-formats-wzxhzdk24wzxhzdk25">Changes to Renderers (Output Formats) <a id="Renderers_0.95beta"></a></h3>
<ul>
<li>
<p><icon alt="add" src="../images/add.jpg"></icon>Added an option to disable the default sRGB profile in PDF output for those who don't care about color fidelity, but care about PDF file size. Committed by JM.</p>
@@ -592,7 +592,7 @@ $(document).ready(function () {
<p><icon alt="update" src="../images/update.jpg"></icon>PDF Transcoder (SVG) text painting has been completely rewritten. Except for some special cases (with filters for example), all text (including flow text) is now painted using PDF text operators. Committed by JM.</p>
</li>
</ul>
-<h3 id="contributors-to-this-release-wzxhzdk26wzxhzdk27">Contributors to this release # <a id="contributors_0.95beta"></a></h3>
+<h3 id="contributors-to-this-release-wzxhzdk26wzxhzdk27">Contributors to this release <a id="contributors_0.95beta"></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), Jeremias Märki (JM), Max Berger (MB), Vincent Hennebert (VH).</p>
<p>This is a list of other contributors:<br></br>Adrian Cumiskey, Andrejus Chaliapinas, Bruno Feurer, ckohrn.at.tng.de, David Churavy, David Delbecq, Gordon Cooke, Justus Piater, Max Berger, Patrick Jaromin, Stefan Ziel, V. Schappert.</p></div>
Modified: websites/staging/xmlgraphics/trunk/content/fop/0.95/compiling.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/0.95/compiling.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/0.95/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/0.95/">0.95</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/0.95/configuration.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/0.95/configuration.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/0.95/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/0.95/">0.95</a></div> -->
<div class="section-content"><h1 id="apachewzxhzdk5-fop-configuration">Apache™ FOP: Configuration</h1>
<p><version>$Revision: 1298724 $</version></p>
-<h2 id="configuration-file-basics-wzxhzdk8wzxhzdk9">Configuration File Basics <a id="general"></a></h2>
+<h2 id="configuration-file-basics-wzxhzdk8wzxhzdk9">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-wzxhzdk10wzxhzdk11">Making Configuration Available to FOP # <a id="general-available"></a></h3>
+<h3 id="making-configuration-available-to-fop-wzxhzdk10wzxhzdk11">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-wzxhzdk12wzxhzdk13">Summary of the General Configuration Options <a id="general-elements"></a></h2>
+<h2 id="summary-of-the-general-configuration-options-wzxhzdk12wzxhzdk13">Summary of the General Configuration Options <a id="general-elements"></a></h2>
<table>
<thead>
<tr>
@@ -450,7 +450,7 @@ $(document).ready(function () {
<default-page-settings height="11in" width="8.26in"/></p>
<p><!-- etc. etc..... -->
</fop></p>
-<h1 id="renderer-configuration-wzxhzdk37wzxhzdk38">Renderer configuration <a id="renderers"></a></h1>
+<h1 id="renderer-configuration-wzxhzdk37wzxhzdk38">Renderer configuration <a id="renderers"></a></h1>
<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>
@@ -476,7 +476,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-wzxhzdk57wzxhzdk58">Special Settings for the PDF Renderer # <a id="pdf-renderer"></a></h3>
+<h3 id="special-settings-for-the-pdf-renderer-wzxhzdk57wzxhzdk58">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>
@@ -514,7 +514,7 @@ $(document).ready(function () {
</pre></div>
-<h2 id="special-settings-for-the-postscript-renderer-wzxhzdk59wzxhzdk60">Special Settings for the PostScript Renderer # <a id="ps-renderer"></a></h2>
+<h2 id="special-settings-for-the-postscript-renderer-wzxhzdk59wzxhzdk60">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>
@@ -533,7 +533,7 @@ $(document).ready(function () {
</pre></div>
-<h2 id="special-settings-for-the-pcl-renderer-wzxhzdk61wzxhzdk62">Special Settings for the PCL Renderer # <a id="pcl-renderer"></a></h2>
+<h2 id="special-settings-for-the-pcl-renderer-wzxhzdk61wzxhzdk62">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">
@@ -542,7 +542,7 @@ $(document).ready(function () {
</renderer>
The default value for the "rendering" setting is "speed" which causes borders to be painted as plain rectangles. In this mode, no special borders (dotted, dashed etc.) are available. If you want support for all border modes, set the value to "quality" as indicated above. This will cause the borders to be painted as bitmaps.</p>
<p>The default value for the "text-rendering" setting is "auto" which paints the base fonts using PCL fonts. Non-base fonts are painted as bitmaps through Java2D. If the mix of painting methods results in unwelcome output, you can set this to "bitmap" which causes all text to be rendered as bitmaps.</p>
-<h2 id="when-it-does-not-work-wzxhzdk69wzxhzdk70">When it does not work <a id="When+it+does+not+work"></a></h2>
+<h2 id="when-it-does-not-work-wzxhzdk69wzxhzdk70">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/0.95/embedding.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/0.95/embedding.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/0.95/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/0.95/">0.95</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-wzxhzdk6wzxhzdk7">Overview <a id="overview"></a></h2>
+<h2 id="overview-wzxhzdk6wzxhzdk7">Overview <a id="overview"></a></h2>
<p>Review <a href="running.html">Running Apache™ FOP</a> for important information that applies to embedded applications as well as command-line use, such as options and performance.</p>
<p>To embed Apache™ FOP in your application, first create a new org.apache.fop.apps.FopFactory instance. This object can be used to launch multiple rendering runs. For each run, create a new org.apache.fop.apps.Fop instance through one of the factory methods of FopFactory. In the method call you specify which output format (i.e. 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-wzxhzdk10wzxhzdk11">Basic Usage Pattern <a id="basics"></a></h1>
+<h1 id="basic-usage-pattern-wzxhzdk10wzxhzdk11">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,20 +389,20 @@ 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-wzxhzdk12wzxhzdk13">Logging # <a id="basic-logging"></a></h3>
+<h3 id="logging-wzxhzdk12wzxhzdk13">Logging <a id="basic-logging"></a></h3>
<p>Logging is now a little different than it was in FOP 0.20.5. We've switched from Avalon Logging to <a href="http://commons.apache.org/logging/">Jakarta Commons Logging</a> . While with Avalon Logging the loggers were directly given to FOP, FOP now retrieves its logger(s) through a statically available LogFactory. This is similar to the general pattern that you use when you work with Apache Log4J directly, for example. We call this "static logging" (Commons Logging, Log4J) as opposed to "instance logging" (Avalon Logging). This has a consequence: You can't give FOP a logger for each processing run anymore. The log output of multiple, simultaneously running FOP instances is sent to the same logger.
We know this may be an issue in multi-threaded server environments if you'd like to know what's going on in every single FOP processing run. We're planning to add an additional feedback facility to FOP which can be used to obtain all sorts of specific feedback (validation messages, layout problems etc.). "Static logging" is mainly interesting for a developer working on FOP and for advanced users who are debugging FOP. We don't consider the logging output to be useful to normal FOP users. Please have some patience until we can add this feature or jump in and help us build it. We've set up a <a href="http://wiki.apache.org/xmlgraphics-fop/ProcessingFeedback">Wiki page</a> which documents what we're going to build.
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>
-<h3 id="processing-xsl-fo-wzxhzdk14wzxhzdk15">Processing XSL-FO # <a id="render"></a></h3>
+<h3 id="processing-xsl-fo-wzxhzdk14wzxhzdk15">Processing XSL-FO <a id="render"></a></h3>
<p>Once the Fop instance is set up, call <code>getDefaultHandler()</code> to obtain a SAX DefaultHandler instance to which you can send the SAX events making up the XSL-FO document you'd like to render. FOP processing starts as soon as the DefaultHandler's <code>startDocument()</code> method is called. Processing stops again when the DefaultHandler's <code>endDocument()</code> method is called. Please refer to the basic usage pattern shown above to render a simple XSL-FO document.</p>
-<h3 id="processing-xsl-fo-generated-from-xmlxslt-wzxhzdk16wzxhzdk17">Processing XSL-FO generated from XML+XSLT # <a id="render-with-xslt"></a></h3>
+<h3 id="processing-xsl-fo-generated-from-xmlxslt-wzxhzdk16wzxhzdk17">Processing XSL-FO generated from XML+XSLT <a id="render-with-xslt"></a></h3>
<p>If you want to process XSL-FO generated from XML using XSLT we recommend again using standard JAXP to do the XSLT part and piping the generated SAX events directly through to FOP. The only thing you'd change to do that on the basic usage pattern above is to set up the Transformer differently:</p>
<p>//without XSLT:
//Transformer transformer = factory.newTransformer(); // identity transformer</p>
<p>//with XSLT:
Source xslt = new StreamSource(new File("mystylesheet.xsl"));
Transformer transformer = factory.newTransformer(xslt);</p>
-<h1 id="input-sources-wzxhzdk18wzxhzdk19">Input Sources <a id="input"></a></h1>
+<h1 id="input-sources-wzxhzdk18wzxhzdk19">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>
@@ -429,9 +429,9 @@ By default, <a href="http://commons.apac
</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-wzxhzdk20wzxhzdk21">Configuring Apache FOP Programmatically <a id="config-internal"></a></h2>
+<h2 id="configuring-apache-fop-programmatically-wzxhzdk20wzxhzdk21">Configuring Apache FOP Programmatically <a id="config-internal"></a></h2>
<p>Apache FOP provides two levels on which you can customize FOP's behaviour: the FopFactory and the user agent.</p>
-<h3 id="customizing-the-fopfactory-wzxhzdk22wzxhzdk23">Customizing the FopFactory # <a id="fop-factory"></a></h3>
+<h3 id="customizing-the-fopfactory-wzxhzdk22wzxhzdk23">Customizing the FopFactory <a id="fop-factory"></a></h3>
<p>The FopFactory holds configuration data and references to objects which are reusable over multiple rendering runs. It's important to instantiate it only once (except in special environments) and reuse it every time to create new FOUserAgent and Fop instances.</p>
<p>You can set all sorts of things on the FopFactory:</p>
<ul>
@@ -464,7 +464,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-wzxhzdk24wzxhzdk25">Customizing the User Agent # <a id="user-agent"></a></h3>
+<h3 id="customizing-the-user-agent-wzxhzdk24wzxhzdk25">Customizing the User Agent <a id="user-agent"></a></h3>
<p>The user agent is the entity that allows you to interact with a single rendering run, i.e. the processing of a single document. If you wish to customize the user agent's behaviour, the first step is to create your own instance of FOUserAgent using the appropriate factory method on FopFactory and pass that to the factory method that will create a new Fop instance:</p>
<p>FopFactory fopFactory = FopFactory.newInstance(); // Reuse the FopFactory if possible!
// do the following for each new rendering run
@@ -519,7 +519,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-wzxhzdk26wzxhzdk27">Using a Configuration File <a id="config-external"></a></h1>
+<h1 id="using-a-configuration-file-wzxhzdk26wzxhzdk27">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>
@@ -530,16 +530,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-wzxhzdk28wzxhzdk29">Hints <a id="hints"></a></h2>
-<h3 id="object-reuse-wzxhzdk30wzxhzdk31">Object reuse # <a id="object-reuse"></a></h3>
+<h2 id="hints-wzxhzdk28wzxhzdk29">Hints <a id="hints"></a></h2>
+<h3 id="object-reuse-wzxhzdk30wzxhzdk31">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-wzxhzdk32wzxhzdk33">AWT issues # <a id="awt"></a></h3>
+<h3 id="awt-issues-wzxhzdk32wzxhzdk33">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-wzxhzdk34wzxhzdk35">Getting information on the rendering process # <a id="render-info"></a></h3>
+<h3 id="getting-information-on-the-rendering-process-wzxhzdk34wzxhzdk35">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-wzxhzdk36wzxhzdk37">Improving performance <a id="performance"></a></h2>
+<h2 id="improving-performance-wzxhzdk36wzxhzdk37">Improving performance <a id="performance"></a></h2>
<p>There are several options to consider:</p>
<ul>
<li>
@@ -558,35 +558,35 @@ The layout of the configuration file is
<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>
</ul>
-<h2 id="multithreading-fop-wzxhzdk38wzxhzdk39">Multithreading FOP <a id="multithreading"></a></h2>
+<h2 id="multithreading-fop-wzxhzdk38wzxhzdk39">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-wzxhzdk40wzxhzdk41">Examples <a id="examples"></a></h2>
+<h2 id="examples-wzxhzdk40wzxhzdk41">Examples <a id="examples"></a></h2>
<p>The directory "{fop-dir}/examples/embedding" contains several working examples.</p>
-<h3 id="examplefo2pdfjava-wzxhzdk42wzxhzdk43">ExampleFO2PDF.java # <a id="ExampleFO2PDF"></a></h3>
+<h3 id="examplefo2pdfjava-wzxhzdk42wzxhzdk43">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-wzxhzdk46wzxhzdk47">ExampleXML2FO.java # <a id="ExampleXML2FO"></a></h2>
+<h2 id="examplexml2fojava-wzxhzdk46wzxhzdk47">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-wzxhzdk50wzxhzdk51">ExampleXML2PDF.java # <a id="ExampleXML2PDF"></a></h2>
+<h2 id="examplexml2pdfjava-wzxhzdk50wzxhzdk51">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-wzxhzdk54wzxhzdk55">ExampleObj2XML.java # <a id="ExampleObj2XML"></a></h3>
+<h3 id="exampleobj2xmljava-wzxhzdk54wzxhzdk55">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-wzxhzdk58wzxhzdk59">ExampleObj2PDF.java # <a id="ExampleObj2PDF"></a></h3>
+<h3 id="exampleobj2pdfjava-wzxhzdk58wzxhzdk59">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-wzxhzdk62wzxhzdk63">ExampleDOM2PDF.java # <a id="ExampleDOM2PDF"></a></h2>
+<h2 id="exampledom2pdfjava-wzxhzdk62wzxhzdk63">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-wzxhzdk64wzxhzdk65">ExampleSVG2PDF.java (PDF Transcoder example) # <a id="ExampleSVG2PDF"></a></h3>
+<h3 id="examplesvg2pdfjava-pdf-transcoder-example-wzxhzdk64wzxhzdk65">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-wzxhzdk66wzxhzdk67">Final notes # <a id="example-notes"></a></h3>
+<h3 id="final-notes-wzxhzdk66wzxhzdk67">Final notes <a id="example-notes"></a></h3>
<p>These examples should give you an idea of what's possible. It should be easy to adjust these examples to your needs. Also, if you have other examples that you think should be added here, please let us know via either the fop-users or fop-dev mailing lists. Finally, for more help please send your questions to the fop-users mailing list.</p></div>
</div>
Modified: websites/staging/xmlgraphics/trunk/content/fop/0.95/extensions.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/0.95/extensions.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/0.95/extensions.html Wed Oct 24 04:26:06 2012
@@ -335,25 +335,25 @@ $(document).ready(function () {
<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, 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-wzxhzdk3wzxhzdk4">SVG <a id="svg"></a></h1>
+<h1 id="svg-wzxhzdk3wzxhzdk4">SVG <a id="svg"></a></h1>
<p>Please see the <a href="graphics.html#svg">SVG documentation</a> for more details.</p>
-<h2 id="fo-extensions-wzxhzdk5wzxhzdk6">FO Extensions <a id="fo-extensions"></a></h2>
-<h3 id="namespace-wzxhzdk7wzxhzdk8">Namespace # <a id="fox-namespace"></a></h3>
+<h2 id="fo-extensions-wzxhzdk5wzxhzdk6">FO Extensions <a id="fo-extensions"></a></h2>
+<h3 id="namespace-wzxhzdk7wzxhzdk8">Namespace <a id="fox-namespace"></a></h3>
<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="pdf-bookmarks-wzxhzdk10wzxhzdk11">PDF Bookmarks # <a id="bookmarks"></a></h2>
+<h2 id="pdf-bookmarks-wzxhzdk10wzxhzdk11">PDF Bookmarks <a id="bookmarks"></a></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>
-<h3 id="anchors-or-named-destinations-wzxhzdk12wzxhzdk13">Anchors or Named Destinations # <a id="named-destinations"></a></h3>
+<h3 id="anchors-or-named-destinations-wzxhzdk12wzxhzdk13">Anchors or Named Destinations <a id="named-destinations"></a></h3>
<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-continuation-label-wzxhzdk19wzxhzdk20">Table Continuation Label # <a id="table-continue-label"></a></h2>
+<h2 id="table-continuation-label-wzxhzdk19wzxhzdk20">Table Continuation Label <a id="table-continue-label"></a></h2>
<p>This extension element hasn't been reimplemented for the redesigned code, yet.</p>
-<h3 id="foxorphan-content-limit-and-foxwidow-content-limit-wzxhzdk21wzxhzdk22">fox:orphan-content-limit and fox:widow-content-limit # <a id="widow-orphan-content-limit"></a></h3>
+<h3 id="foxorphan-content-limit-and-foxwidow-content-limit-wzxhzdk21wzxhzdk22">fox:orphan-content-limit and fox:widow-content-limit <a id="widow-orphan-content-limit"></a></h3>
<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>
-<h3 id="foxexternal-document-wzxhzdk23wzxhzdk24">fox:external-document # <a id="external-document"></a></h3>
+<h3 id="foxexternal-document-wzxhzdk23wzxhzdk24">fox:external-document <a id="external-document"></a></h3>
<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>
@@ -421,11 +421,11 @@ This is a proprietary extension element
</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="free-form-transformation-for-foblock-container-wzxhzdk29wzxhzdk30">Free-form Transformation for fo:block-container # <a id="transform"></a></h2>
+<h2 id="free-form-transformation-for-foblock-container-wzxhzdk29wzxhzdk30">Free-form Transformation for fo:block-container <a id="transform"></a></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-wzxhzdk31wzxhzdk32">Color functions # <a id="color-functions"></a></h2>
+<h2 id="color-functions-wzxhzdk31wzxhzdk32">Color functions <a id="color-functions"></a></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>
<h4 id="cmyk-wzxhzdk33wzxhzdk34">cmyk() ## <a id="color-function-cmyk"></a></h4>
<p><code>color cmyk(numeric, numeric, numeric, numeric)</code> </p>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: commits-help@xmlgraphics.apache.org