You are viewing a plain text version of this content. The canonical link for it is here.
Posted to fop-commits@xmlgraphics.apache.org by ga...@apache.org on 2012/07/05 21:15:15 UTC
svn commit: r1357814 [6/7] - in /xmlgraphics/fop/branches/fop-1_1: ./
src/documentation/content/ src/documentation/content/xdocs/
src/documentation/content/xdocs/1.1rc1/
src/documentation/content/xdocs/1.1rc1/fotree/
src/documentation/content/xdocs/1.1...
Added: xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/1.1rc1/pdfencryption.xml
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/1.1rc1/pdfencryption.xml?rev=1357814&view=auto
==============================================================================
--- xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/1.1rc1/pdfencryption.xml (added)
+++ xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/1.1rc1/pdfencryption.xml Thu Jul 5 19:15:13 2012
@@ -0,0 +1,301 @@
+<?xml version="1.0" encoding="UTF-8" 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: 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>
+ Apache⢠FOP supports encryption of PDF output, thanks to Patrick
+ C. Lankswert. This feature is commonly used to prevent
+ unauthorized viewing, printing, editing, copying text from the
+ document and doing annotations. It is also possible to ask the
+ user for a password in order to view the contents. Note that
+ there already exist third party applications which can decrypt
+ an encrypted PDF without effort and allow the aforementioned
+ operations, therefore the degree of protection is limited.
+ </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 following command-line options:
+ <table>
+ <tr>
+ <th>Option</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><code>-noprint</code></td>
+ <td>disable printing</td>
+ </tr>
+ <tr>
+ <td><code>-nocopy</code></td>
+ <td>disable copy/paste of content</td>
+ </tr>
+ <tr>
+ <td><code>-noedit</code></td>
+ <td>disable editing in Adobe Acrobat</td>
+ </tr>
+ <tr>
+ <td><code>-noannotations</code></td>
+ <td>disable editing of annotations</td>
+ </tr>
+ <tr>
+ <td><code>-nofillinforms</code></td>
+ <td>disable filling in forms</td>
+ </tr>
+ <tr>
+ <td><code>-noaccesscontent</code></td>
+ <td>disable text and graphics extraction for accessibility purposes</td>
+ </tr>
+ <tr>
+ <td><code>-noassembledoc</code></td>
+ <td>disable assembling documents</td>
+ </tr>
+ <tr>
+ <td><code>-noprinthq</code></td>
+ <td>disable high quality printing</td>
+ </tr>
+ </table>
+ </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>encryption-length</td>
+ <td>The encryption length in bit</td>
+ <td>Any multiple of 8 between 40 and 128</td>
+ <td>40</td>
+ </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 in Adobe Acrobat</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>
+ <tr>
+ <td>allowFillInForms</td>
+ <td>Allows/disallows filling in forms</td>
+ <td>"TRUE" or "FALSE"</td>
+ <td>"TRUE"</td>
+ </tr>
+ <tr>
+ <td>allowAccessContent</td>
+ <td>Allows/disallows text and graphics extraction for accessibility purposes</td>
+ <td>"TRUE" or "FALSE"</td>
+ <td>"TRUE"</td>
+ </tr>
+ <tr>
+ <td>allowAssembleDocument</td>
+ <td>Allows/disallows assembling document</td>
+ <td>"TRUE" or "FALSE"</td>
+ <td>"TRUE"</td>
+ </tr>
+ <tr>
+ <td>allowPrintHq</td>
+ <td>Allows/disallows high quality printing</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>
+ <li>allowFillInForms: true if filling in forms is allowed.</li>
+ <li>allowAccessContent: true if extracting text and graphics is allowed</li>
+ <li>allowAssembleDocument: true if assembling document is allowed</li>
+ <li>allowPrintHq: true if printing to high quality 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>
+ <li>nofillinforms: Boolean or "true"/"false"</li>
+ <li>noaccesscontent: Boolean or "true"/"false"</li>
+ <li>noassembledoc: Boolean or "true"/"false"</li>
+ <li>noprinthq: 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.
+ </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>.
+ </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>
\ No newline at end of file
Added: xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/1.1rc1/pdfx.xml
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/1.1rc1/pdfx.xml?rev=1357814&view=auto
==============================================================================
--- xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/1.1rc1/pdfx.xml (added)
+++ xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/1.1rc1/pdfx.xml Thu Jul 5 19:15:13 2012
@@ -0,0 +1,136 @@
+<?xml version="1.0" encoding="UTF-8" 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>Apache⢠FOP: 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 is 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>
\ No newline at end of file
Added: xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/1.1rc1/running.xml
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/1.1rc1/running.xml?rev=1357814&view=auto
==============================================================================
--- xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/1.1rc1/running.xml (added)
+++ xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/1.1rc1/running.xml Thu Jul 5 19:15:13 2012
@@ -0,0 +1,370 @@
+<?xml version="1.0" encoding="UTF-8" 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.4.x or later Runtime Environment.
+ <ul>
+ <li>
+ Many JREs >=1.4 contain older JAXP implementations (which often contain bugs). It's
+ usually a good idea to replace them with a current implementation.
+ </li>
+ </ul>
+ </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 class="fork" href="ext:xmlgraphics.apache.org/commons">Apache XML Graphics Commons</a>, an shared library for Batik and FOP.</li>
+ <li><a class="fork" href="ext:batik">Apache Batik</a>, an SVG library.</li>
+ <li><a class="fork" href="ext:commons-logging">Apache Commons Logging</a>, a logger abstraction kit.</li>
+ <li><a class="fork" href="ext:commons-io">Apache 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, JPEG and GIF). 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]
+ -version print FOP version and exit
+ -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
+ -nocs disable complex script features
+ -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 run in verbose mode (currently simply print FOP version and continue)
+
+ -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
+ -nofillinforms PDF file will be encrypted without fill in forms permission
+ -noaccesscontent PDF file will be encrypted without extract text and graphics permission
+ -noassembledoc PDF file will be encrypted without assemble the document permission
+ -noprinthq PDF file will be encrypted without print high quality permission
+ -a enables accessibility features (Tagged PDF etc., default off)
+ -pdfprofile prof PDF file will be generated with the specified profile
+ (Examples for prof: PDF/A-1b or PDF/X-3:2003)
+
+ -conserve enable memory-conservation policy (trades memory-consumption for disk I/O)
+ (Note: currently only influences whether the area tree is serialized.)
+
+ -cache specifies a file/directory path location
+ -flush flushes the current font cache file
+
+ [INPUT]
+ infile xsl:fo input file (the same as the next)
+ (use '-' for infile to pipe input from stdin)
+ -fo infile xsl:fo input file
+ -xml infile xml input file, must be used together with -xsl
+ -atin infile area tree input file
+ -ifin infile intermediate format input file
+ -imagein infile image input file (piping through stdin not supported)
+ -xsl stylesheet xslt stylesheet
+
+ -param name value <value> to use for parameter <name> in xslt stylesheet
+ (repeat '-param name value' for each parameter)
+
+ -catalog use catalog resolver for input XML and XSLT files
+ [OUTPUT]
+ outfile input will be rendered as PDF into outfile
+ (use '-' for outfile to pipe output to stdout)
+ -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 the AT to be converted
+ to final format later
+ -if [mime] out representation of document in intermediate format XML (outfile req'd)
+ specify optional mime output to allow the IF 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)
+ -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 -xml - -xsl foo.xsl -pdf -
+ fop foo.fo -mif foo.mif
+ fop foo.fo -rtf foo.rtf
+ fop foo.fo -print
+ 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.4/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>
Added: xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/1.1rc1/servlets.xml
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/1.1rc1/servlets.xml?rev=1357814&view=auto
==============================================================================
--- xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/1.1rc1/servlets.xml (added)
+++ xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/1.1rc1/servlets.xml Thu Jul 5 19:15:13 2012
@@ -0,0 +1,325 @@
+<?xml version="1.0" encoding="UTF-8" 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: 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: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
Added: xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/1.1rc1/upgrading.xml
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/1.1rc1/upgrading.xml?rev=1357814&view=auto
==============================================================================
--- xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/1.1rc1/upgrading.xml (added)
+++ xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/1.1rc1/upgrading.xml Thu Jul 5 19:15:13 2012
@@ -0,0 +1,181 @@
+<?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="fop-1.0">
+ <title>Upgrading from Version 1.0</title>
+ <p>
+ You should encounter very few issues in upgrading from FOP 1.0, except as noted in the following:
+ </p>
+ <ul>
+ <li>
+ The intermediate format (IF) output format has underwent minor modification as follows:
+ <ul>
+ <li>
+ In order to track changes to the IF format, a <code>version</code> attribute has been added to the root
+ <code>document</code> element. Since no version information was provided previously, the initial
+ value of this attribute is <code>2.0</code>. Future backward compatible changes will update the minor
+ version number, while future non-backward compatible changes will update the major version number.
+ </li>
+ <li>
+ On the <code>text</code> element, a new alternate representation is used for adjustments to glyph positions as expressed by a <code>dp</code>
+ attribute instead of the <code>dx</code> attribute. For further information, see
+ <a href="http://mail-archives.apache.org/mod_mbox/xmlgraphics-fop-dev/201202.mbox/%3cCACQ=j+evStXx=7hW=CHVNKCrZHUso9FHZCSk_5EoENOHcGpGOg@mail.gmail.com%3e">complex
+ script patch - intermediate format changes</a>.
+ </li>
+ <li>
+ On the <code>border-rect</code> element, the attributes {<code>before</code>, <code>after</code>, <code>start</code>, <code>end</code>}
+ have been renamed to {<code>top</code>, <code>bottom</code>, <code>left</code>, <code>right</code>}, respectively.
+ For further information, see
+ <a href="http://mail-archives.apache.org/mod_mbox/xmlgraphics-fop-dev/201202.mbox/%3cCACQ=j+evStXx=7hW=CHVNKCrZHUso9FHZCSk_5EoENOHcGpGOg@mail.gmail.com%3e">complex
+ script patch - intermediate format changes</a>.
+ </li>
+ </ul>
+ </li>
+ <li>
+ The <code>IFPainter</code> interface (of package <code>org.apache.fop.render.intermediate</code>), specifically the
+ <code>drawText</code> and <code>drawBorderRect</code> method signatures, have been modified to express the semantics of the above changes to the IF output format.
+ </li>
+ <li>
+ The area tree (AT) output format has underwent minor modification as follows:
+ <ul>
+ <li>
+ In order to track changes to the AT format, a <code>version</code> attribute has been added to the root
+ <code>areaTree</code> element. Since no version information was provided previously, the initial
+ value of this attribute is <code>2.0</code>. Future backward compatible changes will update the minor
+ version number, while future non-backward compatible changes will update the major version number.
+ </li>
+ <li>
+ An optional <code>level</code> attribute has been added to a number of element types to express resolved bidirectional level.
+ </li>
+ <li>
+ An optional <code>reversed</code> attribute has been added to the <code>word</code> element type to express that the glyphs that
+ correspond to the character content of the element should be reversed (in order) in the inline progression dimension when rendering.
+ </li>
+ </ul>
+ </li>
+ <li>
+ Because complex script features are now enabled by default, it is possible that different font specific data will be used for
+ kerning than was previously used. This may be the case if a font supports a traditional TrueType <code>kern</code> table and
+ also supports the advanced typographic <code>kern</code> feature with a <code>GPOS</code> table. In FOP 1.0, the former is used for kerning,
+ while in FOP 1.1 with complex script features enabled, the latter is used. If it is desired to explicitly use the <code>kern</code> table (rather
+ than the <code>GPOS</code> table) in such a case, then the <code>-nocs</code> command line option may be used when invoking FOP
+ in order to disable complex script features.
+ </li>
+ </ul>
+ </section>
+ <section id="pre-1.0">
+ <title>Upgrading from Pre-1.0 Versions</title>
+ <p>
+ If you're planning to upgrade to the latest Apache⢠FOP version from a pre-1.0 version,
+ there are a few very important things to consider:
+ </p>
+ <ul>
+ <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 conf/fop.xconf for
+ an example configuration file. A XML Schema file can be found under
+ src/foschema/fop-configuration.xsd.
+ </li>
+ <li>
+ Beginning with version 0.94 you can skip the generation of
+ font metric files and remove the "font-metrics" attribute
+ in the font configuration. In the unlikely case that due to
+ a bug you still need to use font metrics files you will need
+ to regenerate the font metrics file if yours are from a FOP
+ version before 0.93.
+ </li>
+ <li>
+ <p>
+ The new code is much more strict about the interpretation of the XSL-FO 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 relaxed validation is enabled) because the specification
+ demands at least one block-level element (<code>(%block;)+</code>, see
+ <a href="http://www.w3.org/TR/xsl/#fo_table-cell">XSL-FO 1.1, 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.sourceforge.net">Barcode4J</a> is available since
+ January 2007.
+ </li>
+ <li>
+ The SVG Renderer and the MIF Handler have not yet been resurrected! They are currently non-functional
+ and hope for someone to step up and reimplement them.
+ </li>
+ </ul>
+ <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>fo:static-content</code>
+ and <code>fo:block-container</code> elements, for example.
+ </li>
+ <li>
+ Version 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 correct behaviour.
+ </li>
+ <li>
+ The <code>fox:outline</code> extension is not implemented in the current version:
+ it has been superseded by the new bookmark elements from XSL-FO 1.1.
+ </li>
+ </ul>
+ </section>
+ </body>
+</document>
Modified: xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/bugs.xml
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/bugs.xml?rev=1357814&r1=1357813&r2=1357814&view=diff
==============================================================================
--- xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/bugs.xml (original)
+++ xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/bugs.xml Thu Jul 5 19:15:13 2012
@@ -17,7 +17,6 @@
-->
<!-- $Id$ -->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd">
-
<document>
<header>
<title>Apache⢠FOP: Bugs and Other Trackable Issues</title>
Modified: xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/compliance.ihtml
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/compliance.ihtml?rev=1357814&r1=1357813&r2=1357814&view=diff
==============================================================================
--- xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/compliance.ihtml (original)
+++ xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/compliance.ihtml Thu Jul 5 19:15:13 2012
@@ -560,9 +560,9 @@
<th rowspan="2">Comments</th>
</tr>
<tr>
- <th align="center">0.95 (stable)</th>
<th align="center">1.0 (stable)</th>
- <th align="center">develop- ment</th>
+ <th align="center">1.1 (rc1)</th>
+ <th align="center">development</th>
</tr>
<tr>
@@ -883,8 +883,8 @@
<td><a name="fo-object-bidi-override" id="fo-object-bidi-override">bidi-override</a></td>
<td class="extended">Extended</td>
<td class="no">no</td>
- <td class="no">no</td>
- <td class="no">no</td>
+ <td class="yes">yes</td>
+ <td class="yes">yes</td>
<td> </td>
</tr>
<tr>
@@ -1439,7 +1439,7 @@
"http://www.w3.org/TR/xsl/#fo_wrapper">§6.13.4</a></td>
<td><a name="fo-object-wrapper" id="fo-object-wrapper">wrapper</a></td>
<td class="basic">Basic</td>
- <td class="partial">partial</td>
+ <td class="yes">yes</td>
<td class="yes">yes</td>
<td class="yes">yes</td>
<td>Only works as expected with inline-level content.</td>
@@ -1491,8 +1491,8 @@
<th rowspan="2">Comments</th>
</tr>
<tr>
- <th align="center">0.95 (stable)</th>
<th align="center">1.0 (stable)</th>
+ <th align="center">1.1 (rc1)</th>
<th align="center">develop- ment</th>
</tr>
@@ -1596,7 +1596,6 @@
<td class="na">na</td>
<td class="na">na</td>
<td class="na">na</td>
- <td class="na">na</td>
<td> </td>
</tr>
<tr>
@@ -1607,7 +1606,6 @@
<td class="na">na</td>
<td class="na">na</td>
<td class="na">na</td>
- <td class="na">na</td>
<td> </td>
</tr>
<tr>
@@ -1618,7 +1616,6 @@
<td class="na">na</td>
<td class="na">na</td>
<td class="na">na</td>
- <td class="na">na</td>
<td> </td>
</tr>
<tr>
@@ -1629,7 +1626,6 @@
<td class="na">na</td>
<td class="na">na</td>
<td class="na">na</td>
- <td class="na">na</td>
<td> </td>
</tr>
<tr>
@@ -1640,7 +1636,6 @@
<td class="na">na</td>
<td class="na">na</td>
<td class="na">na</td>
- <td class="na">na</td>
<td> </td>
</tr>
<tr>
@@ -1651,7 +1646,6 @@
<td class="na">na</td>
<td class="na">na</td>
<td class="na">na</td>
- <td class="na">na</td>
<td> </td>
</tr>
<tr>
@@ -1662,7 +1656,6 @@
<td class="na">na</td>
<td class="na">na</td>
<td class="na">na</td>
- <td class="na">na</td>
<td> </td>
</tr>
<tr>
@@ -1673,7 +1666,6 @@
<td class="na">na</td>
<td class="na">na</td>
<td class="na">na</td>
- <td class="na">na</td>
<td> </td>
</tr>
<tr>
@@ -1684,7 +1676,6 @@
<td class="na">na</td>
<td class="na">na</td>
<td class="na">na</td>
- <td class="na">na</td>
<td> </td>
</tr>
<tr>
@@ -1695,7 +1686,6 @@
<td class="na">na</td>
<td class="na">na</td>
<td class="na">na</td>
- <td class="na">na</td>
<td> </td>
</tr>
<tr>
@@ -1706,7 +1696,6 @@
<td class="na">na</td>
<td class="na">na</td>
<td class="na">na</td>
- <td class="na">na</td>
<td> </td>
</tr>
<tr>
@@ -1717,7 +1706,6 @@
<td class="na">na</td>
<td class="na">na</td>
<td class="na">na</td>
- <td class="na">na</td>
<td> </td>
</tr>
<tr>
@@ -1728,7 +1716,6 @@
<td class="na">na</td>
<td class="na">na</td>
<td class="na">na</td>
- <td class="na">na</td>
<td> </td>
</tr>
<tr>
@@ -1740,7 +1727,6 @@
<td class="na">na</td>
<td class="na">na</td>
<td class="na">na</td>
- <td class="na">na</td>
<td> </td>
</tr>
<tr>
@@ -1751,7 +1737,6 @@
<td class="na">na</td>
<td class="na">na</td>
<td class="na">na</td>
- <td class="na">na</td>
<td> </td>
</tr>
<tr>
@@ -1762,7 +1747,6 @@
<td class="na">na</td>
<td class="na">na</td>
<td class="na">na</td>
- <td class="na">na</td>
<td> </td>
</tr>
<tr>
@@ -1773,7 +1757,6 @@
<td class="na">na</td>
<td class="na">na</td>
<td class="na">na</td>
- <td class="na">na</td>
<td> </td>
</tr>
<tr>
@@ -1784,7 +1767,6 @@
<td class="na">na</td>
<td class="na">na</td>
<td class="na">na</td>
- <td class="na">na</td>
<td> </td>
</tr>
@@ -2321,7 +2303,7 @@
<td class="yes">yes</td>
<td class="yes">yes</td>
<td>For PDF output: Only 2-letter codes from ISO 639 are supported properly to
- identify the natural language!</td>
+ identify the natural language! Also used with complex scripts features.</td>
</tr>
<tr>
<td align="center"><a href=
@@ -2329,9 +2311,9 @@
<td><a name="fo-property-script" id="fo-property-script">script</a></td>
<td class="extended">Extended</td>
<td class="no">no</td>
- <td class="no">no</td>
- <td class="no">no</td>
- <td> </td>
+ <td class="no">yes</td>
+ <td class="no">yes</td>
+ <td>Used with complex scripts features to override default script heuristics.</td>
</tr>
<tr>
<td align="center"><a href=
@@ -2745,7 +2727,7 @@
"http://www.w3.org/TR/xsl/#max-height">§7.15.8</a></td>
<td><a name="fo-property-max-height" id="fo-property-max-height">max-height</a></td>
<td class="complete">Complete</td>
- <td class="no">no</td>
+ <td class="yes">yes</td>
<td class="yes">yes</td>
<td class="yes">yes</td>
<td> </td>
@@ -2755,7 +2737,7 @@
"http://www.w3.org/TR/xsl/#max-width">§7.15.9</a></td>
<td><a name="fo-property-max-width" id="fo-property-max-width">max-width</a></td>
<td class="complete">Complete</td>
- <td class="no">no</td>
+ <td class="yes">yes</td>
<td class="yes">yes</td>
<td class="yes">yes</td>
<td> </td>
@@ -2765,7 +2747,7 @@
"http://www.w3.org/TR/xsl/#min-height">§7.15.10</a></td>
<td><a name="fo-property-min-height" id="fo-property-min-height">min-height</a></td>
<td class="complete">Complete</td>
- <td class="no">no</td>
+ <td class="yes">yes</td>
<td class="yes">yes</td>
<td class="yes">yes</td>
<td> </td>
@@ -2775,7 +2757,7 @@
"http://www.w3.org/TR/xsl/#min-width">§7.15.11</a></td>
<td><a name="fo-property-min-width" id="fo-property-min-width">min-width</a></td>
<td class="complete">Complete</td>
- <td class="no">no</td>
+ <td class="yes">yes</td>
<td class="yes">yes</td>
<td class="yes">yes</td>
<td> </td>
@@ -3164,7 +3146,6 @@
<td class="partial">partial</td>
<td>
<ul>
- <li>[0.95] <integer> values are not supported.</li>
<li>[1.0 and later] minimal support for <integer> value.</li>
</ul>
</td>
@@ -3182,7 +3163,6 @@
<ul>
<li>works on all implemented block-level FOs, but not on inline-level
FOs.</li>
- <li>[0.95] <integer> values are not supported.</li>
<li>[1.0 and later] minimal support for <integer> value.</li>
</ul>
</td>
@@ -3198,11 +3178,8 @@
<td class="partial">partial</td>
<td>
<ul>
- <li>[0.95] works on all implemented FOs, except list- and inline-level
- FOs.</li>
<li>[1.0 and later] works on all implemented block-level
FOs, but not on inline-level FOs.</li>
- <li>[0.95] <integer> values are not supported.</li>
<li>[1.0 and later] minimal support for <integer> value.</li>
</ul>
</td>
@@ -3443,7 +3420,7 @@
<td><a name="fo-property-show-destination" id=
"fo-property-show-destination">show-destination</a></td>
<td class="extended">Extended</td>
- <td class="no">no</td>
+ <td class="partial">partial</td>
<td class="partial">partial</td>
<td class="partial">partial</td>
<td>[1.0 and later] only has effect in PDF output, for external PDF destinations (links pointing to destinations
@@ -3670,9 +3647,9 @@
<td><a name="fo-property-format" id="fo-property-format">format</a></td>
<td class="basic">Basic</td>
<td class="partial">partial</td>
- <td class="partial">partial</td>
- <td class="partial">partial</td>
- <td>only values '0*1', 'a', 'A', 'i', 'I' supported</td>
+ <td class="yes">yes</td>
+ <td class="yes">yes</td>
+ <td>[1.0 and earlier] only values '0*1', 'a', 'A', 'i', 'I' supported</td>
</tr>
<tr>
<td align="center"><a href=
@@ -3681,8 +3658,8 @@
"fo-property-grouping-separator">grouping-separator</a></td>
<td class="extended">Extended</td>
<td class="no">no</td>
- <td class="no">no</td>
- <td class="no">no</td>
+ <td class="yes">yes</td>
+ <td class="yes">yes</td>
<td> </td>
</tr>
<tr>
@@ -3691,8 +3668,8 @@
<td><a name="fo-property-grouping-size" id="fo-property-grouping-size">grouping-size</a></td>
<td class="extended">Extended</td>
<td class="no">no</td>
- <td class="no">no</td>
- <td class="no">no</td>
+ <td class="yes">yes</td>
+ <td class="yes">yes</td>
<td> </td>
</tr>
<tr>
@@ -3701,8 +3678,8 @@
<td><a name="fo-property-letter-value" id="fo-property-letter-value">letter-value</a></td>
<td class="basic">Basic</td>
<td class="no">no</td>
- <td class="no">no</td>
- <td class="no">no</td>
+ <td class="yes">yes</td>
+ <td class="yes">yes</td>
<td> </td>
</tr>
@@ -3852,7 +3829,7 @@
"http://www.w3.org/TR/xsl/#page-position">§7.27.14</a></td>
<td><a name="fo-property-page-position" id="fo-property-page-position">page-position</a></td>
<td class="extended">Extended</td>
- <td class="partial">partial</td>
+ <td class="yes">yes</td>
<td class="yes">yes</td>
<td class="yes">yes</td>
<td>value "only" not supported</td>
@@ -4200,9 +4177,9 @@
<td><a name="fo-property-writing-mode" id="fo-property-writing-mode">writing-mode</a></td>
<td class="basic">Basic</td>
<td class="no">no</td>
- <td class="no">no</td>
- <td class="no">no</td>
- <td> </td>
+ <td class="yes">yes</td>
+ <td class="yes">yes</td>
+ <td>[1.1 and later] only horizontal left-to-right and right-to-left modes</td>
</tr>
<tr>
@@ -4522,7 +4499,6 @@
<td class="na">na</td>
<td class="na">na</td>
<td class="na">na</td>
- <td class="na">na</td>
<td> </td>
</tr>
<tr>
@@ -4596,7 +4572,6 @@
<td class="na">na</td>
<td class="na">na</td>
<td class="na">na</td>
- <td class="na">na</td>
<td> </td>
</tr>
<tr>
@@ -4667,11 +4642,10 @@
<th rowspan="2">Comments</th>
</tr>
<tr>
- <th align="center">0.95 (stable)</th>
<th align="center">1.0 (stable)</th>
- <th align="center">develop- ment</th>
+ <th align="center">1.1 (rc1)</th>
+ <th align="center">development</th>
</tr>
-
<tr>
<td class="category" align="center"><a href=
"http://www.w3.org/TR/xsl/#d0e5860">§5.10.1</a></td>
Modified: xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/download.xml
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/download.xml?rev=1357814&r1=1357813&r2=1357814&view=diff
==============================================================================
--- xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/download.xml (original)
+++ xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/download.xml Thu Jul 5 19:15:13 2012
@@ -85,6 +85,25 @@
<p/>
<table>
<tr>
+ <th colspan="2">This Candidate Release</th>
+ </tr>
+ <tr>
+ <td>Repository URL</td>
+ <td>
+ <link href="http://svn.apache.org/repos/asf/xmlgraphics/fop/tags/fop-1_1rc1/">
+ <code>http://svn.apache.org/repos/asf/xmlgraphics/fop/tags/fop-1_1rc1/</code>
+ </link>
+ </td>
+ </tr>
+ <tr>
+ <td>Web view</td>
+ <td>
+ <link href="http://svn.apache.org/viewvc/xmlgraphics/fop/tags/fop-1_1rc1/">
+ <code>http://svn.apache.org/viewvc/xmlgraphics/fop/tags/fop-1_1rc1/</code>
+ </link>
+ </td>
+ </tr>
+ <tr>
<th colspan="2">Latest Stable Release</th>
</tr>
<tr>
@@ -109,7 +128,7 @@
<tr>
<td>Repository URL</td>
<td>
- <link href="http://svn.apache.org/repos/asf/xmlgraphics/fop/tags/fop-0_95/">
+ <link href="http://svn.apache.org/repos/asf/xmlgraphics/fop/tages/fop-0_95/">
<code>http://svn.apache.org/repos/asf/xmlgraphics/fop/tags/fop-0_95/</code>
</link>
</td>
@@ -168,11 +187,11 @@
<title>Archive Download</title>
<p>
FOP Archive distributions are linked from the upper portion of the Apache FOP
- Download Mirror Page and can be downloaded from the FOP Archives
- <link href="http://archive.apache.org/dist/xmlgraphics/fop/binaries/">binaries</link> &
- <link href="http://archive.apache.org/dist/xmlgraphics/fop/source/">source</link> links.
+ Download Mirror Page and can be downloaded from the FOP
+ <link href="http://archive.apache.org/dist/xmlgraphics/fop/binaries/">binaries</link> and
+ <link href="http://archive.apache.org/dist/xmlgraphics/fop/source/">source</link> archives.
</p>
</section>
</body>
</document>
-<!-- Last Line of $RCSfile$ -->
\ No newline at end of file
+<!-- Last Line of $RCSfile$ -->
Modified: xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/faq.xml
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/faq.xml?rev=1357814&r1=1357813&r2=1357814&view=diff
==============================================================================
--- xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/faq.xml (original)
+++ xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/faq.xml Thu Jul 5 19:15:13 2012
@@ -146,16 +146,16 @@
<answer>
<p>
When it's ready and the committers have enough time to go
- through the time-consuming process of creating a release. We
- released version 1.0 on 21 July 2010, and will release version
- 1.1 when we accumulated enough additions and bug fixes. If
- you want to speed up the process, consider <link
- href="dev/index.html#involved">contributing</link> to
- FOP.</p>
+ through the time-consuming process of creating a release. Version
+ 1.1rc1 was released on 02 July 2012. A subsequent final
+ Version 1.1 is expected to be released within 1 to 3 months following
+ this release candidate. If you want to speed up the process, consider <link
+ href="dev/index.html#involved">contributing</link> to FOP.
+ </p>
</answer>
</faq>
<faq id="redesign">
- <question>Why did you redesign FOP?</question>
+ <question>Why did you redesign FOP between Versions 0.2X and 0.9X?</question>
<answer>
<p>The code redesign of FOP was necessary in order to be able to adress following issues:</p>
<ul>
Modified: xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/fo.xml
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/fo.xml?rev=1357814&r1=1357813&r2=1357814&view=diff
==============================================================================
--- xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/fo.xml (original)
+++ xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/fo.xml Thu Jul 5 19:15:13 2012
@@ -17,7 +17,6 @@
-->
<!-- $Id$ -->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd">
-
<document>
<header>
<title>Apache⢠FOP: XSL-FO Input</title>
@@ -67,7 +66,7 @@ The following hexadecimal example will r
Getting your XML correctly encoded is only part of the job.
If you want the character to display or print correctly (and you probably do), then the selected font must contain the necessary glyph.
Because of differences between font encoding methods, and limitations in some font technologies, this can be a troublesome issue, especially for symbol characters.
-The FOP example file <link href="fo/fonts.fo.pdf">Base-14 Font Character Mapping</link> is a very useful resource in sorting these issues out for the Base-14 fonts.
+The FOP example file <link href="fo/fonts.pdf">Base-14 Font Character Mapping</link> is a very useful resource in sorting these issues out for the Base-14 fonts.
For other fonts, use font editing sofware or operating system utilities (such as the Character Map in most Windows platforms) to determine what characters the font supports.
</p>
<p>
@@ -519,10 +518,10 @@ This applies similarly to the extent of
<section id="external-resources">
<title>External Resources</title>
<p>Resources needed by an XSL-FO file that are external to it (graphics, for example), are defined in the XSL-FO standard as being of type "uri-specification". This is defined in the standard at <jump href="http://www.w3.org/TR/xsl11/#datatype">Section 5.11 Property Datatypes</jump>, which includes a link to the URI standard itself. Refer to the XSL-FO and URI standards themselves for more detailed instructions.</p>
- <p>URIs may be either absolute or relative to a base URI. (See <link href="1.0/configuration.html">FOP: Configuration</link> for information on setting the base URI for a FOP session). Here is an example referencing an external-graphic that is relative to the base URI:</p>
+ <p>URIs may be either absolute or relative to a base URI. (See <link href="1.1rc1/configuration.html">FOP: Configuration</link> for information on setting the base URI for a FOP session). Here is an example referencing an external-graphic that is relative to the base URI:</p>
<source><![CDATA[<fo:external-graphic src="url('images/logo.jpg')"/>]]></source>
<p>Here is an example referencing an external-graphic that is an absolute URI on a local filesystem:</p>
- <source><![CDATA[fo:external-graphic src="url('file:d:///images/logo.jpg')"/>]]></source>
+ <source><![CDATA[fo:external-graphic src="url('file:///d:/images/logo.jpg')"/>]]></source>
</section>
</section>
</body>
Modified: xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/index.xml
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/index.xml?rev=1357814&r1=1357813&r2=1357814&view=diff
==============================================================================
--- xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/index.xml (original)
+++ xmlgraphics/fop/branches/fop-1_1/src/documentation/content/xdocs/index.xml Thu Jul 5 19:15:13 2012
@@ -17,7 +17,6 @@
-->
<!-- $Id$ -->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd">
-
<document>
<header>
<title>Apache⢠FOP</title>
@@ -26,25 +25,22 @@
<body>
<section id="intro">
<title>Introduction</title>
- <p>Apache⢠FOP (Formatting Objects Processor) is a print formatter driven by XSL
+ <p>
+ Apache⢠FOP (Formatting Objects Processor) is a print formatter driven by XSL
formatting objects (XSL-FO) and an output independent formatter. It is a Java
application that reads a formatting object (FO) tree and renders the resulting
- pages to a specified output. <link href="1.0/output.html">Output formats</link>
+ pages to a specified output. <link href="1.1rc1/output.html">Output formats</link>
currently supported include PDF, PS, PCL, AFP, XML (area tree representation),
Print, AWT and PNG, and to a lesser extent, RTF and TXT. The primary output target is PDF.
</p>
- <p>The Apache⢠FOP project is part of the <a href="http://www.apache.org">Apacheâ¢</a>
- Software Foundation, which is a wider community of users and developers of open
- source projects.
+ <p>
+ The Apache⢠FOP project is part of the <link href="http://www.apache.org">Apacheâ¢</link>
+ Software Foundation, which is a wider community of users and developers of open source projects.
+ </p>
+ <figure width="480" height="260" src="images/document.jpg" alt="Render Diagram" />
+ <p>
+ A release candidate (rc1) of the latest version of FOP is available at <link href="1.1rc1/">FOP 1.1rc1</link>.
</p>
- <figure width="480" height="260" src="images/document.jpg" alt="Render Diagram" />
- <p>
- A stable release of the latest version of FOP (<link href="1.0/">1.0</link>) is
- available. It's the third
- stable release after the large redesign effort and implements a large subset of the
- <link href="http://www.w3.org/TR/xsl11/">XSL-FO Version 1.1 W3C
- Recommendation</link>.
- </p>
<p>
Support for each of the standard's objects and properties is detailed in <link href="compliance.html">FOP Compliance</link>.
<link href="download.html">Download</link> options include a precompiled version, source code, and many example files to get you started. <link href="resources.html">Resources</link> include links to XSL-FO introductions and many other useful references. A checklist for <link href="gethelp.html">Getting Help</link> will guide you toward maximizing the usefulness of FOP.
---------------------------------------------------------------------
To unsubscribe, e-mail: fop-commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: fop-commits-help@xmlgraphics.apache.org