Installation

ids. git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196349 13f79535-47bb-0310-9956-ffa450edef68 --- src/documentation/content/xdocs/running.xml | 45 +++++++++++---------- 1 file changed, 24 insertions(+), 21 deletions(-) diff --git a/src/documentation/content/xdocs/running.xml b/src/documentation/content/xdocs/running.xml index 22e17e163..399ec804d 100644 --- a/src/documentation/content/xdocs/running.xml +++ b/src/documentation/content/xdocs/running.xml @@ -8,9 +8,9 @@ -

Installation -

Overview

The following software must be installed:

Optional Libraries

Instructions

Basic FOP installation consists of first unzipping the .gz file that is the distribution medium, then unarchiving the resulting .tar file in a directory/folder that is convenient on your system. Please consult your operating system documentation or Zip application software documentation for instructions specific to your site.

Problems

Some Mac OSX users have experienced filename truncation problems using Stuffit to unzip and unarchive their distribution media. This is a legacy of older Mac operating systems, which had a 31-character pathname limit. Several Mac OSX users have recommended that Mac OSX users use the shell command tar -xzf instead.

- Starting FOP as a standalone application -

Review the batch file fop.bat or the shell script fop.sh to see how FOP is invoked.

+ Starting FOP as a Standalone Application +

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.sh (Unix/Linux). +If you write your own scripts, be sure to review these standard scripts to make sure that you get your environment properly configured.

The standard scripts for starting FOP require that the environment variable JAVA_HOME be set to a path pointing to the appropriate Java installation on your system. Macintosh OSX includes a Java environment as part of its distribution. We are told by Mac OSX users that the path to use in this case is /Library/Java/Home. Caveat: We suspect that, as Apple releases new Java environments and as FOP upgrades the minimum Java requirements, the two will inevitably not match on some systems. Please see Java on Mac OSX FAQ for information as it becomes available.

fop [options] [-fo|-xml] infile [-xsl file] [-awt|-pdf|-mif|-pcl|-ps|-txt|-svg|-at|-print] <outfile>

[OPTIONS]

@@ -81,24 +82,26 @@ fop foo.fo -awt

PDF encryption is only available if FOP was compiled with encryption support and if compatible encryption support is availabe at run time. Currently, only the JCE is supported. Check the Details.

- Running Xalan +

+ Using Xalan to Check XSL-FO Input +

FOP sessions that use -xml and -xsl input instead of -fo input are actually controlling two distinct conversions: Tranforming XML to XSL-FO, then formatting the XSL-FO to PDF (or another FOP output format). +Although FOP controls both of these processes, the first is included merely as a convenience and for performance reasons. +Only the second is part of FOP's core processing. +If a user has a problem running FOP, it is important to determine which of these two processes is causing the problem. +If the problem is in the first process, the user's stylesheet is likely the cause. +The FOP development team does not have resources to help with stylesheet issues, although we have included links to some useful Specifications and Books/Articles. +If the problem is in the second process, FOP may have a bug or an unimplemented feature that does require attention from the FOP development team.

+ The user is always responsible to provide correct XSL-FO code to FOP. +

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 xalan.bat (Windows batch file) and xalan.sh (Unix/Linux script), which run only the first (transformation) step, and write the results to a file.

+ When asking for help on the FOP mailing lists, never attach XML and XSL to illustrate the issue. Always run the xalan script and send the resulting XSL-FO file instead. Of course, be sure that the XSL-FO file is correct before sending it.

- The FOP distribution provicdes a Xalan.bat and a Xalan.sh - script for conveniently running an XSL transformation without - formatting. This can be useful for tracking down problems - introduced during transformation and for preparing FO files - for all kinds of purposes, including for inquiring help on the - mailing lists. -

- The scripts are invoked the same way Xalan is, in short: + The scripts are invoked the same way that Xalan is:

xalan -in xmlfile -xsl file -out outfile

- Note that there are subtle differences to the FOP command line. + Note that there are some subtle differences between the "fop" and "xalan" command lines.

@@ -156,9 +159,9 @@ One of FOP's stated design goals is to be able to process input of arbitrary siz Addressing this goal is one of the prime motivations behind the FOP Redesign.

Problems -

If you have problems running FOP, please have a look at the "How to get Help" page.

If you have problems running FOP, please see the "How to get Help" page.

-- 2.39.5