diff options
| author | Vincent Hennebert <vhennebert@apache.org> | 2007-08-23 18:30:05 +0000 |
|---|---|---|
| committer | Vincent Hennebert <vhennebert@apache.org> | 2007-08-23 18:30:05 +0000 |
| commit | 99cfed96f71c2deff9afdf30c71f93c2ca30d005 (patch) | |
| tree | 960682f0658c15dcddf2ec5f615c7c0f179ee7f1 /src/documentation/content/xdocs/0.94 | |
| parent | aa33ef3ebb6e48dae2da620f596d34d7548bf402 (diff) | |
| download | xmlgraphics-fop-99cfed96f71c2deff9afdf30c71f93c2ca30d005.tar.gz xmlgraphics-fop-99cfed96f71c2deff9afdf30c71f93c2ca30d005.zip | |
Merged revisions 556567-558280,558282-562946,562948-563926,563928-563950,563952-563955,563957-564855,564857-567293,567295-567296,567298-567302,567304-569099 via svnmerge from
https://svn.apache.org/repos/asf/xmlgraphics/fop/branches/fop-0_94
........
r560595 | vhennebert | 2007-07-28 21:26:51 +0200 (sam, 28 jui 2007) | 2 lines
Remove tab for the no longer supported 0.20.5 version
........
r560596 | vhennebert | 2007-07-28 21:28:30 +0200 (sam, 28 jui 2007) | 2 lines
Create a tab for the new 0.94 version
........
r560600 | vhennebert | 2007-07-28 21:45:13 +0200 (sam, 28 jui 2007) | 2 lines
Remove any reference to the old maintenance branch
........
r560886 | vhennebert | 2007-07-30 10:19:59 +0200 (lun, 30 jui 2007) | 2 lines
Update the documentation before releasing
........
r562023 | clay | 2007-08-02 08:08:49 +0200 (jeu, 02 aoû 2007) | 1 line
Changes to fop-0_94 branch to prepare it for 0.94 release.
........
r562024 | clay | 2007-08-02 08:09:33 +0200 (jeu, 02 aoû 2007) | 1 line
Changes to fop-0_94 branch to prepare it for 0.94 release.
........
r562027 | clay | 2007-08-02 08:27:01 +0200 (jeu, 02 aoû 2007) | 1 line
Changes to fop-0_94 branch to prepare it for 0.94 release.
........
r562332 | clay | 2007-08-03 07:09:50 +0200 (ven, 03 aoû 2007) | 1 line
Updated FOP Compliance page to include additional column for 0.94 (did not remove 0.20.5 or 0.93 column). Also 'Notes' column was *not* modified for 0.94-specific information.
........
r562333 | clay | 2007-08-03 07:10:47 +0200 (ven, 03 aoû 2007) | 1 line
Updated FOP Compliance page to include additional column for 0.94 (did not remove 0.20.5 or 0.93 column). Also 'Notes' column was *not* modified for 0.94-specific information.
........
r562880 | vhennebert | 2007-08-05 17:05:41 +0200 (dim, 05 aoû 2007) | 4 lines
- Update the website content
- Fix some typos
- Fix broken links
........
r562881 | vhennebert | 2007-08-05 17:06:59 +0200 (dim, 05 aoû 2007) | 5 lines
Changes in the trunk tab:
- update content
- fix typos
- fix broken links
........
r562887 | vhennebert | 2007-08-05 17:22:15 +0200 (dim, 05 aoû 2007) | 2 lines
Merge changes on the Trunk tab from revision 562881
........
r562891 | vhennebert | 2007-08-05 17:32:33 +0200 (dim, 05 aoû 2007) | 4 lines
Update the list of known issues:
- border-collapsing model for tables is available
- internal links point to the exact location
........
r562900 | vhennebert | 2007-08-05 17:48:50 +0200 (dim, 05 aoû 2007) | 2 lines
Setup the "known issues" infrastructure for the 0.94 tab
........
r562903 | vhennebert | 2007-08-05 18:23:59 +0200 (dim, 05 aoû 2007) | 2 lines
Style only: remove tab characters
........
r562909 | vhennebert | 2007-08-05 19:11:58 +0200 (dim, 05 aoû 2007) | 2 lines
Disable "Valid HTML" icons. The site isn't valid...
........
r562919 | vhennebert | 2007-08-05 19:52:13 +0200 (dim, 05 aoû 2007) | 3 lines
Disable any link to relnotes.html. This file is not properly placed (in no tab), and only contains release notes for versions up to 0.92.
TODO determine what to do with this file; newer versions have their own system
........
r562924 | vhennebert | 2007-08-05 20:09:44 +0200 (dim, 05 aoû 2007) | 2 lines
Add a link to the Release Notes for version 0.94
........
r562925 | vhennebert | 2007-08-05 20:10:34 +0200 (dim, 05 aoû 2007) | 2 lines
Replace "Apache Forrest" with "Apache FOP". Copy-paste error?
........
r564159 | vhennebert | 2007-08-09 11:56:41 +0200 (jeu, 09 aoû 2007) | 2 lines
Introduce 0.94 in status.xml and README
........
r564233 | vhennebert | 2007-08-09 17:09:49 +0200 (jeu, 09 aoû 2007) | 2 lines
Update the compliance page
........
r564864 | vhennebert | 2007-08-11 10:41:15 +0200 (sam, 11 aoû 2007) | 2 lines
Fix error that made the 0.94 menu appear in the Trunk tab and vice-versa
........
r564866 | vhennebert | 2007-08-11 10:45:39 +0200 (sam, 11 aoû 2007) | 2 lines
Add my key for signing the release
........
r564871 | vhennebert | 2007-08-11 10:51:35 +0200 (sam, 11 aoû 2007) | 2 lines
Update dependency on version 1.2 of XML Graphics Commons
........
r567299 | vhennebert | 2007-08-18 19:23:09 +0200 (sam, 18 aoû 2007) | 2 lines
Update .htaccess to 0.94 release
........
r567539 | clay | 2007-08-20 06:12:42 +0200 (lun, 20 aoû 2007) | 1 line
Added formatting for code in page.
........
git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@569104 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'src/documentation/content/xdocs/0.94')
21 files changed, 5361 insertions, 0 deletions
diff --git a/src/documentation/content/xdocs/0.94/anttask.xml b/src/documentation/content/xdocs/0.94/anttask.xml new file mode 100644 index 000000000..44550c3d7 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/anttask.xml @@ -0,0 +1,197 @@ +<?xml version="1.0" standalone="no"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!-- $Id$ --> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd"> +<document> + <header> + <title>Ant task</title> + <version>$Revision$</version> + </header> + <body> + <p> + Apache FOP provides an Ant task for automating the document build process. + </p> + <section id="basics"> + <title>Description</title> + <p> + The FOP Ant task will convert XSL-FO documents to PDF, PS, PCL etc. output + (see <a href="output.html">Output formats</a> for available formats). + </p> + <p> + To call FOP tasks within Ant, first add a FOP task definition to your Ant build file. + One method of defining the task is as follows: + </p> + <source><![CDATA[ +<property name="fop.home" value="....path to your FOP HOME directory..."/> + +<taskdef name="fop" + classname="org.apache.fop.tools.anttasks.Fop"> + <classpath> + <fileset dir="${fop.home}/lib"> + <include name="*.jar"/> + </fileset> + <fileset dir="${fop.home}/build"> + <include name="fop.jar"/> + <include name="fop-hyph.jar" /> + </fileset> + </classpath> +</taskdef> + ]]></source> +<p> + Then create FOP tasks within your Ant build file, using the FOP task parameters listed below.</p> + </section> + <!-- TODO: Installation/Configuration --> + <section id="parameters"><title>Parameters for FOP Ant task</title> + <table><caption>Parameters specified as attributes</caption> + <tr> + <th>Attribute</th> + <th>Description</th> + <th>Required</th> + </tr> + <tr> + <td>fofile</td> + <td>XSL-FO file to be rendered</td> + <td>Yes, if no fileset nested element is used</td> + </tr> + <tr> + <td>outfile</td> + <td>Output filename</td> + <td>Yes, when fofile is used. (This attribute is not valid for filesets.)</td> + </tr> + <tr> + <td>format</td> + <td>Possible output formats:<br/> + <code>application/X-fop-awt-preview</code><br/> + <code>application/X-fop-print</code><br/> + <code>application/X-fop-areatree</code><br/> + <code>application/pdf</code><br/> + <code>application/postscript</code><br/> + <code>application/mif</code><br/> + <code>application/rtf</code>, + <code>text/richtext</code>, + <code>text/rtf</code><br/> + <code>application/x-pcl</code>, + <code>application/vnd.hp-PCL</code><br/> + <code>application/x-afp</code>, + <code>application/vnd.ibm.modcap</code><br/> + <code>text/plain</code><br/> + <code>image/svg+xml</code><br/> + <code>image/gif</code><br/> + <code>image/png</code><br/> + <code>image/tiff</code><br/> + </td> + <td>No, defaults to <code>application/pdf</code></td> + </tr> + <tr> + <td>outdir</td> + <td>Output directory</td> + <td>Required if a fileset is used to specify the files to render; optional for fofile. (Can alternatively specify the full path in the fofile value.)</td> + </tr> + <tr> + <td>force</td> + <td>Recreate target files, even if they are newer than their corresponding + source files. Note: This attribute is available in post-0.20.5 + versions (0.20.x nightly build and 1.0dev) only; target files are + always generated (i.e., force=true) in 0.20.5 release. + </td> + <td>No, default is <code>false</code></td> + </tr> + <tr> + <td>basedir</td> + <td>Base directory to resolve relative references (e.g., graphics files) within the + FO document. + </td> + <td>No, for single FO File entry, default is to use the location + of that FO file. + </td> + </tr> + <tr> + <td>relativebase</td> + <td>For fileset usage only. A value of <code>true</code> specifies using the location + of each .fo file as the base directory for resolving relative file references located + within that .fo file. A value of <code>false</code> specifies using the value of + basedir for all files within the fileset, or just the current working directory + if basedir is not specified. + </td> + <td>No, default is <code>false</code>. + </td> + </tr> + <tr> + <td>userconfig</td> + <td>User configuration file (same as the FOP "-c" command line option).</td> + <td>No</td> + </tr> + <tr> + <td>messagelevel</td> + <td>Logging level<br/> + Possible values: <code>error</code>, <code>warn</code>, <code>info</code>, <code>verbose</code>, <code>debug</code>. <strong>Currently doesn't work in FOP Trunk!!!</strong></td> + <td>No, defaults to <code>verbose</code></td> + </tr> + <tr> + <td>logFiles</td> + <td>Controls whether the names of the files that are processed are logged + (<code>true</code>) or not (<code>false</code>). <strong>Currently doesn't work in FOP Trunk!!!</strong></td> + <td>No, default is <code>true</code></td> + </tr> + </table> + <p/> + <table><caption>Parameters specified as nested elements</caption> + <tr> + <th>Attribute</th> + <th>Description</th> + <th>Required</th> + </tr> + <tr> + <td>fileset</td> + <td><a href="http://ant.apache.org/manual/CoreTypes/fileset.html">FileSets</a> + are used to specify multiple XSL-FO files to be rendered.</td> + <td>Yes, if no fofile attribute is supplied</td> + </tr> + </table> + </section> + <section id="examples"> + <title>Examples</title> + <p> + The following example converts a single XSL-FO file to a PDF document: + </p> + + <source><![CDATA[ +<target name="generate-pdf" description="Generates a single PDF file"> + <fop format="application/pdf" + fofile="c:\working\foDirectory\foDocument.fo" + outfile="c:\working\pdfDirectory\pdfDocument.pdf" /> +</target> + ]]></source> + <p> + This example converts all XSL-FO files within an entire directory to PostScript: + </p> + <source><![CDATA[ +<target name="generate-multiple-ps" + description="Generates multiple PostScript files"> + <fop format="application/postscript" + outdir="${build.dir}" messagelevel="debug"> + <fileset dir="${fo.examples.dir}"> + <include name="*.fo"/> + </fileset> + </fop> +</target> + ]]></source> + </section> + </body> +</document> + diff --git a/src/documentation/content/xdocs/0.94/compiling.xml b/src/documentation/content/xdocs/0.94/compiling.xml new file mode 100644 index 000000000..c6c17a3c0 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/compiling.xml @@ -0,0 +1,141 @@ +<?xml version="1.0" standalone="no"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!-- $Id$ --> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd"> +<document> + <header> + <title>Apache FOP: Building from Source Code</title> + <version>$Revision$</version> + </header> + <body> + <section id="build-needed"> + <title>Do You Need To Build?</title> + <p> + FOP distributions are either pre-compiled binary or source. + If you are using a binary distribution, it is already built and there is no need to build it again. + See the <a href="../download.html">Download Instructions</a> for information about whether a + binary or source distribution is best for your needs. + </p> + <p> + If you got the source code from a repository snapshot or via Subversion you will need to build FOP + in any case. + </p> + </section> + <section id="env"> + <title>Set Up Your Environment</title> + <section id="env-jdk"> + <title>JDK</title> + <p> + Building FOP requires a minimum Java Development Kit (JDK/SDK) of 1.3 + (A Java Runtime Environment is not sufficient). + </p> + </section> + <section id="env-classpath"> + <title>CLASSPATH</title> + <p> + There is generally no need to setup a classpath. All libraries needed to compile FOP are included + in the source distribution and are referenced by the build script. + You will only need to adjust the classpath if you build FOP in some other way. See the build + script build.xml for details. + </p> + </section> + <section id="env-java-home"> + <title>JAVA_HOME</title> + <p> + The build script uses <a href="ext:ant">Apache Ant</a>, a popular + Java-based build tool, which usually requires that the environment variable JAVA_HOME point to + your local JDK root directory. This is true even if you use JDK 1.3 or above, which normally + does not need this setting. + </p> + </section> + <section id="env-ant"> + <title>Apache Ant</title> + <p> + <a href="ext:ant">Apache Ant</a> must be installed in order to + build FOP. Following best practices we don't include Ant with FOP anymore. You can find the + <a href="ext:ant/manual/">instructions to install Ant in the Ant manual</a> on the web. + </p> + </section> + </section> + <section id="build-script"> + <title>Run the Build Script</title> + <p> + Change to the FOP root directory and build FOP by executing the build script (build.xml) + using the "ant" command. + </p> + <note> + The "ant" command is only available on your system if you've properly + <a href="ext:ant/manual/">installed Apache Ant</a> and added Ant's location to the PATH + environment variable. + </note> + <p> + The file build.xml in the FOP root directory is the blueprint that Ant uses for the build. It + contains information for numerous build targets, many of which are building blocks to more + useful target, and others which are primarily used by the FOP developers. + You may benefit from looking through this file to learn more about the various build targets. + To obtain a complete list of useful build targets: + </p> + <source>ant -projecthelp</source> + <p>The most useful targets are:</p> + <ul> + <li> + <strong>package</strong>: Generates the JAR files (default). This is the normal build that + produces a jar file usable for running FOP. + </li> + <li> + <strong>clean </strong>: Cleans the build directory. This is useful for making sure that + any build errors are cleaned up before starting a new build. It should not ordinarily be + needed, but may be helpful if you are having problems with the build process itself. + </li> + <li> + <strong>javadocs</strong>: Creates the FOP API documentation. + <note>A minimum JDK version of 1.4.2 is required for generating the javadocs.</note> + </li> + </ul> + <p>To run the build:</p> + <source>ant [target ...]</source> + <p>For example to do a normal build for the "all" target (which is the default):</p> + <source>ant</source> + <p>OR</p> + <source>ant all</source> + <p>To clean the build directory first:</p> + <source>ant clean all</source> + <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> + </section> + <section id="problems"> + <title id="Troubleshooting">Troubleshooting</title> + <p>If you have problems building FOP, please try the following:</p> + <ul> + <li>Run the build with the target of "clean", then rerun the build.</li> + <li>Delete the build directory completely, then rerun the build.</li> + <li> + Make sure you do not have a non-FOP version of xerces.jar, xalan.jar, batik.jar, + or another dependency product somewhere in your CLASSPATH. + </li> + <li> + If the build still fails, see the <a href="../gethelp.html">Getting Help</a> + page for further help. + </li> + </ul> + </section> + </body> +</document> + diff --git a/src/documentation/content/xdocs/0.94/configuration.xml b/src/documentation/content/xdocs/0.94/configuration.xml new file mode 100644 index 000000000..656c3b706 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/configuration.xml @@ -0,0 +1,385 @@ +<?xml version="1.0" standalone="no"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!-- $Id$ --> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd"> +<document> + <header> + <title>Apache FOP: Configuration</title> + <version>$Revision$</version> + </header> + + <body> + <section id="general"> + <title>Configuration File Basics</title> + <p> + The FOP configuration file is an XML file containing a variety of settings that are useful + for controlling FOP's behavior, and for helping it find resources that you wish it to use. + </p> + <p> + The easiest way to get started using a FOP configuration file is to copy the sample found + at <code>{fop-dir}/conf/fop.xconf</code> to a location of your choice, and then to + edit it according to your needs. + It contains templates for the various configuration options, most of which are commented + out. Remove the comments and change the settings for entries that you wish to use. + Be sure to follow any instructions, including comments which specify the value range. + Also, since the configuration file is XML, be sure to keep it well-formed. + </p> + <section id="general-available"> + <title>Making Configuration Available to FOP</title> + <p>After creating your configuration file, you must tell FOP how to find it:</p> + <ul> + <li> + If running FOP from the command-line, see the "-c" command-line option in + <a href="running.html">Running FOP</a>. + </li> + <li> + If running FOP as an embedded application, see + <a href="embedding.html#config-external">Embedding, Using a Configuration File</a>. + </li> + </ul> + <p> + See <a href="embedding.html#config-internal">Setting the Configuration Programmatically</a> + for instructions on how to do so in an embedded environment. + </p> + </section> + </section> + <section id="general-elements"> + <title>Summary of the General Configuration Options</title> + <table> + <tr> + <th>Element</th> + <th>Data Type (for the value)</th> + <th>Description</th> + <th>Default Value</th> + </tr> + <tr> + <td>base</td> + <td>URL or directory</td> + <td>Specifies the base URL based on which relative URL will be resolved.</td> + <td>current directory</td> + </tr> + <tr> + <td>font-base</td> + <td>URL or directory</td> + <td>Specifies the base URL based on which relative font URLs will be resolved. + </td> + <td>base URL/directory (above)</td> + </tr> + <tr> + <td>hyphenation-base</td> + <td>URL or directory</td> + <td>Specifies the base URL based on which relative URLs to hyphenation pattern + files will be resolved. If not specified, support for user-supplied hyphenation + patterns remains disabled. + </td> + <td>disabled</td> + </tr> + <tr> + <td>source-resolution</td> + <td>Integer, dpi</td> + <td> + Resolution in dpi (dots per inch) which is used internally to determine the pixel + size for SVG images and bitmap images without resolution information. + </td> + <td>72 dpi</td> + </tr> + <tr> + <td>target-resolution</td> + <td>Integer, dpi</td> + <td> + Resolution in dpi (dots per inch) used to specify the output resolution for bitmap + images generated by bitmap renderers (such as the TIFF renderer) and by bitmaps + generated by Apache Batik for filter effects and such. + </td> + <td>72 dpi</td> + </tr> + <tr> + <td>strict-configuration</td> + <td>Boolean (true, false)</td> + <td> + Setting this option to 'true' will cause FOP to strictly verify the contents of the + FOP configuration file to ensure that defined resources (such as fonts and base + URLs/directories) are valid and available to FOP. Any errors found will cause FOP to + immediately raise an exception.</td> + <td>false</td> + </tr> + <tr> + <td>strict-validation</td> + <td>Boolean (true, false)</td> + <td> + Setting this option to 'false' causes FOP to be more forgiving about XSL-FO validity, + for example, you're allowed to specify a border on a region-body which is supported + by some FO implementations but is non-standard. Note that such a border would + currently have no effect in Apache FOP.</td> + <td>true</td> + </tr> + <tr> + <td>break-indent-inheritance</td> + <td>Boolean (true, false)</td> + <td> + Setting this option to 'true' causes FOP to use an alternative rule set to determine + text indents specified through margins, start-indent and end-indent. Many commercial + FO implementations have chosen to break the XSL specification in this aspect. This + option tries to mimic their behaviour. Please note that Apache FOP may still not + behave exactly like those implementations either because FOP has not fully matched + the desired behaviour and because the behaviour among the commercial implementations + varies. The default for this option (i.e. false) is to behave exactly like the + specification describes.</td> + <td>false</td> + </tr> + <tr> + <td>default-page-settings</td> + <td>n/a</td> + <td> + Specifies the default width and height of a page if "auto" is specified + for either or both values. Use "height" and "width" attributes on the + default-page-settings element to specify the two values.</td> + <td>"height" 11 inches, "width" 8.26 inches</td> + </tr> + <tr> + <td>use-cache</td> + <td>boolean (true, false)</td> + <td>All fonts information that has been gathered as a result of "directory" + or "auto-detect" font configurations will be cached for future rendering runs. + This setting should improve performance on systems where + fonts have been configured using the "directory" or "auto-detect" tag mechanisms. + By default this option is switched on.</td> + <td>true</td> + </tr> + <tr> + <td>cache-file</td> + <td>String</td> + <td>This options specifies the file/directory path of the fop cache file. + This option can also be specified on the command-line using the -cache option. + This file is currently only used to cache font triplet information for future reference.</td> + <td>${base}/conf/fop.cache</td> + </tr> + <tr> + <td>renderers</td> + <td>(see text below)</td> + <td>Contains the configuration for each renderer. See below.</td> + <td>N/A</td> + </tr> + </table> + <p> + This is an excerpt from the example configuration file coming with FOP: + </p> + <source><![CDATA[ +<fop version="1.0"> + + <!-- Strict user configuration --> + <strict-configuration>true</strict-configuration> + + <!-- Strict FO validation --> + <strict-validation>true</strict-validation> + + <!-- Base URL for resolving relative URLs --> + <base>./</base> + + <!-- Font Base URL for resolving relative font URLs --> + <font-base>./</font-base> + + <!-- Source resolution in dpi (dots/pixels per inch) for determining the size of pixels in SVG and bitmap images, default: 72dpi --> + <source-resolution>72</source-resolution> + <!-- Target resolution in dpi (dots/pixels per inch) for specifying the target resolution for generated bitmaps, default: 72dpi --> + <target-resolution>72</target-resolution> + + <!-- default page-height and page-width, in case + value is specified as auto --> + <default-page-settings height="11in" width="8.26in"/> + + <!-- etc. etc..... --> +</fop>]]></source> + </section> + <section id="renderers"> + <title>Renderer configuration</title> + <p> + Each Renderer has its own configuration section which is identified by the + MIME type the Renderer is written for, ex. "application/pdf" for the PDF Renderer. + </p> + <p> + The configuration for the PDF Renderer could look like this: + </p> + <source><![CDATA[ + <renderers> + <renderer mime="application/pdf"> + <filterList> + <!-- provides compression using zlib flate (default is on) --> + <value>flate</value> + </filterList> + <fonts> + <font metrics-url="arial.xml" kerning="yes" embed-url="arial.ttf"> + <font-triplet name="Arial" style="normal" weight="normal"/> + <font-triplet name="ArialMT" style="normal" weight="normal"/> + </font> + <font metrics-url="arialb.xml" kerning="yes" embed-url="arialb.ttf"> + <font-triplet name="Arial" style="normal" weight="bold"/> + <font-triplet name="ArialMT" style="normal" weight="bold"/> + </font> + </fonts> + </renderer> + + <renderer mime="application/postscript"> + <!-- etc. etc..... -->]]></source> + <p> + The details on the font configuration can be found on the separate <a href="fonts.html">Fonts</a> page. + Note especially the section entitled <a href="fonts.html#register">Register Fonts with FOP</a>. + </p> + <section id="pdf-renderer"> + <title>Special Settings for the PDF Renderer</title> + <p> + The configuration element for the PDF renderer contains two elements. One is for the font configuration + (please follow the link above) and one is for the "filter list". The filter list controls how the + individual objects in a PDF file are encoded. By default, all objects get "flate" encoded (i.e. simply + compressed with the same algorithm that is also used in ZIP files). Most users don't need to change that + setting. For debugging purposes, it may be desired not to compress the internal objects at all so the + generated PDF commands can be read. In that case, you can simply use the following filter list. The + second filter list (type="image") ensures that all images still get compressed but also ASCII-85 encoded + so the produced PDF file is still easily readable in a text editor. + </p> + <source><![CDATA[ + <renderer mime="application/pdf"> + <filterList> + <value>null</value> + </filterList> + <filterList type="image"> + <value>flate</value> + <value>ascii-85</value> + </filterList> + + <fonts.... + </renderer>]]></source> + <p> + Another (optional) setting specific to the PDF Renderer is an output color profile, an ICC + color profile which indicates the target color space the PDF file is generated for. This + setting is mainly used in conjunction with the <a href="pdfx.html">PDF/X</a> feature. + An example: + </p> + <source><![CDATA[ + <renderer mime="application/pdf"> + <filterList... + + <output-profile>C:\FOP\Color\EuropeISOCoatedFOGRA27.icc</output-profile> + + <fonts.... + </renderer>]]></source> + </section> + <section id="ps-renderer"> + <title>Special Settings for the PostScript Renderer</title> + <p> + Besides the normal font configuration (the same "fonts" element as for the PDF renderer) the PostScript + renderer has an additional setting to force landscape pages to be rotated to fit on a page inserted into + the printer in portrait mode. Set the value to "true" to activate this feature. The default is "false". + Example: + </p> + <source><![CDATA[ + <renderer mime="application/postscript"> + <auto-rotate-landscape>true</auto-rotate-landscape> + + <fonts> + <font metrics-url="arial.xml" kerning="yes" embed-url="arial.ttf"> + <font-triplet name="Arial" style="normal" weight="normal"/> + <font-triplet name="ArialMT" style="normal" weight="normal"/> + </font> + <font metrics-url="arialb.xml" kerning="yes" embed-url="arialb.ttf"> + <font-triplet name="Arial" style="normal" weight="bold"/> + <font-triplet name="ArialMT" style="normal" weight="bold"/> + </font> + </fonts> + </renderer>]]></source> + </section> + <section id="pcl-renderer"> + <title>Special Settings for the PCL Renderer</title> + <p> + Non-standard fonts for the PCL renderer are made available through the Java2D subsystem which means that + you don't have to do any custom font configuration in this case but you have to use the font names + offered by Java. + </p> + <p> + Additionally, there are certain settings that control how the renderer handles various elements. + </p> +<source><![CDATA[<renderer mime="application/vnd.hp-PCL"> + <rendering>quality</rendering> + <text-rendering>bitmap</text-rendering> +</renderer>]]></source> + <p> + The default value for the "rendering" setting is "speed" which causes borders + to be painted as plain rectangles. In this mode, no special borders (dotted, + dashed etc.) are available. If you want support for all border modes, set the + value to "quality" as indicated above. This will cause the borders to be painted + as bitmaps. + </p> + <p> + The default value for the "text-rendering" setting is "auto" which paints the + base fonts using PCL fonts. Non-base fonts are painted as bitmaps through Java2D. + If the mix of painting methods results in unwelcome output, you can set this + to "bitmap" which causes all text to be rendered as bitmaps. + </p> + </section> + </section> + <section id="fonts"> + <title>Apache FOP Font Config</title> + <p> + Apache FOP has special Font configuration considerations, which are explained + in detail on the <a href="fonts.html">Fonts</a> page. + </p> + </section> + + <section> + <title>When it does not work</title> + + <p>FOP searches the configuration file for the information it +expects, at the position it expects. When that information is not +present, FOP will not complain, it will just continue. When there is +other information in the file, FOP will not complain, it will just +ignore it. That means that when your configuration information is in +the file but in a different XML element, or in a different XML path, +than FOP expects, it will be silently ignored.</p> + + <p>Check the following possibilities:</p> + + <ul> + <li>The format of the configuration file has changed +considerably between FOP 0.20.5 and FOP 1.0 and its beta versions. Did +you convert your file to the new format?</li> + + <li>The FOP distribution contains a schema for configuration +files, at src/foschema/fop-configuration.xsd. Did you validate your +configuration file against it? Add the following schema location to +the <code>schema</code> element: + +<source><![CDATA[<fop +xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" +xsi:noNamespaceSchemaLocation= +"http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/foschema/fop-configuration.xsd?view=co">]]> +</source> + +and run the configuration file through a validating schema +parser. Note that the schema cannot detect all errors, and that it is +stricter about the order of some elements than FOP itself is.</li> + + <li>Run FOP in debug mode (command line option +<code>-d</code>). This makes FOP report which configuration +information it finds. Check if FOP finds what you expect.</li> + + </ul> + + </section> + </body> +</document> + diff --git a/src/documentation/content/xdocs/0.94/embedding.xml b/src/documentation/content/xdocs/0.94/embedding.xml new file mode 100644 index 000000000..3e3c964f8 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/embedding.xml @@ -0,0 +1,689 @@ +<?xml version="1.0" standalone="no"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!-- $Id$ --> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd"> +<!-- Embedding FOP --> +<document> + <header> + <title>Apache FOP: Embedding</title> + <subtitle>How to Embed FOP in a Java application</subtitle> + <version>$Revision$</version> + </header> + + <body> + <section id="overview"> + <title>Overview</title> + <p> + Review <a href="running.html">Running FOP</a> for important information that applies + to embedded applications as well as command-line use, such as options and performance. + </p> + <p> + To embed Apache FOP in your application, first create a new + org.apache.fop.apps.FopFactory instance. This object can be used to launch multiple + rendering runs. For each run, create a new org.apache.fop.apps.Fop instance through + one of the factory methods of FopFactory. In the method call you specify which output + format (i.e. Renderer) to use and, if the selected renderer requires an OutputStream, + which OutputStream to use for the results of the rendering. You can customize FOP's + behaviour in a rendering run by supplying your own FOUserAgent instance. The + FOUserAgent can, for example, be used to set your own Renderer instance (details + below). Finally, you retrieve a SAX DefaultHandler instance from the Fop object and + use that as the SAXResult of your transformation. + </p> + <note> + 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. + </note> + </section> + <section id="basics"> + <title>Basic Usage Pattern</title> + <p> + Apache FOP relies heavily on JAXP. It uses SAX events exclusively to receive the XSL-FO + input document. It is therefore a good idea that you know a few things about JAXP (which + is a good skill anyway). Let's look at the basic usage pattern for FOP... + </p> + <p>Here is the basic pattern to render an XSL-FO file to PDF: + </p> + <source><![CDATA[ +import org.apache.fop.apps.FopFactory; +import org.apache.fop.apps.Fop; +import org.apache.fop.apps.MimeConstants; + +/*..*/ + +// Step 1: Construct a FopFactory +// (reuse if you plan to render multiple documents!) +FopFactory fopFactory = FopFactory.newInstance(); + +// Step 2: Set up output stream. +// Note: Using BufferedOutputStream for performance reasons (helpful with FileOutputStreams). +OutputStream out = new BufferedOutputStream(new FileOutputStream(new File("C:/Temp/myfile.pdf"))); + +try { + // Step 3: Construct fop with desired output format + Fop fop = fopFactory.newFop(MimeConstants.MIME_PDF, out); + + // Step 4: Setup JAXP using identity transformer + TransformerFactory factory = TransformerFactory.newInstance(); + Transformer transformer = factory.newTransformer(); // identity transformer + + // Step 5: Setup input and output for XSLT transformation + // Setup input stream + Source src = new StreamSource(new File("C:/Temp/myfile.fo")); + + // Resulting SAX events (the generated FO) must be piped through to FOP + Result res = new SAXResult(fop.getDefaultHandler()); + + // Step 6: Start XSLT transformation and FOP processing + transformer.transform(src, res); + +} finally { + //Clean-up + out.close(); +}]]></source> + <p> + Let's discuss these 5 steps in detail: + </p> + <ul> + <li> + <strong>Step 1:</strong> You create a new FopFactory instance. The FopFactory instance holds + references to configuration information and cached data. It's important to reuse this + instance if you plan to render multiple documents during a JVM's lifetime. + </li> + <li> + <strong>Step 2:</strong> You set up an OutputStream that the generated document + will be written to. It's a good idea to buffer the OutputStream as demonstrated + to improve performance. + </li> + <li> + <strong>Step 3:</strong> You create a new Fop instance through one of the factory + methods on the FopFactory. You tell the FopFactory what your desired output format + is. This is done by using the MIME type of the desired output format (ex. "application/pdf"). + You can use one of the MimeConstants.* constants. The second parameter is the + OutputStream you've setup up in step 2. + </li> + <li> + <strong>Step 4</strong> We recommend that you use JAXP Transformers even + if you don't do XSLT transformations to generate the XSL-FO file. This way + you can always use the same basic pattern. The example here sets up an + "identity transformer" which just passes the input (Source) unchanged to the + output (Result). You don't have to work with a SAXParser if you don't do any + XSLT transformations. + </li> + <li> + <strong>Step 5:</strong> Here you set up the input and output for the XSLT + transformation. The Source object is set up to load the "myfile.fo" file. + The Result is set up so the output of the XSLT transformation is sent to FOP. + The FO file is sent to FOP in the form of SAX events which is the most efficient + way. Please always avoid saving intermediate results to a file or a memory buffer + because that affects performance negatively. + </li> + <li> + <strong>Step 6:</strong> Finally, we start the XSLT transformation by starting + the JAXP Transformer. As soon as the JAXP Transformer starts to send its output + to FOP, FOP itself starts its processing in the background. When the + <code>transform()</code> method returns FOP will also have finished converting + the FO file to a PDF file and you can close the OutputStream. + <note label="Tip!"> + It's a good idea to enclose the whole conversion in a try..finally statement. If + you close the OutputStream in the finally section, this will make sure that the + OutputStream is properly closed even if an exception occurs during the conversion. + </note> + </li> + </ul> + <p> + If you're not totally familiar with JAXP Transformers, please have a look at the + <a href="#examples">Embedding examples</a> below. The section contains examples + for all sorts of use cases. If you look at all of them in turn you should be able + to see the patterns in use and the flexibility this approach offers without adding + too much complexity. + </p> + <p> + This may look complicated at first, but it's really just the combination of an + XSL transformation and a FOP run. It's also easy to comment out the FOP part + for debugging purposes, for example when you're tracking down a bug in your + stylesheet. You can easily write the XSL-FO output from the XSL transformation + to a file to check if that part generates the expected output. An example for that + can be found in the <a href="#examples">Embedding examples</a> (See "ExampleXML2FO"). + </p> + <section id="basic-logging"> + <title>Logging</title> + <p> + Logging is now a little different than it was in FOP 0.20.5. We've switched from + Avalon Logging to <a href="ext:jakarta/commons/logging">Jakarta Commons Logging</a>. + While with Avalon Logging the loggers were directly given to FOP, FOP now retrieves + its logger(s) through a statically available LogFactory. This is similar to the + general pattern that you use when you work with Apache Log4J directly, for example. + We call this "static logging" (Commons Logging, Log4J) as opposed to "instance logging" + (Avalon Logging). This has a consequence: You can't give FOP a logger for each + processing run anymore. The log output of multiple, simultaneously running FOP instances + is sent to the same logger. + </p> + <note> + We know this may be an issue in multi-threaded server environments if you'd like to + know what's going on in every single FOP processing run. We're planning to add an + additional feedback facility to FOP which can be used to obtain all sorts of specific + feedback (validation messages, layout problems etc.). "Static logging" is mainly + interesting for a developer working on FOP and for advanced users who are debugging + FOP. We don't consider the logging output to be useful to normal FOP users. Please + have some patience until we can add this feature or jump in and help us build it. We've + set up a <a href="http://wiki.apache.org/xmlgraphics-fop/ProcessingFeedback">Wiki page</a> + which documents what we're going to build. + </note> + <p> + By default, <a href="ext:jakarta/commons/logging">Jakarta Commons Logging</a> uses + JDK logging (available in JDKs 1.4 or higher) as its backend. You can configure Commons + Logging to use an alternative backend, for example Log4J. Please consult the + <a href="ext:jakarta/commons/logging">documentation for Jakarta Commons Logging</a> on + how to configure alternative backends. + </p> + </section> + + <section id="render"> + <title>Processing XSL-FO</title> + <p> + Once the Fop instance is set up, call <code>getDefaultHandler()</code> to obtain a SAX + DefaultHandler instance to which you can send the SAX events making up the XSL-FO + document you'd like to render. FOP processing starts as soon as the DefaultHandler's + <code>startDocument()</code> method is called. Processing stops again when the + DefaultHandler's <code>endDocument()</code> method is called. Please refer to the basic + usage pattern shown above to render a simple XSL-FO document. + </p> + </section> + + <section id="render-with-xslt"> + <title>Processing XSL-FO generated from XML+XSLT</title> + <p> + If you want to process XSL-FO generated from XML using XSLT we recommend + again using standard JAXP to do the XSLT part and piping the generated SAX + events directly through to FOP. The only thing you'd change to do that + on the basic usage pattern above is to set up the Transformer differently: + </p> + <source><![CDATA[ + //without XSLT: + //Transformer transformer = factory.newTransformer(); // identity transformer + + //with XSLT: + Source xslt = new StreamSource(new File("mystylesheet.xsl")); + Transformer transformer = factory.newTransformer(xslt);]]></source> + </section> + </section> + <section id="input"> + <title>Input Sources</title> + <p> + The input XSL-FO document is always received by FOP as a SAX stream (see the + <a href="../dev/design/parsing.html">Parsing Design Document</a> for the rationale). + </p> + <p> + However, you may not always have your input document available as a SAX stream. + But with JAXP it's easy to convert different input sources to a SAX stream so you + can pipe it into FOP. That sounds more difficult than it is. You simply have + to set up the right Source instance as input for the JAXP transformation. + A few examples: + </p> + <ul> + <li> + <strong>URL:</strong> <code>Source src = new StreamSource("http://localhost:8080/testfile.xml");</code> + </li> + <li> + <strong>File:</strong> <code>Source src = new StreamSource(new File("C:/Temp/myinputfile.xml"));</code> + </li> + <li> + <strong>String:</strong> <code>Source src = new StreamSource(new StringReader(myString)); // myString is a String</code> + </li> + <li> + <strong>InputStream:</strong> <code>Source src = new StreamSource(new MyInputStream(something));</code> + </li> + <li> + <strong>Byte Array:</strong> <code>Source src = new StreamSource(new ByteArrayInputStream(myBuffer)); // myBuffer is a byte[] here</code> + </li> + <li> + <strong>DOM:</strong> <code>Source src = new DOMSource(myDocument); // myDocument is a Document or a Node</code> + </li> + <li> + <strong>Java Objects:</strong> Please have a look at the <a href="#examples">Embedding examples</a> which contain an example for this. + </li> + </ul> + <p> + There are a variety of upstream data manipulations possible. + For example, you may have a DOM and an XSL stylesheet; or you may want to + set variables in the stylesheet. Interface documentation and some cookbook + solutions to these situations are provided in + <a href="http://xml.apache.org/xalan-j/usagepatterns.html">Xalan Basic Usage Patterns</a>. + </p> + </section> + <section id="config-internal"> + <title>Configuring Apache FOP Programmatically</title> + <p> + Apache FOP provides two levels on which you can customize FOP's + behaviour: the FopFactory and the user agent. + </p> + <section id="fop-factory"> + <title>Customizing the FopFactory</title> + <p> + The FopFactory holds configuration data and references to objects which are reusable over + multiple rendering runs. It's important to instantiate it only once (except in special + environments) and reuse it every time to create new FOUserAgent and Fop instances. + </p> + <p> + You can set all sorts of things on the FopFactory: + </p> + <ul> + <li> + <p> + The <strong>font base URL</strong> to use when resolving relative URLs for fonts. Example: + </p> + <source>fopFactory.setFontBaseURL("file:///C:/Temp/fonts");</source> + </li> + <li> + <p> + The <strong>hyphenation base URL</strong> to use when resolving relative URLs for + hyphenation patterns. Example: + </p> + <source>fopFactory.setHyphenBaseURL("file:///C:/Temp/hyph");</source> + </li> + <li> + <p> + Disable <strong>strict validation</strong>. When disabled FOP is less strict about the rules + established by the XSL-FO specification. Example: + </p> + <source>fopFactory.setStrictValidation(false);</source> + </li> + <li> + <p> + Enable an <strong>alternative set of rules for text indents</strong> that tries to mimic the behaviour of many commercial + FO implementations, that chose to break the specification in this respect. The default of this option is + 'false', which causes Apache FOP to behave exactly as described in the specification. To enable the + alternative behaviour, call: + </p> + <source>fopFactory.setBreakIndentInheritanceOnReferenceAreaBoundary(true);</source> + </li> + <li> + <p> + Set the <strong>source resolution</strong> for the document. This is used internally to determine the pixel + size for SVG images and bitmap images without resolution information. Default: 72 dpi. Example: + </p> + <source>fopFactory.setSourceResolution(96); // =96dpi (dots/pixels per Inch)</source> + </li> + <li> + <p> + Manually add an <strong>ElementMapping instance</strong>. If you want to supply a special FOP extension + you can give the instance to the FOUserAgent. Normally, the FOP extensions can be automatically detected + (see the documentation on extension for more info). Example: + </p> + <source>fopFactory.addElementMapping(myElementMapping); // myElementMapping is a org.apache.fop.fo.ElementMapping</source> + </li> + <li> + <p> + Set a <strong>URIResolver</strong> for custom URI resolution. By supplying a JAXP URIResolver you can add + custom URI resolution functionality to FOP. For example, you can use + <a href="ext:xml.apache.org/commons/resolver">Apache XML Commons Resolver</a> to make use of XCatalogs. Example: + </p> + <source>fopFactory.setURIResolver(myResolver); // myResolver is a javax.xml.transform.URIResolver</source> + <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> + </li> + </ul> + </section> + <section id="user-agent"> + <title>Customizing the User Agent</title> + <p> + The user agent is the entity that allows you to interact with a single rendering run, i.e. the processing of a single + document. If you wish to customize the user agent's behaviour, the first step is to create your own instance + of FOUserAgent using the appropriate factory method on FopFactory and pass that + to the factory method that will create a new Fop instance: + </p> + <source><![CDATA[ + FopFactory fopFactory = FopFactory.newInstance(); // Reuse the FopFactory if possible! + // do the following for each new rendering run + FOUserAgent userAgent = fopFactory.newFOUserAgent(); + // customize userAgent + Fop fop = fopFactory.newFop(MimeConstants.MIME_POSTSCRIPT, userAgent, out);]]></source> + <p> + You can do all sorts of things on the user agent: + </p> + <ul> + <li> + <p> + The <strong>base URL</strong> to use when resolving relative URLs. Example: + </p> + <source>userAgent.setBaseURL("file:///C:/Temp/");</source> + </li> + <li> + <p> + Set the <strong>producer</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. The default producer is "Apache FOP". Example: + </p> + <source>userAgent.setProducer("MyKillerApplication");</source> + </li> + <li> + <p> + Set the <strong>creating user</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example: + </p> + <source>userAgent.setCreator("John Doe");</source> + </li> + <li> + <p> + Set the <strong>author</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example: + </p> + <source>userAgent.setAuthor("John Doe");</source> + </li> + <li> + <p> + Override the <strong>creation date and time</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example: + </p> + <source>userAgent.setCreationDate(new Date());</source> + </li> + <li> + <p> + Set the <strong>title</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example: + </p> + <source>userAgent.setTitle("Invoice No 138716847");</source> + </li> + <li> + <p> + Set the <strong>keywords</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example: + </p> + <source>userAgent.setKeywords("XML XSL-FO");</source> + </li> + <li> + <p> + Set the <strong>target resolution</strong> for the document. This is used to + specify the output resolution for bitmap images generated by bitmap renderers + (such as the TIFF renderer) and by bitmaps generated by Apache Batik for filter + effects and such. Default: 72 dpi. Example: + </p> + <source>userAgent.setTargetResolution(300); // =300dpi (dots/pixels per Inch)</source> + </li> + <li> + <p> + Set <strong>your own Renderer instance</strong>. If you want to supply your own renderer or + configure a Renderer in a special way you can give the instance to the FOUserAgent. Normally, + the Renderer instance is created by FOP. Example: + </p> + <source>userAgent.setRendererOverride(myRenderer); // myRenderer is an org.apache.fop.render.Renderer</source> + </li> + <li> + <p> + Set <strong>your own FOEventHandler instance</strong>. If you want to supply your own FOEventHandler or + configure an FOEventHandler subclass in a special way you can give the instance to the FOUserAgent. Normally, + the FOEventHandler instance is created by FOP. Example: + </p> + <source>userAgent.setFOEventHandlerOverride(myFOEventHandler); // myFOEventHandler is an org.apache.fop.fo.FOEventHandler</source> + </li> + <li> + <p> + Set a <strong>URIResolver</strong> for custom URI resolution. By supplying a JAXP URIResolver you can add + custom URI resolution functionality to FOP. For example, you can use + <a href="ext:xml.apache.org/commons/resolver">Apache XML Commons Resolver</a> to make use of XCatalogs. Example: + </p> + <source>userAgent.setURIResolver(myResolver); // myResolver is a javax.xml.transform.URIResolver</source> + <note> + Both the FopFactory and the FOUserAgent have a method to set a URIResolver. The URIResolver on the FOUserAgent is + used for resolving URIs which are document-related. If it's not set or cannot resolve a URI, the URIResolver + from the FopFactory is used. + </note> + </li> + </ul> + <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> + </section> + </section> + <section id="config-external"> + <title>Using a Configuration File</title> + <p> + Instead of setting the parameters manually in code as shown above you can also set + many values from an XML configuration file: + </p> + <source><![CDATA[ +import org.apache.avalon.framework.configuration.Configuration; +import org.apache.avalon.framework.configuration.DefaultConfigurationBuilder; + +/*..*/ + +DefaultConfigurationBuilder cfgBuilder = new DefaultConfigurationBuilder(); +Configuration cfg = cfgBuilder.buildFromFile(new File("C:/Temp/mycfg.xml")); +fopFactory.setUserConfig(cfg); + +/* ..or.. */ + +fopFactory.setUserConfig(new File("C:/Temp/mycfg.xml"));]]></source> + <p> + The layout of the configuration file is described on the <a href="configuration.html">Configuration page</a>. + </p> + </section> + <section id="hints"> + <title>Hints</title> + <section id="object-reuse"> + <title>Object reuse</title> + <p> + Fop instances shouldn't (and can't) be reused. Please recreate + Fop and FOUserAgent instances for each rendering run using the FopFactory. + This is a cheap operation as all reusable information is held in the + FopFactory. That's why it's so important to reuse the FopFactory instance. + </p> + </section> + <section id="awt"> + <title>AWT issues</title> + <p> + If your XSL-FO files contain SVG then Apache Batik will be used. When Batik is + initialised it uses certain classes in <code>java.awt</code> that + intialise the Java AWT classes. This means that a daemon thread + is created by the JVM and on Unix it will need to connect to a + DISPLAY. + </p> + <p> + The thread means that the Java application may not automatically quit + when finished, you will need to call <code>System.exit()</code>. These + issues should be fixed in the JDK 1.4. + </p> + <p> + If you run into trouble running FOP on a head-less server, please see the + <a href="graphics.html#batik">notes on Batik</a>. + </p> + </section> + <section id="render-info"> + <title>Getting information on the rendering process</title> + <p> + To get the number of pages that were rendered by FOP you can call + <code>Fop.getResults()</code>. This returns a <code>FormattingResults</code> object + where you can look up the number of pages produced. It also gives you the + page-sequences that were produced along with their id attribute and their + numbers of pages. This is particularly useful if you render multiple + documents (each enclosed by a page-sequence) and have to know the number of + pages of each document. + </p> + </section> + </section> + <section id="performance"> + <title>Improving performance</title> + <p> + There are several options to consider: + </p> + <ul> + <li> + Whenever possible, try to use SAX to couple the individual components involved + (parser, XSL transformer, SQL datasource etc.). + </li> + <li> + Depending on the target OutputStream (in case of a FileOutputStream, but not + for a ByteArrayOutputStream, for example) it may improve performance considerably + if you buffer the OutputStream using a BufferedOutputStream: + <code>out = new java.io.BufferedOutputStream(out);</code> + <br/> + Make sure you properly close the OutputStream when FOP is finished. + </li> + <li> + Cache the stylesheet. If you use the same stylesheet multiple times + you can set up a JAXP <code>Templates</code> object and reuse it each time you do + the XSL transformation. (More information can be found + <a class="fork" href="http://www.javaworld.com/javaworld/jw-05-2003/jw-0502-xsl.html">here</a>.) + </li> + <li> + Use an XSLT compiler like <a class="fork" href="http://xml.apache.org/xalan-j/xsltc_usage.html">XSLTC</a> + that comes with Xalan-J. + </li> + <li> + Fine-tune your stylesheet to make the XSLT process more efficient and to create XSL-FO that can + be processed by FOP more efficiently. Less is more: Try to make use of property inheritance where possible. + </li> + </ul> + </section> + <section id="multithreading"> + <title>Multithreading FOP</title> + <p> + Apache FOP may currently not be completely thread safe. + The code has not been fully tested for multi-threading issues, yet. + If you encounter any suspicious behaviour, please notify us. + </p> + <p> + There is also a known issue with fonts being jumbled between threads when using + the Java2D/AWT renderer (which is used by the -awt and -print output options). + In general, you cannot safely run multiple threads through the AWT renderer. + </p> + </section> +<section id="examples"> + <title>Examples</title> + <p> + The directory "{fop-dir}/examples/embedding" contains several working examples. + </p> + <section id="ExampleFO2PDF"> + <title>ExampleFO2PDF.java</title> + <p>This + <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleFO2PDF.java?view=markup"> + example</a> +demonstrates the basic usage pattern to transform an XSL-FO +file to PDF using FOP. + </p> + <figure src="images/EmbeddingExampleFO2PDF.png" alt="Example XSL-FO to PDF"/> + </section> + <section id="ExampleXML2FO"> + <title>ExampleXML2FO.java</title> + <p>This + <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleXML2FO.java?view=markup"> + example</a> +has nothing to do with FOP. It is there to show you how an XML +file can be converted to XSL-FO using XSLT. The JAXP API is used to do the +transformation. Make sure you've got a JAXP-compliant XSLT processor in your +classpath (ex. <a href="http://xml.apache.org/xalan-j">Xalan</a>). + </p> + <figure src="images/EmbeddingExampleXML2FO.png" alt="Example XML to XSL-FO"/> + </section> + <section id="ExampleXML2PDF"> + <title>ExampleXML2PDF.java</title> + <p>This + <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleXML2PDF.java?view=markup"> + example</a> +demonstrates how you can convert an arbitrary XML file to PDF +using XSLT and XSL-FO/FOP. It is a combination of the first two examples +above. The example uses JAXP to transform the XML file to XSL-FO and FOP to +transform the XSL-FO to PDF. + </p> + <figure src="images/EmbeddingExampleXML2PDF.png" alt="Example XML to PDF (via XSL-FO)"/> + <p> +The output (XSL-FO) from the XSL transformation is piped through to FOP using +SAX events. This is the most efficient way to do this because the +intermediate result doesn't have to be saved somewhere. Often, novice users +save the intermediate result in a file, a byte array or a DOM tree. We +strongly discourage you to do this if it isn't absolutely necessary. The +performance is significantly higher with SAX. + </p> + </section> + <section id="ExampleObj2XML"> + <title>ExampleObj2XML.java</title> + <p>This + <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleObj2XML.java?view=markup"> + example</a> +is a preparatory example for the next one. It's an example that +shows how an arbitrary Java object can be converted to XML. It's an often +needed task to do this. Often people create a DOM tree from a Java object and +use that. This is pretty straightforward. The example here, however, shows how +to do this using SAX, which will probably be faster and not even more +complicated once you know how this works. + </p> + <figure src="images/EmbeddingExampleObj2XML.png" alt="Example Java object to XML"/> + <p> +For this example we've created two classes: ProjectTeam and ProjectMember +(found in xml-fop/examples/embedding/java/embedding/model). They represent +the same data structure found in +xml-fop/examples/embedding/xml/xml/projectteam.xml. We want to serialize to XML a +project team with several members which exist as Java objects. +Therefore we created the two classes: ProjectTeamInputSource and +ProjectTeamXMLReader (in the same place as ProjectTeam above). + </p> + <p> +The XMLReader implementation (regard it as a special kind of XML parser) is +responsible for creating SAX events from the Java object. The InputSource +class is only used to hold the ProjectTeam object to be used. + </p> + <p> +Have a look at the source of ExampleObj2XML.java to find out how this is +used. For more detailed information see other resources on JAXP (ex. +<a class="fork" href="http://java.sun.com/xml/jaxp/dist/1.1/docs/tutorial/xslt/3_generate.html">An older JAXP tutorial</a>). + </p> + </section> + <section id="ExampleObj2PDF"> + <title>ExampleObj2PDF.java</title> + <p>This + <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleObj2PDF.java?view=markup"> + example</a> +combines the previous and the third to demonstrate +how you can transform a Java object to a PDF directly in one smooth run +by generating SAX events from the Java object that get fed to an XSL +transformation. The result of the transformation is then converted to PDF +using FOP as before. + </p> + <figure src="images/EmbeddingExampleObj2PDF.png" alt="Example Java object to PDF (via XML and XSL-FO)"/> + </section> + <section id="ExampleDOM2PDF"> + <title>ExampleDOM2PDF.java</title> + <p>This + <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleDOM2PDF.java?view=markup"> + example</a> +has FOP use a DOMSource instead of a StreamSource in order to +use a DOM tree as input for an XSL transformation. + </p> + </section> + <section id="ExampleSVG2PDF"> + <title>ExampleSVG2PDF.java (PDF Transcoder example)</title> + <p>This + <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleSVG2PDF.java?view=markup"> + example</a> +shows the usage of the PDF Transcoder, a sub-application within FOP. +It is used to generate a PDF document from an SVG file. + </p> + </section> + <section id="example-notes"> + <title>Final notes</title> + <p> +These examples should give you an idea of what's possible. It should be easy +to adjust these examples to your needs. Also, if you have other examples that you +think should be added here, please let us know via either the fop-users or fop-dev +mailing lists. Finally, for more help please send your questions to the fop-users +mailing list. + </p> + </section> +</section> + </body> +</document> + diff --git a/src/documentation/content/xdocs/0.94/extensions.xml b/src/documentation/content/xdocs/0.94/extensions.xml new file mode 100644 index 000000000..dd4a79535 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/extensions.xml @@ -0,0 +1,121 @@ +<?xml version="1.0" standalone="no"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!-- $Id$ --> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd"> +<document> + <header> + <title>Standard FOP Extensions</title> + <version>$Revision$</version> + </header> + <body> + <p> + By "extension", we mean any data that can be placed in the input XML document that + is not addressed by the XSL-FO standard. + By having a mechanism for supporting extensions, FOP is able to add features that + are not covered in the specification. + </p> + <p> + The extensions documented here are included with FOP, and are automatically available + to you. If you wish to add an extension of your own to FOP, please see the + <a href="../dev/extensions.html">Developers' Extension Page</a>. + </p> + <note>All extensions require the correct use of an appropriate namespace in your input document.</note> + <section id="svg"> + <title>SVG</title> + <p> + Please see the <a href="graphics.html#svg">SVG documentation</a> for more details. + </p> + </section> + <section id="fo-extensions"> + <title>FO Extensions</title> + <section id="fox-namespace"> + <title>Namespace</title> + <p> + By convention, FO extensions in FOP use the "fox" namespace prefix. + To use any of the FO extensions, add a namespace entry for + <code>http://xml.apache.org/fop/extensions</code> to the root element: + </p> + <source><![CDATA[<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format" + xmlns:fox="http://xmlgraphics.apache.org/fop/extensions">]]></source> + </section> + <section id="bookmarks"> + <title>PDF Bookmarks</title> + <p> + In previous versions of Apache FOP there was a <code>fox:outline</code> element + which was used to create outlines in PDF files. The redesigned code makes use + of the new <a href="http://www.w3.org/TR/xsl11/#fo_bookmark-tree">bookmark feature defined in the latest XSL 1.1 working draft</a>. + </p> + </section> + <section id="named-destinations"> + <title>Anchors or Named Destinations</title> + <p>This extension element hasn't been reimplemented for the redesigned code, yet.</p> + <!--p>Use the fox:destination element to define "named destinations" inside a PDF document. +These are useful as fragment identifiers, e.g. "http://server/document.pdf#anchor-name". +fox:destination elements can be placed almost anywhere in the fo document, including a child of +root, a block-level element, or an inline-level element. +For the destination to actually work, it must correspond to an "id" attribute on some fo element +within the document. In other words, the "id" attribute actually creates the "view" within the +PDF document. The fox:destination simply gives that view an independent name. +</p> + <source><![CDATA[<fox:destination internal-destination="table-of-contents"/> +... +<fo:block id="table-of-contents">Table of Contents</fo:block>]]></source> + <warning>It is possible that in some future release of FOP, <em>all </em>elements with +"id" attributes will generate named-destinations, which will eliminate the need for +fox:destination.</warning--> + </section> + <section id="table-continue-label"> + <title>Table Continuation Label</title> + <p>This extension element hasn't been reimplemented for the redesigned code, yet.</p> + <!--p>Use the fox:continued-label element to create content in table-header and +table-footer cells that will appear only on pages after the first page that the table +appears. fox:continued-label is itself inline content, and is a container of fo:inline +content. This content will be laid out only if the table does not fit on a single page and flows +to following pages. Here is an example of FO code creating such a table-header:</p> +<source><![CDATA[<fo:table-header> + <fo:table-row> + <fo:table-cell> + <fo:block>Header column 1 with continued label + <fox:continued-label><fo:inline> (cont.)</fo:inline></fox:continued-label> + </fo:block> + </fo:table-cell> + <fo:table-cell> + <fo:block>Header column 2 with no continued label</fo:block> + </fo:table-cell> + </fo:table-row> +</fo:table-header>]]></source--> + </section> + <section id="widow-orphan-content-limit"> + <title>fox:orphan-content-limit and fox:widow-content-limit</title> + <p> + The two proprietary extension properties, fox:orphan-content-limit and + fox:widow-content-limit, are used to improve the layout of list-blocks and tables. + If you have a table with many entries, you don't want a single row to be left over + on a page. You will want to make sure that at least two or three lines are kept + together. The properties take an absolute length which specifies the area at the + beginning (fox:widow-content-limit) or at the end (fox:orphan-content-limit) of a + table or list-block. The properties are inherited and only have an effect on fo:table + and fo:list-block. An example: fox:widow-content-limit="3 * 1.2em" would make sure + the you'll have at least three lines (assuming line-height="1.2") together on a table + or list-block. + </p> + </section> + </section> + </body> +</document> + diff --git a/src/documentation/content/xdocs/0.94/fonts.xml b/src/documentation/content/xdocs/0.94/fonts.xml new file mode 100644 index 000000000..f60dad000 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/fonts.xml @@ -0,0 +1,334 @@ +<?xml version="1.0" standalone="no"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!-- $Id$ --> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd"> +<document> + <header> + <title>Apache FOP: Fonts</title> + <version>$Revision$</version> + <authors> + <person name="Jeremias Märki" email=""/> + <person name="Tore Engvig" email=""/> + <person name="Adrian Cumiskey" email=""/> + </authors> + </header> + <body> + <section id="intro"> + <title>Summary</title> + <note>The FOP Font subsystem is currently undergoing a significant change. + The details provided here especially related to the generation of FOP Font + Metrics files and the FOP Font configuration are likely to change substantially + in the future. + </note> + <p>The following table summarizes the font capabilities of the various FOP renderers:</p> + <table> + <tr> + <th>Renderer</th> + <th>Base-14</th> + <th>AWT/OS</th> + <th>Custom</th> + <th>Custom Embedding</th> + </tr> + <tr> + <td>PDF</td> + <td>yes</td> + <td>no</td> + <td>yes</td> + <td>yes</td> + </tr> + <tr> + <td>PostScript</td> + <td>yes</td> + <td>no</td> + <td>yes</td> + <td>yes</td> + </tr> + <!--tr> NOT AVAILABLE YET!!! + <td>PCL</td> + <td>yes (modified)</td> + <td>no</td> + <td>no</td> + <td>no</td> + </tr--> + <tr> + <td>TXT</td> + <td>yes (used for layout but not for output)</td> + <td>no</td> + <td>yes (used for layout but not for output)</td> + <td>no</td> + </tr> + <tr> + <td>AWT</td> + <td>if available from OS</td> + <td>yes</td> + <td>yes</td> + <td>n/a (display only)</td> + </tr> + <tr> + <td>Print</td> + <td>if available from OS</td> + <td>yes</td> + <td>yes</td> + <td>controlled by OS printer driver</td> + </tr> + <tr> + <td>RTF</td> + <td>n/a (font metrics not needed)</td> + <td>n/a</td> + <td>n/a</td> + <td>n/a</td> + </tr> + <tr> + <td>MIF</td> + <td>n/a (font metrics not needed)</td> + <td>n/a</td> + <td>n/a</td> + <td>n/a</td> + </tr> + <tr> + <td>SVG</td> + <td>if available from OS</td> + <td>yes</td> + <td>no</td> + <td>no</td> + </tr> + <tr> + <td>XML</td> + <td>yes</td> + <td>no</td> + <td>yes</td> + <td>n/a</td> + </tr> + </table> + </section> + <section> + <title>Base-14 Fonts</title> + <p>The Adobe PDF Specification specifies a set of 14 fonts that must be available to every PDF reader: Helvetica (normal, bold, italic, bold italic), Times (normal, bold, italic, bold italic), Courier (normal, bold, italic, bold italic), Symbol and ZapfDingbats.</p> + </section> + <section id="awt"> + <title>AWT/Operating System Fonts</title> + <p>The AWT family of renderers (AWT, Print, SVG), use the Java AWT libraries for font metric information. Through operating system registration, the AWT libraries know what fonts are available on the system, and the font metrics for each one.</p> + </section> + <section id="custom"> + <title>Custom Fonts</title> + <p>Support for custom fonts is added by creating font metric files (written in XML) from the actual font files, and registering them with FOP. Currently only Type 1 and TrueType fonts can be added. +More information about fonts can be found at:</p> + <ul> + <li><a href="http://partners.adobe.com/asn/developer/type/ftypes.html">Adobe font types</a></li> + <li><a href="http://partners.adobe.com/asn/developer/technotes/fonts.html">Adobe Font Technote</a></li> + </ul> + <section id="type1-metrics"> + <title>Type 1 Font Metrics</title> + <p>FOP includes PFMReader, which reads the PFM file that normally comes with a Type 1 font, and generates an appropriate font metrics file for it. +To use it, run the class org.apache.fop.fonts.apps.PFMReader:</p> + <p>Windows (on JDK 1.4 and later):</p> + <source>java -cp build\fop.jar;lib\avalon-framework.jar;lib\commons-logging.jar;lib\commons-io.jar + org.apache.fop.fonts.apps.PFMReader [options] pfm-file xml-file</source> + <p>Windows (on JDK 1.3.x):</p> + <source>java -cp build\fop.jar;lib\avalon-framework.jar;lib\commons-logging.jar;lib\commons-io.jar;lib\xml-apis.jar; + lib\xercesImpl.jar;lib\xalan.jar;lib\serializer.jar + org.apache.fop.fonts.apps.PFMReader [options] pfm-file xml-file</source> + <p>Unix (on JDK 1.4 and later):</p> + <source>java -cp build/fop.jar:lib/avalon-framework.jar:lib/commons-logging.jar:lib/commons-io.jar + org.apache.fop.fonts.apps.PFMReader [options] pfm-file xml-file</source> + <p>Unix (on JDK 1.3.1):</p> + <source>java -cp build/fop.jar:lib/avalon-framework.jar:lib/commons-logging.jar:lib/commons-io.jar:lib/xml-apis.jar: + lib/xercesImpl.jar:lib/xalan.jar:lib/serializer.jar + org.apache.fop.fonts.apps.PFMReader [options] pfm-file xml-file</source> + <p>PFMReader [options]:</p> + <ul> + <li><strong>-fn <fontname></strong> By default, FOP uses the fontname from the +.pfm file when embedding the font. Use the "-fn" option to override this name with one you have +chosen. This may be useful in some cases to ensure that applications using the output document +(Acrobat Reader for example) use the embedded font instead of a local font with the same +name.</li> + </ul> + <note>The classpath in the above example has been simplified for readability. +You will have to adjust the classpath to the names of the actual JAR files in the lib directory. +xml-apis.jar, xercesImpl.jar, xalan.jar and serializer.jar are not necessary for JDK version 1.4 or later.</note> + <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> + </section> + <section id="truetype-metrics"> + <title>TrueType Font Metrics</title> + <p>FOP includes TTFReader, which reads the TTF file and generates an appropriate font metrics file for it. +Use it in a similar manner to PFMReader. +For example, to create such a metrics file in Windows from the TrueType font at c:\myfonts\cmr10.ttf:</p> + <source>java -cp build\fop.jar;lib\avalon-framework.jar;lib\commons-logging.jar;lib\commons-io.jar + org.apache.fop.fonts.apps.TTFReader [options] + C:\myfonts\cmr10.ttf ttfcm.xml</source> + <p>TTFReader [options]:</p> + <ul> + <li><strong>-d <DEBUG | INFO ></strong> Sets the debug level (default is +INFO).</li> + <li><strong>-fn <fontname></strong> Same as for PFMReader.</li> + <li><strong>-ttcname <fontname></strong> If you're reading data from a +TrueType Collection (.ttc file) you must specify which font from the collection you will read +metrics from. +If you read from a .ttc file without this option, the fontnames will be listed for you.</li> + <li><strong>-enc ansi</strong> Creates a WinAnsi-encoded font metrics file. +Without this option, a CID-keyed font metrics file is created. +The table below summarizes the differences between these two encoding options as currently +used within FOP. +Please note that this information only applies to TrueType fonts and TrueType collections:</li> + </ul> + <table id="ttf-encoding"> + <tr> + <th>Issue</th> + <th>WinAnsi</th> + <th>CID-keyed</th> + </tr> + <tr> + <td>Usable Character Set</td> + <td>Limited to WinAnsi character set, which is roughly equivalent to iso-8889-1.</td> + <td>Limited only by the characters in the font itself.</td> + </tr> + <tr> + <td>Character Encoding in the Output Document.</td> + <td>Correct.</td> + <td>Never correct. Search, index, and cut-and-paste operations in the output document +will produce incorrect results.</td> + </tr> + <tr> + <td>Character Display</td> + <td>Correct.</td> + <td>Correct, but copy/paste won't work in Acrobat Reader. (FOP currently doesn't emit the /ToUnicode table which is necessary for copy/paste to work.)</td> + </tr> + <tr> + <td>Embedding the Font</td> + <td>Optional.</td> + <td>Mandatory. Not embedding the font produces invalid PDF documents.</td> + </tr> + </table> + <warning> + You may experience failures with certain TrueType fonts, especially if they don't contain + the so-called "cmap" table. TTFReader can currently not deal with font like this. + </warning> + </section> + <section id="truetype-collections-metrics"> + <title>TrueType Collections Font Metrics</title> + <p>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.</p> + <p>To get a list of the fonts in a collection, just start the TTFReader as if it were a normal TrueType file (without the -ttcname option). +It will display all of the font names and exit with an Exception.</p> + <p>Here is an example of generating a metrics file for a .ttc file:</p> + <source>java -cp build\fop.jar;lib\avalon-framework.jar;lib\commons-logging.jar;lib\commons-io.jar + org.apache.fop.fonts.apps.TTFReader -ttcname "MS Mincho" + msmincho.ttc msminch.xml</source> + </section> + <section id="register"> + <title>Register Fonts with FOP - Auto-Detect Fonts</title> + <p>You must tell FOP how to find and use the font metrics files by registering them in the <a href="configuration.html">FOP Configuration</a>. Add entries for your custom fonts, regardless of font type, to the configuration file in a manner similar to the following:</p> + <source><![CDATA[ +<fonts> + <!-- register a particular font --> + <font metrics-url="file:///C:/myfonts/FTL_____.xml" kerning="yes" + embed-url="file:///C:/myfonts/FTL_____.pfb"> + <font-triplet name="FrutigerLight" style="normal" weight="normal"/> + </font> + + <!-- register all the fonts found in a directory --> + <directory>C:\MyFonts1</directory> + + <!-- register all the fonts found in a directory + and all of its sub directories (use with care) --> + <directory recursive="true">C:\MyFonts2</directory> + + <!-- automatically detect operating system installed fonts --> + <auto-detect/> +</fonts>]]></source> + <note> + Review the documentation for <a href="configuration.html">FOP Configuration</a> for + instructions on making the FOP configuration available to FOP when it runs. Otherwise, + FOP has no way of finding your custom font information. + </note> + The Unix autodetect feature looks in the following locations for fonts it can use: + <ul> + <li><code>java user.home + "/.fonts"</code></li> + <li><code>"/usr/local/fonts"</code></li> + <li><code>"/usr/share/fonts"</code></li> + <li><code>"/usr/X11R6/lib/X11/fonts"</code></li> + </ul> + <ul> + <li> + URLs are used to access the font metric and font files. + Relative URLs are resolved relative to the font-base property (or base) if available. + See <a href="configuration.html">FOP: Configuration</a> for more information. + </li> + <li>Either an "embed-url" or a "metrics-url" must be specified for font tag configurations.</li> + <li>The font "kerning" attribute is optional.</li> + <li>If embedding is off, the output will position the text correctly (from the metrics file), but it will not be displayed or printed correctly unless the viewer has the applicable font available to their local system.</li> + <li>When setting the "embed-url" attribute for Type 1 fonts, be sure to specify the PFB (actual font data), not PFM (font metrics) file that you used to generate the XML font metrics file.</li> + <li>The fonts "directory" tag can be used to register fonts contained within a single or list of directory paths. The "recursive" attribute can be specified to recursively add fonts from all sub directories.</li> + <li>The fonts "auto-detect" tag can be used to automatically register fonts that are found to be installed on the native operating system.</li> + <li>Fonts registered with "font" tag configurations override fonts found by means of "directory" tag definitions.</li> + <li>Fonts found as a result of a "directory" tag configuration override fonts found as a result of the "auto-detect" tag being specified.</li> + <li> + 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. + </li> + </ul> + <!--note>Cocoon users will need to setup the config, see FOPSerializer for more information.</note--> + </section> + <section id="embedding"> + <title>Embedding</title> + <note>The PostScript renderer does not yet support TrueType fonts, but can embed Type 1 fonts.</note> + <note>The font is simply embedded into the PDF file, it is not converted.</note> + <p>Font embedding is enabled in the userconfig.xml file and controlled by the embed-url attribute. +If you don't specify the embed-url attribute the font will not be embedded, but will only be referenced.</p> + <warning> + Omitting the embed-url attribute for CID-encoded TrueType fonts will currently produce invalid + PDF files! If you create the XML font metric file using the "-enc ansi" option, you can omit + the embed-url attribute for TrueType fonts but you're restricted to the WinAnsi character set. + </warning> + <p>When FOP embeds a font, it adds a prefix to the fontname to ensure that the name will not match the fontname of an installed font. +This is helpful with older versions of Acrobat Reader that preferred installed fonts over embedded fonts.</p> + <p>When embedding PostScript fonts, the entire font is always embedded.</p> + <p>When embedding TrueType fonts (ttf) or TrueType Collections (ttc), a subset of the + original font, containing only the glyphs used, is embedded in the output document.</p> + </section> + <section id="embedding-base14"> + <title>Explicitly embedding the base 14 fonts</title> + <p> + There are cases where you might want to force the embedding of one or more of the base 14 fonts that + can normally be considered available on the target platform (viewer, printer). One of these cases is + PDF/A which mandates the embedding of even the base 14 fonts. Embedding a font such as Helvetica or + Courier is straight-forward. The "Symbol" and "ZapfDingbats" fonts, however, currently present a + problem because FOP cannot correctly determine the encoding of these two single-byte fonts through + the PFM file. FOP now correctly interprets the "encoding" value in the XML font metrics file, but the + PFMReader application writes "UnknownEncoding" to the generated XML file. In order to embed "Symbol" + and "ZapfDingbats" you have to manually change the XML font metrics file and specify "SymbolEncoding" + or "ZapfdingbatsEncoding" encoding respectively as the value for the "encoding" element. + </p> + <p>Example:</p> + <source><![CDATA[ +<?xml version="1.0" encoding="UTF-8"?> +<font-metrics type="TYPE1"> + <font-name>Symbol</font-name> + <embed/> + <encoding>SymbolEncoding</encoding> + <cap-height>673</cap-height> + <x-height>766</x-height> + [..]]]></source> + </section> + </section> + </body> +</document> diff --git a/src/documentation/content/xdocs/0.94/fotree/disabled-testcases.xml b/src/documentation/content/xdocs/0.94/fotree/disabled-testcases.xml new file mode 100644 index 000000000..196eafcc4 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/fotree/disabled-testcases.xml @@ -0,0 +1,31 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!-- $Id$ --> +<disabled-testcases> + <testcase> + <name>demo test failure</name> + <file>demo-test-failure.fo</file> + <description></description> + </testcase> + <testcase> + <name>Markers and core function evaluation</name> + <file>from-table-column_marker.fo</file> + <description>The code currently evaluates this function according to the column in which the + marker appears in the source document, rather than the column it is retrieved in.</description> + </testcase> +</disabled-testcases> diff --git a/src/documentation/content/xdocs/0.94/graphics.xml b/src/documentation/content/xdocs/0.94/graphics.xml new file mode 100644 index 000000000..164069733 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/graphics.xml @@ -0,0 +1,401 @@ +<?xml version="1.0" standalone="no"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!-- $Id$ --> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd"> +<document> + <header> + <title>Apache FOP: Graphics Formats</title> + <version>$Revision$</version> + </header> + <body> + <section id="support-overview"> + <title>Overview of Graphics Support</title> + <p> + The table below summarizes the <em>theoretical</em> support for graphical formats within FOP. In other words, within the constraints of the limitations listed here, these formats <em>should</em> work. However, many of them have not been tested, and there may be limitations that have not yet been discovered or documented. The packages needed to support some formats are not included in the FOP distribution and must be installed separately. Follow the links in the "Support Thru" column for more details. + </p> + <table> + <tr> + <th>Format</th> + <th>Type</th> + <th><a href="#native">FOP native support</a></th> + <th><a href="#batik">Batik SVG</a></th> + <th><a href="#batik-codecs">Batik codecs</a></th> + <th><a href="#imageio">Image I/O</a></th> + <th><a href="#jai">JAI</a></th> + <th><a href="#jimi">JIMI</a></th> + </tr> + <tr> + <td><a href="#bmp">BMP</a> (Microsoft Windows Bitmap)</td> + <td>bitmap</td> + <td>X</td> + <td></td> + <td></td> + <td></td> + <td></td> + <td></td> + </tr> + <tr> + <td><a href="#eps">EPS</a> (Encapsulated PostScript)</td> + <td>metafile (both bitmap and vector), probably most frequently used for vector drawings</td> + <td>(X)</td> + <td></td> + <td></td> + <td></td> + <td></td> + <td></td> + </tr> + <tr> + <td>GIF (Graphics Interchange Format)</td> + <td>bitmap</td> + <td>X</td> + <td></td> + <td></td> + <td>X</td> + <td>X</td> + <td>X</td> + </tr> + <tr> + <td><a href="#jpeg">JPEG</a> (Joint Photographic Experts Group)</td> + <td>bitmap</td> + <td>(X)</td> + <td></td> + <td></td> + <td>X</td> + <td></td> + <td></td> + </tr> + <tr> + <td><a href="#png">PNG</a> (Portable Network Graphic)</td> + <td>bitmap</td> + <td></td> + <td></td> + <td>X</td> + <td>X</td> + <td></td> + <td></td> + </tr> + <tr> + <td><a href="#svg">SVG</a> (Scalable Vector Graphics)</td> + <td>vector (with embedded bitmaps)</td> + <td></td> + <td>X</td> + <td></td> + <td></td> + <td></td> + <td></td> + </tr> + <tr> + <td><a href="#tiff">TIFF</a> (Tag Image Format File)</td> + <td>bitmap</td> + <td>(X)</td> + <td></td> + <td>X</td> + <td>X</td> + <td>X</td> + <td></td> + <!--td><a href="#native">FOP native</a> or <a href="#jai">JAI</a>, depending on the subformat. See <a href="#tiff">TIFF</a> for more details.(JIMI also supports TIFF, but this has not been implemented within FOP).</td--> + </tr> + <tr> + <td><a href="#emf">EMF</a> (Windows Enhanced Metafile)</td> + <td>vector (with embedded bitmaps)</td> + <td>(X)</td> + <td></td> + <td></td> + <td></td> + <td></td> + <td></td> + </tr> + </table> + <note>"(X)" means restricted support. Please see the details below.</note> + </section> + <section id="packages"> + <title>Graphics Packages</title> + <section id="native"> + <title>FOP Native</title> + <p> + FOP has native ability to handle some graphic file formats. + </p> + </section> + <section id="batik-codecs"> + <title>"Internal" codecs</title> + <p> + Apache XML Graphics Commons contains codecs for PNG and TIFF access. FOP can use these. + </p> + </section> + <section id="imageio"> + <title>Image I/O (JDK 1.4 or higher)</title> + <p> + For JDKs 1.4 or higher, FOP provides a wrapper to load images through the + <a class="fork" href="http://java.sun.com/j2se/1.4.2/docs/guide/imageio/index.html">JDK's Image I/O API</a> (JSR 015). + Image I/O allows to dynamically add additional image codecs. An example of such an add-on library are the + <a class="fork" href="http://java.sun.com/products/java-media/jai/">JAI Image I/O Tools</a> available from Sun. + </p> + </section> + <section id="jimi"> + <title>JIMI</title> + <p> + Because of licensing issues, the JIMI image library is not included in the FOP distribution. First, <a class="fork" href="http://java.sun.com/products/jimi">download</a> and install it. +Then, copy the file "JimiProClasses.zip" from the archive to {fop-install-dir}/lib/jimi-1.0.jar. Please note that FOP binary distributions are compiled with JIMI support, so there is no need for you to build FOP to add the support. If jimi-1.0.jar is installed in the right place, it will automatically be used by FOP, otherwise it will not. + </p> + </section> + <section id="jai"> + <title>JAI (Java Advanced Imaging API)</title> + <p> + FOP has been compiled with JAI support, but JAI is not included in the FOP distribution. +To use it, install <a href="http://java.sun.com/products/java-media/jai">JAI</a>, then copy the jai_core.jar and the jai_codec.jar files to {fop-install-dir}/lib. +JAI is much faster than JIMI, but is not available for all platforms. See <a href="http://java.sun.com/products/java-media/jai/forDevelopers/jaifaq.html#platforms">What platforms are supported?</a> on the JAI FAQ page for more details. + </p> + </section> + <section id="batik"> + <title>Apache Batik</title> + <p>Current FOP distributions include a distribution of the Apache <a class="fork" href="ext:batik">Batik</a> version 1.6. +It is automatically installed with FOP. +Because Batik's API changes frequently, it is highly recommended that you use the version that ships with FOP, at least when running FOP.</p> + <warning>Batik must be run in a graphical environment.</warning> + <p>Batik must be run in a graphical environment. +It uses AWT classes for rendering SVG, which in turn require an X server on Unixish systems. +If you run a server without X, or if you can't connect to the X server due to security restrictions or policies (a so-called "headless" environment), SVG rendering will fail.</p> + <p>Here are some workarounds:</p> + <ul> + <li>If you are using JDK 1.4, start it with the <code>-Djava.awt.headless=true</code> command line option.</li> + <li>Install an X server which provides an in-memory framebuffer without actually using a screen device or any display hardware. One example is Xvfb.</li> + <li>Install a toolkit which emulates AWT without the need for an underlying X server. One example is the <a href="http://www.eteks.com/pja/en">PJA toolkit</a>, which is free and comes with detailed installation instructions.</li> + </ul> + </section> + </section> + <section id="bmp"> + <title>BMP</title> + <p>FOP native support for BMP images is limited to the RGB color-space.</p> + </section> + <section id="eps"> + <title>EPS</title> + <p>FOP provides support for two output targets:</p> + <ul> + <li>PostScript (full support).</li> + <li> + PDF (partial support). Due to the lack of a built-in PostScript interpreter, FOP + can only embed the EPS file into the PDF. Acrobat Reader will not currently display + the EPS (it doesn't have a PostScript interpreter, either) but it will be shown + correctly when you print the PDF on a PostScript-capable printer. PostScript devices + (including GhostScript) will render the EPS correctly. + </li> + </ul> + <warning> + Please note that the EPS embedding feature has been <strong>deprecated</strong> in the + PDF specification version 1.4. You should not use this feature anymore, especially + since newer PDF tools don't support embedded EPS files anymore. + </warning> + <p> + Other output targets can't be supported at the moment because + FOP lacks a PostScript interpreter. Furthermore, FOP is not able + to parse the preview bitmaps sometimes contained in EPS files. + </p> + </section> + <section id="jpeg"> + <title>JPEG</title> + <p> + FOP native support 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. + </p> + </section> + <section id="png"> + <title>PNG</title> + <p> + If using JAI for PNG support, only RGB and RGBA color-spaces are supported for + FOP rendering. + </p> + <p> + Transparency is supported but not guaranteed to work with every output format. + </p> + </section> + <section id="svg"> + <title>SVG</title> + <section id="svg-intro"> + <title>Introduction</title> + <p>FOP uses <a href="#batik"> Apache Batik</a> for SVG support. +This format can be handled as an <code>fo:instream-foreign-object</code> or in a separate +file referenced with <code>fo:external-graphic</code>.</p> + <note> +Batik's SVG Rasterizer utility may also be used to convert standalone SVG +documents into PDF. For more information please see the +<a href="http://xmlgraphics.apache.org/batik/svgrasterizer.html">SVG Rasterizer documentation</a> +on the Batik site. + </note> + </section> + <section id="svg-pdf-graphics"> + <title>Placing SVG Graphics into PDF</title> + <p> +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 will be converted to a bitmap +image. + </p> + <p> +There are a number of SVG things that cannot be converted directly into +PDF. Parts of the graphic such as effects, patterns and images are inserted +into the PDF as a raster graphic. The resolution of these raster images can + be controlled through the "target resolution" setting in the + <a href="configuration.html">configuration</a>.</p> + <p> +Currently transparency is limited in PDF so many svg images that +contain effects or graphics with transparent areas may not be displayed +correctly. + </p> + </section> + <section id="svg-pdf-text"> + <title>Placing SVG Text into PDF and PostScript</title> + <p>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 <a href="../dev/svg/text.svg">text.svg</a> / +<!--link href="../dev/svg/text.pdf"-->text.pdf<!--/link--> +shows how various types and effects with text are handled. +Note that tspan and outlined text are not yet implemented.</p> + <p> +Otherwise, text is converted and drawn as a set of shapes by Batik, using the stroking text painter. +This means that a typical character will +have about 10 curves (each curve consists of at least 20 characters). +This can make the output files large and when it is viewed the +viewer may not normally draw those fine curves very well (In Adobe Acrobat, turning on +"Smooth Line Art" in the preferences will fix this). +If the text is inserted into the output file using the inbuilt text commands +it will use a single character. + </p> + <p> + 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.</p> + </section> + <section id="svg-scaling"> + <title>Scaling</title> + <p> + Currently, SVG images are rendered with the dimensions specified <em>in the SVG + file</em>, 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. FOP will probably implement a scaling + mechanism in the future. + </p> + <p> + If you use pixels to specify the size of an SVG graphic the "source resolution" setting + in the <a href="configuration.html">configuration</a> 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. + </p> + </section> + <section id="svg-problems"> + <title>Known Problems</title> + <ul> + <li> +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. + </li> + <li> +There is some problem with a gradient inside a pattern causing a PDF +error when viewed in acrobat 5. + </li> + <li> +Text is not always handled correctly, it may select the wrong font +especially if characters have multiple fonts in the font list. + </li> + <li> +More PDF text handling could be implemented. +It could draw the string using the attributed character iterator +to handle tspans and other simple changes of text. + </li> + <li> +JPEG images are not inserted directly into the pdf document. +This area has not been implemented yet since the appropriate +method in batik is static. + </li> + <li> +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. + </li> + </ul> + </section> + </section> + <section id="tiff"> + <title>TIFF</title> + <p> + FOP-native TIFF support is limited to PDF and PostScript output only. Also, + according to user reports, FOP's native support for TIFF is limited to images with the + following characteristics (all must be true for successful rendering): + </p> + <ul> + <li>single channel images (i.e., bi-level and grayscale only)</li> + <li>uncompressed images, or images using CCITT T.4, CCITT T.6, or JPEG compression</li> + <li>images using white-is-zero encoding in the TIFF PhotometricInterpretation tag</li> + </ul> + <note> + Native support in this case means that the images can be embedded into the output format + without decoding it. + </note> + <p><em>JAI:</em> Supports RGB and RGBA only for FOP rendering.</p> + </section> + <section id="emf"> + <title>EMF</title> + <p>Windows Enhanced Metafiles (EMF) are only supported in RTF output.</p> + </section> + <section id="resolution"> + <title>Graphics Resolution</title> + <p> + Some bitmapped image file formats store a dots-per-inch (dpi) or other resolution + values. FOP tries to use this resolution information whenever possible to determine + the image's intrinsic size. This size is used during the layout process when it is not + superceeded by an explicit size on fo:external-graphic (content-width and content-height + properties). + </p> + <p> + Please note that not all images contain resolution information. If it's not available + 72 dpi is assumed (the default resolution of PDF and PostScript). + </p> + <p> + Bitmap images are generally embedded into the output format at their original resolution + (as is). No resampling of the image is performed. Explicit resampling is on our wishlist, + but hasn't been implemented, yet. Bitmaps included in SVG graphics may be resampled to + the resolution specified in the "target resolution" setting in the + <a href="configuration.html">configuration</a> if SVG filters are applied. This can be + used as a work-around to resample images in FO documents. + </p> + </section> + <section id="caching"> + <title>Image caching</title> + <p> + FOP caches images between runs. There is one cache per FopFactory instance. The URI is + used as a key to identify images which means that when a particular URI appears again, + the image is taken from the cache. If you have a servlet that generates a different + image each time it is called with the same URL you need to use a constantly + changing dummy parameter on the URL to avoid caching. + </p> + <p> + The image cache has been improved considerably in the redesigned code. Therefore, a + resetCache() method like in earlier versions of FOP has become unnecessary. If you + still experience OutOfMemoryErrors, please notify us. + </p> + </section> + </body> +</document> diff --git a/src/documentation/content/xdocs/0.94/hyphenation.xml b/src/documentation/content/xdocs/0.94/hyphenation.xml new file mode 100644 index 000000000..ed97c6868 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/hyphenation.xml @@ -0,0 +1,237 @@ +<?xml version="1.0" standalone="no"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!-- $Id$ --> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd"> +<document> + <header> + <title>Apache FOP: Hyphenation</title> + <version>$Revision$</version> + </header> + <body> + <section id="support"> + <title>Hyphenation Support</title> + <section id="intro"> + <title>Introduction</title> + <p>FOP uses Liang's hyphenation algorithm, well known from TeX. It needs + language specific pattern and other data for operation.</p> + <p>Because of <a href="#license-issues">licensing issues</a> (and for + convenience), all hyphenation patterns for FOP are made available through + the <a class="fork" href="http://offo.sourceforge.net/hyphenation/index.html">Objects For + Formatting Objects</a> project.</p> + <note>If you have made improvements to an existing FOP hyphenation pattern, + or if you have created one from scratch, please consider contributing these + to OFFO so that they can benefit other FOP users as well. + Please inquire on the <a href="../maillist.html#fop-user">FOP User + mailing list</a>.</note> + </section> + <section id="license-issues"> + <title>License Issues</title> + <p>Many of the hyphenation files distributed with TeX and its offspring are + licenced under the <a class="fork" href="http://www.latex-project.org/lppl.html">LaTeX + Project Public License (LPPL)</a>, which prevents them from being + distributed with Apache software. The LPPL puts restrictions on file names + in redistributed derived works which we feel can't guarantee. Some + hyphenation pattern files have other or additional restrictions, for + example against use for commercial purposes.</p> + <p>Although Apache FOP cannot redistribute hyphenation pattern files that do + not conform with its license scheme, that does not necessarily prevent users + from using such hyphenation patterns with FOP. However, it does place on + the user the responsibility for determining whether the user can rightly use + such hyphenation patterns under the hyphenation pattern license.</p> + <warning>The user is responsible to settle license issues for hyphenation + pattern files that are obtained from non-Apache sources.</warning> + </section> + <section id="sources"> + <title>Sources of Custom Hyphenation Pattern Files</title> + <p>The most important source of hyphenation pattern files is the + <a class="fork" href="http://www.ctan.org/tex-archive/language/hyphenation/">CTAN TeX + Archive</a>.</p> + </section> + <section id="install"> + <title>Installing Custom Hyphenation Patterns</title> + <p>To install a custom hyphenation pattern for use with FOP:</p> + <ol> + <li>Convert the TeX hyphenation pattern file to the FOP format. The FOP + format is an xml file conforming to the DTD found at + <code>{fop-dir}/hyph/hyphenation.dtd</code>.</li> + <li>Name this new file following this schema: + <code>languageCode_countryCode.xml</code>. The country code is + optional, and should be used only if needed. For example: + <ul> + <li><code>en_US.xml</code> would be the file name for American + English hyphenation patterns.</li> + <li><code>it.xml</code> would be the file name for Italian + hyphenation patterns.</li> + </ul> + The language and country codes must match the XSL-FO input, which + follows <a href="http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt">ISO + 639</a> (languages) and <a href="http://www.ics.uci.edu/pub/ietf/http/related/iso3166.txt">ISO + 3166</a> (countries). NOTE: The ISO 639/ISO 3166 convention is that + language names are written in lower case, while country codes are written + in upper case. FOP does not check whether the language and country specified + in the FO source are actually from the current standard, but it relies + on it being two letter strings in a few places. So you can make up your + own codes for custom hyphenation patterns, but they should be two + letter strings too (patches for proper handling extensions are welcome)</li> + <li>There are basically three ways to make the FOP-compatible hyphenation pattern + file(s) accessible to FOP: + <ul> + <li>Download the precompiled JAR from <a class="fork" href="http://offo.sourceforge.net/hyphenation/index.html">OFFO + </a> and place it either in the <code>{fop-dir}/lib</code> directory, or + in a directory of your choice (and append the full path to the JAR to + the environment variable <code>FOP_HYPHENATION_PATH</code>).</li> + <li>Download the desired FOP-compatible hyphenation pattern file(s) from + <a class="fork" href="http://offo.sourceforge.net/hyphenation/index.html">OFFO</a>, + and/or take your self created hyphenation pattern file(s), + <ul> + <li>place them in the directory <code>{fop-dir}/hyph</code>, </li> + <li>or place them in a directory of your choice and set the Ant variable + <code>user.hyph.dir</code> to point to that directory (in + <code>build-local.properties</code>),</li> + </ul> + and run Ant with build target + <code>jar-hyphenation</code>. This will create a JAR containing the + compiled patterns in <code>{fop-dir}/build</code> that will be added to the + classpath on the next run. + (When FOP is built from scratch, and there are pattern source file(s) + present in the directory pointed to by the + <code>user.hyph.dir</code> variable, this JAR will automatically + be created from the supplied pattern(s)).</li> + <li>Put the pattern source file(s) into a directory of your choice and + configure FOP to look for custom patterns in this directory, by setting the + <a href="configuration.html"><hyphenation-base></a> + configuration option.</li> + </ul> + </li> + </ol> + <warning> + Either of these three options will ensure hyphenation is working when using + FOP from the command-line. If FOP is being embedded, remember to add the location(s) + of the hyphenation JAR(s) to the CLASSPATH (option 1 and 2) or to set the + <a href="configuration.html#hyphenation-dir"><hyphenation-dir></a> + configuration option programmatically (option 3). + </warning> + </section> + </section> + <section id="patterns"> + <title>Hyphenation Patterns</title> + <p>If you would like to build your own hyphenation pattern files, or modify + existing ones, this section will help you understand how to do so. Even + when creating a pattern file from scratch, it may be beneficial to start + with an existing file and modify it. See <a class="fork" href="http://offo.sourceforge.net/hyphenation/index.html"> + OFFO's Hyphenation page</a> for examples. + Here is a brief explanation of the contents of FOP's hyphenation patterns:</p> + <warning>The remaining content of this section should be considered "draft" + quality. It was drafted from theoretical literature, and has not been + tested against actual FOP behavior. It may contain errors or omissions. + Do not rely on these instructions without testing everything stated here. + If you use these instructions, please provide feedback on the + <a href="../maillist.html#fop-user">FOP User mailing list</a>, either + confirming their accuracy, or raising specific problems that we can + address.</warning> + <ul> + <li>The root of the pattern file is the <hyphenation-info> element.</li> + <li><hyphen-char>: its attribute "value" contains the character signalling + a hyphen in the <exceptions> section. It has nothing to do with the + hyphenation character used in FOP, use the XSLFO hyphenation-character + property for defining the hyphenation character there. At some points + a dash U+002D is hardwired in the code, so you'd better use this too + (patches to rectify the situation are welcome). There is no default, + if you declare exceptions with hyphenations, you must declare the + hyphen-char too.</li> + <li><hyphen-min> contains two attributes: + <ul> + <li>before: the minimum number of characters in a word allowed to exist + on a line immediately preceding a hyphenated word-break.</li> + <li>after: the minimum number of characters in a word allowed to exist + on a line immediately after a hyphenated word-break.</li> + </ul> + This element is unused and not even read. It should be considered a + documentation for parameters used during pattern generation. + </li> + <li><classes> contains whitespace-separated character sets. The members + of each set should be treated as equivalent for purposes of hyphenation, + usually upper and lower case of the same character. The first character + of the set is the canonical character, the patterns and exceptions + should only contain these canonical representation characters (except + digits for weight, the period (.) as word delimiter in the patterns and + the hyphen char in exceptions, of course).</li> + <li><exceptions> contains whitespace-separated words, each of which + has either explicit hyphen characters to denote acceptable breakage + points, or no hyphen characters, to indicate that this word should + never be hyphenated, or contain explicit <hyp> elements for specifying + changes of spelling due to hyphenation (like backen -> bak-ken or + Stoffarbe -> Stoff-farbe in the old german spelling). Exceptions override + the patterns described below. Explicit <hyp> declarations don't work + yet (patches welcome). Exceptions are generally a bit brittle, test + carefully.</li> + <li><patterns> includes whitespace-separated patterns, which are what + drive most hyphenation decisions. The characters in these patterns are + explained as follows: + <ul> + <li>non-numeric characters represent characters in a sub-word to be + evaluated</li> + <li>the period character (.) represents a word boundary, i.e. either + the beginning or ending of a word</li> + <li>numeric characters represent a scoring system for indicating the + acceptability of a hyphen in this location. Odd numbers represent an + acceptable location for a hyphen, with higher values overriding lower + inhibiting values. Even numbers indicate an unacceptable location, with + higher values overriding lower values indicating an acceptable position. + A value of zero (inhibiting) is implied when there is no number present. + Generally patterns are constructed so that valuse greater than 4 are rare. + Due to a bug currently patterns with values of 8 and greater don't + have an effect, so don't wonder.</li> + </ul> + Here are some examples from the English patterns file: + <ul> + <li>Knuth (<em>The TeXBook</em>, Appendix H) uses the example <strong>hach4</strong>, which indicates that it is extremely undesirable to place a hyphen after the substring "hach", for example in the word "toothach-es".</li> + <li><strong>.leg5e</strong> indicates that "leg-e", when it occurs at the beginning of a word, is a very good place to place a hyphen, if one is needed. Words like "leg-end" and "leg-er-de-main" fit this pattern.</li> + </ul> + Note that the algorithm that uses this data searches for each of the word's substrings in the patterns, and chooses the <em>highest</em> value found for letter combination. + </li> + </ul> + <p>If you want to convert a TeX hyphenation pattern file, you have to undo + the TeX encoding for non-ASCII text. FOP uses Unicode, and the patterns + must be proper Unicode too. You should be aware of the XML encoding issues, + preferably use a good Unicode editor.</p> + <p>Note that FOP does not do Unicode character normalization. If you use + combining chars for accents and other character decorations, you must + declare character classes for them, and use the same sequence of base character + and combining marks in the XSLFO source, otherwise the pattern wouldn't match. + Fortunately, Unicode provides precomposed characters for all important cases + in common languages, until now nobody run seriously into this issue. Some dead + languages and dialects, especially ancient ones, may pose a real problem + though.</p> + <p>If you want to generate your own patterns, an open-source utility called + patgen is available on many Unix/Linux distributions and every TeX + distribution which can be used to assist in + creating pattern files from dictionaries. Pattern creation for languages like + english or german is an art. If you can, read Frank Liang's original paper + "Word Hy-phen-a-tion by Com-pu-ter" (yes, with hyphens). It is not available + online. The original patgen.web source, included in the TeX source distributions, + contains valuable comments, unfortunately technical details obscure often the + high level issues. Another important source is + <a class="fork" href="http://www.ctan.org/tex-archive/systems/knuth/tex/texbook.tex">The + TeX Book</a>, appendix H (either read the TeX source, or run it through + TeX to typeset it). Secondary articles, for example the works by Petr Sojka, + may also give some much needed insight into problems arising in automated + hyphenation.</p> + </section> + </body> +</document> diff --git a/src/documentation/content/xdocs/0.94/index.xml b/src/documentation/content/xdocs/0.94/index.xml new file mode 100644 index 000000000..750047678 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/index.xml @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!-- $Id$ --> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd"> +<document> + <header> + <title>Apache FOP Version 0.94</title> + <version>$Revision: 201586 $</version> + </header> + <body> + <section id="intro"> + <title>Introduction</title> + <p> + The Apache FOP team is proud to present to you this production quality release. + We're still in the process of adding new features. We welcome any feedback you + might have and even more, any other form of help to get the project forward. + </p> + <p> + This fifth release contains many bug fix release and new features compared + to 0.92beta. To see what has changed since the last release, please visit the + <a href="changes_0.94.html">Changes Page</a> and the <a href="releaseNotes_0.94.html">Release Notes</a>. + </p> + </section> + <section id="upgrading"> + <title>Upgrading from an earlier version</title> + <p> + If you're upgrading to this version from an earlier version of FOP, please read the + information contained on the <a href="upgrading.html">Upgrading page</a>! + </p> + </section> + <section id="download"> + <title>Download</title> + <p> + To download this version, please visit the <a href="../download.html">download page</a>. + </p> + </section> + </body> +</document> diff --git a/src/documentation/content/xdocs/0.94/intermediate.xml b/src/documentation/content/xdocs/0.94/intermediate.xml new file mode 100644 index 000000000..4744185aa --- /dev/null +++ b/src/documentation/content/xdocs/0.94/intermediate.xml @@ -0,0 +1,146 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!-- $Id$ --> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd"> +<document> + <header> + <title>Intermediate Format</title> + <version>$Revision$</version> + </header> + <body> + <note> + Please note that the intermediate format is an <strong>advanced feature</strong> and can be ignored by most + users of Apache FOP. + </note> + <section id="introduction"> + <title>Introduction</title> + <p> + The intermediate format (IF) is a proprietary XML format that represents the area tree + generated by the layout engine. The area tree is conceptually defined in the + <a href="http://www.w3.org/TR/2001/REC-xsl-20011015/slice1.html#section-N742-Formatting">XSL-FO specification in chapter 1.1.2</a>. + The IF can be generated through the area tree XML Renderer (the XMLRenderer). + </p> + <p> + The intermediate format can be used to generate intermediate documents that are modified + before they are finally rendered to their ultimate output format. Modifications include + adjusting and changing trait values, adding or modifying area objects, inserting prefabricated + pages, overlays, imposition (n-up, rotation, scaling etc.). Multiple IF files can be combined + to a single output file. + </p> + </section> + <section id="usage"> + <title>Usage of the Intermediate Format</title> + <p> + As already mentioned, the IF is generated by using the <strong>XMLRenderer</strong> (MIME type: + <strong>application/X-fop-areatree</strong>). So, you basically set the right MIME type for + the output format and process your FO files as if you would create a PDF file. However, there + is an important detail to consider: The various Renderers don't all use the same font sources. + To be able to create the right area tree for the ultimate output file, you need to create + the IF file using the right font setup. This is achieved by telling the XMLRenderer to mimic + another renderer. This is done by calling the XMLRenderer's mimicRenderer() method with an + instance of the ultimate target renderer as the single parameter. This has a consequence: An + IF file rendered with the Java2DRenderer may not look as expected when it was actually generated + for the PDF renderer. For renderers that use the same font setup, this restriction does not + apply (PDF and PS, for example). Generating the intermediate format file is the first step. + </p> + <p> + The second step is to reparse the IF file using the <strong>AreaTreeParser</strong> which is + found in the org.apache.fop.area package. The pages retrieved from the IF file are added to an + AreaTreeModel instance from where they are normally rendered using one of the available Renderer + implementations. You can find examples for the IF processing in the + <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/"><code>examples/embedding</code></a> + directory in the FOP distribution + </p> + <p> + The basic pattern to parse the IF format looks like this: + </p> + <source><![CDATA[ +FopFactory fopFactory = FopFactory.newInstance(); + +// Setup output +OutputStream out = new java.io.FileOutputStream(pdffile); +out = new java.io.BufferedOutputStream(out); +try { + //Setup fonts and user agent + FontInfo fontInfo = new FontInfo(); + FOUserAgent userAgent = fopFactory.newFOUserAgent(); + + //Construct the AreaTreeModel that will received the individual pages + AreaTreeModel treeModel = new RenderPagesModel(userAgent, + MimeConstants.MIME_PDF, fontInfo, out); + + //Parse the IF file into the area tree + AreaTreeParser parser = new AreaTreeParser(); + Source src = new StreamSource(myIFFile); + parser.parse(src, treeModel, userAgent); + + //Signal the end of the processing. The renderer can finalize the target document. + treeModel.endDocument(); +} finally { + out.close(); +}]]></source> + <p> + This example simply reads an IF file and renders it to a PDF file. Please note, that in normal + FOP operation you're shielded from having to instantiate the FontInfo object yourself. This + is normally a task of the AreaTreeHandler which is not present in this scenario. The same + applies to the AreaTreeModel instance, in this case an instance of a subclass called + RenderPagesModel. RenderPagesModel is ideal in this case as it has very little overhead + processing the individual pages. An important line in the example is the call to + <code>endDocument()</code> on the AreaTreeModel. This lets the Renderer know that the processing + is now finished. + </p> + <p> + The intermediate format can also be used from the <a href="running.html#standalone-start">command-line</a> + by using the "-atin" parameter for specifying the area tree XML as input file. You can also + specify a "mimic renderer" by inserting a MIME type between "-at" and the output file. + </p> + <section id="concat"> + <title>Concatenating Documents</title> + <p> + This initial example is obviously not very useful. It would be faster to create the PDF file + directly. As the <a href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/ExampleConcat.java">ExampleConcat.java</a> + example shows you can easily parse multiple IF files in a row and add the parsed pages to the + same AreaTreeModel instance which essentially concatenates all the input document to one single + output document. + </p> + </section> + <section id="modifying"> + <title>Modifying Documents</title> + <p> + One of the most important use cases for the intermediate format is obviously modifying the area + tree XML before finally rendering it to the target format. You can easily use XSLT to process + the IF file according to your needs. Please note, that we will currently not formally describe + the intermediate format. You need to have a good understanding its structure so you don't + create any non-parseable files. We may add an XML Schema and more detailed documentation at a + later time. You're invited to help us with that. + </p> + </section> + <section id="advanced"> + <title>Advanced Use</title> + <p> + The generation of the intermediate format as well as it parsing process has been designed to allow + for maximum flexibility and optimization. Please note that you can call <code>setTransformerHandler()</code> on + XMLRenderer to give the XMLRenderer your own TransformerHandler instance in case you would like to + do custom serialization (to a W3C DOM, for example) and/or to directly modify the area tree using + XSLT. The AreaTreeParser on the other side allows you to retrieve a ContentHandler instance where + you can manually send SAX events to to start the parsing process (see <code>getContentHandler()</code>). + </p> + </section> + </section> + </body> +</document> diff --git a/src/documentation/content/xdocs/0.94/known-issues.xml b/src/documentation/content/xdocs/0.94/known-issues.xml new file mode 100644 index 000000000..27ae55494 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/known-issues.xml @@ -0,0 +1,94 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!-- $Id$ --> +<known-issues> + <known-issue> + MIF and SVG output support have not been restored, yet. + </known-issue> + <known-issue> + Java2D/AWT support has been improved, but some problems remain, + for example with block-containers. + </known-issue> + <known-issue> + Auto table layout is not implemented, yet. + </known-issue> + <known-issue> + Footnotes may overlap with text of the region-body in multi-column + documents. + </known-issue> + <known-issue> + Space resolution does not work between footnote regions. + </known-issue> + <known-issue> + There's a problem involving nested block-containers and + reference-orientation 180/-180 (<a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=36391">Bugzilla #36391</a>) + </known-issue> + <known-issue> + block-containers with no height currently don't create a fence for + spaces as they should (they behave like a normal block). + </known-issue> + <known-issue> + Preserved linefeeds in fo:character are not handled correctly. + </known-issue> + <known-issue> + An empty block currently produces a fence for stacking constraints + which it shouldn't. + </known-issue> + <known-issue> + There are several small problems around white space handling. + </known-issue> + <known-issue> + Images currently don't shrink so they fit on a page when they are + too big and shrinking is allowed to happen. + </known-issue> + <known-issue> + inline-container may not work as expected. + </known-issue> + <known-issue> + letter-spacing and word-spacing properties may not work as expected. + </known-issue> + <known-issue> + leaders with leader-pattern="use-content" may not work as expected. + </known-issue> + <known-issue> + keep-with-previous doesn't work inside tables and lists, yet. + </known-issue> + <known-issue> + If two consecutive pages don't have the same available width, the + content currently isn't properly fit into the available space on + the new page. + </known-issue> + <known-issue> + background-images on page-number-citations are not placed correctly. + </known-issue> + <known-issue> + Not all FO elements can be referenced by their "id", most notably: + table-body, table-header, table-footer and table-row. + </known-issue> + <known-issue> + The backgrounds of table-body, table-header, table-footer and + table-column are not painted, yet. + </known-issue> + <known-issue> + Border and padding conditionality are not supported on table-cells, yet. + </known-issue> + <known-issue> + Column balancing in multi-column documents may not work as expected + (<a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=36356">Bugzilla #36356</a>) + </known-issue> +</known-issues> diff --git a/src/documentation/content/xdocs/0.94/knownissues_overview.xml b/src/documentation/content/xdocs/0.94/knownissues_overview.xml new file mode 100644 index 000000000..5720424b7 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/knownissues_overview.xml @@ -0,0 +1,70 @@ +<?xml version="1.0" standalone="no"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!-- $Id$ --> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd"> +<document xmlns:xi="http://www.w3.org/2001/XInclude"> + <header> + <title>Apache FOP: Known Issues</title> + <version>$Revision$</version> + </header> +<body> +<section> + <title>Known issues</title> + <p> + This page lists currently known issues in the current release. + </p> + <note> + <p> + For additional information on known issues in Apache FOP, please have a look at the following pages, too: + </p> + <ul> + <li><a href="../bugs.html">the bug list in Bugzilla</a></li> + <li><a href="http://wiki.apache.org/xmlgraphics-fop/FOPProjectTasks">the task list in the Wiki</a></li> + </ul> + </note> + <p> + Apache FOP has an extensive automated testing infrastructure. Parts of this infrastructure are several + sets of test cases. When a test case is listed in disabled-testcases.xml it is disabled in the JUnit + tests during the normal build process. This indicates a problem in the current codebase. When a bug is + fixed or a missing feature is added the entry for the relevant test case(s) are removed. + </p> + <section> + <title>FO Tree</title> + <p> + This section lists disabled test cases in the test suite for the FO tree tests, at the time + of the release. + </p> + <xi:include href="cocoon://knownissues-raw-fotree_0.94.xml#xpointer(/document/body/*)"/> + </section> + <section> + <title>Layout Engine</title> + <p> + This section lists disabled test cases in the test suite for the layout engine tests, at the + time of the release. + </p> + <xi:include href="cocoon://knownissues-raw-layoutengine_0.94.xml#xpointer(/document/body/*)"/> + </section> + <section> + <title>Other known issues</title> + <p>This section lists other known issues.</p> + <xi:include href="cocoon://knownissues-raw-static_0.94.xml#xpointer(/document/body/*)"/> + </section> +</section> +</body> +</document> + diff --git a/src/documentation/content/xdocs/0.94/layoutengine/disabled-testcases.xml b/src/documentation/content/xdocs/0.94/layoutengine/disabled-testcases.xml new file mode 100644 index 000000000..d81c0dc27 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/layoutengine/disabled-testcases.xml @@ -0,0 +1,327 @@ +<?xml version="1.0" encoding="UTF-8"?> +<?xml-stylesheet type="text/xsl" href="disabled-testcases.xsl"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!-- $Id$ --> +<!--DOCTYPE disabled-testcases SYSTEM "disabled-testcases.dtd"--> +<disabled-testcases> + <testcase> + <name>External link around an SVG not properly sized</name> + <file>basic-link_external-destination_2.xml</file> + <description>The bpd trait of the inlineparent area for the basic-link + is not sized correctly if it wraps an image that is higher than the + nominal line.</description> + </testcase> + <testcase> + <name>Bugzilla #36391: reference-orientation</name> + <file>block-container_reference-orientation_bug36391.xml</file> + <description>There's a problem involving nested block-containers + and reference-orientation 180/-180.</description> + <reference>http://issues.apache.org/bugzilla/show_bug.cgi?id=36391</reference> + </testcase> + <testcase> + <name>Auto-height block-containers produce fences</name> + <file>block-container_space-before_space-after_3.xml</file> + <description>Block-containers with no height currently don't + create a fence for spaces as they should (they behave like a + normal block).</description> + </testcase> + <testcase> + <name>font-stretch NYI</name> + <file>block_font-stretch.xml</file> + <description>Font-stretch is not implemented, yet.</description> + </testcase> + <testcase> + <name>Hyphenation with preserved linefeeds</name> + <file>block_hyphenation_linefeed_preserve.xml</file> + <description>When hyphenation is enabled and linefeeds are preserved linefeeds + are painted as '#' and the text is output multiple times.</description> + </testcase> + <testcase> + <name>linefeed-treatment</name> + <file>block_linefeed-treatment.xml</file> + <description>Preserved linefeeds in a fo:character are not handled + correctly.</description> + </testcase> + <testcase> + <name>white-space-treatment</name> + <file>block_white-space-treatment_3.xml</file> + <description>White space handling incorrectly stops at fo:inline + boundaries when it comes to formatter generated line breaks.</description> + </testcase> + <testcase> + <name>Empty blocks produce fences</name> + <file>block_space-before_space-after_8.xml</file> + <description>An empty block currently produces a fence for + stacking constraints which it shouldn't.</description> + </testcase> + <testcase> + <name>block white-space nbsp 2</name> + <file>block_white-space_nbsp_2.xml</file> + <description>The nbsp given as an fo:character is not adjustable and therefore + the justification does not work in this case.</description> + </testcase> + <testcase> + <name>block word-spacing</name> + <file>block_word-spacing.xml</file> + <description>Word-spacing may not work as expected.</description> + </testcase> + <testcase> + <name>block word-spacing text-align justify</name> + <file>block_word-spacing_text-align_justify.xml</file> + <description>Word-spacing may not work as expected.</description> + </testcase> + <testcase> + <name>external-graphic don't shrink</name> + <file>external-graphic_oversized.xml</file> + <description>Images currently don't shrink so they fit on a page + when they are too big and shrinking is allowed to + happen (min/opt/max).</description> + </testcase> + <testcase> + <name>Test case with HTTP URL</name> + <file>external-graphic_src_uri.xml</file> + <description>Doesn't work behind a proxy which requires + authorization.</description> + </testcase> + <testcase> + <name>Space Resolution in foot note area</name> + <file>footnote_space-resolution.xml</file> + <description>Space resolution does not work between footnote + regions.</description> + </testcase> + <testcase> + <name>Footnotes swallowed in lists</name> + <file>footnote_in_list.xml</file> + <description>Element lists for lists are created by combining the + element lists from list-item-label and list-item-body. The + footnotes contained in the KnuthBlockBoxes are not propagated to + the combined element list.</description> + <reference>http://issues.apache.org/bugzilla/show_bug.cgi?id=37579</reference> + </testcase> + <testcase> + <name>Footnotes swallowed in tables</name> + <file>footnote_in_table.xml</file> + <description>Element lists for tables are created by combining the + element lists from the individual table-cells. The footnotes + contained in the KnuthBlockBoxes are not propagated to the combined + element list.</description> + <reference>http://issues.apache.org/bugzilla/show_bug.cgi?id=37579</reference> + </testcase> + <testcase> + <name>keeps on inlines NYI</name> + <file>inline_keep-together.xml</file> + <description>Keeps are not implemented in inline-level elements, yet.</description> + </testcase> + <testcase> + <name>NPE for table inside an inline</name> + <file>inline_block_nested_3.xml</file> + <description>Placing a table as a child of an fo:inline produces a + NullPointerException.</description> + </testcase> + <testcase> + <name>inline-container is not implemented, yet.</name> + <file>inline-container_block_nested.xml</file> + <description>inline-container is not implemented, yet. Content of an + inline-container will get swallowed. The test case contains no checks.</description> + </testcase> + <testcase> + <name>inline-container is not implemented, yet.</name> + <file>inline-container_border_padding.xml</file> + <description>inline-container is not implemented, yet. Content of an + inline-container will get swallowed.</description> + </testcase> + <testcase> + <name>inline letter-spacing</name> + <file>inline_letter-spacing.xml</file> + <description>Letter-spacing may not work as + expected within fo:inline.</description> + </testcase> + <testcase> + <name>inline word-spacing</name> + <file>inline_word-spacing.xml</file> + <description>Word-spacing may not work as expected within + fo:inline.</description> + </testcase> + <testcase> + <name>inline word-spacing text-align justify</name> + <file>inline_word-spacing_text-align_justify.xml</file> + <description></description> + </testcase> + <testcase> + <name>leader-alignment NYI</name> + <file>leader-alignment.xml</file> + <description>Leader-alignment is not yet + implemented.</description> + </testcase> + <testcase> + <name>leader-pattern="use-content": Problem with line height</name> + <file>leader_leader-pattern_use-content_bug.xml</file> + <description>Line height is not correctly calculated for + use-content leaders whose height is larger than the rest of the + line.</description> + <reference>http://www.nabble.com/leaders-with-leader-pattern%3D%22use-content%22-t546244.html</reference> + </testcase> + <testcase> + <name>keep-with-previous doesn't work in lists</name> + <file>list-block_keep-with-previous.xml</file> + <description>Keep-with-previous doesn't work inside tables and + lists, yet.</description> + </testcase> + <testcase> + <name>keep-with-previous doesn't work in lists</name> + <file>list-item_block_keep-with-previous.xml</file> + <description>Keep-with-previous doesn't work inside tables and + lists, yet.</description> + </testcase> + <testcase> + <name>Page breaking doesn't deal with IPD changes</name> + <file>page-breaking_4.xml</file> + <description>Page breaking currently doesn't support changing available IPD + between pages of a single page-sequence. Element list generation has to be reset to + redetermine line breaks in this case.</description> + </testcase> + <testcase> + <name>Overflow handing is incomplete</name> + <file>page-breaking_6.xml</file> + <description>Line breaking is not 100% correct when there's too little space. + Overflows are not detected and warned.</description> + </testcase> + <testcase> + <name>Indefinite page height handling is imcomplete</name> + <file>page-height_indefinite_simple.xml</file> + <description>A RuntimeException is thrown for a page of indefinite height. Lots of warnings.</description> + </testcase> + <testcase> + <name>page-number-citation: Problem with background-image</name> + <file>page-number-citation_background-image.xml</file> + <description>Background-images on page-number-citations are not + placed correctly.</description> + </testcase> + <testcase> + <name>page-number-citation-last: FOs spanning multiple pages are not properly handled.</name> + <file>page-number-citation-last_basic.xml</file> + <description>Resolution of forward references does not wait until an FO is fully finished when an FO spans multiple pages.</description> + </testcase> + <testcase> + <name>IDs are not working on all FO elements</name> + <file>page-number-citation_complex_1.xml</file> + <description>The "id" attributes are not properly handled for all block-level FO elements.</description> + </testcase> + <testcase> + <name>IDs are not working on all FO elements</name> + <file>page-number-citation_complex_2.xml</file> + <description>The "id" attributes are not properly handled for all inline-level FO elements.</description> + </testcase> + <testcase> + <name>Footnotes in multi-column documents</name> + <file>region-body_column-count_footnote.xml</file> + <description>Footnotes may overlap with text of the region-body in + multi-column documents.</description> + </testcase> + <testcase> + <name>Column Balancing problems</name> + <file>region-body_column-count_balance_4col.xml</file> + <description>Situation in a 4-column document where the column balancing doesn't work and even causes some + content to disappear.</description> + </testcase> + <testcase> + <name>Column Balancing problems</name> + <file>region-body_column-count_bug36356.xml</file> + <description>Column balancing doesn't work as expected.</description> + </testcase> + <testcase> + <name>No background-images on table-body</name> + <file>table-body_background-image.xml</file> + <description>The backgrounds of table-body, table-header, + table-footer and table-column are not painted, yet.</description> + </testcase> + <testcase> + <name>Collapsing Border Model NYI</name> + <file>table_border-collapse_collapse_1.xml</file> + <description>Border-collapse="collapse" is not yet + implemented.</description> + </testcase> + <testcase> + <name>Collapsing Border Model NYI</name> + <file>table_border-collapse_collapse_2.xml</file> + <description>Border-collapse="collapse" is not yet + implemented.</description> + </testcase> + <testcase> + <name>Problems with border and padding on tables</name> + <file>table_border_padding.xml</file> + <description>The element list seems to not be fully correct, yet, causing + the layout to look odd.</description> + </testcase> + <testcase> + <name>keep-with-previous doesn't work inside tables</name> + <file>table-cell_block_keep-with-previous.xml</file> + <description>Keep-with-previous doesn't work inside tables and + lists, yet.</description> + </testcase> + <testcase> + <name>Border and padding conditionality is NYI on table-cells</name> + <file>table-cell_border_padding_conditionality.xml</file> + <description>Border and padding conditionality are not supported + on table-cells, yet.</description> + </testcase> + <testcase> + <name>No background-images on table-header</name> + <file>table-header_background-image.xml</file> + <description>The backgrounds of table-body, table-header, + table-footer and table-column are not painted, yet.</description> + </testcase> + <testcase> + <name>keep-with-previous doesn't work on table-rows</name> + <file>table-row_keep-with-previous.xml</file> + <description>Keep-with-previous doesn't work inside tables and + lists, yet.</description> + </testcase> + <testcase> + <name>table-cell empty area with marker.xml</name> + <file>table-cell_empty_area_with_marker.xml</file> + <description>A table-cell producing an empty area does currently not add any markers to a page. + See TODO entry in AreaAdditionUtil.</description> + </testcase> + <testcase> + <name>Border conditionality on table</name> + <file>table_border-width_conditionality.xml</file> + <description>The code should be ok, but the test case uses shorthands and therefore + is probably not expressing the indended outcome according to the spec. The test + case should be revisited.</description> + </testcase> + <testcase> + <name>fo:wrapper around block-level content (with id)</name> + <file>wrapper_block_id.xml</file> + <description>"id" attributes on fo:wrapper around block-level content don't get + added to the area tree.</description> + </testcase> + <testcase> + <name>Bugzilla #40230: invalid extra page break</name> + <file>block_break-after_bug40230.xml</file> + <description>Currently an extra page is created even if there is nothing + after a block with break-after="page"</description> + <reference>http://issues.apache.org/bugzilla/show_bug.cgi?id=40230</reference> + </testcase> + <testcase> + <name>Soft hyphen with normal hyphenation enabled</name> + <file>block_shy_linebreaking_hyph.xml</file> + <description>A soft hyphen should be a preferred as break compared to a + normal hyphenation point but is not.</description> + </testcase> +</disabled-testcases> diff --git a/src/documentation/content/xdocs/0.94/output.xml b/src/documentation/content/xdocs/0.94/output.xml new file mode 100644 index 000000000..998a5e1ce --- /dev/null +++ b/src/documentation/content/xdocs/0.94/output.xml @@ -0,0 +1,805 @@ +<?xml version="1.0" standalone="no"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!-- $Id$ --> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd"> +<!-- Output Formats: Renderers --> +<document> + <header> + <title>Apache FOP Output Formats</title> + <version>$Revision$</version> + <authors> + <person name="Keiron Liddle" email="keiron@aftexsw.com"/> + <person name="Art Welch" email=""/> + </authors> + </header> + + <body> + <p> + FOP supports multiple output formats by using a different renderer for each format. + The renderers do not all have the same set of capabilities, sometimes because of + the output format itself, sometimes because some renderers get more development + attention than others. + </p> + <section id="general"> + <title>General Information</title> + <section id="general-fonts"> + <title>Fonts</title> + <p> + Most FOP renderers use a FOP-specific system for font registration. + However, the Java2D/AWT and print renderers use the Java AWT package, which gets its + font information from the operating system registration. + This can result in several differences, including actually using different fonts, + and having different font metrics for the same font. + The net effect is that the layout of a given FO document can be quite different between + renderers that do not use the same font information. + </p> + </section> + <section id="general-direct-output"> + <title>Output to a Printer or Other Device</title> + <p> + The most obvious way to print your document is to use the FOP + <a href="#print">print renderer</a>, which uses the Java2D API (AWT). + However, you can also send output from the Postscript renderer directly to a Postscript + device, or output from the PCL renderer directly to a PCL device. + </p> + <p> + Here are Windows command-line examples for Postscript and PCL: + </p> + <source><![CDATA[fop ... -ps \\computername\printer]]></source> + <source><![CDATA[fop ... -pcl \\computername\printer]]></source> + <p> + Here is some Java code to accomplish the task in UNIX: + </p> + <source><![CDATA[proc = Runtime.getRuntime().exec("lp -d" + print_queue + " -o -dp -"); +out = proc.getOutputStream();]]></source> + <p> + Set the output MIME type to "application/x-pcl" (MimeConstants.MIME_PCL) and + it happily sends the PCL to the UNIX printer queue. + </p> + </section> + </section> + <section id="pdf"> + <title>PDF</title> + <p> + PDF is the best supported output format. It is also the most accurate + with text and layout. This creates a PDF document that is streamed out + as each page is rendered. This means that the internal page index + information is stored near the end of the document. + The PDF version supported is 1.4. PDF versions are forwards/backwards + compatible. + </p> + <p> + Note that FOP does not currently support "tagged PDF" or PDF/A-1a. + Support for <a href="pdfa.html">PDF/A-1b</a> and <a + href="pdfx.html">PDF/X</a> has recently been added, however. + </p> + <section id="pdf-fonts"> + <title>Fonts</title> + <p> + PDF has a set of fonts that are always available to all PDF viewers; + to quote from the PDF Specification: + + <em>"PDF prescribes a set of 14 standard fonts that can be used without prior + definition. + These include four faces each of three Latin text typefaces (Courier, + Helvetica, and Times), as well as two symbolic fonts (Symbol and ITC Zapf + Dingbats). These fonts, or suitable substitute fonts with the same metrics, are + guaranteed to be available in all PDF viewer applications."</em> + </p> + </section> + <section id="pdf-postprocess"> + <title>Post-processing</title> + <p> + FOP does not currently support several desirable PDF features: XMP metadata and watermarks. + One workaround is to use Adobe Acrobat (the full version, not the Reader) to process + the file manually or with scripting that it supports. + </p> + <p> + Another popular post-processing tool is <a href="http://www.lowagie.com/iText">iText</a>, + which has tools for adding security features, document properties, watermarks, and many + other features to PDF files. + </p> + <warning> + Caveat: iText may swallow PDF bookmarks. But + <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=37589">Jens Stavnstrup tells us</a> + that this doesn't happen if you use iText's PDFStamper. + </warning> + <p> + Here is some sample code that uses iText to encrypt a FOP-generated PDF. (Note that FOP now + supports <a href="pdfencryption.html">PDF encryption</a>. However the principles for using + iText for other PDF features are similar.) + </p> + <source><![CDATA[public static void main(String args[]) { + try { + ByteArrayOutputStream fopout = new ByteArrayOutputStream(); + FileOutputStream outfile = new FileOutputStream(args[2]); + FopFactory fopFactory = FopFactory.newInstance(); + Fop fop = fopFactory.newFop(MimeConstants.MIME_PDF, fopout); + + Transformer transformer = TransformerFactory.newInstance().newTransformer( + new StreamSource(new File(args[1]))); + transformer.transform(new StreamSource(new File(args[0])), + new SAXResult(fop.getDefaultHandler())); + PdfReader reader = new PdfReader(fopout.toByteArray()); + int n = reader.getNumberOfPages(); + Document document = new Document(reader.getPageSizeWithRotation(1)); + PdfWriter writer = PdfWriter.getInstance(document, outfile); + writer.setEncryption(PdfWriter.STRENGTH40BITS, "pdf", null, + PdfWriter.AllowCopy); + document.open(); + PdfContentByte cb = writer.getDirectContent(); + PdfImportedPage page; + int rotation; + int i = 0; + while (i < n) { + i++; + document.setPageSize(reader.getPageSizeWithRotation(i)); + document.newPage(); + page = writer.getImportedPage(reader, i); + rotation = reader.getPageRotation(i); + if (rotation == 90 || rotation == 270) { + cb.addTemplate(page, 0, -1f, 1f, 0, 0, + reader.getPageSizeWithRotation(i).height()); + } else { + cb.addTemplate(page, 1f, 0, 0, 1f, 0, 0); + } + System.out.println("Processed page " + i); + } + document.close(); + } catch( Exception e) { + e.printStackTrace(); + } +}]]></source> + <p> + Check the iText tutorial and documentation for setting access flags, password, + encryption strength and other parameters. + </p> + </section> + <section id="pdf-watermark"> + <title>Watermarks</title> + <p> + In addition to the <a href="#pdf-postprocess">PDF Post-processing</a> options, consider the following workarounds: + </p> + <ul> + <li> + Use a background image for the body region. + </li> + <li> + (submitted by Trevor Campbell) Place an image in a + region that overlaps the flowing text. For example, make + region-before large enough to contain your image. Then include a + block (if necessary, use an absolutely positioned block-container) + containing the watermark image in the static-content for the + region-before. Note that the image will be drawn on top of the + normal content. + </li> + </ul> + </section> +</section> +<section id="ps"> + <title>PostScript</title> + <p> + The PostScript renderer has been brought up to a similar quality as the + PDF renderer, but may still be missing certain features. It provides good + support for most text and layout. + Images and SVG are not fully supported, yet. Currently, the PostScript + renderer generates PostScript Level 3 with most DSC comments. Actually, + the only Level 3 features used are the FlateDecode and DCTDecode + filter (the latter is used for 1:1 embedding of JPEG images), everything + else is Level 2. + </p> + <section id="ps-configuration"> + <title>Configuration</title> + <p> + The PostScript renderer configuration currently allows the following settings: + </p> +<source><![CDATA[<renderer mime="application/postscript"> + <auto-rotate-landscape>false</auto-rotate-landscape> + <language-level>3</language-level> + <optimize-resources>false</optimize-resources> +</renderer>]]></source> + <p> + The default value for the "auto-rotate-landscape" setting is "false". Setting it + to "true" will automatically rotate landscape pages and will mark them as landscape. + </p> + <p> + The default value for the "language-level" setting is "3". This setting specifies + the PostScript language level which should be used by FOP. Set this to "2" + only if you don't have a Level 3 capable interpreter. + </p> + <p> + The default value for the "optimize-resources" setting is "false". Setting it + to "true" will produce the PostScript file in two steps. A temporary file will be + written first which will then be processed to add only the fonts which were really + used and images are added to the stream only once as PostScript forms. This will + reduce file size but can potentially increase the memory needed in the interpreter + to process. + </p> + </section> + <section id="ps-limitations"> + <title>Limitations</title> + <ul> + <li>Images and SVG may not be displayed correctly. SVG support is far from being complete. No image transparency is available.</li> + <li>Only Type 1 fonts are supported.</li> + <li>Multibyte characters are not supported.</li> + <li>PPD support is still missing.</li> + </ul> + </section> +</section> + <section id="pcl"> + <title>PCL</title> + <p> + This format is for the Hewlett-Packard PCL printers and other printers + supporting PCL. It should produce output as close to identical as possible + to the printed output of the PDFRenderer within the limitations of the + renderer, and output device. + </p> + <p> + The output created by the PCLRenderer is generic PCL 5, HP GL/2 and PJL. + This should allow any device fully supporting PCL 5 to be able to + print the output generated by the PCLRenderer. PJL is used to control the + print job and switch to the PCL language. PCL 5 is used for text, raster + graphics and rectangular fill graphics. HP GL/2 is used for more complex + painting operations. Certain painting operations are done off-screen and + rendered to PCL as bitmaps because of limitations in PCL 5. + </p> + <section id="pcl-references"> + <title>References</title> + <ul> + <li><a href="http://en.wikipedia.org/wiki/Printer_Control_Language">WikiPedia entry on PCL</a></li> + <li><a href="http://h20000.www2.hp.com/bizsupport/TechSupport/Document.jsp?objectID=bpl04568">Technical reference documents on PCL from Hewlett-Packard</a></li> + </ul> + </section> + <section id="pcl-limitations"> + <title>Limitations</title> + <ul> + <li> + Text or graphics outside the left or top of the printable area are not + rendered properly. This is a limitation of PCL, not FOP. In general, + things that should print to the left of the printable area are shifted + to the right so that they start at the left edge of the printable area. + </li> + <li> + The Helvetica and Times fonts are not well supported among PCL printers + so Helvetica is mapped to Arial and Times is mapped to Times New. This + is done in the PCLRenderer, no changes are required in the FO's. The + metrics and appearance for Helvetica/Arial and Times/Times New are + nearly identical, so this has not been a problem so far. + </li> + <li>For the non-symbol fonts, the ISO 8859-1 symbol set is used (PCL set "0N").</li> + <li> + All fonts available to the Java2D subsystem are usable. The texts are + painted as bitmap much like the Windows PCL drivers do. + </li> + <li>Multibyte characters are not supported.</li> + <li> + At the moment, only monochrome output is supported. PCL5c color extensions + will only be implemented on demand. Color and grayscale images are converted + to monochrome bitmaps (1-bit). Dithering only occurs if the JAI image library + is available. + </li> + <li> + Images are scaled up to the next resolution level supported by PCL (75, + 100, 150, 200, 300, 600 dpi). For color and grayscale images an even + higher PCL resolution is selected to give the dithering algorithm a chance + to improve the bitmap quality. + </li> + <li> + Currently, there's no support for clipping and image transparency, largely + because PCL 5 has certain limitations. + </li> + </ul> + </section> + <section id="pcl-configuration"> + <title>Configuration</title> + <p> + The PCL renderer configuration currently allows the following settings: + </p> +<source><![CDATA[<renderer mime="application/vnd.hp-PCL"> + <rendering>quality</rendering> + <text-rendering>bitmap</text-rendering> +</renderer>]]></source> + <p> + The default value for the "rendering" setting is "speed" which causes borders + to be painted as plain rectangles. In this mode, no special borders (dotted, + dashed etc.) are available. If you want support for all border modes, set the + value to "quality" as indicated above. This will cause the borders to be painted + as bitmaps. + </p> + <p> + The default value for the "text-rendering" setting is "auto" which paints the + base fonts using PCL fonts. Non-base fonts are painted as bitmaps through Java2D. + If the mix of painting methods results in unwelcome output, you can set this + to "bitmap" which causes all text to be rendered as bitmaps. + </p> + <p> + You can control the output resolution for the PCL using the "target resolution" + setting on the FOUserAgent. The actual value will be rounded up to the next + supported PCL resolution. Currently, only 300 and 600 dpi are supported which + should be enough for most use cases. Note that this setting directly affects + the size of the output file and the print quality. + </p> + </section> + <section id="pcl-extensions"> + <title>Extensions</title> + <p>The PCL Renderer supports some PCL specific extensions which can be embedded + into the input FO document. To use the extensions the appropriate namespace must + be declared in the fo:root element like this:</p> + <source><![CDATA[ + <fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format" + xmlns:pcl="http://xmlgraphics.apache.org/fop/extensions/pcl"> +]]></source> + <section id="pcl-page-source"> + <title>Page Source (Tray selection)</title> + <p> + The page-source extension attribute on fo:simple-page-master allows to + select the paper tray the sheet for a particular simple-page-master is + to be taken from. Example: + </p> + <source><![CDATA[ + <fo:layout-master-set> + <fo:simple-page-master master-name="simple" pcl:paper-source="2"> + ... + </fo:simple-page-master> + </fo:layout-master-set> +]]></source> + <p> + Note: the tray number is a positive integer and the value depends on + the target printer. Not all PCL printers support the same paper trays. + Usually, + "1" is the default tray, + "2" is the manual paper feed, + "3" is the manual envelope feed, + "4" is the "lower" tray and + "7" is "auto-select". + Consult the technical reference for your printer for all available values. + </p> + </section> + </section> + </section> + <section id="afp"> + <title>AFP</title> + <warning>The AFP Renderer is a new addition (27-Apr-2006) to the sandbox and as such not yet fully tested or feature complete.</warning> + <p> + The FOP AFP Renderer deals with creating documents conforming to the IBM AFP document architecture + also refered to as MO:DCA (Mixed Object Document Content Architecture). + </p> + <section id="afp-references"> + <title>References</title> + <ul> + <li><a href="http://en.wikipedia.org/wiki/Advanced_Function_Presentation">AFP (Advanced Function Presentation)</a></li> + <li><a href="http://wiki.apache.org/xmlgraphics-fop/AFPResources">AFP Resources on the FOP WIKI</a></li> + </ul> + </section> + <section id="afp-limitations"> + <title>Limitations</title> + <p>This list is most likely badly incomplete.</p> + <ul> + <li> + Clipping of text and graphics is not supported. + </li> + <li> + Only IBM outline and raster fonts and to a limited extend the original fonts built into FOP are supported. + Support for TrueType fonts may be added later. + </li> + </ul> + </section> + <section id="afp-configuration"> + <title>Configuration</title> + <section id="afp-font-config"> + <title>Fonts</title> + <p>The AFP Renderer requires special configuration particularly related to fonts. + AFP Render configuration is done through the normal FOP configuration file. The MIME type + for the AFP Renderer is application/x-afp which means the AFP Renderer section in the FOP configuration file + looks like:</p> + <source><![CDATA[<renderer mime="application/x-afp"> + <!-- AFP Renderer --> + ... +</renderer>]]></source> + <p>There are 3 font configuration variants supported:</p> + <ol> + <li>IBM Raster fonts</li> + <li>IBM Outline fonts</li> + <li>FOP built-in Base14 fonts</li> + </ol> + <p>A typical raster font configuration looks like:</p> +<source><![CDATA[ <!-- This is an example of mapping actual IBM raster fonts / code pages to a FOP font --> + <font> + <!-- The afp-font element defines the IBM code page, the matching Java encoding and the + path to the font --> + <afp-font type="raster" codepage="T1V10500" encoding="Cp500" path="fonts/ibm"> + <!-- For a raster font a separate element for each font size is required providing + the font size and the corresponding IBM Character set name --> + <afp-raster-font size="7" characterset="C0N20070"/> + <afp-raster-font size="8" characterset="C0N20080"/> + <afp-raster-font size="10" characterset="C0N20000"/> + <afp-raster-font size="11" characterset="C0N200A0"/> + <afp-raster-font size="12" characterset="C0N200B0"/> + <afp-raster-font size="14" characterset="C0N200D0"/> + <afp-raster-font size="16" characterset="C0N200F0"/> + <afp-raster-font size="18" characterset="C0N200H0"/> + <afp-raster-font size="20" characterset="C0N200J0"/> + <afp-raster-font size="24" characterset="C0N200N0"/> + <afp-raster-font size="30" characterset="C0N200T0"/> + <afp-raster-font size="36" characterset="C0N200Z0"/> + </afp-font> + <!-- These are the usual FOP font triplets as they apply to this font --> + <font-triplet name="serif" style="normal" weight="normal"/> + <font-triplet name="Times" style="normal" weight="normal"/> + <font-triplet name="Times-Roman" style="normal" weight="normal"/> + <font-triplet name="TimesNewRoman" style="normal" weight="normal"/> + </font>]]></source> + <p>An outline font configuration is simpler as the individual font size entries are not required. + However, the characterset definition is now required within the afp-font element.</p> +<source><![CDATA[ <font> + <afp-font type="outline" codepage="T1V10500" encoding="Cp500" characterset="CZH200 " + path="fonts/ibm" /> + <font-triplet name="sans-serif" style="normal" weight="normal"/> + <font-triplet name="Helvetica" style="normal" weight="normal"/> + <font-triplet name="any" style="normal" weight="normal"/> + </font> +]]></source> + <p>Experimentation has shown that the font metrics for the FOP built-in Base14 fonts are actually + very similar to some of the IBM outline and raster fonts. In cases were the IBM font files are not + available the path attribute in the afp-font element can be replaced by a base14-font attribute + giving the name of the matching Base14 font. In this case the AFP Renderer will take the + font metrics from the built-in font.</p> +<source><![CDATA[ <!-- The following are examples of defining outline fonts based on FOP built-in + font metrics for the Adobe Base14 fonts --> + <!-- sans-serif fonts based on Helvetica --> + <font> + <afp-font type="outline" codepage="T1V10500" encoding="Cp500" characterset="CZH200 " + base14-font="Helvetica" /> + <font-triplet name="sans-serif" style="normal" weight="normal"/> + <font-triplet name="Helvetica" style="normal" weight="normal"/> + <font-triplet name="any" style="normal" weight="normal"/> + </font> + <font> + <afp-font type="outline" codepage="T1V10500" encoding="Cp500" characterset="CZH300 " + base14-font="HelveticaOblique" /> + <font-triplet name="sans-serif" style="italic" weight="normal"/> + <font-triplet name="Helvetica" style="italic" weight="normal"/> + <font-triplet name="any" style="italic" weight="normal"/> + </font> + <font> + <afp-font type="outline" codepage="T1V10500" encoding="Cp500" characterset="CZH400 " + base14-font="HelveticaBold" /> + <font-triplet name="sans-serif" style="normal" weight="bold"/> + <font-triplet name="Helvetica" style="normal" weight="bold"/> + <font-triplet name="any" style="normal" weight="bold"/> + </font> + <font> + <afp-font type="outline" codepage="T1V10500" encoding="Cp500" characterset="CZH500 " + base14-font="HelveticaBoldOblique" /> + <font-triplet name="sans-serif" style="italic" weight="bold"/> + <font-triplet name="Helvetica" style="italic" weight="bold"/> + <font-triplet name="any" style="italic" weight="bold"/> + </font> + + <!-- serif fonts based on Times Roman --> + <font> + <afp-font type="outline" codepage="T1V10500" encoding="Cp500" characterset="CZN200 " + base14-font="TimesRoman" /> + <font-triplet name="serif" style="normal" weight="normal"/> + <font-triplet name="Times" style="normal" weight="normal"/> + <font-triplet name="Times-Roman" style="normal" weight="normal"/> + </font> + + <!-- The following are examples of defining raster fonts based on FOP built-in + font metrics for the Adobe Base14 fonts --> + <!-- monospaced fonts based on Courier --> + <font> + <afp-font type="raster" codepage="T1V10500" encoding="Cp500"> + <afp-raster-font size="7" characterset="C0420070" base14-font="Courier"/> + <afp-raster-font size="8" characterset="C0420080" base14-font="Courier"/> + <afp-raster-font size="10" characterset="C0420000" base14-font="Courier"/> + <afp-raster-font size="12" characterset="C04200B0" base14-font="Courier"/> + <afp-raster-font size="14" characterset="C04200D0" base14-font="Courier"/> + <afp-raster-font size="20" characterset="C04200J0" base14-font="Courier"/> + </afp-font> + <font-triplet name="monospace" style="normal" weight="normal"/> + <font-triplet name="Courier" style="normal" weight="normal"/> + </font> + <font> + <afp-font type="raster" codepage="T1V10500" encoding="Cp500"> + <afp-raster-font size="7" characterset="C0440070" base14-font="CourierBold"/> + <afp-raster-font size="8" characterset="C0440080" base14-font="CourierBold"/> + <afp-raster-font size="10" characterset="C0440000" base14-font="CourierBold"/> + <afp-raster-font size="12" characterset="C04400B0" base14-font="CourierBold"/> + <afp-raster-font size="14" characterset="C04400D0" base14-font="CourierBold"/> + <afp-raster-font size="20" characterset="C04400J0" base14-font="CourierBold"/> + </afp-font> + <font-triplet name="monospace" style="normal" weight="bold"/> + <font-triplet name="Courier" style="normal" weight="bold"/> + </font>]]></source> + </section> + <section id="afp-image-config"> + <title>Images</title> + <p>By default the AFP Renderer converts all images to 8 bit grey level. + This can be overridden by the <images> configuration element. Example:</p> + <source><![CDATA[ + <images mode="color" /> +]]></source> + <p>This will put images as RGB images into the AFP output stream. The default setting is:</p> + <source><![CDATA[ + <images mode="b+w" bits-per-pixel="8" /> +]]></source> + <p>Only the values "color" and "b+w" are allowed for the mode attribute. The bits-per-pixel + attribute is ignored if mode is "color". For "b+w" mode is must be 1, 4, or 8.</p> + </section> + </section> + <section id="afp-extensions"> + <title>Extensions</title> + <p>The AFP Renderer supports some AFP specific extensions which can be embedded into the input + fo document. To use the extensions the appropriate namespace must be declared in the fo:root element like this:</p> + <source><![CDATA[ + <fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format" + xmlns:afp="http://xmlgraphics.apache.org/fop/extensions/afp"> +]]></source> + <section id="afp-page-overlay"> + <title>Page Overlay Extension</title> + <p>The include-page-overlay extension element allows to define on a per simple-page-master basis a page overlay resource. Example:</p> + <source><![CDATA[ + <fo:layout-master-set> + <fo:simple-page-master master-name="simple"> + <afp:include-page-overlay name="O1SAMP1 " /> + ... + </fo:simple-page-master> + </fo:layout-master-set> +]]></source> + <p>The mandatory name attribute must refer to an 8 character (space padded) resource name that + must be known in the AFP processing environment.</p> + </section> + <section id="afp-page-segment"> + <title>Page Segment Extension</title> + <p>The include-page-segment extension element allows to define resource substitution for fo:external-graphics elements. + Example:</p> + <source><![CDATA[ + <fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format" + xmlns:afp="http://xmlgraphics.apache.org/fop/extensions/afp"> + <fo:layout-master-set> + <fo:simple-page-master master-name="simple"> + <afp:include-page-segment name="S1ISLOGO" src="../../resources/images/bgimg300dpi.jpg" /> + <fo:region-body/> + </fo:simple-page-master> + </fo:layout-master-set> +]]></source> + <p>The include-page-segment extension element can only occur within a simple-page-master. + Multiple include-page-segment extension elements within a simple-page-master are allowed. + The mandatory name attribute must refer to an 8 character + (space padded) resource name that must be known in the AFP processing environment. + The value of the mandatory src attribute is compared against the value of the src attribute in + fo:external-graphic elements and if it is identical (string matching is used) in the generated + AFP the external graphic is replaced by a reference to the given resource. + </p> + </section> + <section id="afp-tag-logical-element"> + <title>Tag Logical Element Extension</title> + <p>The tag-logical-element extension element allows to injects TLEs into the AFP output stream. Example: + Example:</p> + <source><![CDATA[ + <fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format" + xmlns:afp="http://xmlgraphics.apache.org/fop/extensions/afp"> + <fo:layout-master-set> + <fo:simple-page-master master-name="simple"> + <afp:tag-logical-element name="The TLE Name" value="The TLE Value" /> + <fo:region-body/> + </fo:simple-page-master> + </fo:layout-master-set> +]]></source> + <p>The tag-logical-element extension element can only occur within a simple-page-master. + Multiple tag-logical-element extension elements within a simple-page-master are allowed. + The name and value attributes are mandatory. + </p> + </section> + </section> + </section> +<section id="rtf"> + <title>RTF</title> + <p> + JFOR, an open source XSL-FO to RTF converter has been integrated into Apache FOP. + This will create an RTF (rich text format) document that will + attempt to contain as much information from the fo document as + possible. The RTF output follows Microsoft's RTF specifications + and produces best results on Microsoft Word. + </p> + <note>RTF output is currently unmaintained and lacks many features compared to other output + formats. Using other editable formats like Open Document Format, instead of producing XSL-FO + then RTF through FOP, might give better results.</note> +</section> +<section id="xml"> + <title>XML (Area Tree XML)</title> + <p> + This is primarily for testing and verification. The XML created is simply + a representation of the internal area tree put into XML. We use that to verify + the functionality of FOP's layout engine. + </p> + <p> + The other use case of the Area Tree XML is as FOP's "intermediate format". More information + on that can be found on the page dedicated to the <a href="intermediate.html">Intermediate Format</a>. + </p> +</section> +<section id="awt"> + <title>Java2D/AWT</title> + <p> + The Java2DRenderer provides the basic functionality for all + Java2D-based output formats (AWT viewer, direct print, PNG, TIFF). + </p> + <p> + The AWT viewer shows a window with the pages displayed inside a + Java graphic. It displays one page at a time. + The fonts used for the formatting and viewing depend on the fonts + available to your JRE. + </p> +</section> +<section id="print"> + <title>Print</title> + <p> + It is possible to directly print the document from the command line. + This is done with the same code that renders to the Java2D/AWT renderer. + </p> +</section> +<section id="bitmap"> + <title>Bitmap (TIFF/PNG)</title> + <p> + It is possible to directly create bitmap images from the individual + pages generated by the layout engine. + This is done with the same code that renders to the Java2D/AWT renderer. + </p> + <p> + Currently, two output formats are supported: PNG and TIFF. TIFF produces + one file with multiple pages, while PNG output produces one file per + page. The quality of the bitmap depends on the target resolution setting + on the FOUserAgent. + </p> + <section id="bitmap-configuration"> + <title>Configuration</title> + <p> + The TIFF and PNG renderer configuration currently allows the following settings: + </p> +<source><![CDATA[<renderer mime="image/png"> + <transparent-page-background>true</transparent-page-background> + <fonts><!-- described elsewhere --></fonts> +</renderer>]]></source> + <p> + The default value for the "transparent-page-background" setting is "false" which + paints an opaque, white background for the whole image. If you set this to true, + no such background will be painted and you will get a transparent image if + an alpha channel is available in the output format. + </p> + </section> + <section id="tiff-configuration"> + <title>TIFF-specific Configuration</title> + <p> + In addition to the above values the TIFF renderer configuration allows some additional + settings: + </p> +<source><![CDATA[<renderer mime="image/tiff"> + <transparent-page-background>true</transparent-page-background> + <compression>CCITT T.6</compression> + <fonts><!-- described elsewhere --></fonts> +</renderer>]]></source> + <p> + The default value for the "compression" setting is "PackBits" which + which is a widely supported RLE compression scheme for TIFF. The set of compression + names to be used here matches the set that the Image I/O API uses. Note that + not all compression schemes may be available during runtime. This depends on the + actual codecs being available. Here is a list of possible values: + </p> + <ul> + <li>NONE (no compression)</li> + <li>PackBits (RLE, run-length encoding)</li> + <li>JPEG</li> + <li>Deflate</li> + <li>LZW</li> + <li>ZLib</li> + <li>CCITT T.4 (Fax Group 3)</li> + <li>CCITT T.6 (Fax Group 4)</li> + </ul> + <note> + If you want to use CCITT compression, please make sure you've got a J2SE 1.4 or later and + <a href="http://java.sun.com/products/java-media/jai/current.html"> + Java Advanced Imaging Image I/O Tools + </a> + in your classpath. The Sun JRE doesn't come with a TIFF codec built in, so it has to be + added separately. The internal TIFF codec from XML Graphics Commons only supports PackBits, + Deflate and JPEG compression for writing. + </note> + </section> +</section> +<section id="txt"> + <title>TXT</title> + <p> + The text renderer produces plain ASCII text output + that attempts to match the output of the PDFRenderer as closely as + possible. This was originally developed to accommodate an archive system + that could only accept plain text files, and is primarily useful for getting + a quick-and-dirty view of the document text. The renderer is very limited, + so do not be surprised if it gives unsatisfactory results. + </p> + <p> + The Text renderer works with a fixed size page buffer. The size of this + buffer is controlled with the textCPI and textLPI public variables. + The textCPI is the effective horizontal characters per inch to use. + The textLPI is the vertical lines per inch to use. From these values + and the page width and height the size of the buffer is calculated. + The formatting objects to be rendered are then mapped to this grid. + Graphic elements (lines, borders, etc) are assigned a lower priority + than text, so text will overwrite any graphic element representations. + </p> + <p> + Because FOP lays the text onto a grid during layout, there are frequently + extra or missing spaces between characters and lines, which is generally + unsatisfactory. + Users have reported that the optimal settings to avoid such spacing problems are: + </p> + <ul> + <li>font-family="Courier"</li> + <li>font-size="7.3pt"</li> + <li>line-height="10.5pt"</li> + </ul> +</section> +<section id="sandbox"> + <title>Output Formats in the Sandbox</title> + <p> + Due to the state of certain renderers we moved some of them to a "sandbox" area until + they are ready for more serious use. The renderers and FOEventHandlers in the sandbox + can be found under src/sandbox and are compiled into build/fop-sandbox.jar during the + main build. The output formats in the sandbox are marked as such below. + </p> + <section id="mif"> + <title>MIF</title> + <warning>The MIF handler is in the sandbox and not yet functional in FOP Trunk!!! Please help us ressurrect this feature.</warning> + <p> + This format is the Maker Interchange Format which is used by + Adobe Framemaker. + </p> + </section> + <section id="svg"> + <title>SVG</title> + <warning>The SVG renderer is in the sandbox and may not work as expected in FOP Trunk!!! Please help us improve this feature.</warning> + <p> + This format creates an SVG document that has links between the pages. + This is primarily for slides and creating svg images of pages. + Large documents will create SVG files that are far too large for + an SVG viewer to handle. Since FO documents usually have text the + SVG document will have a large number of text elements. + The font information for the text is obtained from the JVM in the + same way as for the AWT viewer. If the SVG is viewed on a + system where the fonts are different, such as another platform, + then the page may look wrong. + </p> + </section> +</section> +<section id="wishlist"> + <title>Wish list</title> + <p> + Apache FOP is easily extensible and allows you to add new output formats to enhance FOP's functionality. There's a number of output formats + which are on our wish list. We're looking for volunteers to help us implement them. + </p> + <ul> + <li> + <a href="http://en.wikipedia.org/wiki/OpenDocument">ODF (Open Document Format)</a>: + The standardized successor to OpenOffice's file format. + </li> + </ul> +</section> + + </body> +</document> + diff --git a/src/documentation/content/xdocs/0.94/pdfa.xml b/src/documentation/content/xdocs/0.94/pdfa.xml new file mode 100644 index 000000000..49ffbeb71 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/pdfa.xml @@ -0,0 +1,159 @@ +<?xml version="1.0" standalone="no"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!-- $Id$ --> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "document-v20.dtd"> +<document> + <header> + <title>PDF/A (ISO 19005)</title> + <version>$Revision: 389563 $</version> + <authors> + <person name="Jeremias Märki" email="jeremias@apache.org"/> + </authors> + </header> + <body> + <section id="overview"> + <title>Overview</title> + <warning> + Support for PDF/A is available beginning with version 0.92. + </warning> + <p> + 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 + <a href="http://www.iso.org/iso/en/CatalogueDetailPage.CatalogueDetail?CSNUMBER=38920&ICS1=37&ICS2=100&ICS3=99">ISO 19005-1:2005(E)</a>. + Work on PDF/A-2 is in progress at + <a href="http://www.aiim.org/standards.asp?ID=25013">AIIM</a>. + </p> + <p> + Design documentation on PDF/A can be found on FOP's Wiki on the + <a href="http://wiki.apache.org/xmlgraphics-fop/PDFA1ConformanceNotes">PDFA1ConformanceNotes</a> page. + </p> + </section> + <section id="status"> + <title>Implementation Status</title> + <p> + <strong>PDF/A-1b</strong> is implemented to the degree that FOP supports + the creation of the elements described in ISO 19005-1. + </p> + <p> + Tests have been performed against jHove and Adobe Acrobat 7.0.7 (Preflight function). + FOP does not validate completely against Apago's PDF Appraiser. Reasons unknown due to + lack of a full license to get a detailed error protocol. + </p> + <p> + <strong>PDF/A-1a</strong> is not implemented, yet. This is mostly because of the requirement + for tagged PDF which is not available in FOP, yet. + </p> + </section> + <section id="command-line"> + <title>Usage (command line)</title> + <p> + 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. + </p> + </section> + <section id="embedded"> + <title>Usage (embedded)</title> + <p> + 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: + </p> + <source><![CDATA[ +userAgent.getRendererOptions().put("pdf-a-mode", "PDF/A-1b"); +Fop fop = fopFactory.newFop(MimeConstants.MIME_PDF, userAgent); +[..]]]></source> + <p> + If one of the validation rules of PDF/A is violated, an PDFConformanceException + (descendant of RuntimeException) is thrown. + </p> + </section> + <section id="rules"> + <title>PDF/A in Action</title> + <p> + 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): + </p> + <ul> + <li> + Make sure all (!) fonts are embedded. If you use base 14 fonts (like Helvetica) + you need to obtain a license for them and embed them like any other font. + </li> + <li> + Don't use PDF encryption. PDF/A doesn't allow it. + </li> + <li> + Don't use CMYK images without an ICC color profile. PDF/A doesn't allow mixing + color spaces and FOP currently only properly supports the sRGB color space. Please + note that FOP embeds a standard sRGB ICC profile (sRGB IEC61966-2.1) as the + primary output intent for the PDF if no other output intent has been specified + in the configuration. + </li> + <li> + Don't use non-RGB colors in SVG images. Same issue as with CMYK images. + </li> + <li> + Don't use EPS graphics with fo:external-graphic. Embedding EPS graphics in PDF + is deprecated since PDF 1.4 and prohibited by PDF/A. + </li> + <li> + PDF is forced to version 1.4 if PDF/A-1 is activated. + </li> + <li> + 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. + </li> + </ul> + </section> + <section id="profile-compatibility"> + <title>PDF profile compatibility</title> + <p> + The PDF profiles "PDF/X-3:2003" and "PDF/A-1b" are compatible and can both be + activated at the same time. + </p> + </section> + <section id="interoperability"> + <title>Interoperability</title> + <p> + 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: + </p> + <table> + <tr> + <td>http://www.aiim.org/pdfa/ns/id.html</td> + <td><strong>obsolete</strong>, from an early draft of ISO-19005-1, used by Adobe Acrobat 7.x</td> + </tr> + <tr> + <td>http://www.aiim.org/pdfa/ns/id</td> + <td><strong>obsolete</strong>, found in the original ISO 19005-1:2005 document</td> + </tr> + <tr> + <td>http://www.aiim.org/pdfa/ns/id/</td> + <td><strong>correct</strong>, found in the technical corrigendum 1 of ISO 19005-1:2005</td> + </tr> + </table> + <p> + If you get an error validating a PDF/A file in Adobe Acrobat 7.x it doesn't mean that + FOP did something wrong. It's Acrobat that is at fault. This is fixed in Adobe Acrobat 8.x + which uses the correct namespace as described in the technical corrigendum 1. + </p> + </section> + </body> +</document> diff --git a/src/documentation/content/xdocs/0.94/pdfencryption.xml b/src/documentation/content/xdocs/0.94/pdfencryption.xml new file mode 100644 index 000000000..c8cdbb29c --- /dev/null +++ b/src/documentation/content/xdocs/0.94/pdfencryption.xml @@ -0,0 +1,230 @@ +<?xml version="1.0" standalone="no"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!-- $Id$ --> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd"> +<document> + <header> + <title>PDF encryption.</title> + <version>$Revision$</version> + <authors> + <person name="J.Pietschmann" email="pietsch@apache.org"/> + <person name="Jeremias Märki" email="jeremias@apache.org"/> + </authors> + </header> + <body> + <section> + <title>Overview</title> + <p> + 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. + </p> + <p> + 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. + </p> + </section> + <section> + <title>Usage (command line)</title> + <p> + Encryption is enabled by supplying any of the encryption related + options. + </p> + <p> + An owner password is set with the <code>-o</code> option. This + password is actually used as encryption key. Many tools for + PDF processing ask for this password to disregard any + restriction imposed on the PDF document. + </p> + <p> + If no owner password has been supplied but FOP was asked to apply some + restrictions, a random password is used. In this case it is obviously + impossiible to disregard restrictions in PDF processing tools. + </p> + <p> + A user password, supplied with the <code>-u</code> option, will + cause the PDF display software to ask the reader for this password in + order to view the contents of the document. If no user password was + supplied, viewing the content is not restricted. + </p> + <p> + Further restrictions can be imposed by using the <code>-noprint</code>, + <code>-nocopy</code>, <code>-noedit</code> and + <code>-noannotations</code> options, which disable printing, copying + text, editing in Adobe Acrobat and making annotations, respectively. + </p> + </section> + <section> + <title>Usage (embedded)</title> + <p> + When FOP is embedded in another Java application you need to set an + options map on the renderer. These are the supported options: + </p> + <table> + <tr> + <th>Option</th> + <th>Description</th> + <th>Values</th> + <th>Default</th> + </tr> + <tr> + <td>ownerPassword</td> + <td>The owner password</td> + <td>String</td> + <td/> + </tr> + <tr> + <td>userPassword</td> + <td>The user password</td> + <td>String</td> + <td/> + </tr> + <tr> + <td>allowPrint</td> + <td>Allows/disallows printing of the PDF</td> + <td>"TRUE" or "FALSE"</td> + <td>"TRUE"</td> + </tr> + <tr> + <td>allowCopyContent</td> + <td>Allows/disallows copy/paste of content</td> + <td>"TRUE" or "FALSE"</td> + <td>"TRUE"</td> + </tr> + <tr> + <td>allowEditContent</td> + <td>Allows/disallows editing of content</td> + <td>"TRUE" or "FALSE"</td> + <td>"TRUE"</td> + </tr> + <tr> + <td>allowEditAnnotations</td> + <td>Allows/disallows editing of annotations</td> + <td>"TRUE" or "FALSE"</td> + <td>"TRUE"</td> + </tr> + </table> + <note> + Encryption is enabled as soon as one of these options is set. + </note> + <p> + An example to enable PDF encryption in Java code: + </p> + <source><![CDATA[ +import org.apache.fop.pdf.PDFEncryptionParams; + +[..] + +FOUserAgent userAgent = fopFactory.newFOUserAgent(); +useragent.getRendererOptions().put("encryption-params", new PDFEncryptionParams( + null, "password", false, false, true, true)); +Fop fop = fopFactory.newFop(MimeConstants.MIME_PDF, userAgent); +[..]]]></source> + <p> + The parameters for the constructor of PDFEncryptionParams are: + </p> + <ol> + <li>userPassword: String, may be null</li> + <li>ownerPassword: String, may be null</li> + <li>allowPrint: true if printing is allowed</li> + <li>allowCopyContent: true if copying content is allowed</li> + <li>allowEditContent: true if editing content is allowed</li> + <li>allowEditAnnotations: true if editing annotations is allowed</li> + </ol> + <p> + Alternatively, you can set each value separately in the Map provided by + FOUserAgent.getRendererOptions() by using the following keys: + </p> + <ol> + <li>user-password: String</li> + <li>owner-password: String</li> + <li>noprint: Boolean or "true"/"false"</li> + <li>nocopy: Boolean or "true"/"false"</li> + <li>noedit: Boolean or "true"/"false"</li> + <li>noannotations: Boolean or "true"/"false"</li> + </ol> + </section> + <section> + <title>Environment</title> + <p> + In order to use PDF encryption, FOP has to be compiled with + cryptography support. Currently, only <a + href="http://java.sun.com/j2se/1.4/docs/guide/security/jce/JCERefGuide.html">JCE</a> + 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. + </p> + <p> + Cryptography support must also be present at run time. In particular, a + provider for the RC4 cipher is needed. Unfortunately, the sample JCE + provider in Sun's JDK 1.4 does <strong>not</strong> provide RC4. If you + get a message saying + </p> + <source>"Cannot find any provider supporting RC4"</source> + <p> + then you don't have the needed infrastructure. + </p> + <p> + There are several commercial and a few Open Source packages which + provide RC4. A pure Java implementation is produced by <a + href="http://www.bouncycastle.org/">The Legion of the Bouncy + Castle</a>. <a + href="http://www.mozilla.org/projects/security/pki/jss/">Mozilla + JSS</a> is an interface to a native implementation. + </p> + </section> + <section id="install_crypto"> + <title>Installing a crypto provider</title> + <p> + The pure Java implementation from <a + href="http://www.bouncycastle.org/">Bouncy Castle</a> is easy to + install. + </p> + <ol> + <li> + Download the binary distribution for your JDK version. If you have JDK + 1.3 or earlier you must also download a JCE from the same page. + </li> + <li> + Unpack the distribution. Add the jar file to your classpath. A + convenient way to use the jar on Linux is to simply drop it into the + FOP lib directory, it will be automatically picked up by + <code>fop.sh</code>. If you have JDK 1.3 or earlier don't forget to + install the JCE as well. + </li> + <li> + Open the <code>java.security</code> file and add<br/> + <code>security.provider.6=org.bouncycastle.jce.provider.BouncyCastleProvider</code>,<br/> + preferably at the end of the block defining the other crypto + providers. For JDK 1.4 this is detailed on <a href="http://java.sun.com/j2se/1.4/docs/guide/security/jce/JCERefGuide.html#InstallProvider">Sun's web site</a>. + </li> + </ol> + <p> + If you have any experience with Mozilla JSS or any other + cryptography provider, please post it to the fop-user list. + </p> + </section> + </body> +</document> diff --git a/src/documentation/content/xdocs/0.94/pdfx.xml b/src/documentation/content/xdocs/0.94/pdfx.xml new file mode 100644 index 000000000..342a0ca4c --- /dev/null +++ b/src/documentation/content/xdocs/0.94/pdfx.xml @@ -0,0 +1,136 @@ +<?xml version="1.0" standalone="no"?> +<!-- + Copyright 2006 The Apache Software Foundation + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!-- $Id$ --> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "document-v20.dtd"> +<document> + <header> + <title>PDF/X (ISO 15930)</title> + <version>$Revision$</version> + <authors> + <person name="Jeremias Märki" email="jeremias@apache.org"/> + </authors> + </header> + <body> + <section id="overview"> + <title>Overview</title> + <warning> + Support for PDF/X was made available beginning with version 0.93. + This feature is new and may not be 100% complete, yet. Feedback is welcome. + </warning> + <p> + 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 + <a href="http://www.iso.org/iso/en/CatalogueDetailPage.CatalogueDetail?CSNUMBER=39940&ICS1=37&ICS2=100&ICS3=99">ISO 15930-6:2003(E)</a>. + More info on PDF/X can be found on the + <a href="http://www.pdfx.info/">PDF/X info site</a>. + </p> + </section> + <section id="status"> + <title>Implementation Status</title> + <p> + <strong>PDF/X-3:2003</strong> is implemented to the degree that FOP supports + the creation of the elements described in ISO 15930-6. + </p> + <p> + An important restriction of the current implementation is that all normal + RGB colors specified in XSL-FO and SVG are left unchanged in the sRGB color + space (XSL-FO and SVG both use sRGB as their default color space). + There's no conversion to a CMYK color space. Although sRGB is a + calibrated color space, its color space has a different size than a CMYK + color space which makes the conversion a lossy conversion and can lead to + unwanted results. Although the use of the calibrated sRGB has been promoted + for years, print shops usually prefer to convert an sRGB PDF to CMYK prior + to production. Until there's full CMYK support in FOP you will have to + work closely with your print service provider to make sure you get the + intended result. + </p> + <p> + 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. + </p> + </section> + <section id="command-line"> + <title>Usage (command line)</title> + <p> + 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. + </p> + </section> + <section id="embedded"> + <title>Usage (embedded)</title> + <p> + 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: + </p> + <source><![CDATA[ +FOUserAgent userAgent = fopFactory.newFOUserAgent(); +userAgent.getRendererOptions().put("pdf-x-mode", "PDF/X-3:2003"); +Fop fop = fopFactory.newFop(MimeConstants.MIME_PDF, userAgent); +[..]]]></source> + <p> + If one of the validation rules of PDF/X is violated, an PDFConformanceException + (descendant of RuntimeException) is thrown. + </p> + </section> + <section id="rules"> + <title>PDF/X in Action</title> + <p> + 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): + </p> + <ul> + <li> + Make sure all (!) fonts are embedded. If you use base 14 fonts (like Helvetica) + you need to obtain a license for them and embed them like any other font. + </li> + <li> + Don't use PDF encryption. PDF/X doesn't allow it. + </li> + <li> + Don't use CMYK images without an ICC color profile. PDF/X doesn't allow mixing + color spaces and FOP currently only properly supports the sRGB color space. However, + you will need to specify an + <a href="configuration.html#pdf-renderer">output device profile</a> + (usually a CMYK profile) in the configuration. sRGB won't work here since it's a + display device profile, not an output device profile. + </li> + <li> + Don't use non-RGB colors in SVG images. Same issue as with CMYK images. + </li> + <li> + Don't use EPS graphics with fo:external-graphic. Embedding EPS graphics in PDF + is deprecated since PDF 1.4 and prohibited by PDF/X-3:2003. + </li> + <li> + PDF is forced to version 1.4 if PDF/X-3:2003 is activated. + </li> + </ul> + </section> + <section id="profile-compatibility"> + <title>PDF profile compatibility</title> + <p> + The PDF profiles "PDF/X-3:2003" and "PDF/A-1b" are compatible and can both be + activated at the same time. + </p> + </section> + </body> +</document> diff --git a/src/documentation/content/xdocs/0.94/running.xml b/src/documentation/content/xdocs/0.94/running.xml new file mode 100644 index 000000000..c09f35fee --- /dev/null +++ b/src/documentation/content/xdocs/0.94/running.xml @@ -0,0 +1,348 @@ +<?xml version="1.0" standalone="no"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!-- $Id$ --> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd"> +<document> + <header> + <title>Running Apache FOP</title> + <version>$Revision$</version> + </header> + + <body> + <section id="require"> + <title>System Requirements</title> + <p>The following software must be installed:</p> + <ul> + <li>Java 1.3.x or later Runtime Environment.</li> + <li> + Apache FOP. The <a href="../download.html">FOP distribution</a> includes all libraries that you will + need to run a basic FOP installation. These can be found in the [fop-root]/lib directory. These + libraries include the following: + <ul> + <li> + A JAXP-compatible XML Parser (FOP comes with <a class="fork" href="ext:xerces">Apache Xerces-J</a>). + </li> + <li> + A JAXP-compatible XSLT Processor (FOP comes with <a class="fork" href="ext:xalan">Apache Xalan-J</a>). + </li> + <li><a class="fork" href="ext:batik">Apache Batik</a>, an SVG library.</li> + <li><a class="fork" href="ext:jakarta/commons/logging">Apache Jakarta Commons Logging</a>, a logger abstraction kit.</li> + <li><a class="fork" href="ext:jakarta/commons/io">Apache Jakarta Commons IO</a>, a library with I/O utilities.</li> + <li><a class="fork" href="ext:excalibur/framework">Apache Excalibur/Avalon Framework</a>, for XML configuration handling.</li> + </ul> + </li> + </ul> + <p>The following software is optional, depending on your needs:</p> + <ul> + <li> + Graphics libraries. Generally, FOP contains direct support for the most important + bitmap image formats (including PNG, TIFF, JPEG and GIF). If you're using JDK 1.3, + you may need additional packages to get GIF images to work. See + <a href="graphics.html">FOP: Graphics Formats</a> for details. + </li> + <li> + PDF encryption. See <a href="pdfencryption.html">FOP: PDF Encryption</a> for details. + </li> + </ul> + <p>In addition, the following system requirements apply:</p> + <ul> + <li> + If you will be using FOP to process SVG, you must do so in a graphical environment. + See <a href="graphics.html#batik">FOP: Graphics (Batik)</a> for details. + </li> + </ul> + </section> + <section id="install"> + <title>Installation</title> + <section id="install-instruct"> + <title>Instructions</title> + <p> + Basic FOP installation consists of first unzipping the <code>.gz</code> file that is the + distribution medium, then unarchiving the resulting <code>.tar</code> 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. + </p> + </section> + <section id="install-problems"> + <title>Problems</title> + <p> + 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 <code>tar -xzf</code> instead. + </p> + </section> + </section> + <section id="standalone-start"> + <title>Starting FOP as a Standalone Application</title> + <section id="fop-script"> + <title>Using the fop script or batch file</title> + <p> + 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 <code>/Library/Java/Home</code>. <strong>Caveat:</strong> + 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 + <a href="http://developer.apple.com/java/faq">Java on Mac OSX FAQ</a> for information as + it becomes available. + </p> + <source><![CDATA[ +USAGE +Fop [options] [-fo|-xml] infile [-xsl file] [-awt|-pdf|-mif|-rtf|-tiff|-png|-pcl|-ps|-txt|-at [mime]|-print] <outfile> + [OPTIONS] + -d debug mode + -x dump configuration settings + -q quiet mode + -c cfg.xml use additional configuration file cfg.xml + -l lang the language to use for user information + -r relaxed/less strict validation (where available) + -dpi xxx target resolution in dots per inch (dpi) where xxx is a number + -s for area tree XML, down to block areas only + -v to show FOP version being used + + -o [password] PDF file will be encrypted with option owner password + -u [password] PDF file will be encrypted with option user password + -noprint PDF file will be encrypted without printing permission + -nocopy PDF file will be encrypted without copy content permission + -noedit PDF file will be encrypted without edit content permission + -noannotations PDF file will be encrypted without edit annotation permission + -pdfprofile prof PDF file will be generated with the specified profile + (Examples for prof: PDF/A-1b or PDF/X-3:2003) + + [INPUT] + infile xsl:fo input file (the same as the next) + -fo infile xsl:fo input file + -xml infile xml input file, must be used together with -xsl + -atin infile area tree input file + -xsl stylesheet xslt stylesheet + + -param name value <value> to use for parameter <name> in xslt stylesheet + (repeat '-param name value' for each parameter) + + [OUTPUT] + outfile input will be rendered as PDF into outfile + -pdf outfile input will be rendered as PDF (outfile req'd) + -pdfa1b outfile input will be rendered as PDF/A-1b compliant PDF + (outfile req'd, same as "-pdf outfile -pdfprofile PDF/A-1b") + -awt input will be displayed on screen + -rtf outfile input will be rendered as RTF (outfile req'd) + -pcl outfile input will be rendered as PCL (outfile req'd) + -ps outfile input will be rendered as PostScript (outfile req'd) + -afp outfile input will be rendered as AFP (outfile req'd) + -tiff outfile input will be rendered as TIFF (outfile req'd) + -png outfile input will be rendered as PNG (outfile req'd) + -txt outfile input will be rendered as plain text (outfile req'd) + -at [mime] out representation of area tree as XML (outfile req'd) + specify optional mime output to allow AT to be converted + to final format later + -print input file will be rendered and sent to the printer + see options with "-print help" + -out mime outfile input will be rendered using the given MIME type + (outfile req'd) Example: "-out application/pdf D:\out.pdf" + (Tip: "-out list" prints the list of supported MIME types) + -mif outfile input will be rendered as MIF (FrameMaker) (outfile req'd) + Experimental feature - requires additional fop-sandbox.jar. + -svg outfile input will be rendered as an SVG slides file (outfile req'd) + Experimental feature - requires additional fop-sandbox.jar. + + -foout outfile input will only be XSL transformed. The intermediate + XSL-FO file is saved and no rendering is performed. + (Only available if you use -xml and -xsl parameters) + + + [Examples] + Fop foo.fo foo.pdf + Fop -fo foo.fo -pdf foo.pdf (does the same as the previous line) + Fop -xml foo.xml -xsl foo.xsl -pdf foo.pdf + Fop -xml foo.xml -xsl foo.xsl -foout foo.fo + Fop foo.fo -mif foo.mif + Fop foo.fo -rtf foo.rtf + Fop foo.fo -print or Fop -print foo.fo + Fop foo.fo -awt]]></source> + <p> + PDF encryption is only available if FOP was compiled with encryption support + <strong>and</strong> if compatible encryption support is available at run time. + Currently, only the JCE is supported. Check the <a href="pdfencryption.html">Details</a>. + </p> + </section> + <section id="your-own-script"> + <title>Writing your own script</title> + <p>FOP's entry point for your own scripts is the class +<code>org.apache.fop.cli.Main</code>. The general pattern for the + command line is: <code>java -classpath <CLASSPATH> + org.apache.fop.cli.Main <arguments></code>. 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. + </p> + </section> + <section id="jar-option"> + <title>Running with java's <code>-jar</code> option</title> + <p> + As an alternative to the start scripts you can run <code>java + -jar path/to/build/fop.jar <arguments></code>, relying on + FOP to build the classpath for running FOP dynamically, see <a + href="#dynamical-classpath">below</a>. If you use hyphenation, + you must put <code>fop-hyph.jar</code> in the <code>lib</code> + directory. + </p> + + <p>You can also run <code>java -jar path/to/fop.jar + <arguments></code>, relying on the <code>Class-Path</code> + entry in the manifest file. This works if you put + <code>fop.jar</code> and all jar files from the <code>lib</code> + directory in a single directory. If you use hyphenation, you + must also put <code>fop-hyph.jar</code> in that directory.</p> + + <p>In both cases the arguments consist of the options and + infile and outfile specifications as shown above for the + standard scripts.</p> + </section> + <section id="dynamical-classpath"> + <title>FOP's dynamical classpath construction</title> + + <p>If FOP is started without a proper classpath, it tries to + add its dependencies dynamically. If the system property + <code>fop.home</code> 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 <code>build</code>, + then its parent directory becomes the base directory.</p> + + <p>FOP expects to find <code>fop.jar</code> in the + <code>build</code> subdirectory of the base directory, and + adds it to the classpath. Subsequently FOP adds all + <code>jar</code> files in the lib directory to the + classpath. The lib directory is either the <code>lib</code> + subdirectory of the base directory, or, if that does not + exist, the base directory itself.</p> + + <p>If the system property <code>fop.optional.lib</code> + contains the name of a directory, then all <code>jar</code> + files in that directory are also added to the classpath. See + the methods <code>getJARList</code> and + <code>checkDependencies</code> in + <code>org.apache.fop.cli.Main</code>.</p> + + </section> + </section> + <section id="check-input"> + <title>Using Xalan to Check XSL-FO Input</title> + <p> + 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 + <a href="../resources.html#specs">Specifications</a> and + <a href="../resources.html#articles">Books/Articles</a>. + 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. + </p> + <note>The user is always responsible to provide correct XSL-FO code to FOP.</note> + <p> + In the case of using -xml and -xsl input, although the user is responsible for + the XSL-FO code that is FOP's input, it is not visible to the user. To make the + intermediate FO file visible, the FOP distribution includes the "-foout" option + which causes FOP to run only the first (transformation) step, and write the + results to a file. (See also the Xalan command-line below) + </p> + <note> + When asking for help on the FOP mailing lists, <em>never</em> attach XML and + XSL to illustrate the issue. Always run the XSLT step (-foout) and send the + resulting XSL-FO file instead. Of course, be sure that the XSL-FO file is + correct before sending it. + </note> + <p> + The -foout option works the same way as if you would call the + <a href="http://xml.apache.org/xalan-j/commandline.html">Xalan command-line</a>: + </p> + <p> + <code>java org.apache.xalan.xslt.Process -IN xmlfile -XSL file -OUT outfile</code> + </p> + <p> + Note that there are some subtle differences between the FOP and Xalan command-lines. + </p> + </section> + <section id="memory"> + <title>Memory Usage</title> + <p> + 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. + </p> + <p> + If you are running out of memory when using FOP, here are some ideas that may help: + </p> + <ul> + <li> + Increase memory available to the JVM. See + <a href="http://java.sun.com/j2se/1.3/docs/tooldocs/solaris/java.html">the -Xmx option</a> + for more information. + <warning> + It is usually unwise to increase the memory allocated to the JVM beyond the amount of + physical RAM, as this will generally cause significantly slower performance. + </warning> + </li> + <li> + Avoid forward references. + Forward references are references to some later part of a document. + Examples include page number citations which refer to pages which follow the citation, + tables of contents at the beginning of a document, and page numbering schemes that + include the total number of pages in the document + (<a href="../faq.html#pagenum">"page N of TOTAL"</a>). + Forward references cause all subsequent pages to be held in memory until the reference + can be resolved, i.e. until the page with the referenced element is encountered. + Forward references may be required by the task, but if you are getting a memory + overflow, at least consider the possibility of eliminating them. + A table of contents could be replaced by PDF bookmarks instead or moved to the end of + the document (reshuffle the paper could after printing). + </li> + <li> + Avoid large images, especially if they are scaled down. + If they need to be scaled, scale them in another application upstream from FOP. + For many image formats, memory consumption is driven mainly by the size of the image + file itself, not its dimensions (width*height), so increasing the compression rate + may help. + </li> + <li> + 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. + </li> + </ul> + </section> + <section id="problems"> + <title>Problems</title> + <p>If you have problems running FOP, please see the <a href="../gethelp.html">"How to get Help" page</a>.</p> + </section> + </body> +</document> diff --git a/src/documentation/content/xdocs/0.94/servlets.xml b/src/documentation/content/xdocs/0.94/servlets.xml new file mode 100644 index 000000000..119ac701e --- /dev/null +++ b/src/documentation/content/xdocs/0.94/servlets.xml @@ -0,0 +1,325 @@ +<?xml version="1.0" standalone="no"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!-- $Id$ --> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd"> +<document> + <header> + <title>Servlets</title> + <subtitle>How to use Apache FOP in a Servlet</subtitle> + <version>$Revision$</version> + </header> + <body> + <section id="overview"> + <title>Overview</title> + <p> + This page discusses topic all around using Apache FOP in a servlet environment. + </p> + </section> + <section id="example-servlets"> + <title>Example Servlets in the FOP distribution</title> + <p> + In the directory {fop-dir}/src/java/org/apache/fop/servlet, you'll find a working example + of a FOP-enabled servlet. + </p> + <p> + The servlet is automatically built when you build Apache FOP using the supplied Ant script. After building + the servlet, drop fop.war into the webapps directory of Apache Tomcat (or any other web container). Then, you can use + URLs like the following to generate PDF files: + </p> + <ul> + <li>http://localhost:8080/fop/fop?fo=/home/path/to/fofile.fo</li> + <li>http://localhost:8080/fop/fop?xml=/home/path/to/xmlfile.xml&xsl=/home/path/to/xslfile.xsl</li> + </ul> + <p/> + <p>The source code for the servlet can be found under {fop-dir}/src/java/org/apache/fop/servlet/FopServlet.java.</p> + <note> + 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. + </note> + </section> + <section id="servlet"> + <title>Create your own Servlet</title> + <note> + This section assumes you are familiar with <a href="embedding.html">embedding FOP</a>. + </note> + <section id="minimal-servlet"> + <title>A minimal Servlet</title> + <p> + Here is a minimal code snippet to demonstrate the basics: + </p> + <source>private FopFactory fopFactory = FopFactory.newInstance(); +private TransformerFactory tFactory = TransformerFactory.newInstance(); + +public void doGet(HttpServletRequest request, + HttpServletResponse response) throws ServletException { + try { + response.setContentType("application/pdf"); + Fop fop = fopFactory.newFop(MimeConstants.MIME_PDF, response.getOutputStream()); + Transformer transformer = tFactory.newTransformer(); + Source src = new StreamSource("foo.fo"); + Result res = new SAXResult(fop.getDefaultHandler()); + transformer.transform(src, res); + } catch (Exception ex) { + throw new ServletException(ex); + } +}</source> + <note> + There are numerous problems with the code snippet above. + Its purpose is only to demonstrate the basic concepts. + See below for details. + </note> + </section> + <section id="xslt"> + <title>Adding XSL tranformation (XSLT)</title> + <p> + 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: + </p> + <source>private FopFactory fopFactory = FopFactory.newInstance(); +private TransformerFactory tFactory = TransformerFactory.newInstance(); + +public void init() throws ServletException { + //Optionally customize the FopFactory and TransformerFactory here +} + +[..] + + //Setup a buffer to obtain the content length + ByteArrayOutputStream out = new ByteArrayOutputStream(); + + //Setup FOP + Fop fop = fopFactory.newFop(MimeConstants.MIME_PDF, out); + + //Setup Transformer + Source xsltSrc = new StreamSource(new File("foo-xml2fo.xsl")); + Transformer transformer = tFactory.newTransformer(xsltSrc); + + //Make sure the XSL transformation's result is piped through to FOP + Result res = new SAXResult(fop.getDefaultHandler()); + + //Setup input + Source src = new StreamSource(new File("foo.xml")); + + //Start the transformation and rendering process + transformer.transform(src, res); + + //Prepare response + response.setContentType("application/pdf"); + response.setContentLength(out.size()); + + //Send content to Browser + response.getOutputStream().write(out.toByteArray()); + response.getOutputStream().flush();</source> + <note> + Buffering the generated PDF in a ByteArrayOutputStream is done to avoid potential + problems with the Acrobat Reader Plug-in in Microsoft Internet Explorer. + </note> + <p> + The <code>Source</code> instance used above is simply an + example. If you have to read the XML from a string, supply + a <code>new StreamSource(new + StringReader(xmlstring))</code>. Constructing and reparsing + an XML string is generally less desirable than using a + SAXSource if you generate your XML. You can alternatively + supply a DOMSource as well. You may also use dynamically + generated XSL if you like. + </p> + <p> + Because you have an explicit <code>Transformer</code> object, you can also use it to + explicitely set parameters for the transformation run. + </p> + </section> + <section id="cfg"> + <title>Custom configuration</title> + <p> + You can easily set up your own FOUserAgent as demonstrated on the <a href="embedding.html">Embedding page</a>. + </p> + </section> + <section id="performance"> + <title>Improving performance</title> + <p> + There are several options to consider: + </p> + <ul> + <li> + Instead of java.io.ByteArrayOutputStream consider using the ByteArrayOutputStream + implementation from the <a href="ext:jakarta/commons/io">Jakarta Commons IO project</a> which allocates less memory. + The full class name is: <code>org.apache.commons.io.output.ByteArrayOutputStream</code> + </li> + <li> + In certain cases it can help to write the generated PDF to a temporary file so + you can quickly reuse the file. This is especially useful, if Internet Explorer + calls the servlet multiple times with the same request or if you often generate + equal PDFs. + </li> + </ul> + <p> + Of course, the + <a href="embedding.html#performance">performance hints from the Embedding page</a> + apply here, too. + </p> + </section> + <section id="uriresolver"> + <title>Accessing resources in your web application</title> + <p> + 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 + <code>org.apache.fop.servlet.ServletContextURIResolver</code>. + </p> + <p> + Here's how to set it up in your servlet. Instantiate a new instance in the servlet's + init() method: + </p> + <source><![CDATA[ + /** URIResolver for use by this servlet */ + protected URIResolver uriResolver; + + public void init() throws ServletException { + this.uriResolver = new ServletContextURIResolver(getServletContext()); + [..] + }]]></source> + <p> + The ServletContextURIResolver reacts on URIs beginning with "servlet-context:". If you + want to access an image in a subdirectory of your web application, you could, for + example, use: "servlet-context:/images/myimage.png". Don't forget the leading slash + after the colon! + </p> + <p> + Further down, you can use the URIResolver for various things: + </p> + <ul> + <li> + With the Transformer (JAXP/XSLT) so things like document() functions can resolver + "servlet-context:" URIs. + </li> + <li> + With the FopFactory so every resource FOP loads can be loaded using a "servlet-context:" + URI. + </li> + <li> + You can the ServletContextURIResolver yourself in your servlet code to access + stylesheets or XML files bundled with your web application. + </li> + </ul> + <p> + Here are some example snippets: + </p> + <source><![CDATA[ +//Setting up the JAXP TransformerFactory +this.transFactory = TransformerFactory.newInstance(); +this.transFactory.setURIResolver(this.uriResolver); + +[..] + +//Setting up the FOP factory +this.fopFactory = FopFactory.newInstance(); +this.fopFactory.setURIResolver(this.uriResolver); + +[..] + +//The stylesheet for the JAXP Transfomer +Source xsltSrc = this.uriResolver.resolve( + "servlet-context:/xslt/mystylesheet.xsl", null); +Transformer transformer = this.transFactory.newTransformer(xsltSrc); +transformer.setURIResolver(this.uriResolver);]]></source> + </section> + </section> + <section id="ie"> + <title>Notes on Microsoft Internet Explorer</title> + <p> + 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: + </p> + <ul> + <li> + Use an URL ending in <code>.pdf</code>, like + <code>http://myserver/servlet/stuff.pdf</code>. Yes, the servlet can + be configured to handle this. If the URL has to contain parameters, + try to have <strong>both</strong> the base URL as well as the last parameter end in + <code>.pdf</code>, if necessary append a dummy parameter, like + <code>http://myserver/servlet/stuff.pdf?par1=a&par2=b&d=.pdf</code>. The + effect may depend on IEx version. + </li> + <li> + Give IEx the opportunity to cache. In particular, ensure the + server does not set any headers causing IEx not to cache the + content. This may be a real problem if the document is sent + over HTTPS, because most IEx installations will by default + <em>not</em> cache any content retrieved over HTTPS. + Setting the <code>Expires</code> header entry may help in + this case:<br/> <code>response.setDateHeader("Expires", + System.currentTimeMillis() + cacheExpiringDuration * + 1000);</code><br/> Consult your server manual and the + relevant RFCs for further details on HTTP headers and + caching. + </li> + <li> + 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. + </li> + </ul> + </section> + <section id="servlet-engine"> + <title>Servlet Engines</title> + <p> + 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. + </p> + <section id="tomcat"> + <title>Tomcat</title> + <p> + 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. + </p> + </section> + <section id="websphere"> + <title>WebSphere 3.5</title> + <p> + 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. + </p> + </section> + </section> + <section id="complex-usecases"> + <title>Handling complex use cases</title> + <p> + 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 <a class="fork" href="ext:cocoon">Apache Cocoon</a> instead + of a custom servlet to accomplish your goal. + </p> + </section> + </body> +</document>
\ No newline at end of file diff --git a/src/documentation/content/xdocs/0.94/upgrading.xml b/src/documentation/content/xdocs/0.94/upgrading.xml new file mode 100644 index 000000000..b9bec0d66 --- /dev/null +++ b/src/documentation/content/xdocs/0.94/upgrading.xml @@ -0,0 +1,132 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!-- $Id$ --> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd"> +<document> + <header> + <title>Upgrading from an Earlier Version of Apache FOP</title> + <version>$Revision$</version> + </header> + <body> + <section id="important"> + <title>Important!</title> + <p> + If you're planning to upgrade to the latest FOP version there are a few very important things + to consider: + </p> + <ul> + <li> + More than half of the codebase has been rewritten over the last three years. With version 0.93 the code has reached <strong>production level</strong>, and + the tradition continues with version 0.94. + </li> + <li> + The API of FOP has changed considerably and is not + backwards-compatible with versions 0.20.5 and + 0.91beta. Version 0.92 introduced the <strong>new stable + API</strong>. + </li> + <li> + Since version 0.92 some deprecated methods which were part + of the old API have been removed. If you upgrade from 0.91 + beta, you will need to adjust your Java code. Similarly if + you upgrade from 0.92 and use deprecated methods. + </li> + <li> + If you are using a configuration file for version 0.20.5, you have to rebuild it in the new format. The format + of the configuration files has changed since version 0.20.5. See <code>conf/fop.xconf</code> for + an example configuration file. A XML Schema file can be found under + <code>src/foschema/fop-configuration.xsd</code>. + </li> + <li> + If you are using font metrics files for version 0.20.5 or + 0.92 or earlier, you have to regenerate them in the new + format. The new format is characterized by a version + attribute on the top-level font-metrics element, whose value + is 2.0. The absence of a version attribute will be + interpreted as version 1.0, and such metrics files will no + longer be parsed. + </li> + <li> + <p> + The new code is much more strict about the interpretation of the XSL-FO 1.0 specification. + Things that worked fine in version 0.20.5 might start to produce warnings or even errors + now. FOP 0.20.5 contains many bugs which have been corrected in the new code. + </p> + <note label="An example"> + While FOP 0.20.5 allowed you to have empty <code>fo:table-cell</code> elements, the new code + will complain about that (unless <a href="/0.94/running.html#fop-script">relaxed validation is enabled</a> via the <code>-r</code> switch via the command line) because the specification + demands at least one block-level element (<code>(%block;)+</code>, see + <a href="http://www.w3.org/TR/2001/REC-xsl-20011015/slice6.html#fo_table-cell">XSL-FO 1.0, 6.7.10</a>) + inside an <code>fo:table-cell</code> element. + </note> + </li> + <li> + Extensions and Renderers written for version 0.20.5 will not work with the new code! The new FOP + extension for <a href="http://barcode4j.krysalis.org">Barcode4J</a> is available since + January 2007. + </li> + <li> + 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. + </li> + </ul> + </section> + <section id="issues"> + <title>What you need to know when you upgrade!</title> + <p> + 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. + </p> + <ul> + <li> + Check the <a href="../compliance.html">Compliance page</a> for the feature causing + trouble. It may contain the necessary information to understand and resolve the problem. + </li> + <li> + Not all 0.20.5 output formats are supported. PDF and Postscript should be fully supported. + See <a href="output.html">Output Targets</a> for a more complete description. + </li> + <li> + As stated above empty table cells <code><fo:table-cell></fo:table-cell></code> + are not allowed by the specification. The same applies to empty <code>static-content</code> + and <code>block-container</code> elements, for example. + </li> + <li> + 0.20.5 is not XSL-FO compliant with respect to sizing images (<code>external-graphic</code>) + or <code>instream-foreign-object</code> + objects. If images or SVGs are sized differently in your outputs with the new FOP version + check <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=37136">Bug 37136</a> + as it contains some hints on what to do. The file + <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/fo/basic/images.fo?view=markup"> + <code>"examples/fo/basic/images.fo"</code></a> has + a number of good examples that show the new, more correct behaviour. + </li> + <li> + The <code>fox:outline</code> extension is not implemented in this version anymore. + It has been superseded by the new bookmark elements from XSL-FO 1.1. + </li> + <li> + The <code>fox:destination</code> extension is also not implemented in this version + although it may be added in the future. See also + <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=37157">Bug 37157</a>. + </li> + </ul> + </section> + </body> +</document> |