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 [5/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/pdfa.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/0.95/pdfa.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/0.95/pdfa.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/0.95/pdfa.mdtext Thu Jul 24 16:21:20 2014
@@ -3,13 +3,13 @@ Title: Apache(tm) FOP: PDF/A (ISO 19005)
#Apache™ FOP: PDF/A (ISO 19005)
<authors><person email="jeremias@apache.org" name="Jeremias Märki"></person></authors>
-## Overview {#overview}
+## Overview { #overview}
PDF/A is a standard which turns PDF into an "electronic document file format for long-term preservation". PDF/A-1 is the first part of the standard and is documented in [ISO 19005-1:2005(E)](http://www.iso.org/iso/en/CatalogueDetailPage.CatalogueDetail?CSNUMBER=38920&ICS1=37&ICS2=100&ICS3=99). Work on PDF/A-2 is in progress at [AIIM](http://www.aiim.org/standards.asp?ID=25013).
Design documentation on PDF/A can be found on FOP's Wiki on the [PDFAConformanceNotes](http://wiki.apache.org/xmlgraphics-fop/PDFAConformanceNotes) page.
-## Implementation Status {#status}
+## Implementation Status { #status}
**PDF/A-1b** is implemented to the degree that FOP supports the creation of the elements described in ISO 19005-1.
@@ -17,11 +17,11 @@ Tests have been performed against jHove
**PDF/A-1a** is not implemented, yet. This is mostly because of the requirement for tagged PDF which is not available in FOP, yet.
-## Usage (command line) {#command-line}
+## Usage (command line) { #command-line}
To activate PDF/A-1b from the command-line, specify "-pdfprofile PDF/A-1b" as a parameter. If there is a violation of one of the validation rules for PDF/A, an error message is presented and the processing stops.
-## Usage (embedded) {#embedded}
+## Usage (embedded) { #embedded}
When FOP is embedded in another Java application you can set a special option on the renderer options in the user agent to activate the PDF/A-1b profile. Here's an example:
@@ -30,7 +30,7 @@ Fop fop = fopFactory.newFop(MimeConstant
[..]
If one of the validation rules of PDF/A is violated, an PDFConformanceException (descendant of RuntimeException) is thrown.
-## PDF/A in Action {#rules}
+## PDF/A in Action { #rules}
There are a number of things that must be looked after if you activate a PDF/A profile. If you receive a PDFConformanceException, have a look at the following list (not necessarily comprehensive):
@@ -49,11 +49,11 @@ There are a number of things that must b
- No filter must be specified explicitely for metadata objects. Metadata must be embedded in clear text so non-PDF-aware applications can extract the XMP metadata.
-## PDF profile compatibility {#profile-compatibility}
+## PDF profile compatibility { #profile-compatibility}
The PDF profiles "PDF/X-3:2003" and "PDF/A-1b" are compatible and can both be activated at the same time.
-## Interoperability {#interoperability}
+## Interoperability { #interoperability}
There has been some confusion about the namespace for the PDF/A indicator in the XMP metadata. At least three variants have been seen in the wild:
Modified: xmlgraphics/site/trunk/content/fop/0.95/pdfencryption.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/0.95/pdfencryption.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/0.95/pdfencryption.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/0.95/pdfencryption.mdtext Thu Jul 24 16:21:20 2014
@@ -3,13 +3,13 @@ Title: Apache(tm) FOP: PDF encryption.
#Apache™ FOP: PDF encryption.
<authors><person email="pietsch@apache.org" name="J.Pietschmann"></person><person email="jeremias@apache.org" name="Jeremias Märki"></person></authors>
-## Overview {#Overview}
+## Overview { #Overview}
Apache™ FOP supports encryption of PDF output, thanks to Patrick C. Lankswert. This feature is commonly used to prevent unauthorized viewing, printing, editing, copying text from the document and doing annotations. It is also possible to ask the user for a password in order to view the contents. Note that there already exist third party applications which can decrypt an encrypted PDF without effort and allow the aforementioned operations, therefore the degree of protection is limited.
For further information about features and restrictions regarding PDF encryption, look at the documentation coming with Adobe Acrobat or the technical documentation on the Adobe web site.
-## Usage (command line) {#Usage-%28command-line%29}
+## Usage (command line) { #Usage-%28command-line%29}
Encryption is enabled by supplying any of the encryption related options.
@@ -21,7 +21,7 @@ A user password, supplied with the `-u`
Further restrictions can be imposed by using the `-noprint`, `-nocopy`, `-noedit` and `-noannotations` options, which disable printing, copying text, editing in Adobe Acrobat and making annotations, respectively.
-## Usage (embedded) {#Usage-%28embedded%29}
+## Usage (embedded) { #Usage-%28embedded%29}
When FOP is embedded in another Java application you need to set an options map on the renderer. These are the supported options:
@@ -77,7 +77,7 @@ Alternatively, you can set each value se
1. noannotations: Boolean or "true"/"false"
-## Environment {#Environment}
+## Environment { #Environment}
In order to use PDF encryption, FOP has to be compiled with cryptography support. Currently, only [JCE](http://java.sun.com/j2se/1.4/docs/guide/security/jce/JCERefGuide.html) is supported. JCE is part of JDK 1.4. For earlier JDKs, it can be installed separately. The build process automatically detects JCE presence and installs PDF encryption support if possible, otherwise a stub is compiled in.
@@ -87,7 +87,7 @@ then you don't have the needed infrastru
There are several commercial and a few Open Source packages which provide RC4. A pure Java implementation is produced by [The Legion of the Bouncy Castle](http://www.bouncycastle.org/). [Mozilla JSS](http://www.mozilla.org/projects/security/pki/jss/) is an interface to a native implementation.
-## Installing a crypto provider {#install_crypto}
+## Installing a crypto provider { #install_crypto}
The pure Java implementation from [Bouncy Castle](http://www.bouncycastle.org/) is easy to install.
Modified: xmlgraphics/site/trunk/content/fop/0.95/pdfx.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/0.95/pdfx.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/0.95/pdfx.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/0.95/pdfx.mdtext Thu Jul 24 16:21:20 2014
@@ -3,11 +3,11 @@ Title: Apache(tm) FOP: PDF/X (ISO 15930)
#Apache™ FOP: PDF/X (ISO 15930)
<authors><person email="jeremias@apache.org" name="Jeremias Märki"></person></authors>
-## Overview {#overview}
+## Overview { #overview}
<warning>Support for PDF/X is available beginning with version 0.93. This feature is new and may not be 100% complete, yet. Feedback is welcome.</warning>
PDF/X is a standard which faciliates prepress digital data exchange using PDF. Currently, only PDF/X-3:2003 is implemented out of the many different flavours of PDF/X profiles. PDF/X-3:2003 is documented in [ISO 15930-6:2003(E)](http://www.iso.org/iso/en/CatalogueDetailPage.CatalogueDetail?CSNUMBER=39940&ICS1=37&ICS2=100&ICS3=99). More info on PDF/X can be found on the [PDF/X info site](http://www.pdfx.info/).
-## Implementation Status {#status}
+## Implementation Status { #status}
**PDF/X-3:2003** is implemented to the degree that FOP supports the creation of the elements described in ISO 15930-6.
@@ -15,11 +15,11 @@ An important restriction of the current
Tests have been performed against Adobe Acrobat 7.0.7 (Preflight function). Note that there are bugs in Adobe Acrobat which cause false alarms if both PDF/A-1b and PDF/X-3:2003 are activated at the same time.
-## Usage (command line) {#command-line}
+## Usage (command line) { #command-line}
To activate PDF/X-3:2003 from the command-line, specify "-pdfprofile PDF/X-3:2003" as a parameter. If there is a violation of one of the validation rules for PDF/X, an error message is presented and the processing stops.
-## Usage (embedded) {#embedded}
+## Usage (embedded) { #embedded}
When FOP is embedded in another Java application you can set a special option on the renderer options in the user agent to activate the PDF/A-1b profile. Here's an example:
@@ -29,7 +29,7 @@ Fop fop = fopFactory.newFop(MimeConstant
[..]
If one of the validation rules of PDF/X is violated, an PDFConformanceException (descendant of RuntimeException) is thrown.
-## PDF/X in Action {#rules}
+## PDF/X in Action { #rules}
There are a number of things that must be looked after if you activate a PDF/X profile. If you receive a PDFConformanceException, have a look at the following list (not necessarily comprehensive):
@@ -46,6 +46,6 @@ There are a number of things that must b
- PDF is forced to version 1.4 if PDF/X-3:2003 is activated.
-## PDF profile compatibility {#profile-compatibility}
+## PDF profile compatibility { #profile-compatibility}
The PDF profiles "PDF/X-3:2003" and "PDF/A-1b" are compatible and can both be activated at the same time.
Modified: xmlgraphics/site/trunk/content/fop/0.95/releaseNotes_0.95.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/0.95/releaseNotes_0.95.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/0.95/releaseNotes_0.95.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/0.95/releaseNotes_0.95.mdtext Thu Jul 24 16:21:20 2014
@@ -26,19 +26,19 @@ The image libraries Jimi and JAI are no
This final 0.95 release also includes all of the [changes made for Apache FOP 0.95beta](changes_0.95beta.html).</section></notes>
-# Major Changes in Version 0.95 {#version_0.95}
+# Major Changes in Version 0.95 { #version_0.95}
This is not a complete list of changes, just some of the more important ones. A full list of changes in this release [is available](changes_0.95.html).
-## Changes to the Code Base {#Changes-to-the-Code-Base}
+## Changes to the Code Base { #Changes-to-the-Code-Base}
-  Fixed potential multi-threading problem concerning the use of DecimalFormat. Committed by JM. See issue [XGC-13](https://issues.apache.org/jira/browse/XGC-13).
-### Changes to the Layout Engine {#Changes-to-the-Layout-Engine}
+### Changes to the Layout Engine { #Changes-to-the-Layout-Engine}
-  Various bugfixes for table layout. Committed by VH. See issue [FOP-1509](https://issues.apache.org/jira/browse/FOP-1509).
-### Changes to Renderers (Output Formats) {#Changes-to-Renderers-%28Output-Formats%29}
+### Changes to Renderers (Output Formats) { #Changes-to-Renderers-%28Output-Formats%29}
-  Fixed positioning of absolutely positioned block-containers in multi-column documents. Committed by JM.
Modified: xmlgraphics/site/trunk/content/fop/0.95/running.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/0.95/running.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/0.95/running.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/0.95/running.mdtext Thu Jul 24 16:21:20 2014
@@ -3,7 +3,7 @@ Title: Running Apache™ FOP
#Running Apache™ FOP
-## System Requirements {#require}
+## System Requirements { #require}
The following software must be installed:
@@ -38,19 +38,19 @@ In addition, the following system requir
- If you will be using FOP to process SVG, you must do so in a graphical environment. See [FOP: Graphics (Batik)](graphics.html#batik) for details.
-## Installation {#install}
+## Installation { #install}
-### Instructions {#install-instruct}
+### Instructions { #install-instruct}
Basic FOP installation consists of first unzipping the `.gz` file that is the distribution medium, then unarchiving the resulting `.tar` file in a directory/folder that is convenient on your system. Please consult your operating system documentation or Zip application software documentation for instructions specific to your site.
-### Problems {#install-problems}
+### Problems { #install-problems}
Some Mac OSX users have experienced filename truncation problems using Stuffit to unzip and unarchive their distribution media. This is a legacy of older Mac operating systems, which had a 31-character pathname limit. Several Mac OSX users have recommended that Mac OSX users use the shell command `tar -xzf` instead.
-## Starting FOP as a Standalone Application {#standalone-start}
+## Starting FOP as a Standalone Application { #standalone-start}
-### Using the fop script or batch file {#fop-script}
+### Using the fop script or batch file { #fop-script}
The usual and recommended practice for starting FOP from the command line is to run the batch file fop.bat (Windows) or the shell script fop (Unix/Linux). These scripts require that the environment variable JAVA_HOME be set to a path pointing to the appropriate Java installation on your system. Macintosh OSX includes a Java environment as part of its distribution. We are told by Mac OSX users that the path to use in this case is `/Library/Java/Home`. **Caveat:** We suspect that, as Apple releases new Java environments and as FOP upgrades the minimum Java requirements, the two will inevitably not match on some systems. Please see [Java on Mac OSX FAQ](http://developer.apple.com/java/faq) for information as it becomes available.
@@ -129,12 +129,12 @@ The usual and recommended practice for s
PDF encryption is only available if FOP was compiled with encryption support **and** if compatible encryption support is available at run time. Currently, only the JCE is supported. Check the [Details](pdfencryption.html).
-### Writing your own script {#your-own-script}
+### Writing your own script { #your-own-script}
FOP's entry point for your own scripts is the class `org.apache.fop.cli.Main`. The general pattern for the command line is: `java -classpath <CLASSPATH>
org.apache.fop.cli.Main <arguments>`. The arguments consist of the options and infile and outfile specifications as shown above for the standard scripts. You may wish to review the standard scripts to make sure that you get your environment properly configured.
-### Running with java's -jar option {#jar-option}
+### Running with java's -jar option { #jar-option}
As an alternative to the start scripts you can run `java
-jar path/to/build/fop.jar <arguments>`, relying on FOP to build the classpath for running FOP dynamically, see [below](#dynamical-classpath). If you use hyphenation, you must put `fop-hyph.jar` in the `lib` directory.
@@ -144,7 +144,7 @@ You can also run `java -jar path/to/fop.
In both cases the arguments consist of the options and infile and outfile specifications as shown above for the standard scripts.
-### FOP's dynamical classpath construction {#dynamical-classpath}
+### FOP's dynamical classpath construction { #dynamical-classpath}
If FOP is started without a proper classpath, it tries to add its dependencies dynamically. If the system property `fop.home` contains the name of a directory, then FOP uses that directory as the base directory for its search. Otherwise the current working directory is the base directory. If the base directory is called `build`, then its parent directory becomes the base directory.
@@ -152,7 +152,7 @@ FOP expects to find `fop.jar` in the `bu
If the system property `fop.optional.lib` contains the name of a directory, then all `jar` files in that directory are also added to the classpath. See the methods `getJARList` and `checkDependencies` in `org.apache.fop.cli.Main`.
-## Using Xalan to Check XSL-FO Input {#check-input}
+## Using Xalan to Check XSL-FO Input { #check-input}
FOP sessions that use -xml and -xsl input instead of -fo input are actually controlling two distinct conversions: Tranforming XML to XSL-FO, then formatting the XSL-FO to PDF (or another FOP output format). Although FOP controls both of these processes, the first is included merely as a convenience and for performance reasons. Only the second is part of FOP's core processing. If a user has a problem running FOP, it is important to determine which of these two processes is causing the problem. If the problem is in the first process, the user's stylesheet is likely the cause. The FOP development team does not have resources to help with stylesheet issues, although we have included links to some useful [Specifications](../resources.html#specs) and [Books/Articles](../resources.html#articles). If the problem is in the second process, FOP may have a bug or an unimplemented feature that does require attention from the FOP development team.
The user is always responsible to provide correct XSL-FO code to FOP.
@@ -164,7 +164,7 @@ The -foout option works the same way as
Note that there are some subtle differences between the FOP and Xalan command-lines.
-## Memory Usage {#memory}
+## Memory Usage { #memory}
FOP can consume quite a bit of memory, even though this has been continually improved. This is partly inherent to the formatting process and partly caused by implementation choices. All FO processors currently on the market have memory problems with certain layouts.
@@ -179,6 +179,6 @@ If you are running out of memory when us
- Use multiple page sequences. FOP starts rendering after the end of a page sequence is encountered. While the actual rendering is done page-by-page, some additional memory is freed after the page sequence has been rendered. This can be substantial if the page sequence contains lots of FO elements.
-## Problems {#problems}
+## Problems { #problems}
If you have problems running FOP, please see the ["How to get Help" page](../gethelp.html).
Modified: xmlgraphics/site/trunk/content/fop/0.95/servlets.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/0.95/servlets.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/0.95/servlets.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/0.95/servlets.mdtext Thu Jul 24 16:21:20 2014
@@ -3,11 +3,11 @@ Title: Apache(tm) FOP: Servlets
#Apache™ FOP: Servlets
<subtitle>How to use Apache™ FOP in a Servlet</subtitle>
-## Overview {#overview}
+## Overview { #overview}
This page discusses topic all around using Apache™ FOP in a servlet environment.
-## Example Servlets in the FOP distribution {#example-servlets}
+## Example Servlets in the FOP distribution { #example-servlets}
In the directory {fop-dir}/src/java/org/apache/fop/servlet, you'll find a working example of a FOP-enabled servlet.
@@ -22,9 +22,9 @@ The servlet is automatically built when
The source code for the servlet can be found under {fop-dir}/src/java/org/apache/fop/servlet/FopServlet.java.
This example servlet should not be used on a public web server connected to the Internet as it does not contain any measures to prevent Denial-of-Service-Attacks. It is provided as an example and as a starting point for your own servlet.
-## Create your own Servlet {#servlet}
+## Create your own Servlet { #servlet}
This section assumes you are familiar with [embedding FOP](embedding.html).
-### A minimal Servlet {#minimal-servlet}
+### A minimal Servlet { #minimal-servlet}
Here is a minimal code snippet to demonstrate the basics:
@@ -48,7 +48,7 @@ Here is a minimal code snippet to demons
There are numerous problems with the code snippet above. Its purpose is only to demonstrate the basic concepts. See below for details.
-### Adding XSL tranformation (XSLT) {#xslt}
+### Adding XSL tranformation (XSLT) { #xslt}
A common requirement is to transform an XML source to XSL-FO using an XSL transformation. It is recommended to use JAXP for this task. The following snippet shows the basic code:
@@ -95,11 +95,11 @@ The `Source` instance used above is simp
Because you have an explicit `Transformer` object, you can also use it to explicitely set parameters for the transformation run.
-### Custom configuration {#cfg}
+### Custom configuration { #cfg}
You can easily set up your own FOUserAgent as demonstrated on the [Embedding page](embedding.html).
-### Improving performance {#performance}
+### Improving performance { #performance}
There are several options to consider:
@@ -110,7 +110,7 @@ There are several options to consider:
Of course, the [performance hints from the Embedding page](embedding.html#performance) apply here, too.
-### Accessing resources in your web application {#uriresolver}
+### Accessing resources in your web application { #uriresolver}
Often, you will want to use resources (stylesheets, images etc.) which are bundled with your web application. FOP provides a URIResolver implementation that lets you access files via the Servlet's ServletContext. The class is called `org.apache.fop.servlet.ServletContextURIResolver`.
@@ -157,7 +157,7 @@ Here are some example snippets:
Transformer transformer = this.transFactory.newTransformer(xsltSrc);
transformer.setURIResolver(this.uriResolver);
-## Notes on Microsoft Internet Explorer {#ie}
+## Notes on Microsoft Internet Explorer { #ie}
Some versions of Internet Explorer will not automatically show the PDF or call the servlet multiple times. These are well-known limitations of Internet Explorer and are not a problem of the servlet. However, Internet Explorer can still be used to download the PDF so that it can be viewed later. Here are some suggestions in this context:
@@ -172,18 +172,18 @@ Consult your server manual and the relev
- Cache in the server. It may help to include a parameter in the URL which has a timestamp as the value min order to decide whether a request is repeated. IEx is reported to retrieve a document up to three times, but never more often.
-## Servlet Engines {#servlet-engine}
+## Servlet Engines { #servlet-engine}
When using a servlet engine, there are potential CLASSPATH issues, and potential conflicts with existing XML/XSLT libraries. Servlet containers also often use their own classloaders for loading webapps, which can cause bugs and security problems.
-### Tomcat {#tomcat}
+### Tomcat { #tomcat}
Check Tomcat's documentation for detailed instructions about installing FOP and Cocoon. There are known bugs that must be addressed, particularly for Tomcat 4.0.3.
-### WebSphere 3.5 {#websphere}
+### WebSphere 3.5 { #websphere}
Put a copy of a working parser in some directory where WebSphere can access it. For example, if /usr/webapps/yourapp/servlets is the CLASSPATH for your servlets, copy the Xerces jar into it (any other directory would also be fine). Do not add the jar to the servlet CLASSPATH, but add it to the CLASSPATH of the application server which contains your web application. In the WebSphere administration console, click on the "environment" button in the "general" tab. In the "variable name" box, enter "CLASSPATH". In the "value" box, enter the correct path to the parser jar file (/usr/webapps/yourapp/servlets/Xerces.jar in our example here). Press "OK", then apply the change and restart the application server.
-## Handling complex use cases {#complex-usecases}
+## Handling complex use cases { #complex-usecases}
Sometimes the requirements for a servlet get quite sophisticated: SQL data sources, multiple XSL transformations, merging of several datasources etc. In such a case consider using [Apache Cocoon](http://cocoon.apache.org/) instead of a custom servlet to accomplish your goal.
Modified: xmlgraphics/site/trunk/content/fop/0.95/upgrading.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/0.95/upgrading.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/0.95/upgrading.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/0.95/upgrading.mdtext Thu Jul 24 16:21:20 2014
@@ -3,7 +3,7 @@ Title: Upgrading from an Earlier Version
#Upgrading from an Earlier Version of Apache™ FOP
-## Important! {#important}
+## Important! { #important}
If you're planning to upgrade to the latest Apache™ FOP version there are a few very important things to consider:
@@ -26,7 +26,7 @@ While FOP 0.20.5 allowed you to have emp
- The SVG Renderer and the MIF Handler have not been resurrected, yet! They are currently non-functional and hope for someone to step up and reimplement them.
-## What you need to know when you upgrade! {#issues}
+## What you need to know when you upgrade! { #issues}
When you use your existing FO files or XML/XSL files which work fine with FOP version 0.20.5 against this FOP version some things may not work as expected. The following list will hopefully help you to identify and correct those problems. This does not mean that the new FOP is at fault. Quite the opposite actually! See below:
Modified: xmlgraphics/site/trunk/content/fop/1.0/accessibility.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/1.0/accessibility.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/1.0/accessibility.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/1.0/accessibility.mdtext Thu Jul 24 16:21:20 2014
@@ -2,13 +2,13 @@ Title: Apache(tm) FOP: Accessibility
#Apache™ FOP: Accessibility
-## Overview {#overview}
+## Overview { #overview}
This page describes the [accessibility](http://en.wikipedia.org/wiki/Accessibility) features of Apache™ FOP. [Section 508](http://www.section508.gov/) defines accessibility in the context of electronic documents for the USA but other countries have similar requirements.
Accessibility features are available only for the PDF output format and there are some implementation limitations. Also, certain actions must be undertaken by the content creator to ensure that FOP can create a truly accessible document.
-## Enabling accessibility {#Enabling-accessibility}
+## Enabling accessibility { #Enabling-accessibility}
There are 3 ways to enable accessibility:
@@ -34,7 +34,7 @@ When accessibility is enabled, additiona
<note>The processing of the logical structure is memory-hungry. You may need to adjust the Java heap size in order to process larger files.</note>
-## Changes to your XSL-FO input files {#source}
+## Changes to your XSL-FO input files { #source}
Apache FOP cannot automatically generate accessible PDFs. Some of the work can only be performed by the content provider. Following are some changes that may be necessary to your XSL-FO content in order to generate really accessible documents:
@@ -47,7 +47,7 @@ Apache FOP cannot automatically generate
- Specify the natural language of the document using the language and country properties (or via the `xml:lang` shorthand property).
-## Customized Tagging {#customTags}
+## Customized Tagging { #customTags}
The [PDF Reference](#PDFReference) defines a set of standard Structure Types to tag content. For example, âPâ is used for identifying paragraphs, âH1â to âH6â for headers, âLâ for lists, âDivâ for block-level groups of elements, etc. This standard set is aimed at improving interoperability between applications producing or consuming PDF.
@@ -62,11 +62,11 @@ You may want to customize that mapping t
If a non-standard structure type is specified, FOP will issue a warning and fall back to the default tag associated to the Formatting Object.
-## Testing {#testing}
+## Testing { #testing}
Accessible PDFs can be tested, for example, using Adobe Acrobat Professional. Its Accessibility Check feature creates a report indicating any deficiencies with a PDF document. Alternatively, you can just let a screen reader read the document aloud.
-## Limitations {#limitations}
+## Limitations { #limitations}
Accessibility support in Apache FOP is relatively new, so there are certain limitations. Please help us identify and close any gaps.
@@ -79,7 +79,7 @@ Accessibility support in Apache FOP is r
- The side regions (region-before, region-after etc.) are currently not specially identified. Screen readers may read their content at page changes.
-## Related Links {#links}
+## Related Links { #links}
Many resources providing guidance about creating accessible documents can be found on the web. Here are a few links, along with additional resources around the topic:
Modified: xmlgraphics/site/trunk/content/fop/1.0/anttask.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/1.0/anttask.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/1.0/anttask.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/1.0/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.0/changes_1.0.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/1.0/changes_1.0.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/1.0/changes_1.0.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/1.0/changes_1.0.mdtext Thu Jul 24 16:21:20 2014
@@ -5,18 +5,18 @@ Title: History of Changes 1.0
[changes_1.0.rss](changes_1.0.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.0 (21 July 2010) {#version_1.0}
+## Version 1.0 (21 July 2010) { #version_1.0}
-### Changes to the End-User API {#API_1.0}
+### Changes to the End-User API { #API_1.0}
-  Added a command-line option '-catalog' to use a catalog resolver for the XML and XSLT files Committed by SP.
-### Changes to the Code Base {#Code_1.0}
+### Changes to the Code Base { #Code_1.0}
-  Added support for xmlfile and xsltfile parameters in FOP's Ant Task. Committed by AC.
@@ -63,12 +63,12 @@ Changes are sorted by "type" and then ch
-  Changed FONode.addCharacters() parameter to closer match the signature of the standard SAX characters() event (reduces confusion and computations). *!! Implementors of extensions that subclass FONode directly, and offer an implementation for addCharacters() should take care to make similar modifications in their code !!* Committed by AD.
-### Changes to the Bundled Extensions {#Extensions_1.0}
+### Changes to the Bundled Extensions { #Extensions_1.0}
-  Added support for the #CMYK pseudo-profile supported by some commercial XSL implementations on the rgb-icc() function. Committed by JM.
-### Changes to the Font Subsystem {#Fonts_1.0}
+### Changes to the Font Subsystem { #Fonts_1.0}
-  Added support for TrueType fonts with symbol character maps (like "Wingdings" and "Symbol"). Character for these fonts are usually found in the 0xF020 to 0xF0FF range (a Unicode private use area). Committed by JM.
@@ -105,7 +105,7 @@ Changes are sorted by "type" and then ch
-  Fix for PFMReader after bug #43089 changed the behavior of PFMFile. Fixes baseline problems when Type 1 fonts are used in conjunction with XML font metric files. Committed by JM. Thanks to J. Frantzius. See issue [FOP-1570](https://issues.apache.org/jira/browse/FOP-1570).
-### Changes to the Image Support {#Images_1.0}
+### Changes to the Image Support { #Images_1.0}
-  Added customization ability for the image loading framework from FOP's configuration file. Committed by JM.
@@ -114,7 +114,7 @@ Changes are sorted by "type" and then ch
-  Bugfix: use the effective color profile supplied by the ImageEncodingHelper, instead of the original one. Committed by JM.
-### Changes to the Layout Engine {#Layout_1.0}
+### Changes to the Layout Engine { #Layout_1.0}
-  Implement internal character classes if the hyphenation pattern file does not contain them Committed by SP.
@@ -179,7 +179,7 @@ Changes are sorted by "type" and then ch
-  Activated min-height/max-height and min-width/max-width properties. Committed by AD. See issue [FOP-1428](https://issues.apache.org/jira/browse/FOP-1428).
-### Changes to Renderers (Output Formats) {#Renderers_1.0}
+### Changes to Renderers (Output Formats) { #Renderers_1.0}
-  AFP Output: Added enhanced dithering functionality for images that are converted to bi-level images. Committed by JM.
@@ -316,7 +316,7 @@ Changes are sorted by "type" and then ch
-  When a JPEG image is embedded, an optionally embedded color profile is filtered out as it's already embedded separately in the PDF file. Committed by JM.
-### Contributors to this release {#contributors_1.0}
+### Contributors to this release { #contributors_1.0}
We thank the following people for their contributions to this release.
Modified: xmlgraphics/site/trunk/content/fop/1.0/compiling.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/1.0/compiling.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/1.0/compiling.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/1.0/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.
@@ -65,7 +65,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.0/configuration.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/1.0/configuration.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/1.0/configuration.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/1.0/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 |
|---------|---------------------------|-------------|---------------|
@@ -67,7 +67,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:
@@ -89,7 +89,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.
@@ -119,7 +119,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.
@@ -172,7 +172,7 @@ FOP supports encryption of PDF output, t
</encryption-params>
</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:
@@ -192,7 +192,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.
@@ -208,7 +208,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}
@@ -229,7 +229,7 @@ The default value for the "renderer-reso
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.0/embedding.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/1.0/embedding.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/1.0/embedding.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/1.0/embedding.mdtext Thu Jul 24 16:21:20 2014
@@ -3,7 +3,7 @@ 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.
@@ -11,7 +11,7 @@ To embed Apache™ FOP in your appli
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...
@@ -76,7 +76,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.
@@ -91,11 +91,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:
@@ -107,7 +107,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).
@@ -148,11 +148,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.
@@ -195,7 +195,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:
@@ -267,7 +267,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:
@@ -287,13 +287,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.
@@ -301,11 +301,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:
@@ -326,29 +326,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.
@@ -356,7 +356,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.
@@ -368,20 +368,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/1.0/events.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/1.0/events.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/1.0/events.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/1.0/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.0/extensions.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/1.0/extensions.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/1.0/extensions.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/1.0/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 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.
@@ -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.0/fonts.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/1.0/fonts.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/1.0/fonts.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/1.0/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)
-## 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.
@@ -84,11 +84,11 @@ If you want FOP to use custom fonts, you
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:
@@ -110,7 +110,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}
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:
@@ -135,7 +135,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>
-### 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.
@@ -154,7 +154,7 @@ Alternatively, the individual sub-fonts
<font-triplet name="GulimChe" style="normal" weight="normal"/>
</font>
-### 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:
@@ -212,7 +212,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.
@@ -224,7 +224,7 @@ FOP will also auto-detect fonts which ar
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}
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.
@@ -261,7 +261,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.
@@ -287,7 +287,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.
@@ -303,6 +303,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.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: commits-help@xmlgraphics.apache.org