Return-Path: X-Original-To: apmail-xmlgraphics-commits-archive@www.apache.org Delivered-To: apmail-xmlgraphics-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 43C36D042 for ; Tue, 23 Oct 2012 15:07:41 +0000 (UTC) Received: (qmail 3532 invoked by uid 500); 23 Oct 2012 15:07:41 -0000 Mailing-List: contact commits-help@xmlgraphics.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: general@xmlgraphics.apache.org Delivered-To: mailing list commits@xmlgraphics.apache.org Received: (qmail 3525 invoked by uid 99); 23 Oct 2012 15:07:41 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 23 Oct 2012 15:07:41 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 23 Oct 2012 15:07:07 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 9494A2388B1B for ; Tue, 23 Oct 2012 15:05:57 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: svn commit: r835892 [7/17] - in /websites/staging/xmlgraphics/trunk/content: ./ batik/ batik/dev/ batik/tools/ batik/using/ batik/using/scripting/ commons/ fop/ fop/0.95/ fop/1.0/ fop/1.1/ fop/dev/ fop/dev/design/ fop/trunk/ Date: Tue, 23 Oct 2012 15:05:47 -0000 To: commits@xmlgraphics.apache.org From: buildbot@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20121023150557.9494A2388B1B@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/hyphenation.html ============================================================================== --- websites/staging/xmlgraphics/trunk/content/fop/1.0/hyphenation.html (original) +++ websites/staging/xmlgraphics/trunk/content/fop/1.0/hyphenation.html Tue Oct 23 15:05:41 2012 @@ -331,18 +331,18 @@ $(document).ready(function () {

$Revision: 1298724 $

-

Hyphenation Support

-

Introduction

+

Hyphenation Support

+

Introduction #

Apache™ FOP uses Liang's hyphenation algorithm, well known from TeX. It needs language specific pattern and other data for operation.

Because of licensing issues (and for convenience), all hyphenation patterns for FOP are made available through the Objects For Formatting Objects project. 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 FOP User mailing list .

-

License Issues

+

License Issues #

Many of the hyphenation files distributed with TeX and its offspring are licenced under the LaTeX Project Public License (LPPL) , 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.

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. The user is responsible to settle license issues for hyphenation pattern files that are obtained from non-Apache sources.

-

Sources of Custom Hyphenation Pattern Files

+

Sources of Custom Hyphenation Pattern Files #

The most important source of hyphenation pattern files is the CTAN TeX Archive .

-

Installing Custom Hyphenation Patterns

+

Installing Custom Hyphenation Patterns #

To install a custom hyphenation pattern for use with FOP:

  1. @@ -381,7 +381,7 @@ and run Ant with build target jar-

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 configuration option programmatically (option 3).

-

Hyphenation Patterns

+

Hyphenation Patterns

If you would like to build your own hyphenation pattern files, or modify existing ones, this section will help you understand how to do so. Even when creating a pattern file from scratch, it may be beneficial to start with an existing file and modify it. See OFFO's Hyphenation page for examples. Here is a brief explanation of the contents of FOP's hyphenation patterns: The remaining content of this section should be considered "draft" quality. It was drafted from theoretical literature, and has not been tested against actual FOP behavior. It may contain errors or omissions. Do not rely on these instructions without testing everything stated here. If you use these instructions, please provide feedback on the FOP User mailing list , either confirming their accuracy, or raising specific problems that we can address.

    Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/index.html ============================================================================== --- websites/staging/xmlgraphics/trunk/content/fop/1.0/index.html (original) +++ websites/staging/xmlgraphics/trunk/content/fop/1.0/index.html Tue Oct 23 15:05:41 2012 @@ -331,14 +331,14 @@ $(document).ready(function () {

    $Revision: 1298724 $

    -

    Introduction

    +

    Introduction

    The Apache™ FOP team is proud to present to you this production quality codebase. FOP 1.0 provides a good subset of the W3C XSL-FO 1.0 and 1.1 Standards. Its stable, 1.0 designation provides added recognition as the productive tool it has been for years.

    We remain committed to improving the tool, and we continue to add new features. We welcome any feedback you might have and even more, any other form of help to get the project forward.

    This release contains many bug fixes and new features compared to the previous version. To see what has changed since the last release, please visit the Changes Page and the Release Notes .

    This release implements a good subset of the W3C XSL-FO 1.0 and 1.1 Standards. For a detailed overview of FOP's compliance, visit the compliance page .

    -

    Upgrading from an earlier version

    +

    Upgrading from an earlier version

    If you're upgrading to this version from an earlier version of FOP, please read the information contained on the Upgrading page !

    -

    Download

    +

    Download

    To download this version, please visit the download page .

    Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/intermediate.html ============================================================================== --- websites/staging/xmlgraphics/trunk/content/fop/1.0/intermediate.html (original) +++ websites/staging/xmlgraphics/trunk/content/fop/1.0/intermediate.html Tue Oct 23 15:05:41 2012 @@ -332,13 +332,13 @@ $(document).ready(function () {

    $Revision: 1298724 $ Please note that the intermediate formats described here are advanced features and can be ignored by most users of Apache™ FOP.

    -

    Introduction

    +

    Introduction

    Apache FOP now provides two different so-called intermediate formats. The first one (let's call it the area tree XML format) is basically a 1:1 XML representation of FOP's area tree as generated by the layout engine. The area tree is conceptually defined in the XSL-FO specification in chapter 1.1.2 . Even though the area tree is mentioned in the XSL-FO specification, this part is not standardized. Therefore, the area tree XML format is a FOP-proprietary XML file format. The area tree XML can be generated through the area tree XML Renderer (the XMLRenderer).

    The second intermediate format (which we shall name exactly like this: the intermediate format) is a recent addition which tries to meet a slightly different set of goals. It is highly optimized for speed.

    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.

    -

    Which Intermediate Format to choose?

    +

    Which Intermediate Format to choose?

    Both formats have their use cases, so the choice you will make will depend on your particular situation. Here is a list of strengths and use cases for both formats:

    -

    Area Tree XML (AT XML)

    +

    Area Tree XML (AT XML) #

    • 1:1 representation of FOP's area tree in XML.

      @@ -350,7 +350,7 @@ Please note that the intermediate format

      Used in FOP's layout engine test suite for regression testing.

    -

    Intermediate Format (IF)

    +

    Intermediate Format (IF) #

    • Highly optimized for speed.

      @@ -369,9 +369,9 @@ Please note that the intermediate format

    More technical information about the two formats can be found on the FOP Wiki .

    -

    Architectural Overview

    +

    Architectural Overview

    -

    Usage of the Area Tree XML format (AT XML)

    +

    Usage of the Area Tree XML format (AT XML)

    As already mentioned, the area tree XML format is generated by using the XMLRenderer (MIME type: application/X-fop-areatree ). 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 format, you need to create the area tree XML 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 area tree XML 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 area tree XML format file is the first step.

    The second step is to reparse the file using the AreaTreeParser which is found in the org.apache.fop.area package. The pages retrieved from the area tree XML 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 area tree XML processing in the directory in the FOP distribution.

    @@ -404,14 +404,14 @@ try { } This example simply reads an area tree 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 endDocument() on the AreaTreeModel. This lets the Renderer know that the processing is now finished.

    The area tree XML format can also be used from the command-line 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.

    -

    Concatenating Documents

    +

    Concatenating Documents #

    This initial example is obviously not very useful. It would be faster to create the PDF file directly. As the ExampleConcat.java example shows you can easily parse multiple area tree 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.

    -

    Modifying Documents

    +

    Modifying Documents #

    One of the most important use cases for this format is obviously modifying the area tree XML before finally rendering it to the target format. You can easily use XSLT to process the AT XML file according to your needs. Please note, that we will currently not formally describe the area tree XML 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. The area tree XML format is sensitive to changes in whitespace. If you're not careful, the modified file may not render correctly.

    -

    Advanced Use

    +

    Advanced Use #

    The generation of the area tree format as well as it parsing process has been designed to allow for maximum flexibility and optimization. Please note that you can call setTransformerHandler() 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 getContentHandler() ).

    -

    Usage of the Intermediate Format (IF)

    +

    Usage of the Intermediate Format (IF)

    The Intermediate Format (IF) is generated by the IFSerializer (MIME type: application/X-fop-intermediate-format ). 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.

    The IFSerializer is an implementation of the IFDocumentHandler and IFPainter interfaces. The IFRenderer class is responsible for converting FOP's area tree into calls against these two interfaces.

      @@ -455,13 +455,13 @@ try { out.close(); } This example simply reads an intermediate file and renders it to a PDF file. Here IFParser.parse() is used, but you can also just get a SAX ContentHandler by using the IFParser.getContentHandler() method.

      -

      Concatenating Documents

      +

      Concatenating Documents #

      This initial example is obviously not very useful. It would be faster to create the PDF file directly (without the intermediate step). As the ExampleConcat.java example shows you can easily parse multiple intermediate files in a row and use the IFConcatenator class to concatenate page sequences from multiple source files to a single output file. This particular example does the concatenation on the level of the IFDocumentHandler interface. You could also do this in XSLT or using SAX on the XML level. Whatever suits your process best.

      -

      Modifying Documents

      +

      Modifying Documents #

      One of the most important use cases for this format is obviously modifying the intermediate format before finally rendering it to the target format. You can easily use XSLT to process the IF file according to your needs.

      There is an XML Schema (located under src/documentation/intermediate-format-ng ) that helps you verify that your modified content is correct.

      For certain output formats there's a caveat: Formats like AFP and PCL do not support arbitrary transformations on the IF's "viewport" and "g" elements. Possible are only rotations in 90 degree steps and translations.

      -

      Advanced Use

      +

      Advanced Use #

      The generation of the intermediate format as well as it parsing process has been designed to allow for maximum flexibility and optimization. So rather than just passing in a StreamResult to IFSerializer's setResult() method, you can also use a SAXResult or a DOMResult. And as you've already seen , the IFParser on the other side allows you to retrieve a ContentHandler instance where you can manually send SAX events to start the parsing process (see getContentHandler() ).

Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/knownissues_overview.html ============================================================================== --- websites/staging/xmlgraphics/trunk/content/fop/1.0/knownissues_overview.html (original) +++ websites/staging/xmlgraphics/trunk/content/fop/1.0/knownissues_overview.html Tue Oct 23 15:05:41 2012 @@ -331,7 +331,7 @@ $(document).ready(function () {

$Revision: 1298724 $

-

Known issues # {#Known+issues}

+

Known issues

This page lists currently known issues in the current release.

For additional information on known issues in Apache™ FOP, please have a look at the following pages, too:

    @@ -343,11 +343,11 @@ $(document).ready(function () {

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.

-

FO Tree ## {#FO+Tree}

+

FO Tree #

This section lists disabled test cases in the test suite for the FO tree tests, at the time of the release.

demo-test-failure.fo (demo test failure):

TODO: Add missing description in disabled-testcases.xml!

from-table-column_marker.fo (Markers and core function evaluation):

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.

-

Layout Engine ## {#Layout+Engine}

+

Layout Engine #

This section lists disabled test cases in the test suite for the layout engine tests, at the time of the release.

basic-link_external-destination_2.xml (External link around an SVG not properly sized):

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.

block-container_space-before_space-after_3.xml (Auto-height block-containers produce fences):

Block-containers with no height currently don't create a fence for spaces as they should (they behave like a normal block).

@@ -383,7 +383,7 @@ $(document).ready(function () {

table_border-width_conditionality.xml (Border conditionality on table):

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.

block_shy_linebreaking_hyph.xml (Soft hyphen with normal hyphenation enabled):

A soft hyphen should be a preferred as break compared to a normal hyphenation point but is not.

keep_within-page_multi-column_overflow.xml (Page-keep not respected in multi-column layout):

The block should cause overflow in the last column on the page, rather than be broken.

-

Other known issues ## {#Other+known+issues}

+

Other known issues #

This section lists other known issues.

  • Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/metadata.html ============================================================================== --- websites/staging/xmlgraphics/trunk/content/fop/1.0/metadata.html (original) +++ websites/staging/xmlgraphics/trunk/content/fop/1.0/metadata.html Tue Oct 23 15:05:41 2012 @@ -330,14 +330,14 @@ $(document).ready(function () {
    -

    Overview

    +

    Overview

    Document metadata is an important tool for categorizing and finding documents. Various formats support different kinds of metadata representation and to different levels. One of the more popular and flexible means of representing document or object metadata is XMP (eXtensible Metadata Platform, specified by Adobe) . PDF 1.4 introduced the use of XMP. The XMP specification lists recommendation for embedding XMP metdata in other document and image formats. Given its flexibility it makes sense to make use this approach in the XSL-FO context. Unfortunately, unlike SVG which also refers to XMP, XSL-FO doesn't recommend a preferred way of specifying document and object metadata. Therefore, there's no portable way to represent metadata in XSL-FO documents. Each implementation does it differently.

    -

    Embedding XMP in an XSL-FO document

    +

    Embedding XMP in an XSL-FO document

    As noted above, there's no officially recommended way to embed metadata in XSL-FO. Apache FOP supports embedding XMP in XSL-FO. Currently, only support for document-level metadata is implemented. Object-level metadata will be implemented when there's interest.

    Document-level metadata can be specified in the fo:declarations element. XMP specification recommends to use x:xmpmeta , rdf:RDF , and rdf:Description elements as shown in example below. Both x:xmpmeta and rdf:RDF elements are recognized as the top-level element introducing an XMP fragment (as per the XMP specification).

    -

    Example

    +

    Example #

    -

    Implementation in Apache FOP

    +

    Implementation in Apache FOP

    Currently, XMP support is only available for PDF output.

    Originally, you could set some metadata information through FOP's FOUserAgent by using its set*() methods (like setTitle(String) or setAuthor(String). These values are directly used to set value in the PDF Info object. Since PDF 1.4, adding metadata as an XMP document to a PDF is possible. That means that there are now two mechanisms in PDF that hold metadata.

    Apache FOP now synchronizes the Info and the Metadata object in PDF, i.e. when you set the title and the author through the FOUserAgent, the two values will end up in the (old) Info object and in the new Metadata object as XMP content. If instead of FOUserAgent, you embed XMP metadata in the XSL-FO document (as shown above), the XMP metadata will be used as-is in the PDF Metadata object and some values from the XMP metadata will be copied to the Info object to maintain backwards-compatibility for PDF readers that don't support XMP metadata.

    @@ -395,7 +395,7 @@ $(document).ready(function () { -## Namespaces +## Namespaces # @@ -430,7 +430,7 @@ $(document).ready(function () {

    Please refer to the XMP Specification for information on other metadata namespaces.

    Property sets (Namespaces) not listed here are simply passed through to the final document (if supported). That is useful if you want to specify a custom metadata schema.

    -

    Links

    +

    Links

    • Adobe's Extensible Metadata Platform (XMP) website

      Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/output.html ============================================================================== --- websites/staging/xmlgraphics/trunk/content/fop/1.0/output.html (original) +++ websites/staging/xmlgraphics/trunk/content/fop/1.0/output.html Tue Oct 23 15:05:41 2012 @@ -332,8 +332,8 @@ $(document).ready(function () {

      $Revision: 1298724 $

      Apache™ 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.

      -

      General Information

      -

      Fonts

      +

      General Information

      +

      Fonts #

      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.

      Theoretically, there's some potential to make the output of the PDF/PS renderers match the output of the Java2D-based renderers. If FOP used the font metrics from its own font subsystem but still used Java2D for text painting in the Java2D-based renderers, this could probably be achieved. However, this approach hasn't been implemented, yet.

      With a work-around, it is possible to match the PDF/PS output in a Java2D-based renderer pretty closely. The clue is to use the intermediate format . The trick is to layout the document using FOP's own font subsystem but then render the document using Java2D. Here are the necessary steps (using the command-line):

      @@ -357,7 +357,7 @@ $(document).ready(function () {

      fop -atin myfile.at.xml -tiff myfile.tiff

    • -

      Output to a Printer or Other Device

      +

      Output to a Printer or Other Device #

      The most obvious way to print your document is to use the FOP print renderer , 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.

      Here are Windows command-line examples for Postscript and PCL: fop ... -ps \computername\printerfop ... -pcl \computername\printer @@ -365,12 +365,12 @@ Here is some Java code to accomplish the proc = Runtime.getRuntime().exec("lp -d" + print_queue + " -o -dp -"); out = proc.getOutputStream(); Set the output MIME type to "application/x-pcl" (MimeConstants.MIME_PCL) and it happily sends the PCL to the UNIX printer queue.

      -

      PDF

      +

      PDF

      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.

      Note that FOP does not currently support PDF/A-1a. Support for Tagged PDF , PDF/A-1b and PDF/X has recently been added, however.

      -

      Fonts

      +

      Fonts #

      PDF has a set of fonts that are always available to all PDF viewers; to quote from the PDF Specification: "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."

      -

      Post-processing

      +

      Post-processing #

      FOP does not currently support several desirable PDF features: watermarks and signatures. One workaround is to use Adobe Acrobat (the full version, not the Reader) to process the file manually or with scripting that it supports.

      Another popular post-processing tool is iText , which has tools for adding security features, document properties, watermarks, and many other features to PDF files. Caveat: iText may swallow PDF bookmarks. But Jens Stavnstrup tells us that this doesn't happen if you use iText's PDFStamper. @@ -419,7 +419,7 @@ public static void main(String args[]) { } } Check the iText tutorial and documentation for setting access flags, password, encryption strength and other parameters.

      -

      Watermarks

      +

      Watermarks #

      In addition to the PDF Post-processing options, consider the following workarounds:

      • @@ -429,9 +429,9 @@ Check the iText tutorial and documentati

        (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.

      -

      PostScript

      +

      PostScript

      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.

      -

      Configuration

      +

      Configuration #

      The PostScript renderer configuration currently allows the following settings: false @@ -445,7 +445,7 @@ The default value for the "auto-rotate-l

      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.

      The default value for the "safe-set-page-device" setting is "false". Setting it to "true" will cause the renderer to invoke a postscript macro which guards against the possibility of invalid/unsupported postscript key/values being issued to the implementing postscript page device.

      The default value for the "dsc-compliant" setting is "true". Setting it to "false" will break DSC compliance by minimizing the number of setpagedevice calls in the postscript document output. This feature may be useful when unwanted blank pages are experienced in your postscript output. This problem is caused by the particular postscript implementation issuing unwanted postscript subsystem initgraphics/erasepage calls on each setpagedevice call.

      -

      Limitations

      +

      Limitations #

      • Images and SVG may not be displayed correctly. SVG support is far from being complete. No image transparency is available.

        @@ -460,10 +460,10 @@ The default value for the "auto-rotate-l

        PPD support is still missing.

      -

      PCL

      +

      PCL

      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.

      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.

      -

      References

      +

      References #

      -

      Limitations

      +

      Limitations #

      • 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.

        @@ -499,7 +499,7 @@ The default value for the "auto-rotate-l

        Currently, there's no support for clipping and image transparency, largely because PCL 5 has certain limitations.

      -

      Configuration

      +

      Configuration #

      The PCL renderer configuration currently allows the following settings: quality @@ -510,14 +510,14 @@ The default value for the "rendering" se

      The default value for the "text-rendering" setting is "auto" which paints the base fonts using PCL fonts. Non-base fonts are painted as bitmaps through Java2D. If the mix of painting methods results in unwelcome output, you can set this to "bitmap" which causes all text to be rendered as bitmaps.

      The default value for the "disable-pjl" setting is "false". This means that the PCL renderer usually generates PJL commands before and after the document in order to switch a printer into PCL language. PJL commands can be disabled if you set this value to "true".

      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.

      -

      Extensions

      +

      Extensions #

      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:

        <fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format"
                  xmlns:pcl="http://xmlgraphics.apache.org/fop/extensions/pcl">
       
      -

      Page Source (Tray selection)

      +

      Page Source (Tray selection) ##

      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:

        <fo:layout-master-set>
           <fo:simple-page-master master-name="simple" pcl:paper-source="2">
      @@ -528,7 +528,7 @@ The default value for the "rendering" se
       
       
       

      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.

      -

      Output Bin

      +

      Output Bin ##

      The output-bin extension attribute on fo:simple-page-master allows to select the output bin into which the printed output should be fed. Example:

        <fo:layout-master-set>
           <fo:simple-page-master master-name="simple" pcl:output-bin="2">
      @@ -539,7 +539,7 @@ The default value for the "rendering" se
       
       
       

      Note: the output bin number is a positive integer and the value depends on the target printer. Not all PCL printers support the same output bins. Usually, "1" is the upper output bin, "2" is the lower (rear) output bin. Consult the technical reference for your printer for all available values.

      -

      Page Duplex Mode

      +

      Page Duplex Mode ##

      The duplex-mode extension attribute on fo:simple-page-master allows to select the duplex mode to be used for a particular simple-page-master. Example:

        <fo:layout-master-set>
           <fo:simple-page-master master-name="simple" pcl:duplex-mode="0">
      @@ -550,7 +550,7 @@ The default value for the "rendering" se
       
       
       

      Note: the duplex is a positive integer and the value depends on the target printer. Not all PCL printers support duplexing. Usually, "0" is simplex, "1" is duplex (long-edge binding), "2" is duplex (short-edge binding). Consult the technical reference for your printer for all available values.

      -

      AFP

      +

      AFP

      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).

      The mapping of XSL-FO elements to the major MO:DCA structures is as follows:

      @@ -576,7 +576,7 @@ The default value for the "rendering" se

      FOP creates exactly one Document per Printfile with an optional Resource Group at the beginning. FOP does not create document indices.

      -

      References

      +

      References #

      -

      Limitations

      +

      Limitations #

      This list is most likely badly incomplete.

      • @@ -598,10 +598,10 @@ The default value for the "rendering" se

        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.

      -

      Deployment in older environments

      +

      Deployment in older environments #

      There are still a big number of older (or limited) MO:DCA/IPDS environments in production out there. AFP has grown in functionality over time and not every environment supports the latest features. We're trying to make AFP output work in as many environments as possible. However, to make AFP output work on older environments it is recommended to set to configuration to 1 bit per pixel (see below on how to do this). In this case, all images are converted to bi-level images using IOCA function set 10 (FS10) and are enclosed in page-segments since some implementation cannot deal with IOCA objects directly. If a higher number of bits per pixel is configured, FOP has to switch to at least FS11 which may not work everywhere.

      -

      Configuration

      -

      Fonts

      +

      Configuration #

      +

      Fonts ##

      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: @@ -739,13 +739,13 @@ A CID-keyed font (Type 0, double-byte ou

      By default, all manually configured fonts are embedded, unless they are matched in the section of the configuration file . However, the default fonts shown above will not be embedded.

      -

      Output Resolution

      +

      Output Resolution ##

      By default the AFP Renderer creates output with a resolution of 240 dpi. This can be overridden by the configuration element. Example:

        <renderer-resolution>240</renderer-resolution>
       
      -

      Images

      +

      Images ##

      By default the AFP Renderer converts all images to 8 bit grey level. This can be overridden by the configuration element. Example:

        <images mode="color" />
       
      @@ -773,32 +773,32 @@ A CID-keyed font (Type 0, double-byte ou
      -

      Shading

      +

      Shading ##

      By default, filled rectangles are painted using their given color using a PTOCA I-axis rule (DIR). But not all environments handle these colors correctly. That's why a setting is supported that paints the rectangles using an ordered dither pattern (bi-level) with an inline IOCA FS10 image that is used together with the "replicate and trim" mapping. The optional "shading" element can be used to control the shading mode. Its default value is "color". To enable the dithered mode, use "dithered". Example:

        <shading>dithered</shading>
       
      -

      Resource Group File

      +

      Resource Group File ##

      By default the AFP Renderer will place all data resource objects such as images within the document of the main output datastream. An external resource group file where document resources may be specified with the configuration element. Example:

        <resource-group-file>external_resources.afp</resource-group-file>
       

      Be careful when using this option not to overwrite existing resource files from previous rendering runs.

      -

      Resource Level Defaults

      +

      Resource Level Defaults ##

      By default, bitmap image objects (or page segments derived from them) are put in the print-file-level resource group and GOCA graphics are inlined for compatibility with the AFP Workbench tool.

      It is possible to override these defaults, either per image (see the afp:resource-level extension attribute below) or by specifying different defaults in the configuration:

      "goca" refers to GOCA graphics and "bitmap" refers to IOCA images. The possible values for the attributes are "inline" and "print-file". In the future, additional possibilities may be added.

      -

      Extensions

      +

      Extensions #

      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:

        <fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format"
                  xmlns:afp="http://xmlgraphics.apache.org/fop/extensions/afp">
       
      -

      Page Overlay (IPO) Extension

      +

      Page Overlay (IPO) Extension ##

      The include-page-overlay extension element allows to define on a per simple-page-master basis a page overlay resource. Example:

        <fo:layout-master-set>
           <fo:simple-page-master master-name="simple">
      @@ -810,7 +810,7 @@ A CID-keyed font (Type 0, double-byte ou
       
       
       

      The mandatory name attribute must refer to an 8 character (space padded) resource name that must be known in the AFP processing environment. Optional x and y attributes can be specified to place the Overlay at an offset from the top left of the page.

      -

      Page Segment (IPS) Extension

      +

      Page Segment (IPS) Extension ##

      The include-page-segment extension element allows to define resource substitution for fo:external-graphics elements. Example:

      <fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format"
        xmlns:afp="http://xmlgraphics.apache.org/fop/extensions/afp">
      @@ -825,7 +825,7 @@ A CID-keyed font (Type 0, double-byte ou
       
       

      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.

      The effect here is that whenever FOP encounters the URI specified in the extension, it will effectively generate code to include the page segment with the given name instead of embedding the image referenced by the URI. The URI is still required as the underlying image serves as a provider for the intrinsic size of the image (At the moment, FOP is unable to extract the intrinsic size of the page segment from an AFP resource file). For the image to appear in an AFP viewer or to be printed, the AFP resource must be available on the target device. FOP does not embed the page segment in the generated file. Please also note that page segments cannot be scaled. They are always rendered in their intrinsic size.

      -

      Tag Logical Element (TLE) Extension

      +

      Tag Logical Element (TLE) Extension ##

      The tag-logical-element extension element allows to injects TLEs into the AFP output stream. Example:

      <fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format"
        xmlns:afp="http://xmlgraphics.apache.org/fop/extensions/afp">
      @@ -844,7 +844,7 @@ A CID-keyed font (Type 0, double-byte ou
       
       
       

      The tag-logical-element extension element can appear within a simple-page-master (page level) or it can appear as child of page-sequence (page group level). Multiple tag-logical-element extension elements within a simple-page-master or page-sequence are allowed. The name and value attributes are mandatory.

      -

      No Operation (NOP) Extension

      +

      No Operation (NOP) Extension ##

      The no-operation extension provides the ability to carry up to 32K of comments or any other type of unarchitected data into the AFP output stream. Example:

      <fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format"
        xmlns:afp="http://xmlgraphics.apache.org/fop/extensions/afp">
      @@ -857,7 +857,7 @@ A CID-keyed font (Type 0, double-byte ou
       
       
       

      The no-operation extension element can only occur within a simple-page-master. Multiple no-operation extension elements within a simple-page-master are allowed. The name attribute is mandatory.

      -

      Invoke Medium Map (IMM) Extension

      +

      Invoke Medium Map (IMM) Extension ##

      The invoke-medium-map extension allows to generate IMM fields (Invoke Medium Map) in the generated AFP output. Example:

      <fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format"
        xmlns:afp="http://xmlgraphics.apache.org/fop/extensions/afp">
      @@ -870,14 +870,14 @@ A CID-keyed font (Type 0, double-byte ou
       
       
       

      The invoke-medium-map element is allowed as child of fo:page-sequence (page group level) or fo:simple-page-master. It is NOT supported on document level (fo:root), yet. FOP also doesn't support specifying medium maps inside XML (using BMM/EMM). It can only reference an existing medium map by name. The medium map has to be constructed through different means and available on the target platform.

      -

      Form Maps/Defs

      +

      Form Maps/Defs ##

      Apache FOP supports embedding an external form map resource in the generated AFP output. This is done using the afp:include-form-map extension. An example:

      The afp:include-form-map is to be placed as a direct child of fo:declarations . The name is an AFP resource name (max. 8 characters) and the src attribute is the URI identifying the external form map resource. When such a form map is embedded, you can use the afp:invoke-medium-map extension (described above) to invoke any medium map included in the form map. Apache FOP doesn't support a way to define a form map or medium map using XML means inside an XSL-FO document. You will have to build the form map with some third-party tool.

      -

      Foreign Attributes

      -

      Resource

      +

      Foreign Attributes #

      +

      Resource ##

      The resource foreign attributes provides the ability to name and control where data object resources (e.g. images/scalable vector graphics) will reside in the AFP output. The afp foreign attributes are only used in conjuntion with and . Example:

      <fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format"
        xmlns:afp="http://xmlgraphics.apache.org/fop/extensions/afp">
      @@ -903,7 +903,7 @@ Apache FOP doesn't support a way to defi
       
       
       

      The resource-level attribute where the resource object will reside in the AFP output datastream. The possible values for this are "inline", "print-file" and "external". When "external" is used a resource-group-file attribute must also be specified. Please refer to the Resource Level Defaults above to see what is used if the resource-level attribute is not specified.

      -

      RTF

      +

      RTF

      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 XSL-FO document as possible. It should be noted that is not possible (due to RTF's limitations) to map all XSL-FO features to RTF. For complex documents, the RTF output will never reach the feature level from PDF, for example. Thus, using RTF output is only recommended for simple documents such as letters.

      The RTF output follows Microsoft's RTF specifications and produces best results on Microsoft Word. 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. @@ -939,21 +939,21 @@ These are some known restrictions compar

      percentages are not supported everywhere

    -

    XML (Area Tree XML)

    +

    XML (Area Tree XML)

    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.

    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 Intermediate Format .

    -

    Java2D/AWT

    +

    Java2D/AWT

    The Java2DRenderer provides the basic functionality for all Java2D-based output formats (AWT viewer, direct print, PNG, TIFF).

    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.

    -

    Print

    +

    Print

    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.

    - +

    Known issues #

    If you run into the problem that the printed output is incomplete on Windows: this often happens to users printing to a PCL printer. There seems to be an incompatibility between Java and certain PCL printer drivers on Windows. Since most network-enabled laser printers support PostScript, try switching to the PostScript printer driver for that printer model.

    -

    Bitmap (TIFF/PNG)

    +

    Bitmap (TIFF/PNG)

    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.

    Currently, two output formats are supported: PNG and TIFF. TIFF produces one file with multiple pages, while PNG output produces one file per page. Note: FOP can only produce multiple files (with PNG output) if you can set a java.io.File indicating the primary PNG file using the FOUserAgent.setOutputFile(File) method.

    The quality of the bitmap depends on the target resolution setting on the FOUserAgent and on further settings described below.

    -

    Configuration

    +

    Configuration #

    The TIFF and PNG renderer configuration currently allows the following settings: rgba @@ -983,7 +983,7 @@ The default value for the "color-m

    The default value for the "background-color" setting is "white" . The color specifies in which color the page background is painted. It will only be painted if "transparent-page-background" is not set to "true" . All XSL-FO colors (including color functions) can be used.

    The default value for the "anti-aliasing" setting is "true" . You can set this value to "false" to disable anti-aliasing and thus improve rendering speeds a bit at the loss of some image quality.

    The default value for the "rendering" setting is "true" . You can set this value to "false" to improve rendering speeds a bit at the loss of some image quality. If this setting has an actual effect depends on the JVM's Java2D backend.

    -

    TIFF-specific Configuration

    +

    TIFF-specific Configuration #

    In addition to the above values the TIFF renderer configuration allows some additional settings: true @@ -1019,11 +1019,11 @@ The default value for the "compression"

This setting may override any setting made using the "color-mode" . For example, if "CCITT T.6" is selected, the color mode is automatically forced to "bi-level" because this compression format only supports bi-level images. If you want to use CCITT compression, please make sure you've got Java Advanced Imaging Image I/O Tools 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.

-

Runtime Rendering Options

+

Runtime Rendering Options #

The IF-based bitmap output implementations support a rendering option with the key "target-bitmap-size" (value: java.awt.Dimension) that allows to force the pages to be proportionally fit into a bitmap of a given size. This can be used to produce thumbnails or little preview images of the individual pages. An example: userAgent.getRenderingOptions().put( "target-bitmap-size", new Dimension(320, 200));

-

TXT

+

TXT

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.

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.

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:

@@ -1038,15 +1038,15 @@ userAgent.getRenderingOptions().put(

line-height="10.5pt"

-

Output Formats in the Sandbox

+

Output Formats in the Sandbox

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.

-

MIF

+

MIF #

The MIF handler is in the sandbox and not yet functional in FOP Trunk!!! Please help us ressurrect this feature. This format is the Maker Interchange Format which is used by Adobe Framemaker.

-

SVG

+

SVG #

The SVG renderer is in the sandbox and may not work as expected in FOP Trunk!!! Please help us improve this feature. 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.

-

Wish list

+

Wish list

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.

  • ODF (Open Document Format) : The standardized successor to OpenOffice's file format.
  • Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/pdfa.html ============================================================================== --- websites/staging/xmlgraphics/trunk/content/fop/1.0/pdfa.html (original) +++ websites/staging/xmlgraphics/trunk/content/fop/1.0/pdfa.html Tue Oct 23 15:05:41 2012 @@ -331,23 +331,23 @@ $(document).ready(function () {

    $Revision: 1298724 $

    -

    Overview

    +

    Overview

    PDF/A is a standard which turns PDF into an "electronic document file format for long-term preservation". PDF/A-1 is the first part of the standard and is documented in ISO 19005-1:2005(E) . Work on PDF/A-2 is in progress at AIIM .

    Design documentation on PDF/A can be found on FOP's Wiki on the PDFA1ConformanceNotes page.

    -

    Implementation Status

    +

    Implementation Status

    PDF/A-1b is implemented to the degree that FOP supports the creation of the elements described in ISO 19005-1.

    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.

    PDF/A-1a is based on PDF-A-1b and adds accessibility features (such as Tagged PDF). This format is available within the limitation described on the Accessibility page .

    -

    Usage (command line)

    +

    Usage (command line)

    To activate PDF/A-1b from the command-line, specify "-pdfprofile PDF/A-1b" as a parameter. If there is a violation of one of the validation rules for PDF/A, an error message is presented and the processing stops.

    PDF/A-1a is enabled by specifying "-pdfprofile PDF/A-1a".

    -

    Usage (embedded)

    +

    Usage (embedded)

    When FOP is embedded in another Java application you can set a special option on the renderer options in the user agent to activate the PDF/A-1b profile. Here's an example:

    userAgent.getRendererOptions().put("pdf-a-mode", "PDF/A-1b"); Fop fop = fopFactory.newFop(MimeConstants.MIME_PDF, userAgent);

    For PDF/A-1a, just use the string "PDF/A-1a" instead of "PDF/A-1b".

    -

    PDF/A in Action

    +

    PDF/A in Action

    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):

    • @@ -373,9 +373,9 @@ Fop fop = fopFactory.newFop(MimeConstant There are additional requirements if you want to enabled PDF/A-1a (Tagged PDF). This is particularly the specification of the natural language and alternative descriptions for images. Please refer to the Accessibility page for details.

    -

    PDF profile compatibility

    +

    PDF profile compatibility

    The PDF profiles "PDF/X-3:2003" and "PDF/A-1b" (or "PDF/A-1a") are compatible and can both be activated at the same time.

    -

    Interoperability

    +

    Interoperability

    There has been some confusion about the namespace for the PDF/A indicator in the XMP metadata. At least three variants have been seen in the wild:

    Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/pdfencryption.html ============================================================================== --- websites/staging/xmlgraphics/trunk/content/fop/1.0/pdfencryption.html (original) +++ websites/staging/xmlgraphics/trunk/content/fop/1.0/pdfencryption.html Tue Oct 23 15:05:41 2012 @@ -331,16 +331,16 @@ $(document).ready(function () {

    $Revision: 1298724 $

    -

    Overview

    +

    Overview

    Apache™ FOP supports encryption of PDF output, thanks to Patrick C. Lankswert. This feature is commonly used to prevent unauthorized viewing, printing, editing, copying text from the document and doing annotations. It is also possible to ask the user for a password in order to view the contents. Note that there already exist third party applications which can decrypt an encrypted PDF without effort and allow the aforementioned operations, therefore the degree of protection is limited.

    For further information about features and restrictions regarding PDF encryption, look at the documentation coming with Adobe Acrobat or the technical documentation on the Adobe web site.

    -

    Usage (command line) # {#Usage+%28command+line%29}

    +

    Usage (command line)

    Encryption is enabled by supplying any of the encryption related options.

    An owner password is set with the -o 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.

    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.

    A user password, supplied with the -u 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.

    Further restrictions can be imposed by using the -noprint , -nocopy , -noedit and -noannotations options, which disable printing, copying text, editing in Adobe Acrobat and making annotations, respectively.

    -

    Usage (embedded) # {#Usage+%28embedded%29}

    +

    Usage (embedded)

    When FOP is embedded in another Java application you need to set an options map on the renderer. These are the supported options:

    @@ -450,13 +450,13 @@ Fop fop = fopFactory.newFop(MimeConstant

    noannotations: Boolean or "true"/"false"

    -

    Environment

    +

    Environment

    In order to use PDF encryption, FOP has to be compiled with cryptography support. Currently, only JCE 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.

    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 not provide RC4. If you get a message saying "Cannot find any provider supporting RC4" then you don't have the needed infrastructure.

    There are several commercial and a few Open Source packages which provide RC4. A pure Java implementation is produced by The Legion of the Bouncy Castle . Mozilla JSS is an interface to a native implementation.

    -

    Installing a crypto provider

    +

    Installing a crypto provider

    The pure Java implementation from Bouncy Castle is easy to install.

    1. Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/pdfx.html ============================================================================== --- websites/staging/xmlgraphics/trunk/content/fop/1.0/pdfx.html (original) +++ websites/staging/xmlgraphics/trunk/content/fop/1.0/pdfx.html Tue Oct 23 15:05:41 2012 @@ -331,22 +331,22 @@ $(document).ready(function () {

      $Revision: 1298724 $

      -

      Overview

      +

      Overview

      Support for PDF/X is available beginning with Apache™ FOP version 0.93. This feature is new and may not be 100% complete, yet. Feedback is welcome. PDF/X is a standard which faciliates prepress digital data exchange using PDF. Currently, only PDF/X-3:2003 is implemented out of the many different flavours of PDF/X profiles. PDF/X-3:2003 is documented in ISO 15930-6:2003(E) . More info on PDF/X can be found on the PDF/X info site .

      -

      Implementation Status

      +

      Implementation Status

      PDF/X-3:2003 is implemented to the degree that FOP supports the creation of the elements described in ISO 15930-6.

      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.

      Tests have been performed against Adobe Acrobat 7.0.7 (Preflight function). Note that there are bugs in Adobe Acrobat which cause false alarms if both PDF/A-1b and PDF/X-3:2003 are activated at the same time.

      -

      Usage (command line)

      +

      Usage (command line)

      To activate PDF/X-3:2003 from the command-line, specify "-pdfprofile PDF/X-3:2003" as a parameter. If there is a violation of one of the validation rules for PDF/X, an error message is presented and the processing stops.

      -

      Usage (embedded)

      +

      Usage (embedded)

      When FOP is embedded in another Java application you can set a special option on the renderer options in the user agent to activate the PDF/A-1b profile. Here's an example:

      FOUserAgent userAgent = fopFactory.newFOUserAgent(); userAgent.getRendererOptions().put("pdf-x-mode", "PDF/X-3:2003"); Fop fop = fopFactory.newFop(MimeConstants.MIME_PDF, userAgent);

      -

      PDF/X in Action

      +

      PDF/X in Action

      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):

      • @@ -368,7 +368,7 @@ Fop fop = fopFactory.newFop(MimeConstant

        PDF is forced to version 1.4 if PDF/X-3:2003 is activated.

      -

      PDF profile compatibility

      +

      PDF profile compatibility

      The PDF profiles "PDF/X-3:2003" and "PDF/A-1b" are compatible and can both be activated at the same time.

      Modified: websites/staging/xmlgraphics/trunk/content/fop/1.0/releaseNotes_1.0.html ============================================================================== --- websites/staging/xmlgraphics/trunk/content/fop/1.0/releaseNotes_1.0.html (original) +++ websites/staging/xmlgraphics/trunk/content/fop/1.0/releaseNotes_1.0.html Tue Oct 23 15:05:41 2012 @@ -330,9 +330,9 @@ $(document).ready(function () {
      -

      Major Changes in Version 1.0

      +

      Major Changes in Version 1.0

      This is not a complete list of changes, just some of the more important ones. A full list of changes in this release is available .

      -

      Changes to the Code Base ## {#Changes+to+the+Code+Base}

      +

      Changes to the Code Base #

      • Fixed memory leak in property cache (not cleaning stale PropertyCache$CacheEntry instances). Committed by JM.

        @@ -344,7 +344,7 @@ $(document).ready(function () {

        Added an event handling framework which allows to get better feedback from within FOP with the ability to customize problem management. Committed by JM.

      -

      Changes to the Font Subsystem ## {#Changes+to+the+Font+Subsystem}

      +

      Changes to the Font Subsystem #

      • Add support for font substitution. Committed by AC.

        @@ -353,7 +353,7 @@ $(document).ready(function () {

        Added support for addressing all glyphs available in a Type 1 font, not just the ones in the font's primary encoding. Committed by JM.

      -

      Changes to the Layout Engine ## {#Changes+to+the+Layout+Engine}

      +

      Changes to the Layout Engine #

      • Added limited support for pages of different inline-progression-dimensions within a page-sequence. Committed by VH.

        @@ -362,7 +362,7 @@ $(document).ready(function () {

        Added minimal support for integer keep values on the various keep properties on block-level FOs. For now, all integer values are treated the same (i.e. without strength distinction). Using integers allows to avoid overflows that can happen when "always" is used extensively. Committed by JM.

      -

      Changes to Renderers (Output Formats) ## {#Changes+to+Renderers+%28Output+Formats%29}

      +

      Changes to Renderers (Output Formats) #

      • AFP Output: An AFPGraphics2D implementation which provides the ability to use Batik to drive the production of AFP Graphics (GOCA) output from SVG. Committed by AC.

        --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscribe@xmlgraphics.apache.org For additional commands, e-mail: commits-help@xmlgraphics.apache.org