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 [7/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/1.1/anttask.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/1.1/anttask.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/1.1/anttask.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/1.1/anttask.mdtext Thu Jul 24 16:21:20 2014
@@ -5,7 +5,7 @@ Title: Apache(tm) FOP: Ant task
Apache™ FOP provides an Ant task for automating the document build process.
-## Description {#basics}
+## Description { #basics}
The FOP Ant task will convert XSL-FO documents to PDF, PS, PCL etc. output (see [Output formats](output.html) for available formats).
@@ -29,7 +29,7 @@ To call FOP tasks within Ant, first add
Then create FOP tasks within your Ant build file, using the FOP task parameters listed below.
-## Parameters for FOP Ant task {#parameters}
+## Parameters for FOP Ant task { #parameters}
<caption>Parameters specified as attributes</caption>
@@ -55,7 +55,7 @@ Then create FOP tasks within your Ant bu
|-----------|-------------|----------|
| fileset | [FileSets](http://ant.apache.org/manual/CoreTypes/fileset.html) are used to specify multiple XSL-FO files to be rendered. | Yes, if no fofile attribute is supplied |
-## Examples {#examples}
+## Examples { #examples}
The following example converts a single XSL-FO file to a PDF document:
Modified: xmlgraphics/site/trunk/content/fop/1.1/changes_1.1.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/1.1/changes_1.1.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/1.1/changes_1.1.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/1.1/changes_1.1.mdtext Thu Jul 24 16:21:20 2014
@@ -5,13 +5,13 @@ Title: History of Changes 1.1
[changes_1.1.rss](changes_1.1.rss)
-## Introduction and explanation of symbols {#introduction}
+## Introduction and explanation of symbols { #introduction}
Changes are sorted by "type" and then chronologically with the most recent at the top. These symbols denote the various action types:=add,=fix,=remove,=update
-## Version 1.1 (20 October 2012) {#version_1.1}
+## Version 1.1 (20 October 2012) { #version_1.1}
-### Changes to the Code Base {#Code_1.1}
+### Changes to the Code Base { #Code_1.1}
-  Added support for the role property on fo:page-sequence, fo:flow and fo:static-content. This allows to change the mapping of those FOs to PDF structure types when enabling accessibility. Committed by VH.
@@ -131,7 +131,7 @@ Changes are sorted by "type" and then ch
-  Add run target for embedded examples. Add increased JVM memory heap flag for example8 in case font cache is rebuilt. Committed by GA. See issue [FOP-1955](https://issues.apache.org/jira/browse/FOP-1955).
-### Changes to the User Configuration {#Config_1.1}
+### Changes to the User Configuration { #Config_1.1}
-  Added configuration option to set the version of the output PDF document. Committed by VH. Thanks to Mehdi Houshmand. See issue [FOP-1945](https://issues.apache.org/jira/browse/FOP-1945).
@@ -142,14 +142,14 @@ Changes are sorted by "type" and then ch
-  Fix for relative URIs in the configuration file (base, font-base, hyphenation-base) are evaluated relative to the base URI of the configuration file. Committed by SP.
-### Changes to Documentation {#Docs_1.1}
+### Changes to Documentation { #Docs_1.1}
-  Fix renderer mime type for PCL output; should be application/x-pcl. Committed by GA. See issue [FOP-2064](https://issues.apache.org/jira/browse/FOP-2064).
-  Update FAQ and New Bug documentation. Committed by GA.
-### Changes to the Font Subsystem {#Fonts_1.1}
+### Changes to the Font Subsystem { #Fonts_1.1}
-  Add support for OpenType advanced typographic tables (GDEF, GSUB, GPOS). Committed by GA.
@@ -182,7 +182,7 @@ Changes are sorted by "type" and then ch
-  Removing experimental feature that violates XSL-FO and Unicode semantics by misinterpreting Basic Latin code points. Users must use private use codepoints to access font specific character mappings that have no assigned Unicode code point. See bug 50492. Committed by GA.
-### Changes to the Image Support {#Images_1.1}
+### Changes to the Image Support { #Images_1.1}
-  Fix incorrect SVG line dash pattern with PDF output format. Committed by GA. Thanks to Luis Bernardo. See issue [FOP-2079](https://issues.apache.org/jira/browse/FOP-2079).
@@ -195,7 +195,7 @@ Changes are sorted by "type" and then ch
-  Fix newly introduced findbugs warnings. Committed by GA. Thanks to Luis Bernardo. See issue [FOP-1256](https://issues.apache.org/jira/browse/FOP-1256).
-### Changes to the Layout Engine {#Layout_1.1}
+### Changes to the Layout Engine { #Layout_1.1}
-  Add support for complex scripts, including: full bidi support, support for advanced typographic tables, advanced support for number conversion. Committed by GA. See issues [FOP-959](https://issues.apache.org/jira/browse/FOP-959), [FOP-1790](https://issues.apache.org/jira/browse/FOP-1790), [FOP-1827](https://issues.apache.org/jira/browse/FOP-1827).
@@ -236,7 +236,7 @@ Changes are sorted by "type" and then ch
-  Fixed retrieval of available BPD for cases spanning columns and multiple pages with differing page masters. Committed by JM. See issue [FOP-1853](https://issues.apache.org/jira/browse/FOP-1853).
-### Changes to Renderers (Output Formats) {#Renderers_1.1}
+### Changes to Renderers (Output Formats) { #Renderers_1.1}
-  Added possibility to embed TrueType fonts in PostScript. Committed by VH. See issue [FOP-2004](https://issues.apache.org/jira/browse/FOP-2004).
@@ -325,14 +325,14 @@ Changes are sorted by "type" and then ch
-  Removed old Renderer implementations for those output formats that have a version based on the new DocumentHandler architecture available (AFP, PCL, PDF, PS). Committed by VH.
-### Changes to unit tests or other test code {#Test_1.1}
+### Changes to unit tests or other test code { #Test_1.1}
-  Fix errors and warnings in example files. Add build.xml for documentation examples. Committed by GA.
-  Add test for basic-link with padding. Committed by GA. Thanks to Matthias Reischenbacher. See issue [FOP-1864](https://issues.apache.org/jira/browse/FOP-1864).
-### Contributors to this release {#contributors_1.1}
+### Contributors to this release { #contributors_1.1}
We thank the following people for their contributions to this release.
Modified: xmlgraphics/site/trunk/content/fop/1.1/compiling.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/1.1/compiling.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/1.1/compiling.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/1.1/compiling.mdtext Thu Jul 24 16:21:20 2014
@@ -3,29 +3,29 @@ 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.
-## Set Up Your Environment {#env}
+## Set Up Your Environment { #env}
-### JDK {#env-jdk}
+### JDK { #env-jdk}
Building FOP 1.1 requires a minimum Java Development Kit (JDK/SDK) of 1.5 (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.5 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.
@@ -61,7 +61,7 @@ To clean the build directory first:
<note>If you want to shorten the build time you can just call the "package" target which doesn't perform any automated tests during the build.</note>
-## Troubleshooting {#problems}
+## Troubleshooting { #problems}
If you have problems building FOP, please try the following:
Modified: xmlgraphics/site/trunk/content/fop/1.1/complexscripts.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/1.1/complexscripts.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/1.1/complexscripts.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/1.1/complexscripts.mdtext Thu Jul 24 16:21:20 2014
@@ -3,7 +3,7 @@ Title: Apache(tm) FOP: Complex Scripts
#Apache™ FOP: Complex Scripts
-## Overview {#overview}
+## Overview { #overview}
This page describes the [complex scripts](http://en.wikipedia.org/wiki/Complex_scripts) features of Apache™ FOP, which include:
@@ -16,7 +16,7 @@ This page describes the [complex scripts
- Support for advanced number to string formatting.
-## Disabling complex scripts {#Disabling-complex-scripts}
+## Disabling complex scripts { #Disabling-complex-scripts}
Complex script features are enabled by default. If some application of FOP does not require this support, then it can be disabled in three ways:
@@ -43,7 +43,7 @@ When complex scripts features are enable
<note>A document author need not make explicit use of any complex scripts feature in order for this additional information to be created. For example, if the author makes use of a font that contains OpenType GSUB and/or GPOS tables, then those tables will be automatically used unless complex scripts features are disabled.</note>
-## Changes to your XSL-FO input files {#source}
+## Changes to your XSL-FO input files { #source}
In most circumstances, XSL-FO content does not need to change in order to make use of complex scripts features; however, in certain contexts, fully automatic processing is not sufficient. In these cases, an author may make use of the following XSL-FO constructs:
@@ -62,11 +62,11 @@ In most circumstances, XSL-FO content do
- Explicit join control characters: U+200C ZWNJ and U+200D ZWJ.
-## Authoring Details {#details}
+## Authoring Details { #details}
The complex scripts related effects of the above enumerated XSL-FO constructs are more fully described in the following sub-sections.
-### Script Property {#script_property}
+### Script Property { #script_property}
In order to apply font specific complex script features, it is necessary to know the script that applies to the text undergoing layout processing. This script is determined using the following algorithm:
@@ -77,7 +77,7 @@ In order to apply font specific complex
In case the automatic algorithm does not produce the desired results, an author may explicitly specify a `script` property with the desired script. If specified, it must be one of the four-letter script code specified in [ISO 15924 Code List](http://unicode.org/iso15924/iso15924-codes.html) or in the [Extended Script Codes](#extended_script_codes) table. Comparison of script codes is performed in a case-insensitive manner, so it does not matter what case is used when specifying these codes in an XSL-FO document.
-#### Standard Script Codes {#standard_script_codes}
+#### Standard Script Codes { #standard_script_codes}
The following table enumerates the standard ISO 15924 4-letter codes recognized by FOP.
@@ -116,7 +116,7 @@ The following table enumerates the stand
| `zyyy` | Undetermined |
| `zzzz` | Uncoded |
-#### Extended Script Codes {#extended_script_codes}
+#### Extended Script Codes { #extended_script_codes}
The following table enumerates a number of non-standard extended script codes recognized by FOP.
@@ -136,13 +136,13 @@ The following table enumerates a number
<note>When performing automatic script determination, FOP selects the OpenType Indic Version 2 script codes by default. If the author requires Version 1 behavior, then an explicit, non-extension script code should be specified in a governing `script` property.</note>
-### Language Property {#language_property}
+### Language Property { #language_property}
Certain fonts that support complex script features can make use of language information in order for language specific processing rules to be applied. For example, a font designed for the Arabic script may support typographic variations according to whether the written language is Arabic, Farsi (Persian), Sindhi, Urdu, or another language written with the Arabic script. In order to apply these language specific features, the author may explicitly mark the text with a [http://www.w3.org/TR/2006/REC-xsl11-20061205/#language](http://www.w3.org/TR/2006/REC-xsl11-20061205/#language) property.
When specifying the `language` property, the value of the property must be either an [ISO639-2 3-letter code](http://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) or an [ISO639-1 2-letter code](http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). Comparison of language codes is performed in a case-insensitive manner, so it does not matter what case is used when specifying these codes in an XSL-FO document.
-### Writing Mode Property {#writing_mode_property}
+### Writing Mode Property { #writing_mode_property}
The `writing-mode` property is used to determine the axes and direction of the inline progression direction, the block progression direction, the column progression direction (in tables and flows), the shift direction, region placement, the resolution of writing-mode relative property values (such as start, end, before, after), and the default block (paragraph) bidirectionality level.
@@ -176,11 +176,11 @@ At present, only the following values of
Writing modes that employ a vertical inline progression direction are not yet supported.
-### Bidi Override Element {#bidi_override_element}
+### Bidi Override Element { #bidi_override_element}
The [fo:bidi-override](http://www.w3.org/TR/2006/REC-xsl11-20061205/#fo_bidi-override) element may be used to override default bidirectional processing behavior, including default embedding levels and default character directionality. In the absence of either this element or use of explicit [Bidi Control Characters](#bidi_controls), the default behavior prescribed by the [Unicode Bidirectional Algorithm](http://www.w3.org/TR/2006/REC-xsl11-20061205/#fo_bidi-override) applies.
-### Bidi Control Characters {#bidi_controls}
+### Bidi Control Characters { #bidi_controls}
In addition to the use of the [Bidi Override Element](#bidi_override_element), an author may make use of the following explicit Unicode Bidi Control Characters:
@@ -201,7 +201,7 @@ In addition to the use of the [Bidi Over
If an embedding or override is not terminated (using U+202C PDF) prior to the end of a [delimited text range](http://www.w3.org/TR/2006/REC-xsl11-20061205/#d0e4879), then it is automatically terminated by FOP.
-### Join Control Characters {#join_controls}
+### Join Control Characters { #join_controls}
In order to prevent joining behavior in contexts where joining occurs by default, for example, between U+0628 ARABIC LETTER BEH and U+0646 ARABIC LETTER NOON, an author may used a U+200C ZERO WIDTH NON-JOINER (ZWNJ).
@@ -209,7 +209,7 @@ Conversely, in order to force joining be
The behavior of ZWNJ and ZWJ is script specific. See [The Unicode Standard, Chapter 8, Middle Eastern Scripts](http://www.unicode.org/versions/Unicode6.1.0/ch08.pdf) for information on the use of these control characters with the Arabic script. See [The Unicode Standard, Chapter 9, South Asian Scripts - I](http://www.unicode.org/versions/Unicode6.1.0/ch09.pdf) for information on the use of these control characters with common Indic scripts.
-## Supported Scripts {#supported_scripts}
+## Supported Scripts { #supported_scripts}
Support for specific complex scripts is enumerated in the following table. Support for those marked as not being supported is expected to be added in future revisions.
@@ -233,11 +233,11 @@ Support for specific complex scripts is
| [Tibetan](http://en.wikipedia.org/wiki/Tibetan_alphabet) | none | none | |
| [Thai](http://en.wikipedia.org/wiki/Thai_alphabet) | none | none | |
-## Supported Fonts {#supported_fonts}
+## Supported Fonts { #supported_fonts}
Support for specific fonts is enumerated in the following sub-sections. If a given font is not listed, then it has not been tested with these complex scripts features.
-### Arabic Fonts {#fonts_arabic}
+### Arabic Fonts { #fonts_arabic}
| Font | Version | Glyphs | Comments |
|------|---------|--------|----------|
@@ -251,7 +251,7 @@ Support for specific fonts is enumerated
| [Traditional Arabic](http://www.microsoft.com/typography/fonts/font.aspx?FID=264) | [5.00](http://www.microsoft.com/typography/fonts/font.aspx?FMID=1658) | 530 | lacks GPOS support |
| [Traditional Arabic](http://www.microsoft.com/typography/fonts/font.aspx?FID=264) | 5.92 | 589 | includes GPOS for advanced position adjustment |
-### Devanagari Fonts {#devanagari_fonts}
+### Devanagari Fonts { #devanagari_fonts}
| Font | Version | Glyphs | Comments |
|------|---------|--------|----------|
@@ -260,7 +260,7 @@ Support for specific fonts is enumerated
| [Mangal](http://www.microsoft.com/typography/fonts/family.aspx?FID=243) | [5.01](http://www.microsoft.com/typography/fonts/font.aspx?FMID=1759) | 885 | designed for use in user interfaces |
| [Utsaah](http://www.microsoft.com/typography/fonts/family.aspx?FID=384) | [1.00](http://www.microsoft.com/typography/fonts/font.aspx?FMID=1811) | 706 | |
-## Other Limitations {#limitations}
+## Other Limitations { #limitations}
Complex scripts support in Apache FOP is relatively new, so there are certain limitations. Please help us identify and close any gaps.
@@ -269,7 +269,7 @@ Complex scripts support in Apache FOP is
- Shaping context does not extend across an element boundary. This limitation prevents the use of `fo:character`, `fo:inline` or `fo:wrapper` in order to colorize individual Arabic letters without affecting shaping behavior across the element boundary.
-## Related Links {#links}
+## Related Links { #links}
In addition to the XSL-FO specification, a number of external resources provide guidance about authoring documents that employ complex scripts and the features described above:
Modified: xmlgraphics/site/trunk/content/fop/1.1/configuration.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/1.1/configuration.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/1.1/configuration.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/1.1/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 Apache™ 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 |
|---------|---------------------------|-------------|---------------|
@@ -74,7 +74,7 @@ This is an excerpt from the example conf
<!-- etc. etc..... -->
</fop>
-## Image Loading Customization {#image-loading}
+## Image Loading Customization { #image-loading}
Apache FOP uses the image loading framework from [Apache XML Graphics Commons](http://xmlgraphics.apache.org/commons/) to load images using various plug-ins. Every image loader plug-in has a hard-coded usage penalty that influences which solution is chosen if there are multiple possibilities to load an image. Sometimes, though, these penalties need to be tweaked and this can be done in the FOP configuration. An example:
@@ -96,7 +96,7 @@ The second penalty element sets an "infi
Negative penalties are possible to promote a plug-in but a negative penalty sum will be treated as zero penalty in most cases. For more details on the image loading framework, please consult the documentation there.
-## 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.
@@ -126,7 +126,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.
@@ -192,7 +192,7 @@ By default FOP produces PDF files of ver
<!-- Versions 1.4, 1.5, 1.6 and 1.7 are accepted, all other values are invalid -->
</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:
@@ -212,7 +212,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.
@@ -228,7 +228,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.
-### Special Settings for the AFP Renderer {#afp-renderer}
+### Special Settings for the AFP Renderer { #afp-renderer}
@@ -252,7 +252,7 @@ The default line width is device depende
By default if there is no configuration definition for "resource-group-file", external resources will be placed in a file called resources.afp.
-## 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/1.1/embedding.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/1.1/embedding.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/1.1/embedding.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/1.1/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 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. MIME type) to use and, if the selected output format 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 document handler instance (details below). Finally, you retrieve a SAX DefaultHandler instance from the Fop object and use that as the SAXResult of your transformation.
-## The API {#API}
+## The API { #API}
FOP has many classes which express the "public" access modifier, however, this is not indicative of their inclusion into the public API. Every attempt will be made to keep the public API static, to minimize regressions for existing users, however, since the API is not clearly defined, the list of classes below are the generally agreed public API:
@@ -30,7 +30,7 @@ FOP has many classes which express the "
- org.apache.fop.render.intermediate.IFUtil
- org.apache.fop.render.intermediate.util.IFConcatenator
-## 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...
@@ -95,7 +95,7 @@ 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.
@@ -110,11 +110,11 @@ As a result of the above we differentiat
The use of "feedback" instead of "logging" is intentional. Most people were using log output as a means to get feedback from events within FOP. Therefore, FOP now includes an `event` package which can be used to receive feedback from the layout engine and other components within FOP **per rendering run**. This feedback is not just some text but event objects with parameters so these events can be interpreted by code. Of course, there is a facility to turn these events into normal human-readable messages. For details, please read on on the [Events page](events.html). This leaves normal logging to be mostly a thing used by the FOP developers although anyone can surely activate certain logging categories but the feedback from the loggers won't be separated by processing runs. If this is required, the [Events subsystem](events.html) is the right approach.
-### 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:
@@ -126,7 +126,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).
@@ -167,11 +167,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.
@@ -214,7 +214,7 @@ You can set all sorts of things on the F
<note>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.</note>
-### 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:
@@ -286,7 +286,7 @@ You can do all sorts of things on the us
<note>You should not reuse an FOUserAgent instance between FOP rendering runs although you can. Especially in multi-threaded environment, this is a bad idea.</note>
-## 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:
@@ -306,7 +306,7 @@ Instead of setting the parameters manual
The layout of the configuration file is described on the [Configuration page](configuration.html).
-## Document Handlers {#documenthandlers}
+## Document Handlers { #documenthandlers}
The document handlers are classes that inherit from `org.apache.fop.render.intermediate.IFDocumentHandler`. This is an interface for which a MIME type specific implementation can be created. This same handler is used either when XSL-FO is used as the input or when Intermediate Format is used. Since IF is output format agnostic, if custom fonts or other configuration information that affect layout (specific to a particular MIME type) are given then FOP needs that contextual information. The document handler provides that context so that when the IF is rendered, it is more visually consistent with FO rendering. The code below shows an example of how a document handler can be used to provide PDF configuration data to the IFSerializer.
@@ -321,13 +321,13 @@ The document handlers are classes that i
The rest of the code is the same as in [Basic Usage Patterns](#basics).
-## 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.
@@ -335,11 +335,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:
@@ -360,29 +360,29 @@ There are several options to consider:
- You may also wish to consider trying to reduce [memory usage](running.html#memory).
-## 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.
@@ -390,7 +390,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.
@@ -402,24 +402,24 @@ 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.
-### ExampleConcat.java (IF Concatenation example) {#ExampleConcat}
+### ExampleConcat.java (IF Concatenation example) { #ExampleConcat}
This can be found in the `embedding.intermediate` package within the examples and describes how IF can be concatenated to produce a document. Because IF has been through FOPs layout engine, it should be visually consistent with FO rendered documents while allowing the user to merge numerous documents together.
-### 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/1.1/events.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/1.1/events.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/1.1/events.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/1.1/events.mdtext Thu Jul 24 16:21:20 2014
@@ -3,7 +3,7 @@ Title: Apache(tm) FOP: Events/Processing
#Apache™ FOP: Events/Processing Feedback
-## Introduction {#introduction}
+## Introduction { #introduction}
In versions until 0.20.5, Apache™ FOP used [Avalon-style Logging](http://excalibur.apache.org/framework/index.html) where it was possible to supply a logger per processing run. During the redesign the logging infrastructure was switched over to [Commons Logging](http://commons.apache.org/logging/) 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.
@@ -11,7 +11,7 @@ With FOP's event subsystem, we'd like to
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).
-## The consumer side {#consumer}
+## The consumer side { #consumer}
The event subsystem is located in the `org.apache.fop.events` package and its base is the `Event` class. An instance is created for each event and is sent to a set of `EventListener` instances by the `EventBroadcaster`. An `Event` contains:
@@ -28,7 +28,7 @@ The `EventFormatter` class can be used t
A full example of what is shown here can be found in the `examples/embedding/java/embedding/events` directory in the FOP distribution. The example can also be accessed [via the web](http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/examples/embedding/java/embedding/events/).
-### Writing an EventListener {#write-listener}
+### Writing an EventListener { #write-listener}
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.
@@ -65,7 +65,7 @@ The code above also shows how you can tu
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!
-### Adding an EventListener {#add-listener}
+### Adding an EventListener { #add-listener}
To register the event listener with FOP, get the `EventBroadcaster` which is associated with the user agent (`FOUserAgent`) and add it there:
@@ -75,7 +75,7 @@ To register the event listener with FOP,
Please note that this is done separately for each processing run, i.e. for each new user agent.
-### An additional listener example {#listener-example1}
+### An additional listener example { #listener-example1}
Here's an additional example of an event listener:
@@ -119,13 +119,13 @@ You can also customize the exception to
This throws a `RuntimeException` with the `FileNotFoundException` as the cause. Further processing effectively stops in FOP. You can catch the exception in your code and react as you see necessary.
-## The producer side (for FOP developers) {#producer}
+## The producer side (for FOP developers) { #producer}
This section is primarily for FOP and FOP plug-in developers. It describes how to use the event subsystem for producing events.
<note>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 [us](mailto:fop-dev@xmlgraphics.apache.org).</note>
-### Producing and sending an event {#basic-event-production}
+### Producing and sending an event { #basic-event-production}
The basics are very simple. Just instantiate an `Event` object and fill it with the necessary parameters. Then pass it to the `EventBroadcaster` which distributes the events to the interested listeneners. Here's a code example:
@@ -140,7 +140,7 @@ The basics are very simple. Just instant
The `Event.paramsBuilder()` is a [fluent interface](http://en.wikipedia.org/wiki/Fluent_interface) to help with the build-up of the parameters. You could just as well instantiate a `Map` (`Map<String, Object>`) and fill it with values.
-### The EventProducer interface {#event-producer}
+### The EventProducer interface { #event-producer}
To simplify event production, the event subsystem provides the `EventProducer` interface. You can create interfaces which extend `EventProducer`. 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.
@@ -178,7 +178,7 @@ To produce the same event as in the firs
TestEventProducer producer = TestEventProducer.Provider.get(broadcaster);
producer.complain(this, "I'm tired", 23);
-### The event model {#event-model}
+### The event model { #event-model}
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 `Event` 's parameter map we need to know the parameter names. These are retrieved from an event object model. This is found in the `org.apache.fop.events.model` 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 (`ant resourcegen`). The Ant task (found in `src/codegen/java/org/apache/fop/tools/EventProducerCollectorTask.java`) scans FOP's sources for descendants of the `EventProducer` interface and uses [QDox](http://qdox.codehaus.org/) to parse these interfaces.
@@ -190,7 +190,7 @@ There's one more information that is ext
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 `EventModelFactory`. This interface is implemented for each event model and registered through the service provider mechanism (see the [plug-ins section](#plug-ins) for details).
-### Event severity {#event-severity}
+### Event severity { #event-severity}
Four different levels of severity for events has been defined:
@@ -205,7 +205,7 @@ Four different levels of severity for ev
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.
-### Plug-ins to the event subsystem {#plug-ins}
+### Plug-ins to the event subsystem { #plug-ins}
The event subsystem is extensible. There are a number of extension points:
@@ -216,7 +216,7 @@ The event subsystem is extensible. There
The names in bold above are used as filenames for the service provider files that are placed in the `META-INF/services` directory. That way, they are automatically detected. This is a mechanism defined by the [JAR file specification](http://java.sun.com/j2se/1.4.2/docs/guide/jar/jar.html#Service%20Provider).
-### Localization (L10n) {#l10n}
+### Localization (L10n) { #l10n}
One goal of the event subsystem was to have localized (translated) event messages. The `EventFormatter` class can be used to convert an event to a human-readable message. Each `EventProducer` 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 `EventFormatter` class).
@@ -226,7 +226,7 @@ The XML format used by the `EventFormatt
<?xml version="1.0" encoding="UTF-8"?>
<catalogue xml:lang="en">
<message key="locator">
- [ (See position {loc})| (See {#gatherContextInfo})| (No context info available)]
+ [ (See position {loc})| (See { #gatherContextInfo})| (No context info available)]
</message>
<message key="org.apache.fop.render.rtf.RTFEventProducer.explicitTableColumnsRequired">
RTF output requires that all table-columns for a table are defined. Output will be incorrect.{{locator}}
@@ -248,4 +248,4 @@ Additional such modifiers can be added b
Square braces can be used to specify optional template sections. The whole section will be omitted if any of the variables used within are unavailable. Pipe (|) characters can be used to specify alternative sub-templates (see "locator" above for an example).
-Developers can also register a function (in the above example: `{#gatherContextInfo})` to do more complex information rendering. These functions are implementations of the `AdvancedMessageFormat$Function` interface. Please take care that this is done in a locale-independent way as there is no locale information available, yet.
+Developers can also register a function (in the above example: `{ #gatherContextInfo})` to do more complex information rendering. These functions are implementations of the `AdvancedMessageFormat$Function` interface. Please take care that this is done in a locale-independent way as there is no locale information available, yet.
Modified: xmlgraphics/site/trunk/content/fop/1.1/extensions.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/1.1/extensions.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/1.1/extensions.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/1.1/extensions.mdtext Thu Jul 24 16:21:20 2014
@@ -9,13 +9,13 @@ The extensions documented here are inclu
<note>All extensions require the correct use of an appropriate namespace in your input document.</note>
-## 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:
@@ -23,11 +23,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 old 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 [bookmark feature defined in the W3C XSL 1.1 standard](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.
@@ -38,15 +38,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}
<note>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.</note>
@@ -56,7 +56,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.
@@ -109,7 +109,7 @@ Datatype "page-set": Value: auto | <inte
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.
@@ -117,17 +117,17 @@ Examples: `fox:transform="rotate(45)"` w
<note>This extension attribute doesn't work for all output formats! It's currently only supported for PDF, PS and Java2D-based renderers.</note>
-### 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)`
This function will construct a color in device-specific CMYK color space. The numbers must be between 0.0 and 1.0. For output formats that don't support device-specific color space the CMYK value is converted to an sRGB value.
-#### #CMYK pseudo-profile {#pseudo-color-profiles}
+#### #CMYK pseudo-profile { #pseudo-color-profiles}
`color rgb-icc(numeric, numeric, numeric, #CMYK, numeric, numeric, numeric, numeric)`
@@ -138,13 +138,13 @@ The `rgb-icc` function will respond to a
- `rgb-icc(153, 153, 102, #CMYK, 0, 0, 0.2, 0.4)`
-### Prepress Support {#prepress}
+### Prepress Support { #prepress}
This section defines a number of extensions related to [prepress](http://en.wikipedia.org/wiki/Prepress) support. `fox:scale` defines a general scale factor for the generated pages. `fox:bleed` defines the [bleed area](http://en.wikipedia.org/wiki/Bleed_%28printing%29) for a page. `fox:crop-offset` 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.
<note>Those extensions have been implemented in the PDF and Java2D renderers only.</note>
-#### fox:scale {#scale}
+#### fox:scale { #scale}
Value: <number>{1,2}
@@ -154,7 +154,7 @@ Applies to: fo:simple-page-master
This property specifies a scale factor along resp. the x and y axes. If only one number is provided it is used for both the x and y scales. A scale factor smaller than 1 shrinks the page. A scale factor greater than 1 enlarges the page.
-#### fox:bleed {#bleed}
+#### fox:bleed { #bleed}
Value: <length>{1,4}
@@ -166,7 +166,7 @@ If there is only one value, it applies t
This extension indirectly defines the BleedBox and is calculated by expanding the TrimBox by the bleed widths. The lengths must be non-negative.
-#### fox:crop-offset {#cropOffset}
+#### fox:crop-offset { #cropOffset}
Value: <length>{1,4}
@@ -178,7 +178,7 @@ Same behaviour as with fox:bleed. The in
This extension indirectly defines the MediaBox and is calculated by expanding the TrimBox by the crop offsets. The lengths must be non-negative.
-#### fox:crop-box {#cropBox}
+#### fox:crop-box { #cropBox}
Value: [trim-box | bleed-box | media-box]
Modified: xmlgraphics/site/trunk/content/fop/1.1/fonts.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/1.1/fonts.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/1.1/fonts.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/1.1/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 Apache™ FOP renderers:
@@ -19,7 +19,7 @@ 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.
@@ -35,21 +35,21 @@ The following font family names are hard
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).
-## Missing Glyphs {#missing-glyphs}
+## Missing Glyphs { #missing-glyphs}
Every font contains a particular set of [glyphs](http://en.wikipedia.org/wiki/Glyph). 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.
-## 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).
@@ -62,7 +62,7 @@ Basic information about fonts can be fou
- [Adobe Font Technote](http://partners.adobe.com/asn/developer/technotes/fonts.html)
-## Bulk Font Configuration {#bulk}
+## Bulk Font Configuration { #bulk}
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). For convenience, FOP allows bulk registering of fonts; 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.
@@ -84,7 +84,7 @@ If you want FOP to use custom fonts, you
<note>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.</note>
-### Register Fonts with FOP {#register}
+### Register Fonts with FOP { #register}
You must tell FOP how to find and use the font 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:
@@ -132,7 +132,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.
-### TrueType Collections {#truetype-collections-metrics}
+### TrueType Collections { #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.
@@ -151,7 +151,7 @@ Alternatively, the individual sub-fonts
<font-triplet name="GulimChe" style="normal" weight="normal"/>
</font>
-### 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.
@@ -164,13 +164,13 @@ FOP will also auto-detect fonts which ar
This feature allows you to create JAR files containing fonts. The JAR files can be added to fop by providing them in the classpath, e.g. copying them into the lib/ directory.
-#### The font cache {#font-cache}
+#### The font cache { #font-cache}
Apache FOP maintains a cache file that is used to speed up auto-detection. This file is usually found in the ".fop" directory under the user's home directory. It's called "fop-fonts.cache". When the user's home directory is not writable, the font cache file is put in the directory for temporary files.
If there was a problem loading a particular font, it is flagged in the cache file so it is not loaded anymore. So, if a font is actually around but is still not found by Apache FOP, it's worth a try to delete the font cache file which forces Apache FOP to reparse all fonts.
-### Type 1 Font Metrics {#type1-metrics}
+### Type 1 Font Metrics { #type1-metrics}
Note that metrics files are optional and no longer required
@@ -194,7 +194,7 @@ PFMReader [options]:
<note>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.</note>
-### TrueType Font Metrics {#truetype-metrics}
+### TrueType Font Metrics { #truetype-metrics}
Note that metrics files are optional and no longer required
@@ -221,7 +221,7 @@ TTFReader [options]:
<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>
-### Embedding {#embedding}
+### Embedding { #embedding}
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.
@@ -258,7 +258,7 @@ Various notes related to embedded fonts:
- 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.
-### Substitution {#substitution}
+### Substitution { #substitution}
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.
@@ -284,7 +284,7 @@ For example you could make all FO font-f
</fonts>
</fop>
-## Font Selection Strategies {#selection}
+## Font Selection Strategies { #selection}
There are two font selection strategies: character-by-character or auto. The default is auto.
@@ -300,6 +300,6 @@ Auto selected the first font from the li
Character-by-Character is NOT yet supported!
-## Font List Command-Line Tool {#font-list}
+## Font List Command-Line Tool { #font-list}
FOP contains a small command-line tool that lets you generate a list of all configured fonts. Its class name is: `org.apache.fop.tools.fontlist.FontListMain`. Run it with the "-?" parameter to get help for the various options.
Modified: xmlgraphics/site/trunk/content/fop/1.1/graphics.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/1.1/graphics.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/1.1/graphics.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/1.1/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}
Some noteworthy features of the image handling subsystem are:
@@ -16,7 +16,7 @@ Some noteworthy features of the image ha
The actual [image loading framework](http://xmlgraphics.apache.org/commons/image-loader.html) does not reside in Apache FOP, but 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.
@@ -40,7 +40,7 @@ Legend:
<note>[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.</note>
-### 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:
@@ -63,17 +63,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.
@@ -90,47 +90,47 @@ 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`.
<note>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.</note>
-#### 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.
@@ -138,7 +138,7 @@ There are a number of SVG things that ca
Currently transparency is limited in PDF so some 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.pdf](../dev/svg/text.pdf) / [text.png](../dev/svg/text.png) shows how various types and effects with text are handled. Note that SVG font support is not yet implemented. Furthermore, text handling in PostScript output is inferior to PDF output - more text will be painted as shapes in PS than in PDF.
@@ -146,19 +146,19 @@ When there's no support to paint text us
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.
-#### Font selection notes {#svg-font-selection}
+#### Font selection notes { #svg-font-selection}
Apache Batik uses the AWT/Java2D subsystem as font source while FOP has its own font subsystem. Great care has been taken that font selection does the best possible choices. But it must be noted when creating PDF or PostScript that a font used in SVG graphics needs to be registered with the operating system as well as in FOP's configuration. By using FOP's font auto-detection, you simply have to install the font in the operating system and not care about anything else. This is less of an issue if you create formats like TIFFs, PNGs or PCL because in these cases SVG graphics are usually rendered to bitmaps which means that on both sides (Batik and FOP), AWT/Java2D is used as the single font source.
Whenever an SVG is converted into a PDF or PostScript file, the font that has been used inside Batik has to be mapped to a font used by the actual output format. Features like font substitution in FOP may need to be taken into account but can also be an advantage when working around font mapping issues. Like for XSL-FO content, you'll get a warning if a particular font could not be found and had to be substituted, or if a particular glyph is missing in a font.
-#### 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.
@@ -169,17 +169,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).
@@ -187,11 +187,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/1.1/hyphenation.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/1.1/hyphenation.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/1.1/hyphenation.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/1.1/hyphenation.mdtext Thu Jul 24 16:21:20 2014
@@ -3,9 +3,9 @@ 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.
@@ -13,7 +13,7 @@ Because of [licensing issues](#license-i
<note>If you have made improvements to an existing Apache™ 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).</note>
-### 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.
@@ -21,11 +21,11 @@ Although Apache FOP cannot redistribute
<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:
@@ -55,7 +55,7 @@ and run Ant with build target `jar-hyphe
<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>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: commits-help@xmlgraphics.apache.org