You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xmlgraphics.apache.org by vh...@apache.org on 2014/07/24 18:21:24 UTC
svn commit: r1613173 [4/15] - in /xmlgraphics/site/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: xmlgraphics/site/trunk/content/fop/0.95/compiling.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/0.95/compiling.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/0.95/compiling.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/0.95/compiling.mdtext Thu Jul 24 16:21:20 2014
@@ -3,31 +3,31 @@ Title: Apache(tm) FOP: Building from Sou
#Apache™ FOP: Building from Source Code
-## Do You Need To Build? {#build-needed}
+## Do You Need To Build? { #build-needed}
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 [Download Instructions](../download.html) for information about whether a binary or source distribution is best for your needs.
If you got the source code from a repository snapshot or via Subversion you will need to build FOP in any case.
-## Set Up Your Environment {#env}
+## Set Up Your Environment { #env}
-### JDK {#env-jdk}
+### JDK { #env-jdk}
Building FOP requires a minimum Java Development Kit (JDK/SDK) of 1.4 (A Java Runtime Environment is not sufficient).
-### CLASSPATH {#env-classpath}
+### CLASSPATH { #env-classpath}
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.
-### JAVA_HOME {#env-java-home}
+### JAVA_HOME { #env-java-home}
The build script uses [Apache Ant](http://ant.apache.org/), 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.
-### Apache Ant {#env-ant}
+### Apache Ant { #env-ant}
[Apache Ant](http://ant.apache.org/) (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 [instructions to install Ant in the Ant manual](http://ant.apache.org/manual/) on the web.
-## Run the Build Script {#build-script}
+## Run the Build Script { #build-script}
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 [installed Apache Ant](http://ant.apache.org/manual/) and added Ant's location to the PATH environment variable.
@@ -50,7 +50,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.
-## Troubleshooting {#problems}
+## Troubleshooting { #problems}
If you have problems building FOP, please try the following:
Modified: xmlgraphics/site/trunk/content/fop/0.95/configuration.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/0.95/configuration.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/0.95/configuration.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/0.95/configuration.mdtext Thu Jul 24 16:21:20 2014
@@ -3,13 +3,13 @@ Title: Apache(tm) FOP: Configuration
#Apache™ FOP: Configuration
-## Configuration File Basics {#general}
+## Configuration File Basics { #general}
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.
The easiest way to get started using a FOP configuration file is to copy the sample found at `{fop-dir}/conf/fop.xconf` 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.
-### Making Configuration Available to FOP {#general-available}
+### Making Configuration Available to FOP { #general-available}
After creating your configuration file, you must tell FOP how to find it:
@@ -20,7 +20,7 @@ After creating your configuration file,
See [Setting the Configuration Programmatically](embedding.html#config-internal) for instructions on how to do so in an embedded environment.
-## Summary of the General Configuration Options {#general-elements}
+## Summary of the General Configuration Options { #general-elements}
| Element | Data Type (for the value) | Description | Default Value |
|---------|---------------------------|-------------|---------------|
@@ -66,7 +66,7 @@ This is an excerpt from the example conf
<!-- etc. etc..... -->
</fop>
-## Renderer configuration {#renderers}
+## Renderer configuration { #renderers}
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.
@@ -96,7 +96,7 @@ The configuration for the PDF Renderer c
The details on the font configuration can be found on the separate [Fonts](fonts.html) page. Note especially the section entitled [Register Fonts with FOP](fonts.html#register).
-### Special Settings for the PDF Renderer {#pdf-renderer}
+### Special Settings for the PDF Renderer { #pdf-renderer}
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.
@@ -135,7 +135,7 @@ Some people don't have high requirements
<fonts....
</renderer>
-### Special Settings for the PostScript Renderer {#ps-renderer}
+### Special Settings for the PostScript Renderer { #ps-renderer}
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:
@@ -155,7 +155,7 @@ Besides the normal font configuration (t
</fonts>
</renderer>
-### Special Settings for the PCL Renderer {#pcl-renderer}
+### Special Settings for the PCL Renderer { #pcl-renderer}
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.
@@ -171,7 +171,7 @@ The default value for the "rendering" se
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.
-## When it does not work {#When-it-does-not-work}
+## When it does not work { #When-it-does-not-work}
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.
Modified: xmlgraphics/site/trunk/content/fop/0.95/embedding.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/0.95/embedding.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/0.95/embedding.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/0.95/embedding.mdtext Thu Jul 24 16:21:20 2014
@@ -3,13 +3,13 @@ Title: Apache(tm) FOP: Embedding
#Apache™ FOP: Embedding
<subtitle>How to Embed Apache™ FOP in a Java application</subtitle>
-## Overview {#overview}
+## Overview { #overview}
Review [Running Apache™ FOP](running.html) for important information that applies to embedded applications as well as command-line use, such as options and performance.
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.
-## Basic Usage Pattern {#basics}
+## Basic Usage Pattern { #basics}
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...
@@ -72,17 +72,17 @@ If you're not totally familiar with JAXP
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 [Embedding examples](#examples) (See "ExampleXML2FO").
-### Logging {#basic-logging}
+### Logging { #basic-logging}
Logging is now a little different than it was in FOP 0.20.5. We've switched from Avalon Logging to [Jakarta Commons Logging](http://commons.apache.org/logging/). 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 [Wiki page](http://wiki.apache.org/xmlgraphics-fop/ProcessingFeedback) which documents what we're going to build.
By default, [Jakarta Commons Logging](http://commons.apache.org/logging/) 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 [documentation for Jakarta Commons Logging](http://commons.apache.org/logging/) on how to configure alternative backends.
-### Processing XSL-FO {#render}
+### Processing XSL-FO { #render}
Once the Fop instance is set up, call `getDefaultHandler()` 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 `startDocument()` method is called. Processing stops again when the DefaultHandler's `endDocument()` method is called. Please refer to the basic usage pattern shown above to render a simple XSL-FO document.
-### Processing XSL-FO generated from XML+XSLT {#render-with-xslt}
+### Processing XSL-FO generated from XML+XSLT { #render-with-xslt}
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:
@@ -94,7 +94,7 @@ If you want to process XSL-FO generated
Source xslt = new StreamSource(new File("mystylesheet.xsl"));
Transformer transformer = factory.newTransformer(xslt);
-## Input Sources {#input}
+## Input Sources { #input}
The input XSL-FO document is always received by FOP as a SAX stream (see the [Parsing Design Document](../dev/design/parsing.html) for the rationale).
@@ -117,11 +117,11 @@ However, you may not always have your in
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 [Xalan Basic Usage Patterns](http://xml.apache.org/xalan-j/usagepatterns.html).
-## Configuring Apache FOP Programmatically {#config-internal}
+## Configuring Apache FOP Programmatically { #config-internal}
Apache FOP provides two levels on which you can customize FOP's behaviour: the FopFactory and the user agent.
-### Customizing the FopFactory {#fop-factory}
+### Customizing the FopFactory { #fop-factory}
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.
@@ -164,7 +164,7 @@ Set a **URIResolver** for custom URI res
`fopFactory.setURIResolver(myResolver); // myResolver is a javax.xml.transform.URIResolver`
Both 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.
-### Customizing the User Agent {#user-agent}
+### Customizing the User Agent { #user-agent}
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:
@@ -234,7 +234,7 @@ Set a **URIResolver** for custom URI res
`userAgent.setURIResolver(myResolver); // myResolver is a javax.xml.transform.URIResolver`
Both the FopFactory and the FOUserAgent have a method to set a URIResolver. The URIResolver on the FOUserAgent is used for resolving URIs which are document-related. If it's not set or cannot resolve a URI, the URIResolver from the FopFactory is used. You should not reuse an FOUserAgent instance between FOP rendering runs although you can. Especially in multi-threaded environment, this is a bad idea.
-## Using a Configuration File {#config-external}
+## Using a Configuration File { #config-external}
Instead of setting the parameters manually in code as shown above you can also set many values from an XML configuration file:
@@ -254,13 +254,13 @@ Instead of setting the parameters manual
The layout of the configuration file is described on the [Configuration page](configuration.html).
-## Hints {#hints}
+## Hints { #hints}
-### Object reuse {#object-reuse}
+### Object reuse { #object-reuse}
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.
-### AWT issues {#awt}
+### AWT issues { #awt}
If your XSL-FO files contain SVG then Apache Batik will be used. When Batik is initialised it uses certain classes in `java.awt` 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.
@@ -268,11 +268,11 @@ The thread means that the Java applicati
If you run into trouble running FOP on a head-less server, please see the [notes on Batik](graphics.html#batik).
-### Getting information on the rendering process {#render-info}
+### Getting information on the rendering process { #render-info}
To get the number of pages that were rendered by FOP you can call `Fop.getResults()`. This returns a `FormattingResults` 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.
-## Improving performance {#performance}
+## Improving performance { #performance}
There are several options to consider:
@@ -289,29 +289,29 @@ There are several options to consider:
- 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.
-## Multithreading FOP {#multithreading}
+## Multithreading FOP { #multithreading}
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.
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.
-## Examples {#examples}
+## Examples { #examples}
The directory "{fop-dir}/examples/embedding" contains several working examples.
-### ExampleFO2PDF.java {#ExampleFO2PDF}
+### ExampleFO2PDF.java { #ExampleFO2PDF}
This [example](http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleFO2PDF.java?view=markup) demonstrates the basic usage pattern to transform an XSL-FO file to PDF using FOP.
-### ExampleXML2FO.java {#ExampleXML2FO}
+### ExampleXML2FO.java { #ExampleXML2FO}
This [example](http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleXML2FO.java?view=markup) 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. [Xalan](http://xml.apache.org/xalan-j)).
-### ExampleXML2PDF.java {#ExampleXML2PDF}
+### ExampleXML2PDF.java { #ExampleXML2PDF}
This [example](http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleXML2PDF.java?view=markup) 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.
@@ -319,7 +319,7 @@ This [example](http://svn.apache.org/vie
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.
-### ExampleObj2XML.java {#ExampleObj2XML}
+### ExampleObj2XML.java { #ExampleObj2XML}
This [example](http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleObj2XML.java?view=markup) 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.
@@ -331,20 +331,20 @@ The XMLReader implementation (regard it
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. [An older JAXP tutorial](http://java.sun.com/xml/jaxp/dist/1.1/docs/tutorial/xslt/3_generate.html)).
-### ExampleObj2PDF.java {#ExampleObj2PDF}
+### ExampleObj2PDF.java { #ExampleObj2PDF}
This [example](http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleObj2PDF.java?view=markup) 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.
-### ExampleDOM2PDF.java {#ExampleDOM2PDF}
+### ExampleDOM2PDF.java { #ExampleDOM2PDF}
This [example](http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleDOM2PDF.java?view=markup) has FOP use a DOMSource instead of a StreamSource in order to use a DOM tree as input for an XSL transformation.
-### ExampleSVG2PDF.java (PDF Transcoder example) {#ExampleSVG2PDF}
+### ExampleSVG2PDF.java (PDF Transcoder example) { #ExampleSVG2PDF}
This [example](http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleSVG2PDF.java?view=markup) shows the usage of the PDF Transcoder, a sub-application within FOP. It is used to generate a PDF document from an SVG file.
-### Final notes {#example-notes}
+### Final notes { #example-notes}
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.
Modified: xmlgraphics/site/trunk/content/fop/0.95/extensions.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/0.95/extensions.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/0.95/extensions.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/0.95/extensions.mdtext Thu Jul 24 16:21:20 2014
@@ -7,13 +7,13 @@ By "extension", we mean any data that ca
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 [Developers' Extension Page](../dev/extensions.html).
All extensions require the correct use of an appropriate namespace in your input document.
-## SVG {#svg}
+## SVG { #svg}
Please see the [SVG documentation](graphics.html#svg) for more details.
-## FO Extensions {#fo-extensions}
+## FO Extensions { #fo-extensions}
-### Namespace {#fox-namespace}
+### Namespace { #fox-namespace}
By convention, FO extensions in FOP use the "fox" namespace prefix. To use any of the FO extensions, add a namespace entry for `http://xmlgraphics.apache.org/fop/extensions` to the root element:
@@ -21,11 +21,11 @@ By convention, FO extensions in FOP use
<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format"
xmlns:fox="http://xmlgraphics.apache.org/fop/extensions">
-### PDF Bookmarks {#bookmarks}
+### PDF Bookmarks { #bookmarks}
In previous versions of Apache FOP there was a `fox:outline` element which was used to create outlines in PDF files. The redesigned code makes use of the new [bookmark feature defined in the latest XSL 1.1 working draft](http://www.w3.org/TR/xsl11/#fo_bookmark-tree).
-### Anchors or Named Destinations {#named-destinations}
+### Anchors or Named Destinations { #named-destinations}
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.
@@ -36,15 +36,15 @@ Use the fox:destination element to defin
<warning>It is possible that in some future release of FOP, *all* elements with "id" attributes will generate named-destinations, which will eliminate the need for fox:destination.</warning>
-### Table Continuation Label {#table-continue-label}
+### Table Continuation Label { #table-continue-label}
This extension element hasn't been reimplemented for the redesigned code, yet.
-### fox:orphan-content-limit and fox:widow-content-limit {#widow-orphan-content-limit}
+### fox:orphan-content-limit and fox:widow-content-limit { #widow-orphan-content-limit}
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.
-### fox:external-document {#external-document}
+### fox:external-document { #external-document}
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 `fox:external-document` element. Each page of the external document will create one full page in the target format.
@@ -53,7 +53,7 @@ The `fox:external-document` element is s
(layout-master-set, declarations?, bookmark-tree?, (page-sequence|page-sequence-wrapper|fox:external-document|fox:destination)+)
-#### Specification {#Specification}
+#### Specification { #Specification}
The `fox:external-document` extension formatting object is used to specify how to create a (sub-)sequence of pages within a document. The content of these pages comes from the individual subimages/pages of an image or paged document (for example: multi-page TIFF in the form of faxes or scanned documents, or PDF files). The formatting object creates the necessary areas to display one image per page.
@@ -102,17 +102,17 @@ The following properties apply to this f
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"
`fox:external-document` is not suitable for concatenating FO documents. For this, XInclude is recommended.
-### Free-form Transformation for fo:block-container {#transform}
+### Free-form Transformation for fo:block-container { #transform}
For `fo:block-container` elements whose `absolute-position` set to "absolute" or "fixed" you can use the extension attribute `fox:transform` to apply a free-form transformation to the whole block-container. The content of the `fox:transform` attribute is the same as for [SVG's transform attribute](http://www.w3.org/TR/SVG/coords.html#TransformAttribute). 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.
Examples: `fox:transform="rotate(45)"` would rotate the block-container by 45 degrees clock-wise around its upper-left corner. `fox:transform="translate(10000,0)"` 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.
-### Color functions {#color-functions}
+### Color functions { #color-functions}
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.
-#### cmyk() {#color-function-cmyk}
+#### cmyk() { #color-function-cmyk}
`color cmyk(numeric, numeric, numeric, numeric)`
Modified: xmlgraphics/site/trunk/content/fop/0.95/fonts.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/0.95/fonts.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/0.95/fonts.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/0.95/fonts.mdtext Thu Jul 24 16:21:20 2014
@@ -3,7 +3,7 @@ Title: Apache(tm) FOP: Fonts
#Apache™ FOP: Fonts
<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>
-## Summary {#intro}
+## Summary { #intro}
The following table summarizes the font capabilities of the various FOP renderers:
@@ -19,23 +19,23 @@ The following table summarizes the font
| TXT | yes (used for layout but not for output) | no | yes (used for layout but not for output) | no |
| XML | yes | no | yes | n/a |
-## Base-14 Fonts {#Base-14-Fonts}
+## Base-14 Fonts { #Base-14-Fonts}
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.
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.
-## Missing Fonts {#Missing-Fonts}
+## Missing Fonts { #Missing-Fonts}
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).
-## Java2D/AWT/Operating System Fonts {#awt}
+## Java2D/AWT/Operating System Fonts { #awt}
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.
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.
-## Custom Fonts {#custom}
+## Custom Fonts { #custom}
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 [output formats](output.html).
@@ -48,7 +48,7 @@ Basic information about fonts can be fou
- [Adobe Font Technote](http://partners.adobe.com/asn/developer/technotes/fonts.html)
-## Basic font configuration {#basics}
+## Basic font configuration { #basics}
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.
@@ -66,11 +66,11 @@ If you want FOP to use custom fonts, you
</fonts>
Review the documentation for [FOP Configuration](configuration.html) 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.
-## Advanced font configuration {#advanced}
+## Advanced font configuration { #advanced}
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.
-### Type 1 Font Metrics {#type1-metrics}
+### Type 1 Font Metrics { #type1-metrics}
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:
@@ -85,7 +85,7 @@ PFMReader [options]:
- **-fn <fontname>** 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.
-## TrueType Font Metrics {#truetype-metrics}
+## TrueType Font Metrics { #truetype-metrics}
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
@@ -107,7 +107,7 @@ TTFReader [options]:
| Usable Character Set | Limited to WinAnsi character set, which is roughly equivalent to iso-8889-1. | Limited only by the characters in the font itself. |
| Embedding the Font | Optional. | Mandatory. Not embedding the font produces invalid PDF documents. |
<warning>You may experience failures with certain TrueType fonts, especially if they don't contain the so-called Unicode "cmap" table. TTFReader can currently not deal with font like this.</warning>
-## TrueType Collections Font Metrics {#truetype-collections-metrics}
+## TrueType Collections Font Metrics { #truetype-collections-metrics}
TrueType collections (.ttc files) contain more than one font. To create metrics files for these fonts, you must specify which font in the collection should be generated, by using the "-ttcname" option with the TTFReader.
@@ -117,7 +117,7 @@ Here is an example of generating a metri
java -cp build\fop.jar;lib\avalon-framework.jar;lib\commons-logging.jar;lib\commons-io.jar
org.apache.fop.fonts.apps.TTFReader -ttcname "MS Mincho"
msmincho.ttc msminch.xml
-## Register Fonts with FOP {#register}
+## Register Fonts with FOP { #register}
You must tell FOP how to find and use the font metrics files by registering them in the [FOP Configuration](configuration.html). Add entries for your custom fonts, regardless of font type, to the configuration file in a manner similar to the following:
@@ -162,7 +162,7 @@ You must tell FOP how to find and use th
- 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.
-### Auto-Detect and auto-embed feature {#autodetect}
+### Auto-Detect and auto-embed feature { #autodetect}
When the "auto-detect" flag is set in the configuration, FOP will automatically search for fonts in the default paths for your operating system.
@@ -173,7 +173,7 @@ Manifest-Version: 1.0
Content-Type: application/x-font
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.
-### Embedding {#embedding}
+### Embedding { #embedding}
The PostScript renderer does not yet support TrueType fonts, but can embed Type 1 fonts.The font is simply embedded into the PDF file, it is not converted.
Font embedding is enabled in the userconfig.xml file and controlled by the embed-url attribute. If you don't specify the embed-url attribute the font will not be embedded, but will only be referenced.
<warning>Omitting the embed-url attribute for CID-encoded TrueType fonts will currently produce invalid PDF files! If you create the XML font metric file using the "-enc ansi" option, you can omit the embed-url attribute for TrueType fonts but you're restricted to the WinAnsi character set.</warning>
Modified: xmlgraphics/site/trunk/content/fop/0.95/graphics.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/0.95/graphics.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/0.95/graphics.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/0.95/graphics.mdtext Thu Jul 24 16:21:20 2014
@@ -3,7 +3,7 @@ Title: Apache(tm) FOP: Graphics Formats
#Apache™ FOP: Graphics Formats
-## Introduction {#introduction}
+## Introduction { #introduction}
After the Apache™ FOP 0.94 release, the image handling subsystem has been rewritten in order to improve the range of supported images and image subtypes, to lower the overall memory consumption when handling images, to produce smaller output files and to increase the performance in certain areas. Of course, this causes a few changes most of which the user will probably not notice. The most important changes are:
@@ -16,7 +16,7 @@ After the Apache™ FOP 0.94 release
The actual [image loading framework](http://xmlgraphics.apache.org/commons/image-loader.html) no longer resides in Apache FOP, but was instead placed in [XML Graphics Commons](http://xmlgraphics.apache.org/commons/).
-## Overview of Graphics Support {#support-overview}
+## Overview of Graphics Support { #support-overview}
The table below summarizes the *theoretical* support for graphical formats within FOP. In other words, within the constraints of the limitations listed here, these formats *should* 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.
@@ -39,7 +39,7 @@ Legend:
- [1]: Requires the presence of [JAI Image I/O Tools](http://jai-imageio.dev.java.net/) (or an equivalent Image I/O compatible codec) in the classpath. JAI Image I/O Tools also adds support for JPEG 2000, WBMP, RAW and PNM. Other Image I/O codecs may provide support for additional formats.
[JAI Image I/O Tools](http://jai-imageio.dev.java.net/) is not the same as the [JAI library](http://java.sun.com/javase/technologies/desktop/media/jai/) ! The former simply exposes JAI's codecs using the Image I/O API but does not include all the image manipulation functionality.
-### Map of supported image formats by output format {#format-map}
+### Map of supported image formats by output format { #format-map}
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:
@@ -62,17 +62,17 @@ Legend:
- [2]: Supported without the need to decode the image, but only for certain subtypes.
-## Graphics Packages {#packages}
+## Graphics Packages { #packages}
-### XML Graphics Commons Native {#native}
+### XML Graphics Commons Native { #native}
[XML Graphics Commons](http://xmlgraphics.apache.org/commons/) 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.
-### FOP Native {#fop-native}
+### FOP Native { #fop-native}
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 [Apache Batik](http://xmlgraphics.apache.org/batik/).
-### Apache Batik {#batik}
+### Apache Batik { #batik}
[Apache Batik](http://xmlgraphics.apache.org/batik/) will later receive the SVG and WMF plug-ins for the image loading framework that are currently hosted inside FOP.
@@ -89,45 +89,45 @@ Here are some workarounds:
- Install a toolkit which emulates AWT without the need for an underlying X server. One example is the [PJA toolkit](http://www.eteks.com/pja/en), which is free and comes with detailed installation instructions.
-### Image I/O {#imageio}
+### Image I/O { #imageio}
The image loading framework in [XML Graphics Commons](http://xmlgraphics.apache.org/commons/) provides a wrapper to load images through the [JDK's Image I/O API](http://java.sun.com/j2se/1.4.2/docs/guide/imageio/index.html) (JSR 015). Image I/O allows to dynamically add additional image codecs. An example of such an add-on library are the [JAI Image I/O Tools](http://java.sun.com/products/java-media/jai/) available from Sun.
-## Details on image formats {#image-formats}
+## Details on image formats { #image-formats}
-### BMP {#bmp}
+### BMP { #bmp}
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.
-### EMF {#emf}
+### EMF { #emf}
Windows Enhanced Metafiles (EMF) are only supported in RTF output where they are embedded without decoding.
-### EPS {#eps}
+### EPS { #eps}
Apache FOP allows to use EPS files when generating PostScript output only.
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.
-### GIF {#gif}
+### GIF { #gif}
GIF images are supported through an Image I/O codec. Transparency is supported but not guaranteed to work with every output format.
-### JPEG {#jpeg}
+### JPEG { #jpeg}
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.
-### PNG {#png}
+### PNG { #png}
PNG images are supported through an Image I/O codec. Transparency is supported but not guaranteed to work with every output format.
-### SVG {#svg}
+### SVG { #svg}
-#### Introduction {#svg-intro}
+#### Introduction { #svg-intro}
FOP uses [Apache Batik](#batik) for SVG support. This format can be handled as an `fo:instream-foreign-object` or in a separate file referenced with `fo:external-graphic`.
Batik's SVG Rasterizer utility may also be used to convert standalone SVG documents into PDF. For more information please see the [SVG Rasterizer documentation](http://xmlgraphics.apache.org/batik/svgrasterizer.html) on the Batik site.
-#### Placing SVG Graphics into PDF {#svg-pdf-graphics}
+#### Placing SVG Graphics into PDF { #svg-pdf-graphics}
The SVG is rendered into PDF by using PDF commands to draw and fill lines and curves. This means that the graphical objects created with this remain as vector graphics. The same applies to PostScript output. For other output formats the SVG graphic may be converted to a bitmap image.
@@ -135,7 +135,7 @@ There are a number of SVG things that ca
Currently transparency is limited in PDF so many SVG images that contain effects or graphics with transparent areas may not be displayed correctly.
-#### Placing SVG Text into PDF and PostScript {#svg-pdf-text}
+#### Placing SVG Text into PDF and PostScript { #svg-pdf-text}
If possible, Batik will use normal PDF or PostScript text when inserting text. It does this by checking if the text can be drawn normally and the font is supported. This example svg [text.svg](../dev/svg/text.svg) /text.pdfshows how various types and effects with text are handled. Note that tspan and outlined text are not yet implemented.
@@ -143,13 +143,13 @@ Otherwise, text is converted and drawn a
Note that because SVG text can be rendered as either text or a vector graphic, you may need to consider settings in your viewer for both. The Acrobat viewer has both "smooth line art" and "smooth text" settings that may need to be set for SVG images to be displayed nicely on your screen (see Edit / Preferences / Display). This setting will not affect the printing of your document, which should be OK in any case, but will only affect the quality of the screen display.
-#### Scaling {#svg-scaling}
+#### Scaling { #svg-scaling}
Currently, SVG images are rendered with the dimensions specified *in the SVG file*, within the viewport specified in the fo:external-graphic element. For everything to work properly, the two should be equal. The SVG standard leaves this issue as an implementation detail. Additional scaling options are available through XSL-FO means.
If you use pixels to specify the size of an SVG graphic the "source resolution" setting in the [configuration](configuration.html) will be used to determine the size of a pixel. The use of pixels to specify sizes is discouraged as they may be interpreted differently in different environments.
-#### Known Problems {#svg-problems}
+#### Known Problems { #svg-problems}
- Soft mask transparency is combined with white so that it looks better on PDF 1.3 viewers but this causes the soft mask to be slightly lighter or darker on PDF 1.4 viewers.
@@ -160,17 +160,17 @@ If you use pixels to specify the size of
- 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.
-### TIFF {#tiff}
+### TIFF { #tiff}
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.
There may be some limitation concerning images in the CMYK color space.
-### WMF {#wmf}
+### WMF { #wmf}
Windows Metafiles (WMF) are supported through classes in [Apache Batik](http://xmlgraphics.apache.org/batik/). At the moment, support for this format is experimental and may not always work as expected.
-## Graphics Resolution {#resolution}
+## Graphics Resolution { #resolution}
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).
@@ -178,11 +178,11 @@ Please note that not all images contain
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 [configuration](configuration.html) if SVG filters are applied. This can be used as a work-around to resample images in FO documents.
-## Page selection for multi-page formats {#page-selection}
+## Page selection for multi-page formats { #page-selection}
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: `http://localhost/images/myimage.tiff#page=3`)
-## Image caching {#caching}
+## Image caching { #caching}
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.
Modified: xmlgraphics/site/trunk/content/fop/0.95/hyphenation.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/0.95/hyphenation.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/0.95/hyphenation.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/0.95/hyphenation.mdtext Thu Jul 24 16:21:20 2014
@@ -3,25 +3,25 @@ Title: Apache(tm) FOP: Hyphenation
#Apache™ FOP: Hyphenation
-## Hyphenation Support {#support}
+## Hyphenation Support { #support}
-### Introduction {#intro}
+### Introduction { #intro}
Apache™ FOP uses Liang's hyphenation algorithm, well known from TeX. It needs language specific pattern and other data for operation.
Because of [licensing issues](#license-issues) (and for convenience), all hyphenation patterns for FOP are made available through the [Objects For Formatting Objects](http://offo.sourceforge.net/hyphenation/index.html) 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 [FOP User mailing list](../maillist.html#fop-user).
-### License Issues {#license-issues}
+### License Issues { #license-issues}
Many of the hyphenation files distributed with TeX and its offspring are licenced under the [LaTeX Project Public License (LPPL)](http://www.latex-project.org/lppl.html), 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.
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>
-### Sources of Custom Hyphenation Pattern Files {#sources}
+### Sources of Custom Hyphenation Pattern Files { #sources}
The most important source of hyphenation pattern files is the [CTAN TeX Archive](http://www.ctan.org/tex-archive/language/hyphenation/).
-### Installing Custom Hyphenation Patterns {#install}
+### Installing Custom Hyphenation Patterns { #install}
To install a custom hyphenation pattern for use with FOP:
@@ -49,7 +49,7 @@ and run Ant with build target `jar-hyphe
- Put the pattern source file(s) into a directory of your choice and configure FOP to look for custom patterns in this directory, by setting the [<hyphenation-base>](configuration.html) configuration option.
<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 [<hyphenation-dir>](configuration.html#hyphenation-dir) configuration option programmatically (option 3).</warning>
-## Hyphenation Patterns {#patterns}
+## Hyphenation Patterns { #patterns}
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 [OFFO's Hyphenation page](http://offo.sourceforge.net/hyphenation/index.html) 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 [FOP User mailing list](../maillist.html#fop-user), either confirming their accuracy, or raising specific problems that we can address.</warning>
Modified: xmlgraphics/site/trunk/content/fop/0.95/index.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/0.95/index.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/0.95/index.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/0.95/index.mdtext Thu Jul 24 16:21:20 2014
@@ -3,16 +3,16 @@ Title: Apache(tm) FOP Version 0.95
#Apache™ FOP Version 0.95
-## Introduction {#intro}
+## Introduction { #intro}
The Apache™ FOP team is proud to present to you this production quality release. We're still in the process of adding new features. We welcome any feedback you might have and even more, any other form of help to get the project forward.
This sixth release contains many bug fix release and new features compared to 0.94. To see what has changed since the last release, please visit the [Changes Page](changes_0.95.html) and the [Release Notes](releaseNotes_0.95.html).
-## Upgrading from an earlier version {#upgrading}
+## Upgrading from an earlier version { #upgrading}
If you're upgrading to this version from an earlier version of FOP, please read the information contained on the [Upgrading page](upgrading.html) !
-## Download {#download}
+## Download { #download}
To download this version, please visit the [download page](../download.html).
Modified: xmlgraphics/site/trunk/content/fop/0.95/intermediate.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/0.95/intermediate.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/0.95/intermediate.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/0.95/intermediate.mdtext Thu Jul 24 16:21:20 2014
@@ -3,13 +3,13 @@ Title: Apache(tm) FOP: Intermediate Form
#Apache™ FOP: Intermediate Format
Please note that the intermediate format is an **advanced feature** and can be ignored by most users of Apache™ FOP.
-## Introduction {#introduction}
+## Introduction { #introduction}
The intermediate format (IF) is a proprietary XML format that represents the area tree generated by the layout engine. The area tree is conceptually defined in the [XSL-FO specification in chapter 1.1.2](http://www.w3.org/TR/2001/REC-xsl-20011015/slice1.html#section-N742-Formatting). The IF can be generated through the area tree XML Renderer (the XMLRenderer).
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.
-## Usage of the Intermediate Format {#usage}
+## Usage of the Intermediate Format { #usage}
As already mentioned, the IF is generated by using the **XMLRenderer** (MIME type: **application/X-fop-areatree**). 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. 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 file, you need to create the IF 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 IF 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 intermediate format file is the first step
.
@@ -47,14 +47,14 @@ This example simply reads an IF file and
The intermediate format can also be used from the [command-line](running.html#standalone-start) 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.
-### Concatenating Documents {#concat}
+### Concatenating Documents { #concat}
This initial example is obviously not very useful. It would be faster to create the PDF file directly. As the [ExampleConcat.java](http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/ExampleConcat.java) example shows you can easily parse multiple IF 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.
-### Modifying Documents {#modifying}
+### Modifying Documents { #modifying}
One of the most important use cases for the intermediate format is obviously modifying the area tree XML before finally rendering it to the target format. You can easily use XSLT to process the IF file according to your needs. Please note, that we will currently not formally describe the intermediate 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.
-### Advanced Use {#advanced}
+### Advanced Use { #advanced}
The generation of the intermediate format as well as it parsing process has been designed to allow for maximum flexibility and optimization. Please note that you can call `setTransformerHandler()` 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 `getContentHandler()`).
Modified: xmlgraphics/site/trunk/content/fop/0.95/knownissues_overview.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/0.95/knownissues_overview.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/0.95/knownissues_overview.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/0.95/knownissues_overview.mdtext Thu Jul 24 16:21:20 2014
@@ -3,7 +3,7 @@ Title: Apache(tm) FOP: Known Issues
#Apache™ FOP: Known Issues
-## Known issues {#Known-issues}
+## Known issues { #Known-issues}
This page lists currently known issues in the current release.
@@ -16,7 +16,7 @@ For additional information on known issu
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.
-### FO Tree {#FO-Tree}
+### FO Tree { #FO-Tree}
This section lists disabled test cases in the test suite for the FO tree tests, at the time of the release.
@@ -25,7 +25,7 @@ This section lists disabled test cases i
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.
-### Layout Engine {#Layout-Engine}
+### Layout Engine { #Layout-Engine}
This section lists disabled test cases in the test suite for the layout engine tests, at the time of the release.
@@ -191,7 +191,7 @@ The code should be ok, but the test case
A soft hyphen should be a preferred as break compared to a normal hyphenation point but is not.
-### Other known issues {#Other-known-issues}
+### Other known issues { #Other-known-issues}
This section lists other known issues.
Modified: xmlgraphics/site/trunk/content/fop/0.95/metadata.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/0.95/metadata.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/0.95/metadata.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/0.95/metadata.mdtext Thu Jul 24 16:21:20 2014
@@ -3,17 +3,17 @@ Title: Apache(tm) FOP: Metadata
#Apache™ FOP: Metadata
-## Overview {#overview}
+## Overview { #overview}
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 [XMP (eXtensible Metadata Platform, specified by Adobe)](http://www.adobe.com/products/xmp/). 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.
-## Embedding XMP in an XSL-FO document {#xmp-in-fo}
+## Embedding XMP in an XSL-FO document { #xmp-in-fo}
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.
Document-level metadata can be specified in the `fo:declarations` element. XMP specification recommends to use `x:xmpmeta`, `rdf:RDF`, and `rdf:Description` elements as shown in example below. Both `x:xmpmeta` and `rdf:RDF` elements are recognized as the top-level element introducing an XMP fragment (as per the XMP specification).
-### Example {#xmp-example}
+### Example { #xmp-example}
:::xml
[..]
@@ -41,7 +41,7 @@ Document-level metadata can be specified
`fo:declarations` **must** be declared after `fo:layout-master-set` and before the first `page-sequence`.
-## Implementation in Apache FOP {#xmp-impl-in-fop}
+## Implementation in Apache FOP { #xmp-impl-in-fop}
Currently, XMP support is only available for PDF output.
@@ -63,7 +63,7 @@ The mapping between the Info and the Met
| ModDate | date | xmp:ModifyDate | Date | Internal |
"Internal" in the Category column means that the user should not set this value. It is set by the application.The "Subject" used to be mapped to `dc:subject` in the initial publication of PDF/A-1 (ISO 19005-1). In the [Technical Corrigendum 1](http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=45613) this was changed to map to `dc:description["x-default"]`.
-### Namespaces {#namespaces}
+### Namespaces { #namespaces}
Metadata is made of property sets where each property set uses a different namespace URI.
@@ -79,7 +79,7 @@ Please refer to the [XMP Specification](
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.
-## Links {#links}
+## Links { #links}
- [Adobe's Extensible Metadata Platform (XMP) website](http://www.adobe.com/products/xmp/)
Modified: xmlgraphics/site/trunk/content/fop/0.95/output.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/0.95/output.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/0.95/output.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/0.95/output.mdtext Thu Jul 24 16:21:20 2014
@@ -5,9 +5,9 @@ Title: Apache(tm) FOP Output Formats
Apache™ FOP supports multiple output formats by using a different renderer for each format. The renderers do not all have the same set of capabilities, sometimes because of the output format itself, sometimes because some renderers get more development attention than others.
-## General Information {#general}
+## General Information { #general}
-### Fonts {#general-fonts}
+### Fonts { #general-fonts}
Most FOP renderers use a FOP-specific system for font registration. However, the Java2D/AWT and print renderers use the Java AWT package, which gets its font information from the operating system registration. This can result in several differences, including actually using different fonts, and having different font metrics for the same font. The net effect is that the layout of a given FO document can be quite different between renderers that do not use the same font information.
@@ -31,7 +31,7 @@ With a work-around, it is possible to ma
- `fop -atin myfile.at.xml -tiff myfile.tiff`
-### Output to a Printer or Other Device {#general-direct-output}
+### Output to a Printer or Other Device { #general-direct-output}
The most obvious way to print your document is to use the FOP [print renderer](#print), which uses the Java2D API (AWT). However, you can also send output from the Postscript renderer directly to a Postscript device, or output from the PCL renderer directly to a PCL device.
@@ -42,17 +42,17 @@ proc = Runtime.getRuntime().exec("lp -d"
out = proc.getOutputStream();
Set the output MIME type to "application/x-pcl" (MimeConstants.MIME_PCL) and it happily sends the PCL to the UNIX printer queue.
-## PDF {#pdf}
+## PDF { #pdf}
PDF is the best supported output format. It is also the most accurate with text and layout. This creates a PDF document that is streamed out as each page is rendered. This means that the internal page index information is stored near the end of the document. The PDF version supported is 1.4. PDF versions are forwards/backwards compatible.
Note that FOP does not currently support "tagged PDF" or PDF/A-1a. Support for [PDF/A-1b](pdfa.html) and [PDF/X](pdfx.html) has recently been added, however.
-### Fonts {#pdf-fonts}
+### Fonts { #pdf-fonts}
PDF has a set of fonts that are always available to all PDF viewers; to quote from the PDF Specification: *"PDF prescribes a set of 14 standard fonts that can be used without prior definition. These include four faces each of three Latin text typefaces (Courier, Helvetica, and Times), as well as two symbolic fonts (Symbol and ITC Zapf Dingbats). These fonts, or suitable substitute fonts with the same metrics, are guaranteed to be available in all PDF viewer applications."*
-### Post-processing {#pdf-postprocess}
+### Post-processing { #pdf-postprocess}
FOP does not currently support several desirable PDF features: watermarks and signatures. One workaround is to use Adobe Acrobat (the full version, not the Reader) to process the file manually or with scripting that it supports.
@@ -105,7 +105,7 @@ Here is some sample code that uses iText
Check the iText tutorial and documentation for setting access flags, password, encryption strength and other parameters.
-### Watermarks {#pdf-watermark}
+### Watermarks { #pdf-watermark}
In addition to the [PDF Post-processing](#pdf-postprocess) options, consider the following workarounds:
@@ -114,11 +114,11 @@ In addition to the [PDF Post-processing]
- (submitted by Trevor Campbell) Place an image in a region that overlaps the flowing text. For example, make region-before large enough to contain your image. Then include a block (if necessary, use an absolutely positioned block-container) containing the watermark image in the static-content for the region-before. Note that the image will be drawn on top of the normal content.
-## PostScript {#ps}
+## PostScript { #ps}
The PostScript renderer has been brought up to a similar quality as the PDF renderer, but may still be missing certain features. It provides good support for most text and layout. Images and SVG are not fully supported, yet. Currently, the PostScript renderer generates PostScript Level 3 with most DSC comments. Actually, the only Level 3 features used are the FlateDecode and DCTDecode filter (the latter is used for 1:1 embedding of JPEG images), everything else is Level 2.
-### Configuration {#ps-configuration}
+### Configuration { #ps-configuration}
The PostScript renderer configuration currently allows the following settings:
@@ -141,7 +141,7 @@ The default value for the "safe-set-page
The default value for the "dsc-compliant" setting is "true". Setting it to "false" will break DSC compliance by minimizing the number of setpagedevice calls in the postscript document output. This feature may be useful when unwanted blank pages are experienced in your postscript output. This problem is caused by the particular postscript implementation issuing unwanted postscript subsystem initgraphics/erasepage calls on each setpagedevice call.
-### Limitations {#ps-limitations}
+### Limitations { #ps-limitations}
- Images and SVG may not be displayed correctly. SVG support is far from being complete. No image transparency is available.
@@ -152,20 +152,20 @@ The default value for the "dsc-compliant
- PPD support is still missing.
-## PCL {#pcl}
+## PCL { #pcl}
This format is for the Hewlett-Packard PCL printers and other printers supporting PCL. It should produce output as close to identical as possible to the printed output of the PDFRenderer within the limitations of the renderer, and output device.
The output created by the PCLRenderer is generic PCL 5, HP GL/2 and PJL. This should allow any device fully supporting PCL 5 to be able to print the output generated by the PCLRenderer. PJL is used to control the print job and switch to the PCL language. PCL 5 is used for text, raster graphics and rectangular fill graphics. HP GL/2 is used for more complex painting operations. Certain painting operations are done off-screen and rendered to PCL as bitmaps because of limitations in PCL 5.
-### References {#pcl-references}
+### References { #pcl-references}
- [WikiPedia entry on PCL](http://en.wikipedia.org/wiki/Printer_Control_Language)
- [Technical reference documents on PCL from Hewlett-Packard](http://h20000.www2.hp.com/bizsupport/TechSupport/Document.jsp?objectID=bpl04568)
-### Limitations {#pcl-limitations}
+### Limitations { #pcl-limitations}
- Text or graphics outside the left or top of the printable area are not rendered properly. This is a limitation of PCL, not FOP. In general, things that should print to the left of the printable area are shifted to the right so that they start at the left edge of the printable area.
@@ -184,7 +184,7 @@ The output created by the PCLRenderer is
- Currently, there's no support for clipping and image transparency, largely because PCL 5 has certain limitations.
-### Configuration {#pcl-configuration}
+### Configuration { #pcl-configuration}
The PCL renderer configuration currently allows the following settings:
@@ -203,7 +203,7 @@ The default value for the "disable-pjl"
You can control the output resolution for the PCL using the "target resolution" setting on the FOUserAgent. The actual value will be rounded up to the next supported PCL resolution. Currently, only 300 and 600 dpi are supported which should be enough for most use cases. Note that this setting directly affects the size of the output file and the print quality.
-### Extensions {#pcl-extensions}
+### Extensions { #pcl-extensions}
The PCL Renderer supports some PCL specific extensions which can be embedded into the input FO document. To use the extensions the appropriate namespace must be declared in the fo:root element like this:
@@ -211,7 +211,7 @@ The PCL Renderer supports some PCL speci
<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format"
xmlns:pcl="http://xmlgraphics.apache.org/fop/extensions/pcl">
-#### Page Source (Tray selection) {#pcl-page-source}
+#### Page Source (Tray selection) { #pcl-page-source}
The page-source extension attribute on fo:simple-page-master allows to select the paper tray the sheet for a particular simple-page-master is to be taken from. Example:
@@ -224,18 +224,18 @@ The page-source extension attribute on f
Note: the tray number is a positive integer and the value depends on the target printer. Not all PCL printers support the same paper trays. Usually, "1" is the default tray, "2" is the manual paper feed, "3" is the manual envelope feed, "4" is the "lower" tray and "7" is "auto-select". Consult the technical reference for your printer for all available values.
-## AFP {#afp}
+## AFP { #afp}
<warning>The AFP Renderer is a new addition (27-Apr-2006) to the sandbox and as such not yet fully tested or feature complete.</warning>
The FOP AFP Renderer deals with creating documents conforming to the IBM AFP document architecture also refered to as MO:DCA (Mixed Object Document Content Architecture).
-### References {#afp-references}
+### References { #afp-references}
- [AFP (Advanced Function Presentation)](http://en.wikipedia.org/wiki/Advanced_Function_Presentation)
- [AFP Resources on the FOP WIKI](http://wiki.apache.org/xmlgraphics-fop/AFPResources)
-### Limitations {#afp-limitations}
+### Limitations { #afp-limitations}
This list is most likely badly incomplete.
@@ -244,9 +244,9 @@ This list is most likely badly incomplet
- Only IBM outline and raster fonts and to a limited extend the original fonts built into FOP are supported. Support for TrueType fonts may be added later.
-### Configuration {#afp-configuration}
+### Configuration { #afp-configuration}
-#### Fonts {#afp-font-config}
+#### Fonts { #afp-font-config}
The AFP Renderer requires special configuration particularly related to fonts. AFP Render configuration is done through the normal FOP configuration file. The MIME type for the AFP Renderer is application/x-afp which means the AFP Renderer section in the FOP configuration file looks like:
@@ -377,14 +377,14 @@ Experimentation has shown that the font
<font-triplet name="Courier" style="normal" weight="bold"/>
</font>
-#### Output Resolution {#afp-renderer-resolution-config}
+#### Output Resolution { #afp-renderer-resolution-config}
By default the AFP Renderer creates output with a resolution of 240 dpi. This can be overridden by the <renderer-resolution/> configuration element. Example:
:::xml
<renderer-resolution>240</renderer-resolution>
-#### Images {#afp-image-config}
+#### Images { #afp-image-config}
By default the AFP Renderer converts all images to 8 bit grey level. This can be overridden by the <images> configuration element. Example:
@@ -398,7 +398,7 @@ This will put images as RGB images into
Only the values "color" and "b+w" are allowed for the mode attribute. The bits-per-pixel attribute is ignored if mode is "color". For "b+w" mode is must be 1, 4, or 8.
-### Extensions {#afp-extensions}
+### Extensions { #afp-extensions}
The AFP Renderer supports some AFP specific extensions which can be embedded into the input fo document. To use the extensions the appropriate namespace must be declared in the fo:root element like this:
@@ -406,7 +406,7 @@ The AFP Renderer supports some AFP speci
<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format"
xmlns:afp="http://xmlgraphics.apache.org/fop/extensions/afp">
-#### Page Overlay Extension {#afp-page-overlay}
+#### Page Overlay Extension { #afp-page-overlay}
The include-page-overlay extension element allows to define on a per simple-page-master basis a page overlay resource. Example:
@@ -420,7 +420,7 @@ The include-page-overlay extension eleme
The mandatory name attribute must refer to an 8 character (space padded) resource name that must be known in the AFP processing environment.
-#### Page Segment Extension {#afp-page-segment}
+#### Page Segment Extension { #afp-page-segment}
The include-page-segment extension element allows to define resource substitution for fo:external-graphics elements. Example:
@@ -436,7 +436,7 @@ The include-page-segment extension eleme
The include-page-segment extension element can only occur within a simple-page-master. Multiple include-page-segment extension elements within a simple-page-master are allowed. The mandatory name attribute must refer to an 8 character (space padded) resource name that must be known in the AFP processing environment. The value of the mandatory src attribute is compared against the value of the src attribute in fo:external-graphic elements and if it is identical (string matching is used) in the generated AFP the external graphic is replaced by a reference to the given resource.
-#### Tag Logical Element Extension {#afp-tag-logical-element}
+#### Tag Logical Element Extension { #afp-tag-logical-element}
The tag-logical-element extension element allows to injects TLEs into the AFP output stream. Example:
@@ -452,7 +452,7 @@ The tag-logical-element extension elemen
The tag-logical-element extension element can only occur within a simple-page-master. Multiple tag-logical-element extension elements within a simple-page-master are allowed. The name and value attributes are mandatory.
-#### No Operation Extension {#afp-no-operation}
+#### No Operation Extension { #afp-no-operation}
The no-operation extension provides the ability to carry up to 32K of comments or any other type of unarchitected data into the AFP output stream. Example:
@@ -467,7 +467,7 @@ The no-operation extension provides the
The no-operation extension element can only occur within a simple-page-master. Multiple no-operation extension elements within a simple-page-master are allowed. The name attribute is mandatory.
-## RTF {#rtf}
+## RTF { #rtf}
JFOR, an open source XSL-FO to RTF converter has been integrated into Apache FOP. This will create an RTF (rich text format) document that will attempt to contain as much information from the XSL-FO document as possible. It should be noted that is not possible (due to RTF's limitations) to map all XSL-FO features to RTF. For complex documents, the RTF output will never reach the feature level from PDF, for example. Thus, using RTF output is only recommended for simple documents such as letters.
@@ -495,33 +495,33 @@ These are some known restrictions compar
- percentages are not supported everywhere
-## XML (Area Tree XML) {#xml}
+## XML (Area Tree XML) { #xml}
This is primarily for testing and verification. The XML created is simply a representation of the internal area tree put into XML. We use that to verify the functionality of FOP's layout engine.
The other use case of the Area Tree XML is as FOP's "intermediate format". More information on that can be found on the page dedicated to the [Intermediate Format](intermediate.html).
-## Java2D/AWT {#awt}
+## Java2D/AWT { #awt}
The Java2DRenderer provides the basic functionality for all Java2D-based output formats (AWT viewer, direct print, PNG, TIFF).
The AWT viewer shows a window with the pages displayed inside a Java graphic. It displays one page at a time. The fonts used for the formatting and viewing depend on the fonts available to your JRE.
-## Print {#print}
+## Print { #print}
It is possible to directly print the document from the command line. This is done with the same code that renders to the Java2D/AWT renderer.
-### Known issues {#print-issues}
+### Known issues { #print-issues}
If you run into the problem that the printed output is incomplete on Windows: this often happens to users printing to a PCL printer. There seems to be an incompatibility between Java and certain PCL printer drivers on Windows. Since most network-enabled laser printers support PostScript, try switching to the PostScript printer driver for that printer model.
-## Bitmap (TIFF/PNG) {#bitmap}
+## Bitmap (TIFF/PNG) { #bitmap}
It is possible to directly create bitmap images from the individual pages generated by the layout engine. This is done with the same code that renders to the Java2D/AWT renderer.
Currently, two output formats are supported: PNG and TIFF. TIFF produces one file with multiple pages, while PNG output produces one file per page. The quality of the bitmap depends on the target resolution setting on the FOUserAgent.
-### Configuration {#bitmap-configuration}
+### Configuration { #bitmap-configuration}
The TIFF and PNG renderer configuration currently allows the following settings:
@@ -533,7 +533,7 @@ The TIFF and PNG renderer configuration
The default value for the "transparent-page-background" setting is "false" which paints an opaque, white background for the whole image. If you set this to true, no such background will be painted and you will get a transparent image if an alpha channel is available in the output format.
-### TIFF-specific Configuration {#tiff-configuration}
+### TIFF-specific Configuration { #tiff-configuration}
In addition to the above values the TIFF renderer configuration allows some additional settings:
@@ -563,7 +563,7 @@ The default value for the "compression"
- `CCITT T.6` (Fax Group 4)
If you want to use CCITT compression, please make sure you've got a J2SE 1.4 or later and [Java Advanced Imaging Image I/O Tools](http://java.sun.com/products/java-media/jai/current.html) in your classpath. The Sun JRE doesn't come with a TIFF codec built in, so it has to be added separately. The internal TIFF codec from XML Graphics Commons only supports PackBits, Deflate and JPEG compression for writing.
-## TXT {#txt}
+## TXT { #txt}
The text renderer produces plain ASCII text output that attempts to match the output of the PDFRenderer as closely as possible. This was originally developed to accommodate an archive system that could only accept plain text files, and is primarily useful for getting a quick-and-dirty view of the document text. The renderer is very limited, so do not be surprised if it gives unsatisfactory results.
@@ -578,19 +578,19 @@ Because FOP lays the text onto a grid du
- line-height="10.5pt"
-## Output Formats in the Sandbox {#sandbox}
+## Output Formats in the Sandbox { #sandbox}
Due to the state of certain renderers we moved some of them to a "sandbox" area until they are ready for more serious use. The renderers and FOEventHandlers in the sandbox can be found under src/sandbox and are compiled into build/fop-sandbox.jar during the main build. The output formats in the sandbox are marked as such below.
-### MIF {#mif}
+### MIF { #mif}
<warning>The MIF handler is in the sandbox and not yet functional in FOP Trunk!!! Please help us ressurrect this feature.</warning>
This format is the Maker Interchange Format which is used by Adobe Framemaker.
-### SVG {#svg}
+### SVG { #svg}
<warning>The SVG renderer is in the sandbox and may not work as expected in FOP Trunk!!! Please help us improve this feature.</warning>
This format creates an SVG document that has links between the pages. This is primarily for slides and creating svg images of pages. Large documents will create SVG files that are far too large for an SVG viewer to handle. Since FO documents usually have text the SVG document will have a large number of text elements. The font information for the text is obtained from the JVM in the same way as for the AWT viewer. If the SVG is viewed on a system where the fonts are different, such as another platform, then the page may look wrong.
-## Wish list {#wishlist}
+## Wish list { #wishlist}
Apache FOP is easily extensible and allows you to add new output formats to enhance FOP's functionality. There's a number of output formats which are on our wish list. We're looking for volunteers to help us implement them.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: commits-help@xmlgraphics.apache.org