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 [6/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/1.0/events.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/events.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/events.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="apachewzxhzdk4-fop-eventsprocessing-feedback">Apache™ FOP: Events/Processing Feedback</h1>
<p><version>$Revision: 1298724 $</version></p>
-<h2 id="introduction-wzxhzdk7wzxhzdk8">Introduction <a id="introduction"></a></h2>
+<h2 id="introduction-wzxhzdk7wzxhzdk8">Introduction <a id="introduction"></a></h2>
<p>In versions until 0.20.5, Apache™ FOP used <a href="http://excalibur.apache.org/framework/index.html">Avalon-style Logging</a> where it was possible to supply a logger per processing run. During the redesign the logging infrastructure was switched over to <a href="http://commons.apache.org/logging/">Commons Logging</a> which is (like Log4J or java.util.logging) a "static" logging framework (the logger is accessed through static variables). This made it very difficult in a multi-threaded system to retrieve information for a single processing run.</p>
<p>With FOP's event subsystem, we'd like to close this gap again and even go further. The first point is to realize that we have two kinds of "logging". Firstly, we have the logging infrastructure for the (FOP) developer who needs to be able to enable finer log messages for certain parts of FOP to track down a certain problem. Secondly, we have the user who would like to be informed about missing images, overflowing lines or substituted fonts. These messages (or events) are targeted at less technical people and may ideally be localized (translated). Furthermore, tool and solution builders would like to integrate FOP into their own solutions. For example, an FO editor should be able to point the user to the right place where a particular problem occurred while developing a document template. Finally, some integrators would like to abort processing if a resource (an image or a font) has not been found, while others would simply continue. The event system allows to react on the
se events.</p>
<p>On this page, we won't discuss logging as such. We will show how the event subsystem can be used for various tasks. We'll first look at the event subsystem from the consumer side. Finally, the production of events inside FOP will be discussed (this is mostly interesting for FOP developers only).</p>
-<h2 id="the-consumer-side-wzxhzdk10wzxhzdk11">The consumer side <a id="consumer"></a></h2>
+<h2 id="the-consumer-side-wzxhzdk10wzxhzdk11">The consumer side <a id="consumer"></a></h2>
<p>The event subsystem is located in the <code>org.apache.fop.events</code> package and its base is the <code>Event</code> class. An instance is created for each event and is sent to a set of <code>EventListener</code> instances by the <code>EventBroadcaster</code> . An <code>Event</code> contains:</p>
<ul>
<li>
@@ -354,7 +354,7 @@ $(document).ready(function () {
</ul>
<p>The <code>EventFormatter</code> class can be used to translate the events into human-readable, localized messages.</p>
<p>A full example of what is shown here can be found in the <code>examples/embedding/java/embedding/events</code> directory in the FOP distribution. The example can also be accessed <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/examples/embedding/java/embedding/events/">via the web</a> .</p>
-<h3 id="writing-an-eventlistener-wzxhzdk12wzxhzdk13">Writing an EventListener # <a id="write-listener"></a></h3>
+<h3 id="writing-an-eventlistener-wzxhzdk12wzxhzdk13">Writing an EventListener <a id="write-listener"></a></h3>
<p>The following code sample shows a very simple EventListener. It basically just sends all events to System.out (stdout) or System.err (stderr) depending on the event severity.
import org.apache.fop.events.Event;
import org.apache.fop.events.EventFormatter;
@@ -385,12 +385,12 @@ public class SysOutEventListener impleme
You can see that for every event the method <code>processEvent</code> of the <code>EventListener</code> will be called. Inside this method you can do whatever processing you would like including throwing a <code>RuntimeException</code> , if you want to abort the current processing run.</p>
<p>The code above also shows how you can turn an event into a human-readable, localized message that can be presented to a user. The <code>EventFormatter</code> class does this for you. It provides additional methods if you'd like to explicitly specify the locale.</p>
<p>It is possible to gather all events for a whole processing run so they can be evaluated afterwards. However, care should be taken about memory consumption since the events provide references to objects inside FOP which may themselves have references to other objects. So holding on to these objects may mean that whole object trees cannot be released!</p>
-<h3 id="adding-an-eventlistener-wzxhzdk14wzxhzdk15">Adding an EventListener # <a id="add-listener"></a></h3>
+<h3 id="adding-an-eventlistener-wzxhzdk14wzxhzdk15">Adding an EventListener <a id="add-listener"></a></h3>
<p>To register the event listener with FOP, get the <code>EventBroadcaster</code> which is associated with the user agent ( <code>FOUserAgent</code> ) and add it there:
FOUserAgent foUserAgent = fopFactory.newFOUserAgent();
foUserAgent.getEventBroadcaster().addEventListener(new SysOutEventListener());
Please note that this is done separately for each processing run, i.e. for each new user agent.</p>
-<h3 id="an-additional-listener-example-wzxhzdk16wzxhzdk17">An additional listener example # <a id="listener-example1"></a></h3>
+<h3 id="an-additional-listener-example-wzxhzdk16wzxhzdk17">An additional listener example <a id="listener-example1"></a></h3>
<p>Here's an additional example of an event listener:</p>
<p>By default, FOP continues processing even if an image wasn't found. If you have more strict requirements and want FOP to stop if an image is not available, you can do something like the following in the simplest case:
public class MyEventListener implements EventListener {</p>
@@ -426,10 +426,10 @@ public class MyEventListener implements
<p>}
This throws a <code>RuntimeException</code> with the <code>FileNotFoundException</code> as the cause. Further processing effectively stops in FOP. You can catch the exception in your code and react as you see necessary.</p>
-<h2 id="the-producer-side-for-fop-developers-wzxhzdk18wzxhzdk19">The producer side (for FOP developers) <a id="producer"></a></h2>
+<h2 id="the-producer-side-for-fop-developers-wzxhzdk18wzxhzdk19">The producer side (for FOP developers) <a id="producer"></a></h2>
<p>This section is primarily for FOP and FOP plug-in developers. It describes how to use the event subsystem for producing events.
The event package has been designed in order to be theoretically useful for use cases outside FOP. If you think this is interesting independently from FOP, please talk to <a href="mailto:fop-dev@xmlgraphics.apache.org">us</a> .</p>
-<h2 id="producing-and-sending-an-event-wzxhzdk20wzxhzdk21">Producing and sending an event # <a id="basic-event-production"></a></h2>
+<h2 id="producing-and-sending-an-event-wzxhzdk20wzxhzdk21">Producing and sending an event <a id="basic-event-production"></a></h2>
<p>The basics are very simple. Just instantiate an <code>Event</code> object and fill it with the necessary parameters. Then pass it to the <code>EventBroadcaster</code> which distributes the events to the interested listeneners. Here's a code example:
Event ev = new Event(this, "complain", EventSeverity.WARN,
Event.paramsBuilder()
@@ -439,7 +439,7 @@ Event ev = new Event(this, "complain", E
EventBroadcaster broadcaster = [get it from somewhere];
broadcaster.broadcastEvent(ev);</p>
<p>The <code>Event.paramsBuilder()</code> is a <a href="http://en.wikipedia.org/wiki/Fluent_interface">fluent interface</a> to help with the build-up of the parameters. You could just as well instantiate a <code>Map</code> ( <code>Map<String, Object></code> ) and fill it with values.</p>
-<h3 id="the-eventproducer-interface-wzxhzdk22wzxhzdk23">The EventProducer interface # <a id="event-producer"></a></h3>
+<h3 id="the-eventproducer-interface-wzxhzdk22wzxhzdk23">The EventProducer interface <a id="event-producer"></a></h3>
<p>To simplify event production, the event subsystem provides the <code>EventProducer</code> interface. You can create interfaces which extend <code>EventProducer</code> . These interfaces will contain one method per event to be generated. By contract, each event method must have as its first parameter a parameter named "source" (Type Object) which indicates the object that generated the event. After that come an arbitrary number of parameters of any type as needed by the event.</p>
<p>The event producer interface does not need to have any implementation. The implementation is produced at runtime by a dynamic proxy created by <code>DefaultEventBroadcaster</code> . The dynamic proxy creates <code>Event</code> instances for each method call against the event producer interface. Each parameter (except "source") is added to the event's parameter map.</p>
<p>To simplify the code needed to get an instance of the event producer interface it is suggested to create a public inner provider class inside the interface.</p>
@@ -468,13 +468,13 @@ To produce the same event as in the firs
EventBroadcaster broadcaster = [get it from somewhere];
TestEventProducer producer = TestEventProducer.Provider.get(broadcaster);
producer.complain(this, "I'm tired", 23);</p>
-<h2 id="the-event-model-wzxhzdk24wzxhzdk25">The event model # <a id="event-model"></a></h2>
+<h2 id="the-event-model-wzxhzdk24wzxhzdk25">The event model <a id="event-model"></a></h2>
<p>Inside an invocation handler for a dynamic proxy, there's no information about the names of each parameter. The JVM doesn't provide it. The only thing you know is the interface and method name. In order to properly fill the <code>Event</code> 's parameter map we need to know the parameter names. These are retrieved from an event object model. This is found in the <code>org.apache.fop.events.model</code> package. The data for the object model is retrieved from an XML representation of the event model that is loaded as a resource. The XML representation is generated using an Ant task at build time ( <code>ant resourcegen</code> ). The Ant task (found in <code>src/codegen/java/org/apache/fop/tools/EventProducerCollectorTask.java</code> ) scans FOP's sources for descendants of the <code>EventProducer</code> interface and uses <a href="http://qdox.codehaus.org/">QDox</a> to parse these interfaces.</p>
<p>The event model XML files are generated during build by the Ant task mentioned above when running the "resourcegen" task. So just run <code>"ant resourcegen"</code> if you receive a <code>MissingResourceException</code> at runtime indicating that <code>"event-model.xml"</code> is missing.</p>
<p>Primarily, the QDox-based collector task records the parameters' names and types. Furthermore, it extracts additional attributes embedded as Javadoc comments from the methods. At the moment, the only such attribute is "@event.severity" which indicates the default event severity (which can be changed by event listeners). The example event producer above shows the Javadocs for an event method.</p>
<p>There's one more information that is extracted from the event producer information for the event model: an optional primary exception. The first exception in the "throws" declaration of an event method is noted. It is used to throw an exception from the invocation handler if the event has an event severity of "FATAL" when all listeners have been called (listeners can update the event severity). Please note that an implementation of <code>org.apache.fop.events.EventExceptionManager$ExceptionFactory</code> has to be registered for the <code>EventExceptionManager</code> to be able to construct the exception from an event.</p>
<p>For a given application, there can be multiple event models active at the same time. In FOP, each renderer is considered to be a plug-in and provides its own specific event model. The individual event models are provided through an <code>EventModelFactory</code> . This interface is implemented for each event model and registered through the service provider mechanism (see the <a href="#plug-ins">plug-ins section</a> for details).</p>
-<h3 id="event-severity-wzxhzdk26wzxhzdk27">Event severity # <a id="event-severity"></a></h3>
+<h3 id="event-severity-wzxhzdk26wzxhzdk27">Event severity <a id="event-severity"></a></h3>
<p>Four different levels of severity for events has been defined:</p>
<ol>
<li>
@@ -491,7 +491,7 @@ producer.complain(this, "I'm tired", 23)
</li>
</ol>
<p>Event listeners can choose to ignore certain events based on their event severity. Please note that you may recieve an event "twice" in a specific case: if there is a fatal error an event is generated and sent to the listeners. After that an exception is thrown with the same information and processing stops. If the fatal event is shown to the user and the following exception is equally presented to the user it may appear that the event is duplicated. Of course, the same information is just published through two different channels.</p>
-<h3 id="plug-ins-to-the-event-subsystem-wzxhzdk28wzxhzdk29">Plug-ins to the event subsystem # <a id="plug-ins"></a></h3>
+<h3 id="plug-ins-to-the-event-subsystem-wzxhzdk28wzxhzdk29">Plug-ins to the event subsystem <a id="plug-ins"></a></h3>
<p>The event subsystem is extensible. There are a number of extension points:</p>
<ul>
<li>
@@ -502,7 +502,7 @@ producer.complain(this, "I'm tired", 23)
</li>
</ul>
<p>The names in bold above are used as filenames for the service provider files that are placed in the <code>META-INF/services</code> directory. That way, they are automatically detected. This is a mechanism defined by the <a href="http://java.sun.com/j2se/1.4.2/docs/guide/jar/jar.html#Service%20Provider">JAR file specification</a> .</p>
-<h3 id="localization-l10n-wzxhzdk30wzxhzdk31">Localization (L10n) # <a id="l10n"></a></h3>
+<h3 id="localization-l10n-wzxhzdk30wzxhzdk31">Localization (L10n) <a id="l10n"></a></h3>
<p>One goal of the event subsystem was to have localized (translated) event messages. The <code>EventFormatter</code> class can be used to convert an event to a human-readable message. Each <code>EventProducer</code> can provide its own XML-based translation file. If there is none, a central translation file is used, called "EventFormatter.xml" (found in the same directory as the <code>EventFormatter</code> class).</p>
<p>The XML format used by the <code>EventFormatter</code> is the same as <a href="http://cocoon.apache.org/">Apache Cocoon's</a> catalog format. Here's an example:
<?xml version="1.0" encoding="UTF-8"?>
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/extensions.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/extensions.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/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, Apache™ FOP is able to add features that are not covered in the specification.</p>
<p>The extensions documented here are included with FOP, and are automatically available to you. If you wish to add an extension of your own to FOP, please see the <a href="../dev/extensions.html">Developers' Extension Page</a> .
All extensions require the correct use of an appropriate namespace in your input document.</p>
-<h1 id="svg-wzxhzdk4wzxhzdk5">SVG <a id="svg"></a></h1>
+<h1 id="svg-wzxhzdk4wzxhzdk5">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-wzxhzdk6wzxhzdk7">FO Extensions <a id="fo-extensions"></a></h2>
-<h3 id="namespace-wzxhzdk8wzxhzdk9">Namespace # <a id="fox-namespace"></a></h3>
+<h2 id="fo-extensions-wzxhzdk6wzxhzdk7">FO Extensions <a id="fo-extensions"></a></h2>
+<h3 id="namespace-wzxhzdk8wzxhzdk9">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-wzxhzdk11wzxhzdk12">PDF Bookmarks # <a id="bookmarks"></a></h2>
+<h2 id="pdf-bookmarks-wzxhzdk11wzxhzdk12">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-wzxhzdk13wzxhzdk14">Anchors or Named Destinations # <a id="named-destinations"></a></h3>
+<h3 id="anchors-or-named-destinations-wzxhzdk13wzxhzdk14">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-wzxhzdk20wzxhzdk21">Table Continuation Label # <a id="table-continue-label"></a></h2>
+<h2 id="table-continuation-label-wzxhzdk20wzxhzdk21">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-wzxhzdk22wzxhzdk23">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-wzxhzdk22wzxhzdk23">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-wzxhzdk24wzxhzdk25">fox:external-document # <a id="external-document"></a></h3>
+<h3 id="foxexternal-document-wzxhzdk24wzxhzdk25">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-wzxhzdk30wzxhzdk31">Free-form Transformation for fo:block-container # <a id="transform"></a></h2>
+<h2 id="free-form-transformation-for-foblock-container-wzxhzdk30wzxhzdk31">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-wzxhzdk32wzxhzdk33">Color functions # <a id="color-functions"></a></h2>
+<h2 id="color-functions-wzxhzdk32wzxhzdk33">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-wzxhzdk34wzxhzdk35">cmyk() ## <a id="color-function-cmyk"></a></h4>
<p><code>color cmyk(numeric, numeric, numeric, numeric)</code> </p>
@@ -441,7 +441,7 @@ This extension attribute doesn't work fo
<p><code>rgb-icc(153, 153, 102, #CMYK, 0, 0, 0.2, 0.4)</code> </p>
</li>
</ul>
-<h3 id="prepress-support-wzxhzdk38wzxhzdk39">Prepress Support # <a id="prepress"></a></h3>
+<h3 id="prepress-support-wzxhzdk38wzxhzdk39">Prepress Support <a id="prepress"></a></h3>
<p>This section defines a number of extensions related to <a href="http://en.wikipedia.org/wiki/Prepress">prepress</a> support. <code>fox:scale</code> defines a general scale factor for the generated pages. <code>fox:bleed</code> defines the <a href="http://en.wikipedia.org/wiki/Bleed_%28printing%29">bleed area</a> for a page. <code>fox:crop-offset</code> defines the outer edges of the area in which crop marks, registration marks, color bars and page information are placed. For details, please read on below.
Those extensions have been implemented in the PDF and Java2D renderers only.</p>
<h3 id="foxscale-wzxhzdk40wzxhzdk41">fox:scale ## <a id="scale"></a></h3>
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/fonts.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/fonts.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/fonts.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/1.0/">1.0</a></div> -->
<div class="section-content"><h1 id="apachewzxhzdk3-fop-fonts">Apache™ FOP: Fonts</h1>
<p><version>$Revision: 1298724 $</version><authors><person email="" name="Jeremias Märki"></person><person email="" name="Tore Engvig"></person><person email="" name="Adrian Cumiskey"></person><person email="" name="Max Berger"></person></authors></p>
-<h2 id="summary-wzxhzdk16wzxhzdk17">Summary <a id="intro"></a></h2>
+<h2 id="summary-wzxhzdk16wzxhzdk17">Summary <a id="intro"></a></h2>
<p>The following table summarizes the font capabilities of the various Apache� FOP renderers:</p>
<table>
<thead>
@@ -410,7 +410,7 @@ $(document).ready(function () {
</tr>
</tbody>
</table>
-<h2 id="base-14-fonts-wzxhzdk18wzxhzdk19">Base-14 Fonts <a id="Base-14+Fonts"></a></h2>
+<h2 id="base-14-fonts-wzxhzdk18wzxhzdk19">Base-14 Fonts <a id="Base-14+Fonts"></a></h2>
<p>The Adobe PostScript and PDF Specification specify a set of 14 fonts that must be available to every PostScript interpreter and PDF reader: Helvetica (normal, bold, italic, bold italic), Times (normal, bold, italic, bold italic), Courier (normal, bold, italic, bold italic), Symbol and ZapfDingbats.</p>
<p>The following font family names are hard-coded into FOP for the Base-14 font set:</p>
<table>
@@ -444,14 +444,14 @@ $(document).ready(function () {
</tbody>
</table>
<p>Please note that recent versions of Adobe Acrobat Reader replace "Helvetica" with "Arial" and "Times" with "Times New Roman" internally. GhostScript replaces "Helvetica" with "Nimbus Sans L" and "Times" with "Nimbus Roman No9 L". Other document viewers may do similar font substitutions. If you need to make sure that there are no such substitutions, you need to specify an explicit font and embed it in the target document.</p>
-<h2 id="missing-fonts-wzxhzdk20wzxhzdk21">Missing Fonts <a id="missing-fonts"></a></h2>
+<h2 id="missing-fonts-wzxhzdk20wzxhzdk21">Missing Fonts <a id="missing-fonts"></a></h2>
<p>When FOP does not have a specific font at its disposal (because it's not installed in the operating system or set up in FOP's configuration), the font is replaced with "any". "any" is internally mapped to the Base-14 font "Times" (see above).</p>
-<h2 id="missing-glyphs-wzxhzdk22wzxhzdk23">Missing Glyphs <a id="missing-glyphs"></a></h2>
+<h2 id="missing-glyphs-wzxhzdk22wzxhzdk23">Missing Glyphs <a id="missing-glyphs"></a></h2>
<p>Every font contains a particular set of <a href="http://en.wikipedia.org/wiki/Glyph">glyphs</a> . If no glyph can be found for a given character, FOP will issue a warning and use the glpyh for "#" (if available) instead. Before it does that, it consults a (currently hard-coded) registry of glyph substitution groups (see Glyphs.java in Apache XML Graphics Commons). This registry can supply alternative glyphs in some cases (like using space when a no-break space is requested). But there's no guarantee that the result will be as expected (for example, in the case of hyphens and similar glyphs). A better way is to use a font that has all the necessary glyphs. This glyph substitution is only a last resort.</p>
-<h2 id="java2dawtoperating-system-fonts-wzxhzdk24wzxhzdk25">Java2D/AWT/Operating System Fonts <a id="awt"></a></h2>
+<h2 id="java2dawtoperating-system-fonts-wzxhzdk24wzxhzdk25">Java2D/AWT/Operating System Fonts <a id="awt"></a></h2>
<p>The Java2D family of renderers (Java2D, AWT, Print, TIFF, PNG), use the Java AWT subsystem for font metric information. Through operating system registration, the AWT subsystem knows what fonts are available on the system, and the font metrics for each one.</p>
<p>When working with one of these output formats and you're missing a font, just install it in your operating system and they should be available for these renderers. Please note that this is not true for other output formats such as PDF or PostScript.</p>
-<h2 id="custom-fonts-wzxhzdk26wzxhzdk27">Custom Fonts <a id="custom"></a></h2>
+<h2 id="custom-fonts-wzxhzdk26wzxhzdk27">Custom Fonts <a id="custom"></a></h2>
<p>Support for custom fonts is highly output format dependent (see above table). This section shows how to add Type 1 and TrueType fonts to the PDF, PostScript and Java2D-based renderers. Other renderers (like AFP) support other font formats. Details in this case can be found on the page about <a href="output.html">output formats</a> .</p>
<p>In earlier FOP versions, it was always necessary to create an XML font metrics file if you wanted to add a custom font. This unconvenient step has been removed and in addition to that, FOP supports auto-registration of fonts, i.e. FOP can find fonts installed in your operating system or can scan user-specified directories for fonts. Font registration via XML font metrics file is still supported and may still be necessary for some very special cases as fallback variant while we stabilize font auto-detection.</p>
<p>Basic information about fonts can be found at:</p>
@@ -463,7 +463,7 @@ $(document).ready(function () {
<p><a href="http://partners.adobe.com/asn/developer/technotes/fonts.html">Adobe Font Technote</a> </p>
</li>
</ul>
-<h2 id="basic-font-configuration-wzxhzdk28wzxhzdk29">Basic font configuration <a id="basics"></a></h2>
+<h2 id="basic-font-configuration-wzxhzdk28wzxhzdk29">Basic font configuration <a id="basics"></a></h2>
<p>If you want FOP to use custom fonts, you need to tell it where to find them. This is done in the configuration file and once per renderer (because each output format is a little different). In the basic form, you can either tell FOP to find your operating system fonts or you can specify directories that it will search for support fonts. These fonts will then automatically be registered.</p>
<p><renderers>
<renderer mime="application/pdf">
@@ -481,9 +481,9 @@ $(document).ready(function () {
<p></renderer>
</renderers>Review the documentation for <a href="configuration.html">FOP Configuration</a> for instructions on making the FOP configuration available to FOP when it runs. Otherwise, FOP has no way of finding your custom font information. It is currently not possible to easily configure fonts from Java code.</p>
-<h1 id="advanced-font-configuration-wzxhzdk38wzxhzdk39">Advanced font configuration <a id="advanced"></a></h1>
+<h1 id="advanced-font-configuration-wzxhzdk38wzxhzdk39">Advanced font configuration <a id="advanced"></a></h1>
<p>The instructions found above should be sufficient for most users. Below are some additional instructions in case the basic font configuration doesn't lead to the desired results.</p>
-<h3 id="type-1-font-metrics-wzxhzdk40wzxhzdk41">Type 1 Font Metrics # <a id="type1-metrics"></a></h3>
+<h3 id="type-1-font-metrics-wzxhzdk40wzxhzdk41">Type 1 Font Metrics <a id="type1-metrics"></a></h3>
<p>FOP includes PFMReader, which reads the PFM file that normally comes with a Type 1 font, and generates an appropriate font metrics file for it. To use it, run the class org.apache.fop.fonts.apps.PFMReader:</p>
<p>Windows:
java -cp build\fop.jar;lib\avalon-framework.jar;lib\commons-logging.jar;lib\commons-io.jar
@@ -496,7 +496,7 @@ PFMReader [options]:</p>
<li><strong>-fn <fontname></strong> By default, FOP uses the fontname from the .pfm file when embedding the font. Use the "-fn" option to override this name with one you have chosen. This may be useful in some cases to ensure that applications using the output document (Acrobat Reader for example) use the embedded font instead of a local font with the same name.
The classpath in the above example has been simplified for readability. You will have to adjust the classpath to the names of the actual JAR files in the lib directory. xml-apis.jar, xercesImpl.jar, xalan.jar and serializer.jar are not necessary for JDK version 1.4 or later.The tool will construct some values (FontBBox, StemV and ItalicAngle) based on assumptions and calculations which are only an approximation to the real values. FontBBox and Italic Angle can be found in the human-readable part of the PFB file or in the AFM file. The PFMReader tool does not yet interpret PFB or AFM files, so if you want to be correct, you may have to adjust the values in the XML file manually. The constructed values however appear to have no visible influence.</li>
</ul>
-<h2 id="truetype-font-metrics-wzxhzdk42wzxhzdk43">TrueType Font Metrics # <a id="truetype-metrics"></a></h2>
+<h2 id="truetype-font-metrics-wzxhzdk42wzxhzdk43">TrueType Font Metrics <a id="truetype-metrics"></a></h2>
<p>FOP includes TTFReader, which reads the TTF file and generates an appropriate font metrics file for it. Use it in a similar manner to PFMReader. For example, to create such a metrics file in Windows from the TrueType font at c:\myfonts\cmr10.ttf:
java -cp build\fop.jar;lib\avalon-framework.jar;lib\commons-logging.jar;lib\commons-io.jar
org.apache.fop.fonts.apps.TTFReader [options]
@@ -541,7 +541,7 @@ TTFReader [options]:</p>
<td></td>
</tr>
<tr>
-<td>## TrueType Collections # <a id="truetype-collections-metrics"></a></td>
+<td>## TrueType Collections <a id="truetype-collections-metrics"></a></td>
<td></td>
<td></td>
</tr>
@@ -557,7 +557,7 @@ Alternatively, the individual sub-fonts
<font embed-url="gulim.ttc" sub-font="GulimChe">
<font-triplet name="GulimChe" style="normal" weight="normal"/>
</font></p>
-<h2 id="register-fonts-with-fop-wzxhzdk47wzxhzdk48">Register Fonts with FOP # <a id="register"></a></h2>
+<h2 id="register-fonts-with-fop-wzxhzdk47wzxhzdk48">Register Fonts with FOP <a id="register"></a></h2>
<p>You must tell FOP how to find and use the font metrics files by registering them in the <a href="configuration.html">FOP Configuration</a> . Add entries for your custom fonts, regardless of font type, to the configuration file in a manner similar to the following:</p>
<p><renderers>
<renderer mime="application/pdf">
@@ -631,7 +631,7 @@ Alternatively, the individual sub-fonts
<p>If relative URLs are specified, they are evaluated relative to the value of the "font-base" setting. If there is no "font-base" setting, the fonts are evaluated relative to the base directory.</p>
</li>
</ul>
-<h3 id="auto-detect-and-auto-embed-feature-wzxhzdk58wzxhzdk59">Auto-Detect and auto-embed feature # <a id="autodetect"></a></h3>
+<h3 id="auto-detect-and-auto-embed-feature-wzxhzdk58wzxhzdk59">Auto-Detect and auto-embed feature <a id="autodetect"></a></h3>
<p>When the "auto-detect" flag is set in the configuration, FOP will automatically search for fonts in the default paths for your operating system.</p>
<p>FOP will also auto-detect fonts which are available in the classpath, if they are described as "application/x-font" in the MANIFEST.MF file. For example, if your .jar file contains font/myfont.ttf:
Manifest-Version: 1.0</p>
@@ -641,7 +641,7 @@ Manifest-Version: 1.0</p>
<p>This feature allows you to create JAR files containing fonts. The JAR files can be added to fop by providem them in the classpath, e.g. copying them into the lib/ directory.</p>
-<h3 id="embedding-wzxhzdk60wzxhzdk61">Embedding # <a id="embedding"></a></h3>
+<h3 id="embedding-wzxhzdk60wzxhzdk61">Embedding <a id="embedding"></a></h3>
<p>By default, all fonts are embedded if an output format supports font embedding. In some cases, however, it is preferred that some fonts are only referenced. When working with referenced fonts it is important to be in control of the target environment where the produced document is consumed, i.e. the necessary fonts have to be installed there.</p>
<p>There are two different ways how you can specify that a font should be referenced:</p>
<ol>
@@ -680,7 +680,7 @@ At the moment, you can only match fonts
<p>When embedding TrueType fonts (ttf) or TrueType Collections (ttc), a subset of the original font, containing only the glyphs used, is embedded in the output document. That's the default, but if you specify encoding-mode="single-byte" (see above), the complete font is embedded.</p>
</li>
</ul>
-<h3 id="substitution-wzxhzdk70wzxhzdk71">Substitution # <a id="substitution"></a></h3>
+<h3 id="substitution-wzxhzdk70wzxhzdk71">Substitution <a id="substitution"></a></h3>
<p>When a <substitutions/> section is defined in the configuration, FOP will re-map any font-family references found in your FO input to a given substitution font.</p>
<ul>
<li>
@@ -705,7 +705,7 @@ At the moment, you can only match fonts
</substitutions>
</fonts>
</fop></p>
-<h1 id="font-selection-strategies-wzxhzdk87wzxhzdk88">Font Selection Strategies <a id="selection"></a></h1>
+<h1 id="font-selection-strategies-wzxhzdk87wzxhzdk88">Font Selection Strategies <a id="selection"></a></h1>
<p>There are two font selection strategies: character-by-character or auto. The default is auto.</p>
<p>Auto selected the first font from the list which is able to display the most characters in a given word. This means (assume font A has characters for abclmn, font B for lnmxyz, fontlist is A,B):</p>
<ul>
@@ -723,7 +723,7 @@ At the moment, you can only match fonts
</li>
</ul>
<p>Character-by-Character is NOT yet supported!</p>
-<h2 id="font-list-command-line-tool-wzxhzdk89wzxhzdk90">Font List Command-Line Tool <a id="font-list"></a></h2>
+<h2 id="font-list-command-line-tool-wzxhzdk89wzxhzdk90">Font List Command-Line Tool <a id="font-list"></a></h2>
<p>FOP contains a small command-line tool that lets you generate a list of all configured fonts. Its class name is: <code>org.apache.fop.tools.fontlist.FontListMain</code> . Run it with the "-?" parameter to get help for the various options.</p></div>
</div>
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/graphics.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/graphics.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/graphics.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/1.0/">1.0</a></div> -->
<div class="section-content"><h1 id="apachewzxhzdk0-fop-graphics-formats">Apache™ FOP: Graphics Formats</h1>
<p><version>$Revision: 1298724 $</version></p>
-<h2 id="introduction-wzxhzdk3wzxhzdk4">Introduction <a id="introduction"></a></h2>
+<h2 id="introduction-wzxhzdk3wzxhzdk4">Introduction <a id="introduction"></a></h2>
<p>Some noteworthy features of the image handling subsystem are:</p>
<ul>
<li>
@@ -346,7 +346,7 @@ $(document).ready(function () {
</li>
</ul>
<p>The actual <a href="http://xmlgraphics.apache.org/commons/image-loader.html">image loading framework</a> does not reside in Apache FOP, but in <a href="http://xmlgraphics.apache.org/commons/">XML Graphics Commons</a> .</p>
-<h2 id="overview-of-graphics-support-wzxhzdk5wzxhzdk6">Overview of Graphics Support <a id="support-overview"></a></h2>
+<h2 id="overview-of-graphics-support-wzxhzdk5wzxhzdk6">Overview of Graphics Support <a id="support-overview"></a></h2>
<p>The table below summarizes the <em>theoretical</em> support for graphical formats within FOP. In other words, within the constraints of the limitations listed here, these formats <em>should</em> work. However, many of them have not been tested, and there may be limitations that have not yet been discovered or documented. The packages needed to support some formats are not included in the FOP distribution and must be installed separately. Follow the links in the "Support Through" columns for more details.</p>
<table>
<thead>
@@ -424,7 +424,7 @@ $(document).ready(function () {
<a href="http://jai-imageio.dev.java.net/">JAI Image I/O Tools</a> is not the same as the <a href="http://java.sun.com/javase/technologies/desktop/media/jai/">JAI library</a> ! The former simply exposes JAI's codecs using the Image I/O API but does not include all the image manipulation functionality.</p>
</li>
</ul>
-<h2 id="map-of-supported-image-formats-by-output-format-wzxhzdk7wzxhzdk8">Map of supported image formats by output format # <a id="format-map"></a></h2>
+<h2 id="map-of-supported-image-formats-by-output-format-wzxhzdk7wzxhzdk8">Map of supported image formats by output format <a id="format-map"></a></h2>
<p>Not all image formats are supported for all output formats! For example, while you can use EPS (Encapsulated PostScript) files when you generate PostScript output, this format will not be supported by any other output format. Here's an overview of which image formats are supported by which output format:</p>
<table>
<thead>
@@ -531,12 +531,12 @@ $(document).ready(function () {
<p>[2]: Supported without the need to decode the image, but only for certain subtypes.</p>
</li>
</ul>
-<h2 id="graphics-packages-wzxhzdk9wzxhzdk10">Graphics Packages <a id="packages"></a></h2>
-<h3 id="xml-graphics-commons-native-wzxhzdk11wzxhzdk12">XML Graphics Commons Native # <a id="native"></a></h3>
+<h2 id="graphics-packages-wzxhzdk9wzxhzdk10">Graphics Packages <a id="packages"></a></h2>
+<h3 id="xml-graphics-commons-native-wzxhzdk11wzxhzdk12">XML Graphics Commons Native <a id="native"></a></h3>
<p><a href="http://xmlgraphics.apache.org/commons/">XML Graphics Commons</a> supports a number of graphic file formats natively as basic functionality: all bitmap formats for which there are Image I/O codecs available (JPEG, PNG, GIF, TIFF, etc.), EPS and EMF.</p>
-<h3 id="fop-native-wzxhzdk13wzxhzdk14">FOP Native # <a id="fop-native"></a></h3>
+<h3 id="fop-native-wzxhzdk13wzxhzdk14">FOP Native <a id="fop-native"></a></h3>
<p>FOP has no native image plug-ins for the image loading framework of its own but currently hosts the Batik-dependent SVG and WMF plug-ins until they can be moved to <a href="http://xmlgraphics.apache.org/batik/">Apache Batik</a> .</p>
-<h3 id="apache-batik-wzxhzdk15wzxhzdk16">Apache Batik # <a id="batik"></a></h3>
+<h3 id="apache-batik-wzxhzdk15wzxhzdk16">Apache Batik <a id="batik"></a></h3>
<p><a href="http://xmlgraphics.apache.org/batik/">Apache Batik</a> will later receive the SVG and WMF plug-ins for the image loading framework that are currently hosted inside FOP.</p>
<p>Current FOP distributions include a distribution of the <a href="http://xmlgraphics.apache.org/batik/">Apache Batik</a> . Because Batik's API changes frequently, it is highly recommended that you use the version that ships with FOP, at least when running FOP.
<warning>Batik must be run in a graphical environment.</warning>
@@ -553,23 +553,23 @@ Batik must be run in a graphical environ
<p>Install a toolkit which emulates AWT without the need for an underlying X server. One example is the <a href="http://www.eteks.com/pja/en">PJA toolkit</a> , which is free and comes with detailed installation instructions.</p>
</li>
</ul>
-<h3 id="image-io-wzxhzdk19wzxhzdk20">Image I/O # <a id="imageio"></a></h3>
+<h3 id="image-io-wzxhzdk19wzxhzdk20">Image I/O <a id="imageio"></a></h3>
<p>The image loading framework in <a href="http://xmlgraphics.apache.org/commons/">XML Graphics Commons</a> provides a wrapper to load images through the <a href="http://java.sun.com/j2se/1.4.2/docs/guide/imageio/index.html">JDK's Image I/O API</a> (JSR 015). Image I/O allows to dynamically add additional image codecs. An example of such an add-on library are the <a href="http://java.sun.com/products/java-media/jai/">JAI Image I/O Tools</a> available from Sun.</p>
-<h2 id="details-on-image-formats-wzxhzdk21wzxhzdk22">Details on image formats <a id="image-formats"></a></h2>
-<h3 id="bmp-wzxhzdk23wzxhzdk24">BMP # <a id="bmp"></a></h3>
+<h2 id="details-on-image-formats-wzxhzdk21wzxhzdk22">Details on image formats <a id="image-formats"></a></h2>
+<h3 id="bmp-wzxhzdk23wzxhzdk24">BMP <a id="bmp"></a></h3>
<p>BMP images are supported through an Image I/O codec. There may be limitations of the codec which are outside the control of Apache FOP.</p>
-<h3 id="emf-wzxhzdk25wzxhzdk26">EMF # <a id="emf"></a></h3>
+<h3 id="emf-wzxhzdk25wzxhzdk26">EMF <a id="emf"></a></h3>
<p>Windows Enhanced Metafiles (EMF) are only supported in RTF output where they are embedded without decoding.</p>
-<h3 id="eps-wzxhzdk27wzxhzdk28">EPS # <a id="eps"></a></h3>
+<h3 id="eps-wzxhzdk27wzxhzdk28">EPS <a id="eps"></a></h3>
<p>Apache FOP allows to use EPS files when generating PostScript output only.</p>
<p>Other output targets can't be supported at the moment because FOP lacks a PostScript interpreter. Furthermore, FOP is currently not able to parse the preview bitmaps sometimes contained in EPS files.</p>
-<h3 id="gif-wzxhzdk29wzxhzdk30">GIF # <a id="gif"></a></h3>
+<h3 id="gif-wzxhzdk29wzxhzdk30">GIF <a id="gif"></a></h3>
<p>GIF images are supported through an Image I/O codec. Transparency is supported but not guaranteed to work with every output format.</p>
-<h3 id="jpeg-wzxhzdk32wzxhzdk33">JPEG # <a id="jpeg"></a></h3>
+<h3 id="jpeg-wzxhzdk32wzxhzdk33">JPEG <a id="jpeg"></a></h3>
<p>FOP native support (i.e. the handling of undecoded images) of JPEG does not include all variants, especially those containing unusual color lookup tables and color profiles. If you have trouble with a JPEG image in FOP, try opening it with an image processing program (such as Photoshop or Gimp) and then saving it. Specifying 24-bit color output may also help. For the PDF and PostScript renderers most JPEG images can be passed through without decompression. User reports indicate that grayscale, RGB, and CMYK color spaces are all rendered properly. However, for other output formats, the JPEG images have to be decompressed. Tests have shown that there are some limitation in some Image I/O codecs concerning images in the CMYK color space. Work-arounds are in place but may not always work as expected.</p>
-<h3 id="png-wzxhzdk35wzxhzdk36">PNG # <a id="png"></a></h3>
+<h3 id="png-wzxhzdk35wzxhzdk36">PNG <a id="png"></a></h3>
<p>PNG images are supported through an Image I/O codec. Transparency is supported but not guaranteed to work with every output format.</p>
-<h3 id="svg-wzxhzdk38wzxhzdk39">SVG # <a id="svg"></a></h3>
+<h3 id="svg-wzxhzdk38wzxhzdk39">SVG <a id="svg"></a></h3>
<h4 id="introduction-wzxhzdk40wzxhzdk41">Introduction ## <a id="svg-intro"></a></h4>
<p>FOP uses <a href="#batik">Apache Batik</a> for SVG support. This format can be handled as an <code>fo:instream-foreign-object</code> or in a separate file referenced with <code>fo:external-graphic</code> .
Batik's SVG Rasterizer utility may also be used to convert standalone SVG documents into PDF. For more information please see the <a href="http://xmlgraphics.apache.org/batik/svgrasterizer.html">SVG Rasterizer documentation</a> on the Batik site.</p>
@@ -602,18 +602,18 @@ Batik's SVG Rasterizer utility may also
<p>Uniform transparency for images and other SVG elements that are converted into a raster graphic are not drawn properly in PDF. The image is opaque.</p>
</li>
</ul>
-<h3 id="tiff-wzxhzdk52wzxhzdk53">TIFF # <a id="tiff"></a></h3>
+<h3 id="tiff-wzxhzdk52wzxhzdk53">TIFF <a id="tiff"></a></h3>
<p>FOP can embed TIFF images without decompression into PDF, PostScript and AFP if they have either CCITT T.4, CCITT T.6, or JPEG compression. Otherwise, a TIFF-capable Image I/O codec is necessary for decoding the image.</p>
<p>There may be some limitation concerning images in the CMYK color space.</p>
-<h3 id="wmf-wzxhzdk55wzxhzdk56">WMF # <a id="wmf"></a></h3>
+<h3 id="wmf-wzxhzdk55wzxhzdk56">WMF <a id="wmf"></a></h3>
<p>Windows Metafiles (WMF) are supported through classes in <a href="http://xmlgraphics.apache.org/batik/">Apache Batik</a> . At the moment, support for this format is experimental and may not always work as expected.</p>
-<h2 id="graphics-resolution-wzxhzdk57wzxhzdk58">Graphics Resolution <a id="resolution"></a></h2>
+<h2 id="graphics-resolution-wzxhzdk57wzxhzdk58">Graphics Resolution <a id="resolution"></a></h2>
<p>Some bitmapped image file formats store a dots-per-inch (dpi) or other resolution values. FOP tries to use this resolution information whenever possible to determine the image's intrinsic size. This size is used during the layout process when it is not superseded by an explicit size on fo:external-graphic (content-width and content-height properties).</p>
<p>Please note that not all images contain resolution information. If it's not available the source resolution set on the FopFactory (or through the user configuration XML) is used. The default here is 72 dpi.</p>
<p>Bitmap images are generally embedded into the output format at their original resolution (as is). No resampling of the image is performed. Explicit resampling is on our wishlist, but hasn't been implemented, yet. Bitmaps included in SVG graphics may be resampled to the resolution specified in the "target resolution" setting in the <a href="configuration.html">configuration</a> if SVG filters are applied. This can be used as a work-around to resample images in FO documents.</p>
-<h2 id="page-selection-for-multi-page-formats-wzxhzdk59wzxhzdk60">Page selection for multi-page formats <a id="page-selection"></a></h2>
+<h2 id="page-selection-for-multi-page-formats-wzxhzdk59wzxhzdk60">Page selection for multi-page formats <a id="page-selection"></a></h2>
<p>Some image formats such as TIFF support multiple pages/sub-images per file. You can select a particular page using a special URI fragment in the form: <uri>#page=<nr> (for example: <code>http://localhost/images/myimage.tiff#page=3</code> )</p>
-<h2 id="image-caching-wzxhzdk63wzxhzdk64">Image caching <a id="caching"></a></h2>
+<h2 id="image-caching-wzxhzdk63wzxhzdk64">Image caching <a id="caching"></a></h2>
<p>FOP caches images between runs. There is one cache per FopFactory instance. The URI is used as a key to identify images which means that when a particular URI appears again, the image is taken from the cache. If you have a servlet that generates a different image each time it is called with the same URI you need to use a constantly changing dummy parameter on the URI to avoid caching.</p>
<p>The image cache has been improved considerably in the redesigned code. Therefore, resetting the image cache should be a thing of the past. If you still experience OutOfMemoryErrors, please notify us.</p>
<p>If all else fails, the image cache can be cleared like this: <code>fopFactory.getImageManager().getCache().clearCache();</code> </p></div>
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/hyphenation.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/hyphenation.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/hyphenation.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/1.0/">1.0</a></div> -->
<div class="section-content"><h1 id="apachewzxhzdk0-fop-hyphenation">Apache™ FOP: Hyphenation</h1>
<p><version>$Revision: 1298724 $</version></p>
-<h2 id="hyphenation-support-wzxhzdk3wzxhzdk4">Hyphenation Support <a id="support"></a></h2>
-<h3 id="introduction-wzxhzdk5wzxhzdk6">Introduction # <a id="intro"></a></h3>
+<h2 id="hyphenation-support-wzxhzdk3wzxhzdk4">Hyphenation Support <a id="support"></a></h2>
+<h3 id="introduction-wzxhzdk5wzxhzdk6">Introduction <a id="intro"></a></h3>
<p>Apache™ FOP uses Liang's hyphenation algorithm, well known from TeX. It needs language specific pattern and other data for operation.</p>
<p>Because of <a href="#license-issues">licensing issues</a> (and for convenience), all hyphenation patterns for FOP are made available through the <a href="http://offo.sourceforge.net/hyphenation/index.html">Objects For Formatting Objects</a> project.
If you have made improvements to an existing FOP hyphenation pattern, or if you have created one from scratch, please consider contributing these to OFFO so that they can benefit other FOP users as well. Please inquire on the <a href="../maillist.html#fop-user">FOP User mailing list</a> .</p>
-<h2 id="license-issues-wzxhzdk8wzxhzdk9">License Issues # <a id="license-issues"></a></h2>
+<h2 id="license-issues-wzxhzdk8wzxhzdk9">License Issues <a id="license-issues"></a></h2>
<p>Many of the hyphenation files distributed with TeX and its offspring are licenced under the <a href="http://www.latex-project.org/lppl.html">LaTeX Project Public License (LPPL)</a> , which prevents them from being distributed with Apache software. The LPPL puts restrictions on file names in redistributed derived works which we feel can't guarantee. Some hyphenation pattern files have other or additional restrictions, for example against use for commercial purposes.</p>
<p>Although Apache FOP cannot redistribute hyphenation pattern files that do not conform with its license scheme, that does not necessarily prevent users from using such hyphenation patterns with FOP. However, it does place on the user the responsibility for determining whether the user can rightly use such hyphenation patterns under the hyphenation pattern license.
<warning>The user is responsible to settle license issues for hyphenation pattern files that are obtained from non-Apache sources.</warning></p>
-<h2 id="sources-of-custom-hyphenation-pattern-files-wzxhzdk12wzxhzdk13">Sources of Custom Hyphenation Pattern Files # <a id="sources"></a></h2>
+<h2 id="sources-of-custom-hyphenation-pattern-files-wzxhzdk12wzxhzdk13">Sources of Custom Hyphenation Pattern Files <a id="sources"></a></h2>
<p>The most important source of hyphenation pattern files is the <a href="http://www.ctan.org/tex-archive/language/hyphenation/">CTAN TeX Archive</a> .</p>
-<h3 id="installing-custom-hyphenation-patterns-wzxhzdk14wzxhzdk15">Installing Custom Hyphenation Patterns # <a id="install"></a></h3>
+<h3 id="installing-custom-hyphenation-patterns-wzxhzdk14wzxhzdk15">Installing Custom Hyphenation Patterns <a id="install"></a></h3>
<p>To install a custom hyphenation pattern for use with FOP:</p>
<ol>
<li>
@@ -382,7 +382,7 @@ and run Ant with build target <code>jar-
</li>
</ol>
<p><warning>Either of these three options will ensure hyphenation is working when using FOP from the command-line. If FOP is being embedded, remember to add the location(s) of the hyphenation JAR(s) to the CLASSPATH (option 1 and 2) or to set the <a href="configuration.html#hyphenation-dir"><hyphenation-dir></a> configuration option programmatically (option 3).</warning></p>
-<h1 id="hyphenation-patterns-wzxhzdk19wzxhzdk20">Hyphenation Patterns <a id="patterns"></a></h1>
+<h1 id="hyphenation-patterns-wzxhzdk19wzxhzdk20">Hyphenation Patterns <a id="patterns"></a></h1>
<p>If you would like to build your own hyphenation pattern files, or modify existing ones, this section will help you understand how to do so. Even when creating a pattern file from scratch, it may be beneficial to start with an existing file and modify it. See <a href="http://offo.sourceforge.net/hyphenation/index.html">OFFO's Hyphenation page</a> for examples. Here is a brief explanation of the contents of FOP's hyphenation patterns:
<warning>The remaining content of this section should be considered "draft" quality. It was drafted from theoretical literature, and has not been tested against actual FOP behavior. It may contain errors or omissions. Do not rely on these instructions without testing everything stated here. If you use these instructions, please provide feedback on the <a href="../maillist.html#fop-user">FOP User mailing list</a> , either confirming their accuracy, or raising specific problems that we can address.</warning></p>
<ul>
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/index.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/index.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/index.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="apachewzxhzdk0-fop-version-10">Apache™ FOP Version 1.0</h1>
<p><version>$Revision: 1298724 $</version></p>
-<h2 id="introduction-wzxhzdk3wzxhzdk4">Introduction <a id="intro"></a></h2>
+<h2 id="introduction-wzxhzdk3wzxhzdk4">Introduction <a id="intro"></a></h2>
<p>The Apache™ FOP team is proud to present to you this production quality codebase. FOP 1.0 provides a good subset of the W3C XSL-FO 1.0 and 1.1 Standards. Its stable, 1.0 designation provides added recognition as the productive tool it has been for years.</p>
<p>We remain committed to improving the tool, and we continue to add new features. We welcome any feedback you might have and even more, any other form of help to get the project forward.</p>
<p>This release contains many bug fixes and new features compared to the previous version. To see what has changed since the last release, please visit the <a href="changes_1.0.html">Changes Page</a> and the <a href="releaseNotes_1.0.html">Release Notes</a> .</p>
<p>This release implements a good subset of the W3C XSL-FO 1.0 and 1.1 Standards. For a detailed overview of FOP's compliance, visit the <a href="../compliance.html">compliance page</a> .</p>
-<h2 id="upgrading-from-an-earlier-version-wzxhzdk6wzxhzdk7">Upgrading from an earlier version <a id="upgrading"></a></h2>
+<h2 id="upgrading-from-an-earlier-version-wzxhzdk6wzxhzdk7">Upgrading from an earlier version <a id="upgrading"></a></h2>
<p>If you're upgrading to this version from an earlier version of FOP, please read the information contained on the <a href="upgrading.html">Upgrading page</a> !</p>
-<h2 id="download-wzxhzdk8wzxhzdk9">Download <a id="download"></a></h2>
+<h2 id="download-wzxhzdk8wzxhzdk9">Download <a id="download"></a></h2>
<p>To download this version, please visit the <a href="../download.html">download page</a> .</p></div>
</div>
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/intermediate.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/intermediate.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/intermediate.html Wed Oct 24 04:26:06 2012
@@ -333,13 +333,13 @@ $(document).ready(function () {
<div class="section-content"><h1 id="apachewzxhzdk2-fop-intermediate-format">Apache™ FOP: Intermediate Format</h1>
<p><version>$Revision: 1298724 $</version>
Please note that the intermediate formats described here are <strong>advanced features</strong> and can be ignored by most users of Apache™ FOP.</p>
-<h1 id="introduction-wzxhzdk6wzxhzdk7">Introduction <a id="introduction"></a></h1>
+<h1 id="introduction-wzxhzdk6wzxhzdk7">Introduction <a id="introduction"></a></h1>
<p>Apache FOP now provides two different so-called intermediate formats. The first one (let's call it the area tree XML format) is basically a 1:1 XML representation of FOP's area tree as generated by the layout engine. The area tree is conceptually defined in the <a href="http://www.w3.org/TR/2001/REC-xsl-20011015/slice1.html#section-N742-Formatting">XSL-FO specification in chapter 1.1.2</a> . Even though the area tree is mentioned in the XSL-FO specification, this part is not standardized. Therefore, the area tree XML format is a FOP-proprietary XML file format. The area tree XML can be generated through the area tree XML Renderer (the XMLRenderer).</p>
<p>The second intermediate format (which we shall name exactly like this: the intermediate format) is a recent addition which tries to meet a slightly different set of goals. It is highly optimized for speed.</p>
<p>The intermediate format can be used to generate intermediate documents that are modified before they are finally rendered to their ultimate output format. Modifications include adjusting and changing trait values, adding or modifying area objects, inserting prefabricated pages, overlays, imposition (n-up, rotation, scaling etc.). Multiple IF files can be combined to a single output file.</p>
-<h2 id="which-intermediate-format-to-choose-wzxhzdk8wzxhzdk9">Which Intermediate Format to choose? <a id="which-if"></a></h2>
+<h2 id="which-intermediate-format-to-choose-wzxhzdk8wzxhzdk9">Which Intermediate Format to choose? <a id="which-if"></a></h2>
<p>Both formats have their use cases, so the choice you will make will depend on your particular situation. Here is a list of strengths and use cases for both formats:</p>
-<h3 id="area-tree-xml-at-xml-wzxhzdk10wzxhzdk11">Area Tree XML (AT XML) # <a id="strengths-at"></a></h3>
+<h3 id="area-tree-xml-at-xml-wzxhzdk10wzxhzdk11">Area Tree XML (AT XML) <a id="strengths-at"></a></h3>
<ul>
<li>
<p>1:1 representation of FOP's area tree in XML.</p>
@@ -351,7 +351,7 @@ Please note that the intermediate format
<p>Used in FOP's layout engine test suite for regression testing.</p>
</li>
</ul>
-<h3 id="intermediate-format-if-wzxhzdk12wzxhzdk13">Intermediate Format (IF) # <a id="strengths-if"></a></h3>
+<h3 id="intermediate-format-if-wzxhzdk12wzxhzdk13">Intermediate Format (IF) <a id="strengths-if"></a></h3>
<ul>
<li>
<p>Highly optimized for speed.</p>
@@ -370,9 +370,9 @@ Please note that the intermediate format
</li>
</ul>
<p>More technical information about the two formats can be found on the <a href="http://wiki.apache.org/xmlgraphics-fop/AreaTreeIntermediateXml/NewDesign">FOP Wiki</a> .</p>
-<h2 id="architectural-overview-wzxhzdk14wzxhzdk15">Architectural Overview <a id="architecture"></a></h2>
+<h2 id="architectural-overview-wzxhzdk14wzxhzdk15">Architectural Overview <a id="architecture"></a></h2>
<p><figure alt="Diagram with an architectural overview over the intermediate formats" src="images/if-architecture-overview.png"></figure></p>
-<h1 id="usage-of-the-area-tree-xml-format-at-xml-wzxhzdk18wzxhzdk19">Usage of the Area Tree XML format (AT XML) <a id="usage"></a></h1>
+<h1 id="usage-of-the-area-tree-xml-format-at-xml-wzxhzdk18wzxhzdk19">Usage of the Area Tree XML format (AT XML) <a id="usage"></a></h1>
<p>As already mentioned, the area tree XML format is generated by using the <strong>XMLRenderer</strong> (MIME type: <strong>application/X-fop-areatree</strong> ). So, you basically set the right MIME type for the output format and process your FO files as if you would create a PDF file.</p>
<p>However, there is an important detail to consider: The various Renderers don't all use the same font sources. To be able to create the right area tree for the ultimate output format, you need to create the area tree XML file using the right font setup. This is achieved by telling the XMLRenderer to mimic another renderer. This is done by calling the XMLRenderer's mimicRenderer() method with an instance of the ultimate target renderer as the single parameter. This has a consequence: An area tree XML file rendered with the Java2DRenderer may not look as expected when it was actually generated for the PDF renderer. For renderers that use the same font setup, this restriction does not apply (PDF and PS, for example). Generating the area tree XML format file is the first step.</p>
<p>The second step is to reparse the file using the <strong>AreaTreeParser</strong> which is found in the org.apache.fop.area package. The pages retrieved from the area tree XML file are added to an AreaTreeModel instance from where they are normally rendered using one of the available Renderer implementations. You can find examples for the area tree XML processing in the <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/"></a> directory in the FOP distribution.</p>
@@ -405,14 +405,14 @@ try {
}
This example simply reads an area tree file and renders it to a PDF file. Please note, that in normal FOP operation you're shielded from having to instantiate the FontInfo object yourself. This is normally a task of the AreaTreeHandler which is not present in this scenario. The same applies to the AreaTreeModel instance, in this case an instance of a subclass called RenderPagesModel. RenderPagesModel is ideal in this case as it has very little overhead processing the individual pages. An important line in the example is the call to <code>endDocument()</code> on the AreaTreeModel. This lets the Renderer know that the processing is now finished.</p>
<p>The area tree XML format can also be used from the <a href="running.html#standalone-start">command-line</a> by using the "-atin" parameter for specifying the area tree XML as input file. You can also specify a "mimic renderer" by inserting a MIME type between "-at" and the output file.</p>
-<h3 id="concatenating-documents-wzxhzdk20wzxhzdk21">Concatenating Documents # <a id="concat"></a></h3>
+<h3 id="concatenating-documents-wzxhzdk20wzxhzdk21">Concatenating Documents <a id="concat"></a></h3>
<p>This initial example is obviously not very useful. It would be faster to create the PDF file directly. As the <a href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/examples/embedding/java/embedding/atxml/ExampleConcat.java">ExampleConcat.java</a> example shows you can easily parse multiple area tree files in a row and add the parsed pages to the same AreaTreeModel instance which essentially concatenates all the input document to one single output document.</p>
-<h3 id="modifying-documents-wzxhzdk22wzxhzdk23">Modifying Documents # <a id="modifying"></a></h3>
+<h3 id="modifying-documents-wzxhzdk22wzxhzdk23">Modifying Documents <a id="modifying"></a></h3>
<p>One of the most important use cases for this format is obviously modifying the area tree XML before finally rendering it to the target format. You can easily use XSLT to process the AT XML file according to your needs. Please note, that we will currently not formally describe the area tree XML format. You need to have a good understanding its structure so you don't create any non-parseable files. We may add an XML Schema and more detailed documentation at a later time. You're invited to help us with that.
The area tree XML format is sensitive to changes in whitespace. If you're not careful, the modified file may not render correctly.</p>
-<h2 id="advanced-use-wzxhzdk24wzxhzdk25">Advanced Use # <a id="advanced"></a></h2>
+<h2 id="advanced-use-wzxhzdk24wzxhzdk25">Advanced Use <a id="advanced"></a></h2>
<p>The generation of the area tree format as well as it parsing process has been designed to allow for maximum flexibility and optimization. Please note that you can call <code>setTransformerHandler()</code> on XMLRenderer to give the XMLRenderer your own TransformerHandler instance in case you would like to do custom serialization (to a W3C DOM, for example) and/or to directly modify the area tree using XSLT. The AreaTreeParser on the other side allows you to retrieve a ContentHandler instance where you can manually send SAX events to to start the parsing process (see <code>getContentHandler()</code> ).</p>
-<h2 id="usage-of-the-intermediate-format-if-wzxhzdk26wzxhzdk27">Usage of the Intermediate Format (IF) <a id="usage-if"></a></h2>
+<h2 id="usage-of-the-intermediate-format-if-wzxhzdk26wzxhzdk27">Usage of the Intermediate Format (IF) <a id="usage-if"></a></h2>
<p>The Intermediate Format (IF) is generated by the <strong>IFSerializer</strong> (MIME type: <strong>application/X-fop-intermediate-format</strong> ). So, you basically set the right MIME type for the output format and process your FO files as if you would create a PDF file.</p>
<p>The IFSerializer is an implementation of the <strong>IFDocumentHandler</strong> and <strong>IFPainter</strong> interfaces. The <strong>IFRenderer</strong> class is responsible for converting FOP's area tree into calls against these two interfaces.</p>
<ul>
@@ -456,13 +456,13 @@ try {
out.close();
}
This example simply reads an intermediate file and renders it to a PDF file. Here IFParser.parse() is used, but you can also just get a SAX ContentHandler by using the IFParser.getContentHandler() method.</p>
-<h3 id="concatenating-documents-wzxhzdk28wzxhzdk29">Concatenating Documents # <a id="concat-if"></a></h3>
+<h3 id="concatenating-documents-wzxhzdk28wzxhzdk29">Concatenating Documents <a id="concat-if"></a></h3>
<p>This initial example is obviously not very useful. It would be faster to create the PDF file directly (without the intermediate step). As the <a href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/ExampleConcat.java">ExampleConcat.java</a> example shows you can easily parse multiple intermediate files in a row and use the IFConcatenator class to concatenate page sequences from multiple source files to a single output file. This particular example does the concatenation on the level of the IFDocumentHandler interface. You could also do this in XSLT or using SAX on the XML level. Whatever suits your process best.</p>
-<h3 id="modifying-documents-wzxhzdk30wzxhzdk31">Modifying Documents # <a id="modifying-if"></a></h3>
+<h3 id="modifying-documents-wzxhzdk30wzxhzdk31">Modifying Documents <a id="modifying-if"></a></h3>
<p>One of the most important use cases for this format is obviously modifying the intermediate format before finally rendering it to the target format. You can easily use XSLT to process the IF file according to your needs.</p>
<p>There is an XML Schema (located under <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/documentation/intermediate-format-ng/">src/documentation/intermediate-format-ng</a> ) that helps you verify that your modified content is correct.</p>
<p>For certain output formats there's a caveat: Formats like AFP and PCL do not support arbitrary transformations on the IF's "viewport" and "g" elements. Possible are only rotations in 90 degree steps and translations.</p>
-<h3 id="advanced-use-wzxhzdk32wzxhzdk33">Advanced Use # <a id="advanced-if"></a></h3>
+<h3 id="advanced-use-wzxhzdk32wzxhzdk33">Advanced Use <a id="advanced-if"></a></h3>
<p>The generation of the intermediate format as well as it parsing process has been designed to allow for maximum flexibility and optimization. So rather than just passing in a StreamResult to IFSerializer's setResult() method, you can also use a SAXResult or a DOMResult. And as you've already seen , the IFParser on the other side allows you to retrieve a ContentHandler instance where you can manually send SAX events to start the parsing process (see <code>getContentHandler()</code> ).</p></div>
</div>
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/knownissues_overview.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/knownissues_overview.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/knownissues_overview.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/1.0/">1.0</a></div> -->
<div class="section-content"><h1 id="apachewzxhzdk0-fop-known-issues">Apache™ FOP: Known Issues</h1>
<p><version>$Revision: 1298724 $</version></p>
-<h2 id="known-issues-wzxhzdk3wzxhzdk4">Known issues <a id="Known+issues"></a></h2>
+<h2 id="known-issues-wzxhzdk3wzxhzdk4">Known issues <a id="Known+issues"></a></h2>
<p>This page lists currently known issues in the current release.</p>
<p>For additional information on known issues in Apache™ FOP, please have a look at the following pages, too:</p>
<ul>
@@ -344,11 +344,11 @@ $(document).ready(function () {
</li>
</ul>
<p>Apache™ FOP has an extensive automated testing infrastructure. Parts of this infrastructure are several sets of test cases. When a test case is listed in disabled-testcases.xml it is disabled in the JUnit tests during the normal build process. This indicates a problem in the current codebase. When a bug is fixed or a missing feature is added the entry for the relevant test case(s) are removed.</p>
-<h3 id="fo-tree-wzxhzdk7wzxhzdk8">FO Tree # <a id="FO+Tree"></a></h3>
+<h3 id="fo-tree-wzxhzdk7wzxhzdk8">FO Tree <a id="FO+Tree"></a></h3>
<p>This section lists disabled test cases in the test suite for the FO tree tests, at the time of the release.</p>
<p><strong>demo-test-failure.fo</strong> (demo test failure):<br></br> <em>TODO: Add missing description in disabled-testcases.xml!</em> </p>
<p><strong>from-table-column_marker.fo</strong> (Markers and core function evaluation):<br></br>The code currently evaluates this function according to the column in which the marker appears in the source document, rather than the column it is retrieved in.</p>
-<h3 id="layout-engine-wzxhzdk13wzxhzdk14">Layout Engine # <a id="Layout+Engine"></a></h3>
+<h3 id="layout-engine-wzxhzdk13wzxhzdk14">Layout Engine <a id="Layout+Engine"></a></h3>
<p>This section lists disabled test cases in the test suite for the layout engine tests, at the time of the release.</p>
<p><strong>basic-link_external-destination_2.xml</strong> (External link around an SVG not properly sized):<br></br>The bpd trait of the inlineparent area for the basic-link is not sized correctly if it wraps an image that is higher than the nominal line.</p>
<p><strong>block-container_space-before_space-after_3.xml</strong> (Auto-height block-containers produce fences):<br></br>Block-containers with no height currently don't create a fence for spaces as they should (they behave like a normal block).</p>
@@ -384,7 +384,7 @@ $(document).ready(function () {
<p><strong>table_border-width_conditionality.xml</strong> (Border conditionality on table):<br></br>The code should be ok, but the test case uses shorthands and therefore is probably not expressing the indended outcome according to the spec. The test case should be revisited.</p>
<p><strong>block_shy_linebreaking_hyph.xml</strong> (Soft hyphen with normal hyphenation enabled):<br></br>A soft hyphen should be a preferred as break compared to a normal hyphenation point but is not.</p>
<p><strong>keep_within-page_multi-column_overflow.xml</strong> (Page-keep not respected in multi-column layout):<br></br>The block should cause overflow in the last column on the page, rather than be broken.</p>
-<h3 id="other-known-issues-wzxhzdk85wzxhzdk86">Other known issues # <a id="Other+known+issues"></a></h3>
+<h3 id="other-known-issues-wzxhzdk85wzxhzdk86">Other known issues <a id="Other+known+issues"></a></h3>
<p>This section lists other known issues.</p>
<ul>
<li>
Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/metadata.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/1.0/metadata.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/1.0/metadata.html Wed Oct 24 04:26:06 2012
@@ -331,14 +331,14 @@ $(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-metadata">Apache™ FOP: Metadata</h1>
-<h2 id="overview-wzxhzdk1wzxhzdk2">Overview <a id="overview"></a></h2>
+<h2 id="overview-wzxhzdk1wzxhzdk2">Overview <a id="overview"></a></h2>
<p>Document metadata is an important tool for categorizing and finding documents. Various formats support different kinds of metadata representation and to different levels. One of the more popular and flexible means of representing document or object metadata is <a href="http://www.adobe.com/products/xmp/">XMP (eXtensible Metadata Platform, specified by Adobe)</a> . PDF 1.4 introduced the use of XMP. The XMP specification lists recommendation for embedding XMP metdata in other document and image formats. Given its flexibility it makes sense to make use this approach in the XSL-FO context. Unfortunately, unlike SVG which also refers to XMP, XSL-FO doesn't recommend a preferred way of specifying document and object metadata. Therefore, there's no portable way to represent metadata in XSL-FO documents. Each implementation does it differently.</p>
-<h2 id="embedding-xmp-in-an-xsl-fo-document-wzxhzdk3wzxhzdk4">Embedding XMP in an XSL-FO document <a id="xmp-in-fo"></a></h2>
+<h2 id="embedding-xmp-in-an-xsl-fo-document-wzxhzdk3wzxhzdk4">Embedding XMP in an XSL-FO document <a id="xmp-in-fo"></a></h2>
<p>As noted above, there's no officially recommended way to embed metadata in XSL-FO. Apache FOP supports embedding XMP in XSL-FO. Currently, only support for document-level metadata is implemented. Object-level metadata will be implemented when there's interest.</p>
<p>Document-level metadata can be specified in the <code>fo:declarations</code> element. XMP specification recommends to use <code>x:xmpmeta</code> , <code>rdf:RDF</code> , and <code>rdf:Description</code> elements as shown in example below. Both <code>x:xmpmeta</code> and <code>rdf:RDF</code> elements are recognized as the top-level element introducing an XMP fragment (as per the XMP specification).</p>
-<h3 id="example-wzxhzdk5wzxhzdk6">Example # <a id="xmp-example"></a></h3>
+<h3 id="example-wzxhzdk5wzxhzdk6">Example <a id="xmp-example"></a></h3>
<p class="."></p>
-<h1 id="implementation-in-apache-fop-wzxhzdk7wzxhzdk8">Implementation in Apache FOP <a id="xmp-impl-in-fop"></a></h1>
+<h1 id="implementation-in-apache-fop-wzxhzdk7wzxhzdk8">Implementation in Apache FOP <a id="xmp-impl-in-fop"></a></h1>
<p>Currently, XMP support is only available for PDF output.</p>
<p>Originally, you could set some metadata information through FOP's FOUserAgent by using its set*() methods (like setTitle(String) or setAuthor(String). These values are directly used to set value in the PDF Info object. Since PDF 1.4, adding metadata as an XMP document to a PDF is possible. That means that there are now two mechanisms in PDF that hold metadata.</p>
<p>Apache FOP now synchronizes the Info and the Metadata object in PDF, i.e. when you set the title and the author through the FOUserAgent, the two values will end up in the (old) Info object and in the new Metadata object as XMP content. If instead of FOUserAgent, you embed XMP metadata in the XSL-FO document (as shown above), the XMP metadata will be used as-is in the PDF Metadata object and some values from the XMP metadata will be copied to the Info object to maintain backwards-compatibility for PDF readers that don't support XMP metadata.</p>
@@ -396,7 +396,7 @@ $(document).ready(function () {
<td></td>
</tr>
<tr>
-<td>## Namespaces # <a id="namespaces"></a></td>
+<td>## Namespaces <a id="namespaces"></a></td>
<td></td>
</tr>
</tbody>
@@ -431,7 +431,7 @@ $(document).ready(function () {
</table>
<p>Please refer to the <a href="http://partners.adobe.com/public/developer/en/xmp/sdk/XMPspecification.pdf">XMP Specification</a> for information on other metadata namespaces.</p>
<p>Property sets (Namespaces) not listed here are simply passed through to the final document (if supported). That is useful if you want to specify a custom metadata schema.</p>
-<h2 id="links-wzxhzdk9wzxhzdk10">Links <a id="links"></a></h2>
+<h2 id="links-wzxhzdk9wzxhzdk10">Links <a id="links"></a></h2>
<ul>
<li>
<p><a href="http://www.adobe.com/products/xmp/">Adobe's Extensible Metadata Platform (XMP) website</a> </p>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: commits-help@xmlgraphics.apache.org