Browse Source

Merge from ^/branches/fop-1_1.

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@1364036 13f79535-47bb-0310-9956-ffa450edef68
tags/fop-2_0
Glenn Adams 11 years ago
parent
commit
56517e87d2
51 changed files with 9028 additions and 550 deletions
  1. 1
    1
      NOTICE
  2. 42
    2
      README
  3. 10
    4
      build.xml
  4. 0
    204
      checkstyle-5.1.xml
  5. 65
    71
      known-issues.xml
  6. 17
    17
      src/documentation/content/.htaccess
  7. 11
    5
      src/documentation/content/doap.rdf
  8. 167
    0
      src/documentation/content/xdocs/1.1rc1/accessibility.xml
  9. 236
    0
      src/documentation/content/xdocs/1.1rc1/anttask.xml
  10. 147
    0
      src/documentation/content/xdocs/1.1rc1/compiling.xml
  11. 694
    0
      src/documentation/content/xdocs/1.1rc1/complexscripts.xml
  12. 541
    0
      src/documentation/content/xdocs/1.1rc1/configuration.xml
  13. 752
    0
      src/documentation/content/xdocs/1.1rc1/embedding.xml
  14. 449
    0
      src/documentation/content/xdocs/1.1rc1/events.xml
  15. 339
    0
      src/documentation/content/xdocs/1.1rc1/extensions.xml
  16. 579
    0
      src/documentation/content/xdocs/1.1rc1/fonts.xml
  17. 31
    0
      src/documentation/content/xdocs/1.1rc1/fotree/disabled-testcases.xml
  18. 590
    0
      src/documentation/content/xdocs/1.1rc1/graphics.xml
  19. 237
    0
      src/documentation/content/xdocs/1.1rc1/hyphenation.xml
  20. 55
    0
      src/documentation/content/xdocs/1.1rc1/index.xml
  21. 331
    0
      src/documentation/content/xdocs/1.1rc1/intermediate.xml
  22. 54
    0
      src/documentation/content/xdocs/1.1rc1/known-issues.xml
  23. 74
    0
      src/documentation/content/xdocs/1.1rc1/knownissues_overview.xml
  24. 223
    0
      src/documentation/content/xdocs/1.1rc1/layoutengine/disabled-testcases.xml
  25. 243
    0
      src/documentation/content/xdocs/1.1rc1/metadata.xml
  26. 1401
    0
      src/documentation/content/xdocs/1.1rc1/output.xml
  27. 168
    0
      src/documentation/content/xdocs/1.1rc1/pdfa.xml
  28. 301
    0
      src/documentation/content/xdocs/1.1rc1/pdfencryption.xml
  29. 136
    0
      src/documentation/content/xdocs/1.1rc1/pdfx.xml
  30. 370
    0
      src/documentation/content/xdocs/1.1rc1/running.xml
  31. 325
    0
      src/documentation/content/xdocs/1.1rc1/servlets.xml
  32. 181
    0
      src/documentation/content/xdocs/1.1rc1/upgrading.xml
  33. 0
    1
      src/documentation/content/xdocs/bugs.xml
  34. 30
    56
      src/documentation/content/xdocs/compliance.ihtml
  35. 24
    5
      src/documentation/content/xdocs/download.xml
  36. 8
    8
      src/documentation/content/xdocs/faq.xml
  37. 3
    4
      src/documentation/content/xdocs/fo.xml
  38. 10
    14
      src/documentation/content/xdocs/index.xml
  39. 17
    12
      src/documentation/content/xdocs/knownissues.xml
  40. 1
    2
      src/documentation/content/xdocs/license.xml
  41. 1
    1
      src/documentation/content/xdocs/maillist.xml
  42. 9
    0
      src/documentation/content/xdocs/news-data.xml
  43. 11
    4
      src/documentation/content/xdocs/news.xml
  44. 7
    7
      src/documentation/content/xdocs/quickstartguide.xml
  45. 38
    46
      src/documentation/content/xdocs/site.xml
  46. 17
    13
      src/documentation/content/xdocs/status.xml
  47. 1
    1
      src/documentation/content/xdocs/tabs.xml
  48. 1
    1
      src/documentation/content/xdocs/team.xml
  49. 6
    0
      src/documentation/resources/stylesheets/known-issues2document.xsl
  50. 0
    1
      src/java/org/apache/fop/afp/AFPGraphics2D.java
  51. 74
    70
      status.xml

+ 1
- 1
NOTICE View File

@@ -1,5 +1,5 @@
Apache FOP
Copyright 1999-2010 The Apache Software Foundation
Copyright 1999-2012 The Apache Software Foundation

This product includes software developed at
The Apache Software Foundation (http://www.apache.org/).

+ 42
- 2
README View File

@@ -22,8 +22,8 @@ Apache FOP is the world's first print formatter driven by XSL formatting
objects. It is a Java application that reads a formatting object tree
conforming to the XSL 1.1 Recommendation (05 December 2006) and then turns it
into a PDF document, certain other output formats or allows you to preview it
directly on screen. Some parts of the XSL 1.1 specification (work in progress!)
have also been implemented.
directly on screen. Note that not all parts of the XSL 1.1 specification
have yes been implemented.

Apache FOP is part of Apache's XML Graphics project. The homepage of Apache
FOP is http://xmlgraphics.apache.org/fop/.
@@ -93,6 +93,46 @@ http://xmlgraphics.apache.org/fop/stable/running.html
RELEASE NOTES
==============================================================================

Version 1.1rc1
==============

This is a candidate release of the next, minor (dot) release of Apache FOP,
which primarily addresses bug fixes and also adds a number of new features.
See below for details.

Compliance
----------

This release implements the XSL 1.0 and 1.1 recommendations to a relatively
high degree of compliance. See the compliance page
http://xmlgraphics.apache.org/fop/compliance.html for further details.

Known issues
------------

A detailed list of known issues in this release is available at
http://xmlgraphics.apache.org/fop/1.1/knownissues_overview.html.

Major Changes in Version 1.1rc1
-------------------------------

* Adds support for complex scripts, in particular those that require
either bidirectional processing or advanced typographic tables in
fonts (e.g., the GSUB and GPOS tables of OpenType).
* Adds support for fo:bidi-override and (relatively) full support
for writing-mode='rl-tb' (or equivalent).
* Adds support for Unicode BIDI Control characters: U+200E LEFT-TO-RIGHT
MARK (LRM), U+200F RIGHT-TO-LEFT MARK (RLM), U+202A LEFT-TO-RIGHT EMBEDDING
(LRE), U+202B RIGHT-TO-LEFT EMBEDDING (RLE), U+202D LEFT-TO-RIGHT OVERRIDE
(LRO), U+202E RIGHT-TO-LEFT OVERRIDE (RLO), and U+202C POP DIRECTIONAL
FORMATTING (PDF).

A more detailed list of changes in this release is available at
http://xmlgraphics.apache.org/fop/1.1rc1/changes_1.1rc1.html.

A more detailed list of changes in this and earlier releases is available at
http://xmlgraphics.apache.org/fop/changes.html.

Version 1.0
===========


+ 10
- 4
build.xml View File

@@ -144,7 +144,7 @@ list of possible build targets.
<property name="name" value="fop"/>
<property name="NAME" value="FOP"/>
<property name="version" value="svn-trunk"/>
<property name="year" value="1999-2010"/>
<property name="year" value="1999-2012"/>
<property name="javac.debug" value="on"/>
<property name="javac.optimize" value="off"/>
<property name="javac.deprecation" value="on"/>
@@ -477,7 +477,7 @@ list of possible build targets.
<attribute name="Build-Id" value="${ts} (${user.name} [${os.name} ${os.version} ${os.arch}, Java ${java.runtime.version}, Target Java ${javac.target}])"/>
<section name="org/apache/fop/">
<attribute name="Specification-Title" value="XSL-FO - Extensible Stylesheet Language"/>
<attribute name="Specification-Version" value="1.0"/>
<attribute name="Specification-Version" value="1.1"/>
<attribute name="Specification-Vendor" value="World Wide Web Consortium"/>
<attribute name="Specification-URL" value="http://www.w3.org/TR/xsl"/>
<attribute name="Implementation-Title" value="${Name}"/>
@@ -1451,14 +1451,20 @@ NOTE:
</delete>
</target>
<target name="validate-xdocs" description="Validate the xdocs. Point schemas.dir to Forrest's 'schemas' directory.">
<property name="schemas.dir" value="../xml-forrest/src/resources/schema"/>
<property name="schemas.dir" value="../xml-forrest/main/webapp/resources/schema"/>
<xmlvalidate failonerror="no">
<fileset dir="${xdocs.dir}" includes="**.xml"/>
<fileset dir="${xdocs.dir}">
<include name="**.xml"/>
<exclude name="**/site.xml"/>
<exclude name="**/news-data.xml"/>
</fileset>
<xmlcatalog>
<entity publicId="-//APACHE//DTD Compliance V1.0//EN" location="src/documentation/resources/schema/dtd/compliance-v10.dtd"/>
<entity publicId="-//APACHE//DTD Documentation V1.1//EN" location="${schemas.dir}/dtd/document-v11.dtd"/>
<entity publicId="-//APACHE//DTD Documentation V1.3//EN" location="${schemas.dir}/dtd/document-v13.dtd"/>
<entity publicId="-//APACHE//DTD Specification V1.1//EN" location="${schemas.dir}/dtd/specification-v11.dtd"/>
<entity publicId="-//APACHE//DTD FAQ V1.1//EN" location="${schemas.dir}/dtd/faq-v11.dtd"/>
<entity publicId="-//APACHE//DTD FAQ V1.3//EN" location="${schemas.dir}/dtd/faq-v13.dtd"/>
<entity publicId="-//APACHE//DTD Changes V1.1//EN" location="${schemas.dir}/dtd/changes-v11.dtd"/>
<entity publicId="-//APACHE//DTD Todo V1.1//EN" location="${schemas.dir}/dtd/todo-v11.dtd"/>
<entity publicId="-//APACHE//DTD Cocoon Documentation Book V1.0//EN" location="${schemas.dir}/dtd/book-cocoon-v10.dtd"/>

+ 0
- 204
checkstyle-5.1.xml View File

@@ -1,204 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.1//EN" "http://www.puppycrawl.com/dtds/configuration_1_1.dtd">
<module name="Checker">
<module name="TreeWalker">
<module name="ArrayTypeStyleCheck">
<property name="javaStyle" value="true"/>
<property name="severity" value="warning"/>
</module>
<module name="ModifierOrderCheck">
<property name="severity" value="warning"/>
</module>
<module name="RedundantModifierCheck">
<property name="severity" value="warning"/>
<property name="tokens" value="METHOD_DEF, VARIABLE_DEF"/>
</module>
<module name="UpperEllCheck">
<property name="severity" value="warning"/>
</module>
<module name="AvoidNestedBlocksCheck">
<property name="severity" value="warning"/>
</module>
<module name="EmptyBlockCheck">
<property name="option" value="text"/>
<property name="severity" value="warning"/>
<property name="tokens" value="LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_IF, LITERAL_FOR, LITERAL_TRY, LITERAL_WHILE, STATIC_INIT"/>
</module>
<module name="LeftCurlyCheck">
<property name="maxLineLength" value="100"/>
<property name="option" value="eol"/>
<property name="severity" value="warning"/>
<property name="tokens" value="CLASS_DEF, CTOR_DEF, INTERFACE_DEF, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF"/>
</module>
<module name="NeedBracesCheck">
<property name="severity" value="warning"/>
<property name="tokens" value="LITERAL_DO, LITERAL_ELSE, LITERAL_IF, LITERAL_FOR, LITERAL_WHILE"/>
</module>
<module name="RightCurlyCheck">
<property name="option" value="same"/>
<property name="severity" value="warning"/>
<property name="tokens" value="LITERAL_CATCH, LITERAL_ELSE, LITERAL_TRY"/>
</module>
<module name="DoubleCheckedLockingCheck">
<property name="severity" value="warning"/>
</module>
<module name="EmptyStatementCheck">
<property name="severity" value="warning"/>
</module>
<module name="EqualsHashCodeCheck">
<property name="severity" value="warning"/>
</module>
<module name="InnerAssignmentCheck">
<property name="severity" value="warning"/>
<property name="tokens" value="ASSIGN, BAND_ASSIGN, BOR_ASSIGN, BSR_ASSIGN, BXOR_ASSIGN, DIV_ASSIGN, MINUS_ASSIGN, MOD_ASSIGN, PLUS_ASSIGN, SL_ASSIGN, SR_ASSIGN, STAR_ASSIGN"/>
</module>
<module name="MissingSwitchDefaultCheck">
<property name="severity" value="warning"/>
</module>
<module name="SimplifyBooleanExpressionCheck">
<property name="severity" value="warning"/>
</module>
<module name="SimplifyBooleanReturnCheck">
<property name="severity" value="warning"/>
</module>
<module name="FinalClassCheck">
<property name="severity" value="warning"/>
</module>
<module name="HideUtilityClassConstructorCheck">
<property name="severity" value="warning"/>
</module>
<module name="VisibilityModifierCheck">
<property name="packageAllowed" value="false"/>
<property name="protectedAllowed" value="true"/>
<property name="publicMemberPattern" value="^serialVersionUID"/>
<property name="severity" value="warning"/>
</module>
<module name="AvoidStarImportCheck">
<property name="severity" value="error"/>
</module>
<module name="JavadocMethodCheck">
<property name="allowMissingParamTags" value="false"/>
<property name="allowMissingReturnTag" value="false"/>
<property name="allowMissingThrowsTags" value="false"/>
<property name="allowThrowsTagsForSubclasses" value="false"/>
<property name="allowUndeclaredRTE" value="false"/>
<property name="scope" value="protected"/>
<property name="severity" value="warning"/>
<property name="tokens" value="METHOD_DEF, CTOR_DEF"/>
</module>
<module name="JavadocTypeCheck">
<property name="scope" value="protected"/>
<property name="severity" value="warning"/>
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF"/>
</module>
<module name="JavadocVariableCheck">
<property name="scope" value="protected"/>
<property name="severity" value="warning"/>
</module>
<module name="ConstantNameCheck">
<property name="format" value="^([A-Z](_?[A-Z0-9]+)*)|(log)$"/>
<property name="severity" value="warning"/>
</module>
<module name="LocalFinalVariableNameCheck">
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
<property name="severity" value="warning"/>
</module>
<module name="LocalVariableNameCheck">
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
<property name="severity" value="warning"/>
</module>
<module name="MemberNameCheck">
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
<property name="severity" value="warning"/>
</module>
<module name="MethodNameCheck">
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
<property name="severity" value="warning"/>
</module>
<module name="PackageNameCheck">
<property name="format" value="^[a-z]+(\.[a-zA-Z_][a-zA-Z0-9_]*)*$"/>
<property name="severity" value="warning"/>
</module>
<module name="ParameterNameCheck">
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
<property name="severity" value="warning"/>
</module>
<module name="StaticVariableNameCheck">
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
<property name="severity" value="warning"/>
</module>
<module name="TypeNameCheck">
<property name="format" value="^[A-Z][a-zA-Z0-9]*$"/>
<property name="severity" value="warning"/>
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF"/>
</module>
<module name="LineLengthCheck">
<property name="ignorePattern" value="^$"/>
<property name="max" value="100"/>
<property name="severity" value="warning"/>
<property name="tabWidth" value="4"/>
</module>
<module name="MethodLengthCheck">
<property name="max" value="150"/>
<property name="severity" value="warning"/>
<property name="tokens" value="METHOD_DEF, CTOR_DEF"/>
</module>
<module name="ParameterNumberCheck">
<property name="max" value="7"/>
<property name="severity" value="warning"/>
<property name="tokens" value="METHOD_DEF, CTOR_DEF"/>
</module>
<module name="EmptyForIteratorPadCheck">
<property name="option" value="nospace"/>
<property name="severity" value="warning"/>
</module>
<module name="NoWhitespaceAfterCheck">
<property name="allowLineBreaks" value="true"/>
<property name="severity" value="warning"/>
<property name="tokens" value="ARRAY_INIT, BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS"/>
</module>
<module name="NoWhitespaceBeforeCheck">
<property name="allowLineBreaks" value="true"/>
<property name="severity" value="warning"/>
<property name="tokens" value="SEMI, POST_DEC, POST_INC"/>
</module>
<module name="OperatorWrapCheck">
<property name="option" value="nl"/>
<property name="severity" value="warning"/>
<property name="tokens" value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, SL, SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN"/>
</module>
<module name="WhitespaceAfterCheck">
<property name="severity" value="warning"/>
<property name="tokens" value="COMMA, SEMI"/>
</module>
<module name="WhitespaceAroundCheck">
<property name="severity" value="warning"/>
<property name="tokens" value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, EQUAL, GE, GT, LAND, LCURLY, LE, LITERAL_ASSERT, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN"/>
</module>
<module name="FileContentsHolder"/>
</module>
<module name="RegexpHeader">
<property name="headerFile" value="${samedir}/checkstyle.header"/>
<property name="severity" value="warning"/>
</module>
<module name="FileLengthCheck">
<property name="max" value="2000"/>
<property name="severity" value="warning"/>
</module>
<module name="FileTabCharacter">
<property name="severity" value="error"/>
</module>
<module name="SuppressionFilter">
<property name="file" value="${samedir}/checkstyle-suppressions.xml"/>
</module>
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="CSOFF\: ([\w\|]+)"/>
<property name="onCommentFormat" value="CSON\: ([\w\|]+)"/>
<property name="checkFormat" value="$1"/>
</module>
<module name="SuppressWithNearbyCommentFilter">
<property name="commentFormat" value="CSOK\: ([\w\|]+)"/>
<property name="checkFormat" value="$1"/>
<property name="influenceFormat" value="0"/>
</module>
</module>

+ 65
- 71
known-issues.xml View File

@@ -17,75 +17,69 @@
-->
<!-- $Id$ -->
<known-issues>
<known-issue>
MIF and SVG output support have not been restored, yet.
</known-issue>
<known-issue>
RTF output is inferior to other output formats supported by FOP.
For details, please see the "Output Targets" page of the release
you're using.
</known-issue>
<known-issue>
Auto table layout is not implemented, yet.
</known-issue>
<known-issue>
Footnotes may overlap with text of the region-body in multi-column
documents.
</known-issue>
<known-issue>
Space resolution does not work between footnote regions.
</known-issue>
<known-issue>
There's a problem involving nested block-containers and
reference-orientation 180/-180 (<a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=36391">Bugzilla #36391</a>)
</known-issue>
<known-issue>
block-containers with no height currently don't create a fence for
spaces as they should (they behave like a normal block).
</known-issue>
<known-issue>
Preserved linefeeds in fo:character are not handled correctly.
</known-issue>
<known-issue>
An empty block currently produces a fence for stacking constraints
which it shouldn't.
</known-issue>
<known-issue>
There are several small problems around white space handling.
</known-issue>
<known-issue>
Images currently don't shrink so they fit on a page when they are
too big and shrinking is allowed to happen.
</known-issue>
<known-issue>
inline-container may not work as expected.
</known-issue>
<known-issue>
letter-spacing and word-spacing properties may not work as expected.
</known-issue>
<known-issue>
leaders with leader-pattern="use-content" may not work as expected.
</known-issue>
<known-issue>
keep-with-previous doesn't work inside tables and lists, yet.
</known-issue>
<known-issue>
If two consecutive pages don't have the same available width, the
content currently isn't properly fit into the available space on
the new page.
</known-issue>
<known-issue>
background-images on page-number-citations are not placed correctly.
</known-issue>
<known-issue>
Not all FO elements can be referenced by their "id", most notably:
table-body, table-header, table-footer and table-row.
</known-issue>
<known-issue>
Border and padding conditionality are not supported on table-cells, yet.
</known-issue>
<known-issue>
Column balancing in multi-column documents may not work as expected
(<a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=36356">Bugzilla #36356</a>)
</known-issue>
<!-- NEED TO REVIEW ALL OF THE FOLLOWING
<known-issue>
MIF and SVG output support have not been restored, yet.
</known-issue>
<known-issue>
RTF output is inferior to other output formats supported by FOP.
For details, please see the "Output Targets" page of the release
you're using.
</known-issue>
<known-issue>
Auto table layout is not implemented, yet.
</known-issue>
<known-issue>
Footnotes may overlap with text of the region-body in multi-column
documents.
</known-issue>
<known-issue>
Space resolution does not work between footnote regions.
</known-issue>
<known-issue>
Block containers with no height currently don't create a fence for
spaces as they should (they behave like a normal block).
</known-issue>
<known-issue>
Preserved linefeeds in fo:character are not handled correctly.
</known-issue>
<known-issue>
An empty block currently produces a fence for stacking constraints
which it shouldn't.
</known-issue>
<known-issue>
There are several small problems around white space handling.
</known-issue>
<known-issue>
Images currently don't shrink so they fit on a page when they are
too big and shrinking is allowed to happen.
</known-issue>
<known-issue>
Inline container may not work as expected.
</known-issue>
<known-issue>
The letter-spacing and word-spacing properties may not work as expected.
</known-issue>
<known-issue>
Leaders with leader-pattern="use-content" may not work as expected.
</known-issue>
<known-issue>
The keep-with-previous property doesn't work inside tables and lists, yet.
</known-issue>
<known-issue>
If two consecutive pages don't have the same available width, the
content currently isn't properly fit into the available space on
the new page.
</known-issue>
<known-issue>
Background images on page number citations are not placed correctly.
</known-issue>
<known-issue>
Not all FO elements can be referenced by their "id", most notably:
table-body, table-header, table-footer and table-row.
</known-issue>
<known-issue>
Border and padding conditionality are not supported on table-cells, yet.
</known-issue>
-->
</known-issues>

+ 17
- 17
src/documentation/content/.htaccess View File

@@ -1,27 +1,27 @@
# redirect moved files
RedirectMatch Permanent ^/fop/anttask(.*) http://xmlgraphics.apache.org/fop/1.0/anttask$1
RedirectMatch Permanent ^/fop/compiling(.*) http://xmlgraphics.apache.org/fop/1.0/compiling$1
RedirectMatch Permanent ^/fop/configuration(.*) http://xmlgraphics.apache.org/fop/1.0/configuration$1
RedirectMatch Permanent ^/fop/embedding(.*) http://xmlgraphics.apache.org/fop/1.0/embedding$1
RedirectMatch Permanent ^/fop/extensions(.*) http://xmlgraphics.apache.org/fop/1.0/extensions$1
RedirectMatch Permanent ^/fop/fonts(.*) http://xmlgraphics.apache.org/fop/1.0/fonts$1
RedirectMatch Permanent ^/fop/graphics(.*) http://xmlgraphics.apache.org/fop/1.0/graphics$1
RedirectMatch Permanent ^/fop/hyphenation(.*) http://xmlgraphics.apache.org/fop/1.0/hyphenation$1
RedirectMatch Permanent ^/fop/intermediate(.*) http://xmlgraphics.apache.org/fop/1.0/intermediate$1
RedirectMatch Permanent ^/fop/output(.*) http://xmlgraphics.apache.org/fop/1.0/output$1
RedirectMatch Permanent ^/fop/pdfa(.*) http://xmlgraphics.apache.org/fop/1.0/pdfa$1
RedirectMatch Permanent ^/fop/pdfencryption(.*) http://xmlgraphics.apache.org/fop/1.0/pdfencryption$1
RedirectMatch Permanent ^/fop/pdfx(.*) http://xmlgraphics.apache.org/fop/1.0/pdfx$1
RedirectMatch Permanent ^/fop/running(.*) http://xmlgraphics.apache.org/fop/1.0/running$1
RedirectMatch Permanent ^/fop/servlets(.*) http://xmlgraphics.apache.org/fop/1.0/servlets$1
RedirectMatch Permanent ^/fop/upgrading(.*) http://xmlgraphics.apache.org/fop/1.0/upgrading$1
RedirectMatch Permanent ^/fop/anttask(.*) http://xmlgraphics.apache.org/fop/1.1rc1/anttask$1
RedirectMatch Permanent ^/fop/compiling(.*) http://xmlgraphics.apache.org/fop/1.1rc1/compiling$1
RedirectMatch Permanent ^/fop/configuration(.*) http://xmlgraphics.apache.org/fop/1.1rc1/configuration$1
RedirectMatch Permanent ^/fop/embedding(.*) http://xmlgraphics.apache.org/fop/1.1rc1/embedding$1
RedirectMatch Permanent ^/fop/extensions(.*) http://xmlgraphics.apache.org/fop/1.1rc1/extensions$1
RedirectMatch Permanent ^/fop/fonts(.*) http://xmlgraphics.apache.org/fop/1.1rc1/fonts$1
RedirectMatch Permanent ^/fop/graphics(.*) http://xmlgraphics.apache.org/fop/1.1rc1/graphics$1
RedirectMatch Permanent ^/fop/hyphenation(.*) http://xmlgraphics.apache.org/fop/1.1rc1/hyphenation$1
RedirectMatch Permanent ^/fop/intermediate(.*) http://xmlgraphics.apache.org/fop/1.1rc1/intermediate$1
RedirectMatch Permanent ^/fop/output(.*) http://xmlgraphics.apache.org/fop/1.1rc1/output$1
RedirectMatch Permanent ^/fop/pdfa(.*) http://xmlgraphics.apache.org/fop/1.1rc1/pdfa$1
RedirectMatch Permanent ^/fop/pdfencryption(.*) http://xmlgraphics.apache.org/fop/1.1rc1/pdfencryption$1
RedirectMatch Permanent ^/fop/pdfx(.*) http://xmlgraphics.apache.org/fop/1.1rc1/pdfx$1
RedirectMatch Permanent ^/fop/running(.*) http://xmlgraphics.apache.org/fop/1.1rc1/running$1
RedirectMatch Permanent ^/fop/servlets(.*) http://xmlgraphics.apache.org/fop/1.1rc1/servlets$1
RedirectMatch Permanent ^/fop/upgrading(.*) http://xmlgraphics.apache.org/fop/1.1rc1/upgrading$1

# redirect to versioned documentation
# Current stable release
Redirect Temp /fop/stable http://xmlgraphics.apache.org/fop/1.0

# Current unstable release (or trunk if no beta is the latest release)
Redirect Temp /fop/unstable http://xmlgraphics.apache.org/fop/trunk
Redirect Temp /fop/unstable http://xmlgraphics.apache.org/fop/1.1rc1

# Latest release
Redirect Temp /fop/current http://xmlgraphics.apache.org/fop/1.0

+ 11
- 5
src/documentation/content/doap.rdf View File

@@ -15,7 +15,6 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
<?xml-stylesheet type="text/xsl" href="../xsl/p2.xsl"?>
<rdf:RDF xml:lang="en"
xmlns="http://usefulinc.com/ns/doap#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
@@ -76,18 +75,25 @@
</asfext:implements>
<release>
<Version>
<name>Previous stable release</name>
<created>2008-08-05</created>
<revision>0.95</revision>
<name>Upcoming release (candidate)</name>
<created>2012-07-02</created>
<revision>1.1rc1</revision>
</Version>
</release>
<release>
<Version>
<name>Latest stable release</name>
<name>Current release (stable)</name>
<created>2010-07-21</created>
<revision>1.0</revision>
</Version>
</release>
<release>
<Version>
<name>Previous release (stable)</name>
<created>2008-08-05</created>
<revision>0.95</revision>
</Version>
</release>
<repository>
<SVNRepository>
<location rdf:resource="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/"/>

+ 167
- 0
src/documentation/content/xdocs/1.1rc1/accessibility.xml View File

@@ -0,0 +1,167 @@
<?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" "document-v20.dtd">
<document>
<header>
<title>Apache™ FOP: Accessibility</title>
</header>
<body>
<section id="overview">
<title>Overview</title>
<p>
This page describes the
<a href="http://en.wikipedia.org/wiki/Accessibility">accessibility</a>
features of Apache™ FOP.
<a href="http://www.section508.gov/">Section 508</a> defines accessibility in the context
of electronic documents for the USA but other countries have similar requirements.
</p>
<p>
Accessibility features are available only for the PDF output format and there are some
implementation limitations. Also, certain actions must be undertaken by the content creator
to ensure that FOP can create a truly accessible document.
</p>
</section>
<section>
<title>Enabling accessibility</title>
<p>There are 3 ways to enable accessibility:</p>
<ol>
<li>
<strong>Command line:</strong> The command line option -a turns on accessibility:
<code>fop -a -fo mydocument.fo -pdf mydocument.pdf</code>
</li>
<li>
<strong>Embedding:</strong> <code>userAgent.setAccessibility(true);</code>
</li>
<li>
<strong>Optional setting in fop.xconf file:</strong>
<pre>
&lt;fop version="1.0"&gt;
&lt;accessibility&gt;true&lt;/accessibility&gt;
...
&lt;/fop&gt;
</pre>
</li>
</ol>
<p>
When accessibility is enabled, additional information relating to the logical structure of
the document is added to the PDF. That information allows the PDF viewer (or a
text-to-speech application) to retrieve the natural reading order of the document.
</p>
<note>The processing of the logical structure is memory-hungry. You may need to adjust the
Java heap size in order to process larger files.</note>
</section>
<section id="source">
<title>Changes to your XSL-FO input files</title>
<p>
Apache FOP cannot automatically generate accessible PDFs. Some of the work can only be
performed by the content provider. Following are some changes that may be necessary to
your XSL-FO content in order to generate really accessible documents:
</p>
<ul>
<li>Table cells must have a table row as their parent.</li>
<li>
Images must have an alternate text: use the <code>fox:alt-text</code> extension attribute
(in the <a href="extensions.html#fox-namespace">fox namespace</a>) on
<code>fo:external-graphic</code> and <code>fo:instream-foreign-object</code> to specify a
short text describing the image.
</li>
<li>
Ensure that the order of <code>fo:block-container</code> elements in a page corresponds to
the reading order.
</li>
<li>
Specify the natural language of the document using the language and country properties
(or via the <code>xml:lang</code> shorthand property).
</li>
</ul>
</section>
<section id="customTags">
<title>Customized Tagging</title>
<p>The <a href="#PDFReference">PDF Reference</a> defines a set of standard Structure Types to
tag content. For example, ‘P’ is used for identifying paragraphs, ‘H1’ to ‘H6’ for headers,
‘L’ for lists, ‘Div’ for block-level groups of elements, etc. This standard set is aimed at
improving interoperability between applications producing or consuming PDF. </p>
<p>FOP provides a default mapping of Formatting Objects to elements from that standard set.
For example, <code>fo:page-sequence</code> is mapped to ‘Part’, <code>fo:block</code> is
mapped to ‘P’, <code>fo:list-block</code> to ‘L’, etc.</p>
<p>You may want to customize that mapping to improve the accuracy of the tagging or deal with
particular FO constructs. For example, you may want to make use of the ‘H1’ to ‘H6’ tags to
make the hierarchical structure of the document appear in the PDF. This is achieved by using
the <code>role</code> XSL-FO property:</p>
<source>...
&lt;fo:block role="H1" font-weight="bold"&gt;I. A Level 1 Heading&lt;/fo:block&gt;
&lt;fo:block&gt;This is the first paragraph of the first section...&lt;/fo:block&gt;
...</source>
<p>If a non-standard structure type is specified, FOP will issue a warning and fall back to
the default tag associated to the Formatting Object.</p>
</section>
<section id="testing">
<title>Testing</title>
<p>
Accessible PDFs can be tested, for example, using Adobe Acrobat Professional. Its
Accessibility Check feature creates a report indicating any deficiencies with a PDF
document. Alternatively, you can just let a screen reader read the document aloud.
</p>
</section>
<section id="limitations">
<title>Limitations</title>
<p>
Accessibility support in Apache FOP is relatively new, so there are certain
limitations. Please help us identify and close any gaps.
</p>
<ul>
<li>
The natural language can currently only be specified at the page-sequence level. The
document language is derived from the language of the first page-sequence. It is
currently not possible to override the language inside the content below the
page-sequence level.
</li>
<li>
It's currently not possible to specify the expanded form of an abbreviation or acronym.
</li>
<li>
SVG graphics (or images in general) are treated as a single figure. Text contained in
SVGs is not accessible. It's only possible to work with <code>fox:alt-text</code>.
</li>
<li>
The side regions (region-before, region-after etc.) are currently not specially
identified. Screen readers may read their content at page changes.
</li>
</ul>
</section>
<section id="links">
<title>Related Links</title>
<p>
Many resources providing guidance about creating accessible documents can be found on the
web. Here are a few links, along with additional resources around the topic:
</p>
<ul>
<li><a href="http://www.section508.gov/">US Government - Website on Section 508</a></li>
<li><a href="http://en.wikipedia.org/wiki/Accessibility">Wikipedia on Accessibility in general</a></li>
<li><a href="http://en.wikipedia.org/wiki/Portable_Document_Format#Accessibility">Wikipedia on Accessibility in PDF</a></li>
<li id="PDFReference">
<a href="http://partners.adobe.com/public/developer/en/pdf/PDFReference.pdf">PDF
Reference 1.4</a> (look up chapters 9.7 "Tagged PDF" and 9.8 "Accessibility Support")
</li>
<li><a href="pdfa.html">PDF/A support in Apache FOP</a></li>
<li><a href="http://wiki.apache.org/xmlgraphics-fop/PDF_Accessibility">Developer-oriented details on the accessibility features (on the Wiki)</a></li>
</ul>
</section>
</body>
</document>

+ 236
- 0
src/documentation/content/xdocs/1.1rc1/anttask.xml View File

@@ -0,0 +1,236 @@
<?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: Ant task</title>
<version>$Revision$</version>
</header>
<body>
<p>
Apache™ FOP provides an Ant task for automating the document build process.
</p>
<section id="basics">
<title>Description</title>
<p>
The FOP Ant task will convert XSL-FO documents to PDF, PS, PCL etc. output
(see <a href="output.html">Output formats</a> for available formats).
</p>
<p>
To call FOP tasks within Ant, first add a FOP task definition to your Ant build file.
One method of defining the task is as follows:
</p>
<source><![CDATA[
<property name="fop.home" value="....path to your FOP HOME directory..."/>

<taskdef name="fop"
classname="org.apache.fop.tools.anttasks.Fop">
<classpath>
<fileset dir="${fop.home}/lib">
<include name="*.jar"/>
</fileset>
<fileset dir="${fop.home}/build">
<include name="fop.jar"/>
<include name="fop-hyph.jar" />
</fileset>
</classpath>
</taskdef>
]]></source>
<p>
Then create FOP tasks within your Ant build file, using the FOP task parameters listed below.</p>
</section>
<!-- TODO: Installation/Configuration -->
<section id="parameters"><title>Parameters for FOP Ant task</title>
<table><caption>Parameters specified as attributes</caption>
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Required</th>
</tr>
<tr>
<td>fofile</td>
<td>XSL-FO file to be rendered</td>
<td>Yes, if no fileset nested element is used</td>
</tr>
<tr>
<td>xmlfile</td>
<td>XML input file</td>
<td>Yes, if no fofile is specified</td>
</tr>
<tr>
<td>xsltfile</td>
<td>XSLT input file</td>
<td>Yes, if no fofile is specified</td>
</tr>
<tr>
<td>outfile</td>
<td>Output filename</td>
<td>Yes, when fofile is used. (This attribute is not valid for filesets.)</td>
</tr>
<tr>
<td>format</td>
<td>Possible output formats:<br/>
<code>application/X-fop-awt-preview</code><br/>
<code>application/X-fop-print</code><br/>
<code>application/X-fop-areatree</code><br/>
<code>application/pdf</code><br/>
<code>application/postscript</code><br/>
<code>application/mif</code><br/>
<code>application/rtf</code>,
<code>text/richtext</code>,
<code>text/rtf</code><br/>
<code>application/x-pcl</code>,
<code>application/vnd.hp-PCL</code><br/>
<code>application/x-afp</code>,
<code>application/vnd.ibm.modcap</code><br/>
<code>text/plain</code><br/>
<code>image/svg+xml</code><br/>
<code>image/gif</code><br/>
<code>image/png</code><br/>
<code>image/tiff</code><br/>
</td>
<td>No, defaults to <code>application/pdf</code></td>
</tr>
<tr>
<td>outdir</td>
<td>Output directory</td>
<td>Required if a fileset is used to specify the files to render; optional for fofile. (Can alternatively specify the full path in the fofile value.)</td>
</tr>
<tr>
<td>force</td>
<td>Recreate target files, even if they are newer than their corresponding
source files. Note: This attribute is available in post-0.20.5
versions (0.20.x nightly build and 1.0dev) only; target files are
always generated (i.e., force=true) in 0.20.5 release.
</td>
<td>No, default is <code>false</code></td>
</tr>
<tr>
<td>basedir</td>
<td>Base directory to resolve relative references (e.g., graphics files) within the
FO document.
</td>
<td>No, for single FO File entry, default is to use the location
of that FO file.
</td>
</tr>
<tr>
<td>relativebase</td>
<td>For fileset usage only. A value of <code>true</code> specifies using the location
of each .fo file as the base directory for resolving relative file references located
within that .fo file. A value of <code>false</code> specifies using the value of
basedir for all files within the fileset, or just the current working directory
if basedir is not specified.
</td>
<td>No, default is <code>false</code>.
</td>
</tr>
<tr>
<td>userconfig</td>
<td>User configuration file (same as the FOP "-c" command line option).</td>
<td>No</td>
</tr>
<tr>
<td>messagelevel</td>
<td>Logging level<br/>
Possible values: <code>error</code>, <code>warn</code>, <code>info</code>, <code>verbose</code>, <code>debug</code>. <strong>Currently doesn't work in FOP Trunk!!!</strong></td>
<td>No, defaults to <code>verbose</code></td>
</tr>
<tr>
<td>logFiles</td>
<td>Controls whether the names of the files that are processed are logged
(<code>true</code>) or not (<code>false</code>). <strong>Currently doesn't work in FOP Trunk!!!</strong></td>
<td>No, default is <code>true</code></td>
</tr>
<tr>
<td>throwexceptions</td>
<td>Controls whether or not an exception is thrown if an error occurs during rendering.</td>
<td>Default is <code>true</code></td>
</tr>
</table>
<p/>
<table><caption>Parameters specified as nested elements</caption>
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Required</th>
</tr>
<tr>
<td>fileset</td>
<td><a href="http://ant.apache.org/manual/CoreTypes/fileset.html">FileSets</a>
are used to specify multiple XSL-FO files to be rendered.</td>
<td>Yes, if no fofile attribute is supplied</td>
</tr>
</table>
</section>
<section id="examples">
<title>Examples</title>
<p>
The following example converts a single XSL-FO file to a PDF document:
</p>

<source><![CDATA[
<target name="generate-pdf" description="Generates a single PDF file">
<fop format="application/pdf"
fofile="c:\working\foDirectory\foDocument.fo"
outfile="c:\working\pdfDirectory\pdfDocument.pdf" />
</target>
]]></source>
<p>
This example converts all XSL-FO files within an entire directory to PostScript:
</p>
<source><![CDATA[
<target name="generate-multiple-ps"
description="Generates multiple PostScript files">
<fop format="application/postscript"
outdir="${build.dir}" messagelevel="debug">
<fileset dir="${fo.examples.dir}">
<include name="*.fo"/>
</fileset>
</fop>
</target>
]]></source>
<p>
The following example transforms and converts a single XML and XSLT file to an AFP document:
</p>
<source><![CDATA[
<target name="generate-afp-from-transform" description="Generates a single AFP file from an XSLT stylesheet">
<fop format="application/x-afp"
xmlfile="c:\working\foDirectory\Document.xml"
xsltfile="c:\working\foDirectory\Document.xslt"
outfile="c:\working\afpDirectory\Document.afp" />
</target>
]]></source>
<p>
This example transforms and converts all XML files within an entire directory to PostScript:
</p>
<source><![CDATA[
<target name="generate-multiple-ps-from-transform" description="Generates multiple PostScript files using an XSLT stylesheet">
<fop format="application/postscript"
xsltfile="c:\working\foDirectory\Document.xslt"
outdir="${build.dir}" messagelevel="debug">
<fileset dir="${test.dir}">
<include name="*.xml"/>
</fileset>
</fop>
</target>
]]></source>
</section>
</body>
</document>

+ 147
- 0
src/documentation/content/xdocs/1.1rc1/compiling.xml View File

@@ -0,0 +1,147 @@
<?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: Building from Source Code</title>
<version>$Revision$</version>
</header>
<body>
<section id="build-needed">
<title>Do You Need To Build?</title>
<!-- text for released versions -->
<!-- <p>
FOP distributions are either pre-compiled binary or source.
If you are using a binary distribution, it is already built and there is no need to build it again.
See the <a href="../download.html">Download Instructions</a> for information about whether a
binary or source distribution is best for your needs.
</p>-->
<!-- /text for released versions -->
<!-- text for trunk -->
<p>
Apache™ FOP snapshots are either pre-compiled binary or source.
If you are using a binary snapshot, it is already built and there is no need to build it again.
If you got the source code from a repository snapshot or via Subversion you will need to build FOP.
See the <a href="../download.html">Download Instructions</a> for information about where to obtain binary or repository snapshots, and whether a
binary or source snapshot is best for your needs.
</p>
<!-- /text for trunk -->
</section>
<section id="env">
<title>Set Up Your Environment</title>
<section id="env-jdk">
<title>JDK</title>
<p>
Building FOP requires a minimum Java Development Kit (JDK/SDK) of 1.4
(A Java Runtime Environment is not sufficient).
</p>
</section>
<section id="env-classpath">
<title>CLASSPATH</title>
<p>
There is generally no need to setup a classpath. All libraries needed to compile FOP are included
in the source distribution and are referenced by the build script.
You will only need to adjust the classpath if you build FOP in some other way. See the build
script build.xml for details.
</p>
</section>
<section id="env-java-home">
<title>JAVA_HOME</title>
<p>
The build script uses <a href="ext:ant">Apache Ant</a>, a popular
Java-based build tool, which usually requires that the environment variable JAVA_HOME point to
your local JDK root directory. This is true even if you use JDK 1.4 or above, which normally
does not need this setting.
</p>
</section>
<section id="env-ant">
<title>Apache Ant</title>
<p>
<a href="ext:ant">Apache Ant</a> (Version 1.7 or later) must be installed in order to
build FOP. Following best practices we don't include Ant with FOP anymore. You can find the
<a href="ext:ant/manual/">instructions to install Ant in the Ant manual</a> on the web.
</p>
</section>
</section>
<section id="build-script">
<title>Run the Build Script</title>
<p>
Change to the FOP root directory and build FOP by executing the build script (build.xml)
using the "ant" command.
</p>
<note>
The "ant" command is only available on your system if you've properly
<a href="ext:ant/manual/">installed Apache Ant</a> and added Ant's location to the PATH
environment variable.
</note>
<p>
The file build.xml in the FOP root directory is the blueprint that Ant uses for the build. It
contains information for numerous build targets, many of which are building blocks to more
useful target, and others which are primarily used by the FOP developers.
You may benefit from looking through this file to learn more about the various build targets.
To obtain a complete list of useful build targets:
</p>
<source>ant -projecthelp</source>
<p>The most useful targets are:</p>
<ul>
<li>
<strong>package</strong>: Generates the JAR files (default). This is the normal build that
produces a jar file usable for running FOP.
</li>
<li>
<strong>clean </strong>: Cleans the build directory. This is useful for making sure that
any build errors are cleaned up before starting a new build. It should not ordinarily be
needed, but may be helpful if you are having problems with the build process itself.
</li>
<li>
<strong>javadocs</strong>: Creates the FOP API documentation.
<note>A minimum JDK version of 1.4.2 is required for generating the javadocs.</note>
</li>
</ul>
<p>To run the build:</p>
<source>ant [target ...]</source>
<p>For example to do a normal build for the "all" target (which is the default):</p>
<source>ant</source>
<p>OR</p>
<source>ant all</source>
<p>To clean the build directory first:</p>
<source>ant clean all</source>
<note>
If you want to shorten the build time you can just call the "package" target which
doesn't perform any automated tests during the build.
</note>
</section>
<section id="problems">
<title id="Troubleshooting">Troubleshooting</title>
<p>If you have problems building FOP, please try the following:</p>
<ul>
<li>Run the build with the target of "clean", then rerun the build.</li>
<li>Delete the build directory completely, then rerun the build.</li>
<li>
Make sure you do not have a non-FOP version of xerces.jar, xalan.jar, batik.jar,
or another dependency product somewhere in your CLASSPATH.
</li>
<li>
If the build still fails, see the <a href="../gethelp.html">Getting Help</a>
page for further help.
</li>
</ul>
</section>
</body>
</document>

+ 694
- 0
src/documentation/content/xdocs/1.1rc1/complexscripts.xml View File

@@ -0,0 +1,694 @@
<?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" "document-v20.dtd">
<document>
<header>
<title>Apache™ FOP: Complex Scripts</title>
</header>
<body>
<section id="overview">
<title>Overview</title>
<p>
This page describes the
<link href="http://en.wikipedia.org/wiki/Complex_scripts">complex scripts</link>
features of Apache™ FOP, which include:
</p>
<ul>
<li>Support for languages written with right-to-left scripts, such as Arabic and Hebrew scripts.</li>
<li>Support for languages written with South Asian and Southeast Asian scripts, such as Devanagari,
Khmer, Tamil, Thai, and others.</li>
<li>Support for advanced substitution, reordering, and positioning of glyphs according to language
and script sensitive rules.</li>
<li>Support for advanced number to string formatting.</li>
</ul>
</section>
<section>
<title>Disabling complex scripts</title>
<p>Complex script features are enabled by default. If some application of FOP does not
require this support, then it can be disabled in three ways:</p>
<ol>
<li>
<strong>Command line:</strong> The command line option <code>-nocs</code> turns off complex script
features: <code>fop -nocs -fo mydocument.fo -pdf mydocument.pdf</code>
</li>
<li>
<strong>Embedding:</strong> <code>userAgent.setComplexScriptFeaturesEnabled(false);</code>
</li>
<li>
<strong>Optional setting in fop.xconf file:</strong>
<pre>
&lt;fop version="1.0"&gt;
&lt;complex-scripts disabled="true"/&gt;
...
&lt;/fop&gt;
</pre>
</li>
</ol>
<p>
When complex scripts features are enabled, additional information related to bidirectional
level resolution, the association between characters and glyphs, and glyph position adjustments
are added to the internal, parsed representation of the XSL-FO tree and its corresponding
formatted area tree. This additional information will somewhat increase the memory requirements for
processing documents that use these features.
</p>
<note>A document author need not make explicit use of any complex scripts feature in order
for this additional information to be created. For example, if the author makes use of a font
that contains OpenType GSUB and/or GPOS tables, then those tables will be automatically used
unless complex scripts features are disabled.</note>
</section>
<section id="source">
<title>Changes to your XSL-FO input files</title>
<p>
In most circumstances, XSL-FO content does not need to change in order to make use of
complex scripts features; however, in certain contexts, fully automatic processing is not
sufficient. In these cases, an author may make use of the following XSL-FO constructs:
</p>
<ul>
<li>The <link href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#script"><code>script</code></link> property.</li>
<li>The <link href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#language"><code>language</code></link> property.</li>
<li>The <link href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#writing-mode"><code>writing-mode</code></link> property.</li>
<li>The number to string conversion properties:
<link href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#format"><code>format</code></link>,
<link href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#grouping-separator"><code>grouping-separator</code></link>,
<link href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#grouping-size"><code>grouping-size</code></link>,
<link href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#letter-value"><code>letter-value</code></link>,
and <code>fox:number-conversion-features</code>.</li>
<li>The <link href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#fo_bidi-override"><code>fo:bidi-override</code></link> element.</li>
<li>Explicit bidirectional control characters: U+200E LRM, U+200F RLM, U+202A LRE,
U+202B RLE, U+202C PDF, U+202D LRO, U+202E RLO.</li>
<li>Explicit join control characters: U+200C ZWNJ and U+200D ZWJ.</li>
</ul>
</section>
<section id="details">
<title>Authoring Details</title>
<p>The complex scripts related effects of the above enumerated XSL-FO constructs are more
fully described in the following sub-sections.</p>
<section id="script_property">
<title>Script Property</title>
<p>In order to apply font specific complex script features, it is necessary to know
the script that applies to the text undergoing layout processing. This script is determined
using the following algorithm:
</p>
<ol>
<li>If the FO element that governs the text specifies a
<link href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#script"><code>script</code></link>
property and its value is not the empty string or <code>"auto"</code>, then that script is used.</li>
<li>Otherwise, the dominant script of the text is determined automatically by finding the
script whose constituent characters appear most frequently in the text.</li>
</ol>
<p>In case the automatic algorithm does not produce the desired results, an author may
explicitly specify a <code>script</code> property with the desired script. If specified,
it must be one of the four-letter script code specified in
<link href="http://unicode.org/iso15924/iso15924-codes.html">ISO 15924 Code List</link> or
in the <link href="#extended_script_codes">Extended Script Codes</link> table. Comparison
of script codes is performed in a case-insensitive manner, so it does not matter what case
is used when specifying these codes in an XSL-FO document.</p>
<section id="standard_script_codes">
<title>Standard Script Codes</title>
<p>The following table enumerates the standard ISO 15924 4-letter codes recognized by FOP.</p>
<table class="ForrestTable tw30">
<tr>
<th style="text-align:center">Code</th>
<th style="text-align:left">Script</th>
</tr>
<tr>
<td style="text-align:center"><code>arab</code></td>
<td>Arabic</td>
</tr>
<tr>
<td style="text-align:center"><code>beng</code></td>
<td>Bengali</td>
</tr>
<tr>
<td style="text-align:center"><code>bopo</code></td>
<td>Bopomofo</td>
</tr>
<tr>
<td style="text-align:center"><code>cyrl</code></td>
<td>Cyrillic</td>
</tr>
<tr>
<td style="text-align:center"><code>deva</code></td>
<td>Devanagari</td>
</tr>
<tr>
<td style="text-align:center"><code>ethi</code></td>
<td>Ethiopic</td>
</tr>
<tr>
<td style="text-align:center"><code>geor</code></td>
<td>Georgian</td>
</tr>
<tr>
<td style="text-align:center"><code>grek</code></td>
<td>Greek</td>
</tr>
<tr>
<td style="text-align:center"><code>gujr</code></td>
<td>Gujarati</td>
</tr>
<tr>
<td style="text-align:center"><code>guru</code></td>
<td>Gurmukhi</td>
</tr>
<tr>
<td style="text-align:center"><code>hang</code></td>
<td>Hangul</td>
</tr>
<tr>
<td style="text-align:center"><code>hani</code></td>
<td>Han</td>
</tr>
<tr>
<td style="text-align:center"><code>hebr</code></td>
<td>Hebrew</td>
</tr>
<tr>
<td style="text-align:center"><code>hira</code></td>
<td>Hiragana</td>
</tr>
<tr>
<td style="text-align:center"><code>kana</code></td>
<td>Katakana</td>
</tr>
<tr>
<td style="text-align:center"><code>knda</code></td>
<td>Kannada</td>
</tr>
<tr>
<td style="text-align:center"><code>khmr</code></td>
<td>Khmer</td>
</tr>
<tr>
<td style="text-align:center"><code>laoo</code></td>
<td>Lao</td>
</tr>
<tr>
<td style="text-align:center"><code>latn</code></td>
<td>Latin</td>
</tr>
<tr>
<td style="text-align:center"><code>mlym</code></td>
<td>Malayalam</td>
</tr>
<tr>
<td style="text-align:center"><code>mymr</code></td>
<td>Burmese</td>
</tr>
<tr>
<td style="text-align:center"><code>mong</code></td>
<td>Mongolian</td>
</tr>
<tr>
<td style="text-align:center"><code>orya</code></td>
<td>Oriya</td>
</tr>
<tr>
<td style="text-align:center"><code>sinh</code></td>
<td>Sinhalese</td>
</tr>
<tr>
<td style="text-align:center"><code>taml</code></td>
<td>Tamil</td>
</tr>
<tr>
<td style="text-align:center"><code>telu</code></td>
<td>Telugu</td>
</tr>
<tr>
<td style="text-align:center"><code>thai</code></td>
<td>Thai</td>
</tr>
<tr>
<td style="text-align:center"><code>tibt</code></td>
<td>Tibetan</td>
</tr>
<tr>
<td style="text-align:center"><code>zmth</code></td>
<td>Math</td>
</tr>
<tr>
<td style="text-align:center"><code>zsym</code></td>
<td>Symbol</td>
</tr>
<tr>
<td style="text-align:center"><code>zyyy</code></td>
<td>Undetermined</td>
</tr>
<tr>
<td style="text-align:center"><code>zzzz</code></td>
<td>Uncoded</td>
</tr>
</table>
</section>
<section id="extended_script_codes">
<title>Extended Script Codes</title>
<p>The following table enumerates a number of non-standard extended script codes recognized by FOP.</p>
<table class="ForrestTable tw70">
<colgrp>
<col style="width:10%"/>
<col style="width:20%"/>
<col style="width:80%"/>
</colgrp>
<tr>
<th>Code</th>
<th>Script</th>
<th>Comments</th>
</tr>
<tr>
<td style="text-align:center"><code>bng2</code></td>
<td>Bengali</td>
<td>OpenType Indic Version 2 (May 2008 and following) behavior.</td>
</tr>
<tr>
<td style="text-align:center"><code>dev2</code></td>
<td>Devanagari</td>
<td>OpenType Indic Version 2 (May 2008 and following) behavior.</td>
</tr>
<tr>
<td style="text-align:center"><code>gur2</code></td>
<td>Gurmukhi</td>
<td>OpenType Indic Version 2 (May 2008 and following) behavior.</td>
</tr>
<tr>
<td style="text-align:center"><code>gjr2</code></td>
<td>Gujarati</td>
<td>OpenType Indic Version 2 (May 2008 and following) behavior.</td>
</tr>
<tr>
<td style="text-align:center"><code>knd2</code></td>
<td>Kannada</td>
<td>OpenType Indic Version 2 (May 2008 and following) behavior.</td>
</tr>
<tr>
<td style="text-align:center"><code>mlm2</code></td>
<td>Malayalam</td>
<td>OpenType Indic Version 2 (May 2008 and following) behavior.</td>
</tr>
<tr>
<td style="text-align:center"><code>ory2</code></td>
<td>Oriya</td>
<td>OpenType Indic Version 2 (May 2008 and following) behavior.</td>
</tr>
<tr>
<td style="text-align:center"><code>tml2</code></td>
<td>Tamil</td>
<td>OpenType Indic Version 2 (May 2008 and following) behavior.</td>
</tr>
<tr>
<td style="text-align:center"><code>tel2</code></td>
<td>Telugu</td>
<td>OpenType Indic Version 2 (May 2008 and following) behavior.</td>
</tr>
</table>
<warning>
Explicit use of one of the above extended script codes is not portable,
and should be limited to use with FOP only.
</warning>
<note>
When performing automatic script determination, FOP selects the OpenType Indic
Version 2 script codes by default. If the author requires Version 1 behavior, then
an explicit, non-extension script code should be specified in a governing <code>script</code>
property.
</note>
</section>
</section>
<section id="language_property">
<title>Language Property</title>
<p>Certain fonts that support complex script features can make use of language information in order for
language specific processing rules to be applied. For example, a font designed for the Arabic script may support
typographic variations according to whether the written language is Arabic, Farsi (Persian), Sindhi, Urdu, or
another language written with the Arabic script. In order to apply these language specific features, the author
may explicitly mark the text with a <link href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#language"><code>language</code></link>
property.</p>
<p>When specifying the <code>language</code> property, the value of the property must be either an
<link href="http://en.wikipedia.org/wiki/List_of_ISO_639-2_codes">ISO639-2 3-letter code</link> or an
<link href="http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes">ISO639-1 2-letter code</link>. Comparison of language
codes is performed in a case-insensitive manner, so it does not matter what case is used when specifying these
codes in an XSL-FO document.</p>
</section>
<section id="writing_mode_property">
<title>Writing Mode Property</title>
<p>The <code>writing-mode</code> property is used to determine the axes and direction of the inline
progression direction, the block progression direction, the column progression direction (in tables
and flows), the shift direction, region placement, the resolution of writing-mode relative property
values (such as start, end, before, after), and the default block (paragraph) bidirectionality
level.
</p>
<p>The <code>writing-mode</code> property is inherited, so it can appear on any XSL-FO element type; however,
it applies (semantically) only to the following element types:
</p>
<ul>
<li><code>fo:page-sequence</code></li>
<li><code>fo:simple-page-master</code></li>
<li><code>fo:region-*</code></li>
<li><code>fo:block-container</code></li>
<li><code>fo:inline-container</code></li>
<li><code>fo:table</code></li>
</ul>
<p>If it is not specified on one of these element types, but is specified on an ancestor element, then the value specified on that
ancestor element (the inherited value) is used; otherwise, the initial value <code>lr-tb</code> is used.</p>
<p>At present, only the following values of the <code>writing-mode</code> property are supported:</p>
<ul>
<li><code>lr-tb</code></li>
<li><code>rl-tb</code></li>
<li><code>lr</code></li>
<li><code>rl</code></li>
</ul>
<p>Writing modes that employ a vertical inline progression direction are not yet supported.</p>
</section>
<!-- [TBD] - NEED TO DOCUMENT
<section id="number_conversion_properties">
<title>Number Conversion Properties</title>
</section>
-->
<section id="bidi_override_element">
<title>Bidi Override Element</title>
<p>The <link href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#fo_bidi-override"><code>fo:bidi-override</code></link>
element may be used to override default bidirectional processing behavior,
including default embedding levels and default character directionality. In the absence of either this element
or use of explicit <link href="#bidi_controls">Bidi Control Characters</link>, the default behavior prescribed
by the <link href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#fo_bidi-override">Unicode Bidirectional Algorithm</link>
applies.
</p>
</section>
<section id="bidi_controls">
<title>Bidi Control Characters</title>
<p>In addition to the use of the <link href="#bidi_override_element">Bidi Override Element</link>, an author
may make use of the following explicit Unicode Bidi Control Characters:</p>
<ul>
<li>U+200E - LEFT-TO-RIGHT MARK (LRM)</li>
<li>U+200F - RIGHT-TO-LEFT MARK (RLM)</li>
<li>U+202A - LEFT-TO-RIGHT EMBEDDING (LRE)</li>
<li>U+202B - RIGHT-TO-LEFT EMBEDDING (RLE)</li>
<li>U+202C - POP DIRECTIONAL FORMATTING (PDF)</li>
<li>U+202D - LEFT-TO-RIGHT OVERRIDE (LRO)</li>
<li>U+202E - RIGHT-TO-LEFT OVERRIDE (RLO)</li>
</ul>
<p>If an embedding or override is not terminated (using U+202C PDF) prior to the end of a
<link href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#d0e4879">delimited text range</link>,
then it is automatically terminated by FOP.
</p>
</section>
<section id="join_controls">
<title>Join Control Characters</title>
<p>In order to prevent joining behavior in contexts where joining occurs by default,
for example, between U+0628 ARABIC LETTER BEH and U+0646 ARABIC LETTER NOON,
an author may used a U+200C ZERO WIDTH NON-JOINER (ZWNJ).
</p>
<p>Conversely, in order to force joining behavior in contexts where joining does not occur by default,
for example, between U+0628 ARABIC LETTER BEH and U+0020 SPACE, an author may used a U+200D ZERO WIDTH JOINER (ZWJ).
</p>
<p>The behavior of ZWNJ and ZWJ is script specific. See
<link href="http://www.unicode.org/versions/Unicode6.1.0/ch08.pdf">The Unicode Standard, Chapter 8,
Middle Eastern Scripts</link> for information on the use of these control characters with the Arabic
script. See
<link href="http://www.unicode.org/versions/Unicode6.1.0/ch09.pdf">The Unicode Standard, Chapter 9,
South Asian Scripts - I</link> for information on the use of these control characters with common
Indic scripts.
</p>
</section>
</section>
<section id="supported_scripts">
<title>Supported Scripts</title>
<p>Support for specific complex scripts is enumerated in the following table. Support
for those marked as not being supported is expected to be added in future revisions.</p>
<table>
<colgrp>
<col style="width: 15%"/>
<col style="width: 10%"/>
<col style="width: 10%"/>
<col style="width: 65%"/>
</colgrp>
<tr>
<th style="text-align:left">Script</th>
<th>Support</th>
<th>Tested</th>
<th style="text-align:left">Comments</th>
</tr>
<tr>
<td><link href="http://en.wikipedia.org/wiki/Arabic_alphabet">Arabic</link></td>
<td class="yes">full</td>
<td class="yes">full</td>
<td></td>
</tr>
<tr>
<td><link href="http://en.wikipedia.org/wiki/Bengali_alphabet">Bengali</link></td>
<td class="no">none</td>
<td class="no">none</td>
<td></td>
</tr>
<tr>
<td><link href="http://en.wikipedia.org/wiki/Burmese_alphabet">Burmese</link></td>
<td class="no">none</td>
<td class="no">none</td>
<td></td>
</tr>
<tr>
<td><link href="http://en.wikipedia.org/wiki/Devanagari_alphabet">Devanagari</link></td>
<td class="partial">partial</td>
<td class="partial">partial</td>
<td style="text-align:left">join controls (ZWJ, ZWNJ) not yet supported</td>
</tr>
<tr>
<td><link href="http://en.wikipedia.org/wiki/Khmer_alphabet">Khmer</link></td>
<td class="no">none</td>
<td class="no">none</td>
<td></td>
</tr>
<tr>
<td><link href="http://en.wikipedia.org/wiki/Gujarati_alphabet">Gujarati</link></td>
<td class="partial">partial</td>
<td class="no">none</td>
<td style="text-align:left">pre-alpha</td>
</tr>
<tr>
<td><link href="http://en.wikipedia.org/wiki/Gurmukhī_alphabet">Gurmukhi</link></td>
<td class="partial">partial</td>
<td class="no">none</td>
<td style="text-align:left">pre-alpha</td>
</tr>
<tr>
<td><link href="http://en.wikipedia.org/wiki/Hebrew_alphabet">Hebrew</link></td>
<td class="yes">full</td>
<td class="partial">partial</td>
<td></td>
</tr>
<tr>
<td><link href="http://en.wikipedia.org/wiki/Kannada_alphabet">Kannada</link></td>
<td class="no">none</td>
<td class="no">none</td>
<td></td>
</tr>
<tr>
<td><link href="http://en.wikipedia.org/wiki/Lao_alphabet">Lao</link></td>
<td class="no">none</td>
<td class="no">none</td>
<td></td>
</tr>
<tr>
<td><link href="http://en.wikipedia.org/wiki/Malayalam_alphabet">Malayalam</link></td>
<td class="no">none</td>
<td class="no">none</td>
<td></td>
</tr>
<tr>
<td><link href="http://en.wikipedia.org/wiki/Mongolian_script">Mongolian</link></td>
<td class="no">none</td>
<td class="no">none</td>
<td></td>
</tr>
<tr>
<td><link href="http://en.wikipedia.org/wiki/Oriya_script">Oriya</link></td>
<td class="no">none</td>
<td class="no">none</td>
<td></td>
</tr>
<tr>
<td><link href="http://en.wikipedia.org/wiki/Tamil_alphabet">Tamil</link></td>
<td class="no">none</td>
<td class="no">none</td>
<td></td>
</tr>
<tr>
<td><link href="http://en.wikipedia.org/wiki/Telugu_alphabet">Telugu</link></td>
<td class="no">none</td>
<td class="no">none</td>
<td></td>
</tr>
<tr>
<td><link href="http://en.wikipedia.org/wiki/Tibetan_alphabet">Tibetan</link></td>
<td class="no">none</td>
<td class="no">none</td>
<td></td>
</tr>
<tr>
<td><link href="http://en.wikipedia.org/wiki/Thai_alphabet">Thai</link></td>
<td class="no">none</td>
<td class="no">none</td>
<td></td>
</tr>
</table>
</section>
<section id="supported_fonts">
<title>Supported Fonts</title>
<p>Support for specific fonts is enumerated in the following sub-sections. If a given
font is not listed, then it has not been tested with these complex scripts features.</p>
<section id="fonts_arabic">
<title>Arabic Fonts</title>
<table>
<colgrp>
<col style="width: 15%"/>
<col style="width: 10%"/>
<col style="width: 10%"/>
<col style="width: 65%"/>
</colgrp>
<tr>
<th style="text-align:left">Font</th>
<th style="text-align:left">Version</th>
<th style="text-align:center">Glyphs</th>
<th style="text-align:left">Comments</th>
</tr>
<tr>
<td><link href="http://www.microsoft.com/typography/fonts/family.aspx?FID=24">Arial Unicode MS</link></td>
<td class="yes" style="text-align:left"><link href="http://www.microsoft.com/typography/fonts/font.aspx?FMID=1081">1.01</link></td>
<td style="text-align:center">50377</td>
<td>limited GPOS support</td>
</tr>
<tr>
<td><link href="http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&amp;id=ArabicFonts">Lateef</link></td>
<td class="yes" style="text-align:left">1.0</td>
<td style="text-align:center">1147</td>
<td>language features for Kurdish (KUR), Sindhi (SND), Urdu (URD)</td>
</tr>
<tr>
<td><link href="http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&amp;id=ArabicFonts">Scheherazade</link></td>
<td class="yes" style="text-align:left">1.0</td>
<td style="text-align:center">1197</td>
<td>language features for Kurdish (KUR), Sindhi (SND), Urdu (URD)</td>
</tr>
<tr>
<td><link href="http://www.microsoft.com/typography/fonts/family.aspx?FID=261">Simplified Arabic</link></td>
<td class="no" style="text-align:left"><link href="http://www.microsoft.com/typography/fonts/font.aspx?FMID=867">1.01</link></td>
<td/>
<td>contains invalid, out of order coverage table entries</td>
</tr>
<tr>
<td><link href="http://www.microsoft.com/typography/fonts/font.aspx?FID=261">Simplified Arabic</link></td>
<td class="yes" style="text-align:left"><link href="http://www.microsoft.com/typography/fonts/font.aspx?FMID=1645">5.00</link></td>
<td style="text-align:center">414</td>
<td>lacks GPOS support</td>
</tr>
<tr>
<td><link href="http://www.microsoft.com/typography/fonts/font.aspx?FID=261">Simplified Arabic</link></td>
<td class="yes" style="text-align:left">5.92</td>
<td style="text-align:center">473</td>
<td>includes GPOS for advanced position adjustment</td>
</tr>
<tr>
<td><link href="http://www.microsoft.com/typography/fonts/family.aspx?FID=264">Traditional Arabic</link></td>
<td class="yes" style="text-align:left"><link href="http://www.microsoft.com/typography/fonts/family.aspx?FMID=877">1.01</link></td>
<td style="text-align:center">530</td>
<td>lacks GPOS support</td>
</tr>
<tr>
<td><link href="http://www.microsoft.com/typography/fonts/font.aspx?FID=264">Traditional Arabic</link></td>
<td class="yes" style="text-align:left"><link href="http://www.microsoft.com/typography/fonts/font.aspx?FMID=1658">5.00</link></td>
<td style="text-align:center">530</td>
<td>lacks GPOS support</td>
</tr>
<tr>
<td><link href="http://www.microsoft.com/typography/fonts/font.aspx?FID=264">Traditional Arabic</link></td>
<td class="yes" style="text-align:left">5.92</td>
<td style="text-align:center">589</td>
<td>includes GPOS for advanced position adjustment</td>
</tr>
</table>
</section>
<section id="devanagari_fonts">
<title>Devanagari Fonts</title>
<table>
<colgrp>
<col style="width: 15%"/>
<col style="width: 10%"/>
<col style="width: 10%"/>
<col style="width: 65%"/>
</colgrp>
<tr>
<th style="text-align:left">Font</th>
<th style="text-align:left">Version</th>
<th style="text-align:center">Glyphs</th>
<th style="text-align:left">Comments</th>
</tr>
<tr>
<td><link href="http://www.microsoft.com/typography/fonts/family.aspx?FID=370">Aparajita</link></td>
<td class="yes" style="text-align:left"><link href="http://www.microsoft.com/typography/fonts/font.aspx?FMID=1700">1.00</link></td>
<td style="text-align:center">706</td>
<td/>
</tr>
<tr>
<td><link href="http://www.microsoft.com/typography/fonts/family.aspx?FID=374">Kokila</link></td>
<td class="yes" style="text-align:left"><link href="http://www.microsoft.com/typography/fonts/font.aspx?FMID=1749">1.00</link></td>
<td style="text-align:center">706</td>
<td/>
</tr>
<tr>
<td><link href="http://www.microsoft.com/typography/fonts/family.aspx?FID=243">Mangal</link></td>
<td class="yes" style="text-align:left"><link href="http://www.microsoft.com/typography/fonts/font.aspx?FMID=1759">5.01</link></td>
<td style="text-align:center">885</td>
<td>designed for use in user interfaces</td>
</tr>
<tr>
<td><link href="http://www.microsoft.com/typography/fonts/family.aspx?FID=384">Utsaah</link></td>
<td class="yes" style="text-align:left"><link href="http://www.microsoft.com/typography/fonts/font.aspx?FMID=1811">1.00</link></td>
<td style="text-align:center">706</td>
<td/>
</tr>
</table>
</section>
</section>
<section id="limitations">
<title>Other Limitations</title>
<p>
Complex scripts support in Apache FOP is relatively new, so there are certain
limitations. Please help us identify and close any gaps.
</p>
<ul>
<li>Only the PDF output format fully supports complex scripts features at the present time.</li>
<li>Shaping context does not extend across an element boundary. This limitation prevents the use of
<code>fo:character</code>, <code>fo:inline</code> or <code>fo:wrapper</code> in order to colorize
individual Arabic letters without affecting shaping behavior across the element boundary.</li>
</ul>
</section>
<section id="links">
<title>Related Links</title>
<p>
In addition to the XSL-FO specification, a number of external resources provide
guidance about authoring documents that employ complex scripts and the features
described above:
</p>
<ul>
<li><link href="http://www.unicode.org/">The Unicode Standard</link></li>
<li><link href="http://www.w3.org/TR/2006/REC-xsl11-20061205/#fo_bidi-override">Unicode Bidirectional Algorithm</link></li>
<li><link href="http://www.microsoft.com/typography/otspec/ttochap1.htm">OpenType Advanced Typographic Extensions</link></li>
<li><link href="http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&amp;item_id=CmplxRndExamples">Examples of Complex Rendering</link></li>
</ul>
</section>
</body>
</document>

+ 541
- 0
src/documentation/content/xdocs/1.1rc1/configuration.xml View File

@@ -0,0 +1,541 @@
<?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: Configuration</title>
<version>$Revision$</version>
</header>

<body>
<section id="general">
<title>Configuration File Basics</title>
<p>
The Apache™ FOP configuration file is an XML file containing a variety of settings that are useful
for controlling FOP's behavior, and for helping it find resources that you wish it to use.
</p>
<p>
The easiest way to get started using a FOP configuration file is to copy the sample found
at <code>{fop-dir}/conf/fop.xconf</code> to a location of your choice, and then to
edit it according to your needs.
It contains templates for the various configuration options, most of which are commented
out. Remove the comments and change the settings for entries that you wish to use.
Be sure to follow any instructions, including comments which specify the value range.
Also, since the configuration file is XML, be sure to keep it well-formed.
</p>
<section id="general-available">
<title>Making Configuration Available to FOP</title>
<p>After creating your configuration file, you must tell FOP how to find it:</p>
<ul>
<li>
If running FOP from the command-line, see the "-c" command-line option in
<a href="running.html">Running FOP</a>.
</li>
<li>
If running FOP as an embedded application, see
<a href="embedding.html#config-external">Embedding, Using a Configuration File</a>.
</li>
</ul>
<p>
See <a href="embedding.html#config-internal">Setting the Configuration Programmatically</a>
for instructions on how to do so in an embedded environment.
</p>
</section>
</section>
<section id="general-elements">
<title>Summary of the General Configuration Options</title>
<table>
<tr>
<th>Element</th>
<th>Data Type (for the value)</th>
<th>Description</th>
<th>Default Value</th>
</tr>
<tr>
<td>base</td>
<td>URL or directory</td>
<td>Specifies the base URL based on which relative URL will be resolved.</td>
<td>current directory</td>
</tr>
<tr>
<td>font-base</td>
<td>URL or directory</td>
<td>Specifies the base URL based on which relative font URLs will be resolved.
</td>
<td>base URL/directory (above)</td>
</tr>
<tr>
<td>hyphenation-base</td>
<td>URL or directory</td>
<td>Specifies the base URL based on which relative URLs to hyphenation pattern
files will be resolved. If not specified, support for user-supplied hyphenation
patterns remains disabled.
</td>
<td>disabled</td>
</tr>
<tr>
<td colspan="4">Relative URIs for the above three properties are evaluated relative to the base URI of the configuration file. If the configuration is provided programmatically, the base URI can be set with <code>FopFactory.setUserConfigBaseURI</code>; default is the current working directory.</td>
</tr>
<tr>
<td>hyphenation-pattern</td>
<td>String, attribute lang, attribute country (optional)</td>
<td>Register a file name for the hyphenation pattern for the mentioned language and country. Language ll and country CC must both consist of two letters.</td>
<td>ll_CC</td>
</tr>
<tr>
<td>source-resolution</td>
<td>Integer, dpi</td>
<td>
Resolution in dpi (dots per inch) which is used internally to determine the pixel
size for SVG images and bitmap images without resolution information.
</td>
<td>72 dpi</td>
</tr>
<tr>
<td>target-resolution</td>
<td>Integer, dpi</td>
<td>
Resolution in dpi (dots per inch) used to specify the output resolution for bitmap
images generated by bitmap renderers (such as the TIFF renderer) and by bitmaps
generated by Apache Batik for filter effects and such.
</td>
<td>72 dpi</td>
</tr>
<tr>
<td>strict-configuration</td>
<td>Boolean (true, false)</td>
<td>
Setting this option to 'true' will cause FOP to strictly verify the contents of the
FOP configuration file to ensure that defined resources (such as fonts and base
URLs/directories) are valid and available to FOP. Any errors found will cause FOP to
immediately raise an exception.</td>
<td>false</td>
</tr>
<tr>
<td>strict-validation</td>
<td>Boolean (true, false)</td>
<td>
Setting this option to 'false' causes FOP to be more forgiving about XSL-FO validity,
for example, you're allowed to specify a border on a region-body which is supported
by some FO implementations but is non-standard. Note that such a border would
currently have no effect in Apache FOP.</td>
<td>true</td>
</tr>
<tr>
<td>break-indent-inheritance</td>
<td>Boolean (true, false)</td>
<td>
Setting this option to 'true' causes FOP to use an alternative rule set to determine
text indents specified through margins, start-indent and end-indent. Many commercial
FO implementations have chosen to break the XSL specification in this aspect. This
option tries to mimic their behaviour. Please note that Apache FOP may still not
behave exactly like those implementations either because FOP has not fully matched
the desired behaviour and because the behaviour among the commercial implementations
varies. The default for this option (i.e. false) is to behave exactly like the
specification describes.</td>
<td>false</td>
</tr>
<tr>
<td>complex-scripts</td>
<td>attribute disabled (optional)</td>
<td>
If present and if an attribute 'disabled' is specified with the value 'false', then
complex script features are disabled. The same result can be obtained on an FOP
per-invocation basis by specifying a '-nocs' command line option when invoking FOP.
When complex script features are disabled, all bidirectional processing and complex
character to glyph mapping processing is disabled; in addition, the loading of
GDEF, GSUB, and GPOS advanced typographic tables is disabled for OpenType and
TrueType fonts. Unless disabled by this mechanism or by use of the '-nocs' command
line option, complex script features will be enabled by default.
</td>
<td>n/a</td>
</tr>
<tr>
<td>default-page-settings</td>
<td>n/a</td>
<td>
Specifies the default width and height of a page if "auto" is specified
for either or both values. Use "height" and "width" attributes on the
default-page-settings element to specify the two values.</td>
<td>"height" 11 inches, "width" 8.26 inches</td>
</tr>
<!-- Disabled: no simultaneous Renderer and IF implementations at the moment
<tr>
<td>prefer-renderer</td>
<td>boolean (true, false)</td>
<td>
By default, FOP prefers the newer output implementations based on the
<code>IFDocumentHandler</code> interface. If no such implementation can be found for
a given MIME type, it looks for an implementation of the <code>Renderer</code> interface.
If necessary, you can invert the lookup order to prefer the Renderer variant over the
IFDocumentHandler variant by setting this value to true.
</td>
<td>false</td>
</tr>
-->
<tr>
<td>use-cache</td>
<td>boolean (true, false)</td>
<td>All fonts information that has been gathered as a result of "directory"
or "auto-detect" font configurations will be cached for future rendering runs.
This setting should improve performance on systems where
fonts have been configured using the "directory" or "auto-detect" tag mechanisms.
By default this option is switched on.</td>
<td>true</td>
</tr>
<tr>
<td>cache-file</td>
<td>String</td>
<td>This option specifies the file/directory path of the fop cache file.
This file is currently only used to cache font triplet information for future reference.</td>
<td>${base}/conf/fop.cache</td>
</tr>
<tr>
<td>renderers</td>
<td>(see text below)</td>
<td>Contains the configuration for each renderer. See below.</td>
<td>N/A</td>
</tr>
</table>
<p>
This is an excerpt from the example configuration file coming with FOP:
</p>
<source><![CDATA[
<fop version="1.0">

<!-- Strict user configuration -->
<strict-configuration>true</strict-configuration>

<!-- Strict FO validation -->
<strict-validation>true</strict-validation>

<!-- Base URL for resolving relative URLs -->
<base>./</base>

<!-- Font Base URL for resolving relative font URLs -->
<font-base>./</font-base>

<!-- Source resolution in dpi (dots/pixels per inch) for determining the size of pixels in SVG and bitmap images, default: 72dpi -->
<source-resolution>72</source-resolution>
<!-- Target resolution in dpi (dots/pixels per inch) for specifying the target resolution for generated bitmaps, default: 72dpi -->
<target-resolution>72</target-resolution>

<!-- default page-height and page-width, in case
value is specified as auto -->
<default-page-settings height="11in" width="8.26in"/>

<!-- Use file name nl_Bel instead of the default nl_BE -->
<hyphenation-pattern lang="nl" country="BE">nl_Bel</hyphenation-pattern>
<!-- etc. etc..... -->
</fop>]]></source>
</section>
<section id="image-loading">
<title>Image Loading Customization</title>
<p>
Apache FOP uses the image loading framework from
<a href="http://xmlgraphics.apache.org/commons/">Apache XML Graphics Commons</a> to load
images using various plug-ins. Every image loader plug-in has a hard-coded usage penalty
that influences which solution is chosen if there are multiple possibilities to load an image.
Sometimes, though, these penalties need to be tweaked and this can be done in the FOP
configuration. An example:
</p>
<source><![CDATA[<fop version="1.0">
[..]
<image-loading>
<penalty value="10000"
class="org.apache.xmlgraphics.image.loader.impl.ImageLoaderRawCCITTFax"/>
<penalty value="INFINITE"
class="org.apache.xmlgraphics.image.loader.impl.ImageLoaderInternalTIFF"/>
</image-loading>
<renderers....
</fop>]]></source>
<p>
The first penalty element increases the penalty for the raw CCITT loader. This practically
forces the decoding of CCITT compressed TIFF images except if there are no TIFF codecs
available.
</p>
<p>
The second penalty element sets an "infinite" penalty for the TIFF loader using the internal
TIFF codec. This practically disables that plug-in as it will never be chosen as a possible
solution.
</p>
<p>
Negative penalties are possible to promote a plug-in but a negative penalty sum will be
treated as zero penalty in most cases. For more details on the image loading framework,
please consult the documentation there.
</p>
</section>
<section id="renderers">
<title>Renderer configuration</title>
<p>
Each Renderer has its own configuration section which is identified by the
MIME type the Renderer is written for, ex. "application/pdf" for the PDF Renderer.
</p>
<p>
The configuration for the PDF Renderer could look like this:
</p>
<source><![CDATA[
<renderers>
<renderer mime="application/pdf">
<filterList>
<!-- provides compression using zlib flate (default is on) -->
<value>flate</value>
</filterList>
<fonts>
<font metrics-url="arial.xml" kerning="yes" embed-url="arial.ttf">
<font-triplet name="Arial" style="normal" weight="normal"/>
<font-triplet name="ArialMT" style="normal" weight="normal"/>
</font>
<font metrics-url="arialb.xml" kerning="yes" embed-url="arialb.ttf">
<font-triplet name="Arial" style="normal" weight="bold"/>
<font-triplet name="ArialMT" style="normal" weight="bold"/>
</font>
</fonts>
</renderer>
<renderer mime="application/postscript">
<!-- etc. etc..... -->]]></source>
<p>
The details on the font configuration can be found on the separate <a href="fonts.html">Fonts</a> page.
Note especially the section entitled <a href="fonts.html#register">Register Fonts with FOP</a>.
</p>
<section id="pdf-renderer">
<title>Special Settings for the PDF Renderer</title>
<p>
The configuration element for the PDF renderer contains two elements. One is for the font configuration
(please follow the link above) and one is for the "filter list". The filter list controls how the
individual objects in a PDF file are encoded. By default, all objects get "flate" encoded (i.e. simply
compressed with the same algorithm that is also used in ZIP files). Most users don't need to change that
setting. For debugging purposes, it may be desired not to compress the internal objects at all so the
generated PDF commands can be read. In that case, you can simply use the following filter list. The
second filter list (type="image") ensures that all images still get compressed but also ASCII-85 encoded
so the produced PDF file is still easily readable in a text editor.
</p>
<source><![CDATA[
<renderer mime="application/pdf">
<filterList>
<value>null</value>
</filterList>
<filterList type="image">
<value>flate</value>
<value>ascii-85</value>
</filterList>
<fonts....
</renderer>]]></source>
<p>
Another (optional) setting specific to the PDF Renderer is an output color profile, an ICC
color profile which indicates the target color space the PDF file is generated for. This
setting is mainly used in conjunction with the <a href="pdfx.html">PDF/X</a> feature.
An example:
</p>
<source><![CDATA[
<renderer mime="application/pdf">
<filterList...
<output-profile>C:\FOP\Color\EuropeISOCoatedFOGRA27.icc</output-profile>
<fonts....
</renderer>]]></source>
<p>
Some people don't have high requirements on color fidelity but instead want the smallest
PDF file sizes possible. In this case it's possible to disable the default sRGB color space
which XSL-FO requires. This will cause RGB colors to be generated as device-specific RGB.
Please note that this option is unavailable (and will cause an error) if you enable
PDF/A or PDF/X functionality or if you specify an output profile. This setting will make the
PDF about 4KB smaller. To disable the sRGB color space add the following setting:
</p>
<source><![CDATA[
<renderer mime="application/pdf">
<filterList...
<disable-srgb-colorspace>true</disable-srgb-colorspace>
<fonts....
</renderer>]]></source>
<p>FOP supports encryption of PDF output, thanks to Patrick C. Lankswert.
This feature is commonly used to prevent unauthorized viewing, printing, editing, copying text
from the document and doing annotations. It is also possible to ask the user for a password in
order to view the contents. Note that there already exist third party applications which can
decrypt an encrypted PDF without effort and allow the aforementioned operations, therefore the
degree of protection is limited. 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>
<source><![CDATA[
<renderer mime="application/pdf">
<encryption-params>
<encryption-length>128</encryption-length>
<user-password>testuserpass</user-password>
<owner-password>testownerpass</owner-password>
<noprint/>
<nocopy/>
<noedit/>
<noannotations/>
<nofillinforms/>
<noaccesscontent/>
<noassembledoc/>
<noprinthq/>
</encryption-params>
</renderer>]]></source>
<p>
By default FOP produces PDF files of version 1.4, but this can be changed in order to benefit
from features that appeared in newer versions of PDF. At the moment, only a few features from
PDF 1.5 have been implemented, but the configuration element will accept any value between
1.4 and 1.7. This is the value that will appear in the PDF header, although only features up
to 1.5 will actually be used.
<source><![CDATA[
<renderer mime="application/pdf">
<version>1.5</version>
<!-- Versions 1.4, 1.5, 1.6 and 1.7 are accepted, all other values are invalid -->
</renderer>]]></source>
</p>
</section>
<section id="ps-renderer">
<title>Special Settings for the PostScript Renderer</title>
<p>
Besides the normal font configuration (the same "fonts" element as for the PDF renderer) the PostScript
renderer has an additional setting to force landscape pages to be rotated to fit on a page inserted into
the printer in portrait mode. Set the value to "true" to activate this feature. The default is "false".
Example:
</p>
<source><![CDATA[
<renderer mime="application/postscript">
<auto-rotate-landscape>true</auto-rotate-landscape>
<fonts>
<font metrics-url="arial.xml" kerning="yes" embed-url="arial.ttf">
<font-triplet name="Arial" style="normal" weight="normal"/>
<font-triplet name="ArialMT" style="normal" weight="normal"/>
</font>
<font metrics-url="arialb.xml" kerning="yes" embed-url="arialb.ttf">
<font-triplet name="Arial" style="normal" weight="bold"/>
<font-triplet name="ArialMT" style="normal" weight="bold"/>
</font>
</fonts>
</renderer>]]></source>
</section>
<section id="pcl-renderer">
<title>Special Settings for the PCL Renderer</title>
<p>
Non-standard fonts for the PCL renderer are made available through the Java2D subsystem which means that
you don't have to do any custom font configuration in this case but you have to use the font names
offered by Java.
</p>
<p>
Additionally, there are certain settings that control how the renderer handles various elements.
</p>
<source><![CDATA[<renderer mime="application/x-pcl">
<rendering>quality</rendering>
<text-rendering>bitmap</text-rendering>
</renderer>]]></source>
<p>
The default value for the "rendering" setting is "speed" which causes borders
to be painted as plain rectangles. In this mode, no special borders (dotted,
dashed etc.) are available. If you want support for all border modes, set the
value to "quality" as indicated above. This will cause the borders to be painted
as bitmaps.
</p>
<p>
The default value for the "text-rendering" setting is "auto" which paints the
base fonts using PCL fonts. Non-base fonts are painted as bitmaps through Java2D.
If the mix of painting methods results in unwelcome output, you can set this
to "bitmap" which causes all text to be rendered as bitmaps.
</p>
</section>
<section id="afp-renderer">
<title>Special Settings for the AFP Renderer</title>
<p>
</p>
<p>
Additionally, there are certain settings that control how the renderer handles various elements.
</p>
<source><![CDATA[<renderer mime="application/x-afp">
<images mode="b+w" bits-per-pixel="8" native="true"/>
<renderer-resolution>240</renderer-resolution>
<line-width-correction>2.5</line-width-correction>
<!-- a default external resource group file -->
<resource-group-file>resources.afp</resource-group-file>
</renderer>]]></source>
<p>
The default value for the images "mode" setting is "b+w" (black and white). When the images "mode" setting is "b+w" a "bits-per-pixel" setting can be provided to aid the grayscale conversion process. With this setting all images referenced in your source document are converted to an IOCA FS45 grayscale bitmap image form.
When the setting is "color" all images are converted to an IOCA FS45 color bitmap image form. When "native" setting is "true", all images encountered (TIFF, GIF, JPEG and Encapsulated Postscript etc.) will be embedded directly in the datastream in their native form using a MO:DCA Object Container.
</p>
<p>
The default value for the "renderer-resolution" is 240 dpi.
</p>
<p>
The default line width is device dependent and may need to be fine tuned so that the output matches the expected result. The default correction value is 2.5.
</p>
<!--
<p>
The default value for the MO:DCA "interchange-set" is "MO:DCA-L". Other compliance settings include presentation interchange sets "MO:DCA-P IS/1" and "MO:DCA-P IS/2" (Resource Groups).
</p>
-->
<p>
By default if there is no configuration definition for "resource-group-file", external resources will be placed in a file called resources.afp.
</p>
</section>
</section>

<section>
<title>When it does not work</title>

<p>FOP searches the configuration file for the information it
expects, at the position it expects. When that information is not
present, FOP will not complain, it will just continue. When there is
other information in the file, FOP will not complain, it will just
ignore it. That means that when your configuration information is in
the file but in a different XML element, or in a different XML path,
than FOP expects, it will be silently ignored.</p>

<p>Check the following possibilities:</p>

<ul>
<li>The format of the configuration file has changed
considerably between FOP 0.20.5 and FOP 1.0 and its beta versions. Did
you convert your file to the new format?</li>

<li>The FOP distribution contains a schema for configuration
files, at src/foschema/fop-configuration.xsd. Did you validate your
configuration file against it? Add the following schema location to
the <code>schema</code> element:

<source><![CDATA[<fop
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation=
"http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/foschema/fop-configuration.xsd?view=co">]]>
</source>

and run the configuration file through a validating schema
parser. Note that the schema cannot detect all errors, and that it is
stricter about the order of some elements than FOP itself is.</li>

<li>Run FOP in debug mode (command line option
<code>-d</code>). This makes FOP report which configuration
information it finds. Check if FOP finds what you expect.</li>

</ul>

</section>
</body>
</document>

+ 752
- 0
src/documentation/content/xdocs/1.1rc1/embedding.xml View File

@@ -0,0 +1,752 @@
<?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">
<!-- Embedding FOP -->
<document>
<header>
<title>Apache™ FOP: Embedding</title>
<subtitle>How to Embed FOP in a Java application</subtitle>
<version>$Revision$</version>
</header>

<body>
<section id="overview">
<title>Overview</title>
<p>
Review <a href="running.html">Running Apache™ FOP</a> for important information that applies
to embedded applications as well as command-line use, such as options and performance.
</p>
<p>
To embed Apache™ FOP in your application, first create a new
org.apache.fop.apps.FopFactory instance. This object can be used to launch multiple
rendering runs. For each run, create a new org.apache.fop.apps.Fop instance through
one of the factory methods of FopFactory. In the method call you specify which output
format (i.e. MIME type) to use and, if the selected output format requires an
OutputStream, which OutputStream to use for the results of the rendering. You can
customize FOP's behaviour in a rendering run by supplying your own FOUserAgent
instance. The FOUserAgent can, for example, be used to set your own document handler
instance (details below). Finally, you retrieve a SAX DefaultHandler instance from
the Fop object and use that as the SAXResult of your transformation.
</p>
</section>
<section id="API">
<title>The API</title>
<p>
FOP has many classes which express the "public" access modifier, however, this is not
indicative of their inclusion into the public API. Every attempt will be made to keep the
public API static, to minimize regressions for existing users, however, since the API is not
clearly defined, the list of classes below are the generally agreed public API:
<source><![CDATA[
org.apache.fop.apps.*
org.apache.fop.fo.FOEventHandler
org.apache.fop.fo.ElementMappingRegistry
org.apache.fop.fonts.FontManager
org.apache.fop.events.EventListener
org.apache.fop.events.Event
org.apache.fop.events.model.EventSeverity
org.apache.fop.render.ImageHandlerRegistry
org.apache.fop.render.RendererFactory
org.apache.fop.render.intermediate.IFContext
org.apache.fop.render.intermediate.IFDocumentHandler
org.apache.fop.render.intermediate.IFException
org.apache.fop.render.intermediate.IFParser
org.apache.fop.render.intermediate.IFSerializer
org.apache.fop.render.intermediate.IFUtil
org.apache.fop.render.intermediate.util.IFConcatenator]]></source>
</p>
</section>
<section id="basics">
<title>Basic Usage Pattern</title>
<p>
Apache FOP relies heavily on JAXP. It uses SAX events exclusively to receive the XSL-FO
input document. It is therefore a good idea that you know a few things about JAXP (which
is a good skill anyway). Let's look at the basic usage pattern for FOP...
</p>
<p>Here is the basic pattern to render an XSL-FO file to PDF:
</p>
<source><![CDATA[
import org.apache.fop.apps.FopFactory;
import org.apache.fop.apps.Fop;
import org.apache.fop.apps.MimeConstants;

/*..*/

// Step 1: Construct a FopFactory
// (reuse if you plan to render multiple documents!)
FopFactory fopFactory = FopFactory.newInstance();

// Step 2: Set up output stream.
// Note: Using BufferedOutputStream for performance reasons (helpful with FileOutputStreams).
OutputStream out = new BufferedOutputStream(new FileOutputStream(new File("C:/Temp/myfile.pdf")));

try {
// Step 3: Construct fop with desired output format
Fop fop = fopFactory.newFop(MimeConstants.MIME_PDF, out);

// Step 4: Setup JAXP using identity transformer
TransformerFactory factory = TransformerFactory.newInstance();
Transformer transformer = factory.newTransformer(); // identity transformer

// Step 5: Setup input and output for XSLT transformation
// Setup input stream
Source src = new StreamSource(new File("C:/Temp/myfile.fo"));

// Resulting SAX events (the generated FO) must be piped through to FOP
Result res = new SAXResult(fop.getDefaultHandler());

// Step 6: Start XSLT transformation and FOP processing
transformer.transform(src, res);

} finally {
//Clean-up
out.close();
}]]></source>
<p>
Let's discuss these 5 steps in detail:
</p>
<ul>
<li>
<strong>Step 1:</strong> You create a new FopFactory instance. The FopFactory instance holds
references to configuration information and cached data. It's important to reuse this
instance if you plan to render multiple documents during a JVM's lifetime.
</li>
<li>
<strong>Step 2:</strong> You set up an OutputStream that the generated document
will be written to. It's a good idea to buffer the OutputStream as demonstrated
to improve performance.
</li>
<li>
<strong>Step 3:</strong> You create a new Fop instance through one of the factory
methods on the FopFactory. You tell the FopFactory what your desired output format
is. This is done by using the MIME type of the desired output format (ex. "application/pdf").
You can use one of the MimeConstants.* constants. The second parameter is the
OutputStream you've setup up in step 2.
</li>
<li>
<strong>Step 4</strong> We recommend that you use JAXP Transformers even
if you don't do XSLT transformations to generate the XSL-FO file. This way
you can always use the same basic pattern. The example here sets up an
"identity transformer" which just passes the input (Source) unchanged to the
output (Result). You don't have to work with a SAXParser if you don't do any
XSLT transformations.
</li>
<li>
<strong>Step 5:</strong> Here you set up the input and output for the XSLT
transformation. The Source object is set up to load the "myfile.fo" file.
The Result is set up so the output of the XSLT transformation is sent to FOP.
The FO file is sent to FOP in the form of SAX events which is the most efficient
way. Please always avoid saving intermediate results to a file or a memory buffer
because that affects performance negatively.
</li>
<li>
<strong>Step 6:</strong> Finally, we start the XSLT transformation by starting
the JAXP Transformer. As soon as the JAXP Transformer starts to send its output
to FOP, FOP itself starts its processing in the background. When the
<code>transform()</code> method returns FOP will also have finished converting
the FO file to a PDF file and you can close the OutputStream.
<note label="Tip!">
It's a good idea to enclose the whole conversion in a try..finally statement. If
you close the OutputStream in the finally section, this will make sure that the
OutputStream is properly closed even if an exception occurs during the conversion.
</note>
</li>
</ul>
<p>
If you're not totally familiar with JAXP Transformers, please have a look at the
<a href="#examples">Embedding examples</a> below. The section contains examples
for all sorts of use cases. If you look at all of them in turn you should be able
to see the patterns in use and the flexibility this approach offers without adding
too much complexity.
</p>
<p>
This may look complicated at first, but it's really just the combination of an
XSL transformation and a FOP run. It's also easy to comment out the FOP part
for debugging purposes, for example when you're tracking down a bug in your
stylesheet. You can easily write the XSL-FO output from the XSL transformation
to a file to check if that part generates the expected output. An example for that
can be found in the <a href="#examples">Embedding examples</a> (See "ExampleXML2FO").
</p>
<section id="basic-logging">
<title>Logging</title>
<p>
Logging is now a little different than it was in FOP 0.20.5. We've switched from
Avalon Logging to <a href="ext:commons-logging">Jakarta Commons Logging</a>.
While with Avalon Logging the loggers were directly given to FOP, FOP now retrieves
its logger(s) through a statically available LogFactory. This is similar to the
general pattern that you use when you work with Apache Log4J directly, for example.
We call this "static logging" (Commons Logging, Log4J) as opposed to "instance logging"
(Avalon Logging). This has a consequence: You can't give FOP a logger for each
processing run anymore. The log output of multiple, simultaneously running FOP instances
is sent to the same logger.
</p>
<p>
By default, <a href="ext:commons-logging">Jakarta Commons Logging</a> uses
JDK logging (available in JDKs 1.4 or higher) as its backend. You can configure Commons
Logging to use an alternative backend, for example Log4J. Please consult the
<a href="ext:commons-logging">documentation for Jakarta Commons Logging</a> on
how to configure alternative backends.
</p>
<p>
As a result of the above we differentiate between two kinds of "logging":
</p>
<ul>
<li>(FOP-)Developer-oriented logging</li>
<li><a href="events.html">User/Integrator-oriented feedback</a> (NEW!)</li>
</ul>
<p>
The use of "feedback" instead of "logging" is intentional. Most people were using
log output as a means to get feedback from events within FOP. Therefore, FOP now
includes an <code>event</code> package which can be used to receive feedback from
the layout engine and other components within FOP <strong>per rendering run</strong>.
This feedback is not just some
text but event objects with parameters so these events can be interpreted by code.
Of course, there is a facility to turn these events into normal human-readable
messages. For details, please read on on the <a href="events.html">Events page</a>.
This leaves normal logging to be mostly a thing used by the FOP developers
although anyone can surely activate certain logging categories but the feedback
from the loggers won't be separated by processing runs. If this is required,
the <a href="events.html">Events subsystem</a> is the right approach.
</p>
</section>

<section id="render">
<title>Processing XSL-FO</title>
<p>
Once the Fop instance is set up, call <code>getDefaultHandler()</code> to obtain a SAX
DefaultHandler instance to which you can send the SAX events making up the XSL-FO
document you'd like to render. FOP processing starts as soon as the DefaultHandler's
<code>startDocument()</code> method is called. Processing stops again when the
DefaultHandler's <code>endDocument()</code> method is called. Please refer to the basic
usage pattern shown above to render a simple XSL-FO document.
</p>
</section>

<section id="render-with-xslt">
<title>Processing XSL-FO generated from XML+XSLT</title>
<p>
If you want to process XSL-FO generated from XML using XSLT we recommend
again using standard JAXP to do the XSLT part and piping the generated SAX
events directly through to FOP. The only thing you'd change to do that
on the basic usage pattern above is to set up the Transformer differently:
</p>
<source><![CDATA[
//without XSLT:
//Transformer transformer = factory.newTransformer(); // identity transformer

//with XSLT:
Source xslt = new StreamSource(new File("mystylesheet.xsl"));
Transformer transformer = factory.newTransformer(xslt);]]></source>
</section>
</section>
<section id="input">
<title>Input Sources</title>
<p>
The input XSL-FO document is always received by FOP as a SAX stream (see the
<a href="../dev/design/parsing.html">Parsing Design Document</a> for the rationale).
</p>
<p>
However, you may not always have your input document available as a SAX stream.
But with JAXP it's easy to convert different input sources to a SAX stream so you
can pipe it into FOP. That sounds more difficult than it is. You simply have
to set up the right Source instance as input for the JAXP transformation.
A few examples:
</p>
<ul>
<li>
<strong>URL:</strong> <code>Source src = new StreamSource("http://localhost:8080/testfile.xml");</code>
</li>
<li>
<strong>File:</strong> <code>Source src = new StreamSource(new File("C:/Temp/myinputfile.xml"));</code>
</li>
<li>
<strong>String:</strong> <code>Source src = new StreamSource(new StringReader(myString)); // myString is a String</code>
</li>
<li>
<strong>InputStream:</strong> <code>Source src = new StreamSource(new MyInputStream(something));</code>
</li>
<li>
<strong>Byte Array:</strong> <code>Source src = new StreamSource(new ByteArrayInputStream(myBuffer)); // myBuffer is a byte[] here</code>
</li>
<li>
<strong>DOM:</strong> <code>Source src = new DOMSource(myDocument); // myDocument is a Document or a Node</code>
</li>
<li>
<strong>Java Objects:</strong> Please have a look at the <a href="#examples">Embedding examples</a> which contain an example for this.
</li>
</ul>
<p>
There are a variety of upstream data manipulations possible.
For example, you may have a DOM and an XSL stylesheet; or you may want to
set variables in the stylesheet. Interface documentation and some cookbook
solutions to these situations are provided in
<a href="http://xml.apache.org/xalan-j/usagepatterns.html">Xalan Basic Usage Patterns</a>.
</p>
</section>
<section id="config-internal">
<title>Configuring Apache FOP Programmatically</title>
<p>
Apache FOP provides two levels on which you can customize FOP's
behaviour: the FopFactory and the user agent.
</p>
<section id="fop-factory">
<title>Customizing the FopFactory</title>
<p>
The FopFactory holds configuration data and references to objects which are reusable over
multiple rendering runs. It's important to instantiate it only once (except in special
environments) and reuse it every time to create new FOUserAgent and Fop instances.
</p>
<p>
You can set all sorts of things on the FopFactory:
</p>
<ul>
<li>
<p>
The <strong>font base URL</strong> to use when resolving relative URLs for fonts. Example:
</p>
<source>fopFactory.getFontManager().setFontBaseURL("file:///C:/Temp/fonts");</source>
</li>
<li>
<p>
The <strong>hyphenation base URL</strong> to use when resolving relative URLs for
hyphenation patterns. Example:
</p>
<source>fopFactory.setHyphenBaseURL("file:///C:/Temp/hyph");</source>
</li>
<li>
<p>
Disable <strong>strict validation</strong>. When disabled FOP is less strict about the rules
established by the XSL-FO specification. Example:
</p>
<source>fopFactory.setStrictValidation(false);</source>
</li>
<li>
<p>
Enable an <strong>alternative set of rules for text indents</strong> that tries to mimic the behaviour of many commercial
FO implementations, that chose to break the specification in this respect. The default of this option is
'false', which causes Apache FOP to behave exactly as described in the specification. To enable the
alternative behaviour, call:
</p>
<source>fopFactory.setBreakIndentInheritanceOnReferenceAreaBoundary(true);</source>
</li>
<li>
<p>
Set the <strong>source resolution</strong> for the document. This is used internally to determine the pixel
size for SVG images and bitmap images without resolution information. Default: 72 dpi. Example:
</p>
<source>fopFactory.setSourceResolution(96); // =96dpi (dots/pixels per Inch)</source>
</li>
<li>
<p>
Manually add an <strong>ElementMapping instance</strong>. If you want to supply a special FOP extension
you can give the instance to the FOUserAgent. Normally, the FOP extensions can be automatically detected
(see the documentation on extension for more info). Example:
</p>
<source>fopFactory.addElementMapping(myElementMapping); // myElementMapping is a org.apache.fop.fo.ElementMapping</source>
</li>
<li>
<p>
Set a <strong>URIResolver</strong> for custom URI resolution. By supplying a JAXP URIResolver you can add
custom URI resolution functionality to FOP. For example, you can use
<a href="ext:xml.apache.org/commons/resolver">Apache XML Commons Resolver</a> to make use of XCatalogs. Example:
</p>
<source>fopFactory.setURIResolver(myResolver); // myResolver is a javax.xml.transform.URIResolver</source>
<note>
Both the FopFactory and the FOUserAgent have a method to set a URIResolver. The URIResolver on the FopFactory
is primarily used to resolve URIs on factory-level (hyphenation patterns, for example) and it is always used
if no other URIResolver (for example on the FOUserAgent) resolved the URI first.
</note>
</li>
</ul>
</section>
<section id="user-agent">
<title>Customizing the User Agent</title>
<p>
The user agent is the entity that allows you to interact with a single rendering run, i.e. the processing of a single
document. If you wish to customize the user agent's behaviour, the first step is to create your own instance
of FOUserAgent using the appropriate factory method on FopFactory and pass that
to the factory method that will create a new Fop instance:
</p>
<source><![CDATA[
FopFactory fopFactory = FopFactory.newInstance(); // Reuse the FopFactory if possible!
// do the following for each new rendering run
FOUserAgent userAgent = fopFactory.newFOUserAgent();
// customize userAgent
Fop fop = fopFactory.newFop(MimeConstants.MIME_POSTSCRIPT, userAgent, out);]]></source>
<p>
You can do all sorts of things on the user agent:
</p>
<ul>
<li>
<p>
The <strong>base URL</strong> to use when resolving relative URLs. Example:
</p>
<source>userAgent.setBaseURL("file:///C:/Temp/");</source>
</li>
<li>
<p>
Set the <strong>producer</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. The default producer is "Apache FOP". Example:
</p>
<source>userAgent.setProducer("MyKillerApplication");</source>
</li>
<li>
<p>
Set the <strong>creating user</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example:
</p>
<source>userAgent.setCreator("John Doe");</source>
</li>
<li>
<p>
Set the <strong>author</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example:
</p>
<source>userAgent.setAuthor("John Doe");</source>
</li>
<li>
<p>
Override the <strong>creation date and time</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example:
</p>
<source>userAgent.setCreationDate(new Date());</source>
</li>
<li>
<p>
Set the <strong>title</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example:
</p>
<source>userAgent.setTitle("Invoice No 138716847");</source>
</li>
<li>
<p>
Set the <strong>keywords</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example:
</p>
<source>userAgent.setKeywords("XML XSL-FO");</source>
</li>
<li>
<p>
Set the <strong>target resolution</strong> for the document. This is used to
specify the output resolution for bitmap images generated by bitmap renderers
(such as the TIFF renderer) and by bitmaps generated by Apache Batik for filter
effects and such. Default: 72 dpi. Example:
</p>
<source>userAgent.setTargetResolution(300); // =300dpi (dots/pixels per Inch)</source>
</li>
<li>
<p>
Set <strong>your own Document Handler</strong>. This feature can be used for several purposes, the most likey usage of which would probably be
binding a MIME type when the output is Intermediate Format (see <a href="#documenthandlers">Document Handlers</a>). This also allows advanced
users to create their own implementation of the document handler.
</p>
<source>userAgent.setDocumentHandlerOverride(documentHandler) // documentHandler is an instance of org.apache.fop.render.intermediate.IFDocumentHandler</source>
</li>
<li>
<p>
Set <strong>your own FOEventHandler instance</strong>. If you want to supply your own FOEventHandler or
configure an FOEventHandler subclass in a special way you can give the instance to the FOUserAgent. Normally,
the FOEventHandler instance is created by FOP. Example:
</p>
<source>userAgent.setFOEventHandlerOverride(myFOEventHandler); // myFOEventHandler is an org.apache.fop.fo.FOEventHandler</source>
</li>
<li>
<p>
Set a <strong>URIResolver</strong> for custom URI resolution. By supplying a JAXP URIResolver you can add
custom URI resolution functionality to FOP. For example, you can use
<a href="ext:xml.apache.org/commons/resolver">Apache XML Commons Resolver</a> to make use of XCatalogs. Example:
</p>
<source>userAgent.setURIResolver(myResolver); // myResolver is a javax.xml.transform.URIResolver</source>
<note>
Both the FopFactory and the FOUserAgent have a method to set a URIResolver. The URIResolver on the FOUserAgent is
used for resolving URIs which are document-related. If it's not set or cannot resolve a URI, the URIResolver
from the FopFactory is used.
</note>
</li>
</ul>
<note>
You should not reuse an FOUserAgent instance between FOP rendering runs although you can. Especially
in multi-threaded environment, this is a bad idea.
</note>
</section>
</section>
<section id="config-external">
<title>Using a Configuration File</title>
<p>
Instead of setting the parameters manually in code as shown above you can also set
many values from an XML configuration file:
</p>
<source><![CDATA[
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.configuration.DefaultConfigurationBuilder;

/*..*/

DefaultConfigurationBuilder cfgBuilder = new DefaultConfigurationBuilder();
Configuration cfg = cfgBuilder.buildFromFile(new File("C:/Temp/mycfg.xml"));
fopFactory.setUserConfig(cfg);

/* ..or.. */

fopFactory.setUserConfig(new File("C:/Temp/mycfg.xml"));]]></source>
<p>
The layout of the configuration file is described on the <a href="configuration.html">Configuration page</a>.
</p>
</section>
<section id="documenthandlers">
<title>Document Handlers</title>
<p>
The document handlers are classes that inherit from <code>org.apache.fop.render.intermediate.IFDocumentHandler</code>. This
is an interface for which a MIME type specific implementation can be created. This same handler is used either when XSL-FO
is used as the input or when Intermediate Format is used. Since IF is output format agnostic, if custom fonts or other
configuration information that affect layout (specific to a particular MIME type) are given then FOP needs that contextual
information. The document handler provides that context so that when the IF is rendered, it is more visually consistent with
FO rendering. The code below shows an example of how a document handler can be used to provide PDF configuration data to the
IFSerializer.
<source><![CDATA[
IFDocumentHandler targetHandler = userAgent.getRendererFactory().createDocumentHandler(userAgent, MimeConstants.MIME_PDF);

IFSerializer ifSerializer = new IFSerializer(); //Create the IFSerializer to write the intermediate format
ifSerializer.setContext(new IFContext(userAgent));
ifSerializer.mimicDocumentHandler(targetHandler); //Tell the IFSerializer to mimic the target format

userAgent.setDocumentHandlerOverride(ifSerializer); //Make sure the prepared document handler is used
]]></source>
The rest of the code is the same as in <a href="#basics">Basic Usage Patterns</a>.
</p>
</section>
<section id="hints">
<title>Hints</title>
<section id="object-reuse">
<title>Object reuse</title>
<p>
Fop instances shouldn't (and can't) be reused. Please recreate
Fop and FOUserAgent instances for each rendering run using the FopFactory.
This is a cheap operation as all reusable information is held in the
FopFactory. That's why it's so important to reuse the FopFactory instance.
</p>
</section>
<section id="awt">
<title>AWT issues</title>
<p>
If your XSL-FO files contain SVG then Apache Batik will be used. When Batik is
initialised it uses certain classes in <code>java.awt</code> that
intialise the Java AWT classes. This means that a daemon thread
is created by the JVM and on Unix it will need to connect to a
DISPLAY.
</p>
<p>
The thread means that the Java application may not automatically quit
when finished, you will need to call <code>System.exit()</code>. These
issues should be fixed in the JDK 1.4.
</p>
<p>
If you run into trouble running FOP on a head-less server, please see the
<a href="graphics.html#batik">notes on Batik</a>.
</p>
</section>
<section id="render-info">
<title>Getting information on the rendering process</title>
<p>
To get the number of pages that were rendered by FOP you can call
<code>Fop.getResults()</code>. This returns a <code>FormattingResults</code> object
where you can look up the number of pages produced. It also gives you the
page-sequences that were produced along with their id attribute and their
numbers of pages. This is particularly useful if you render multiple
documents (each enclosed by a page-sequence) and have to know the number of
pages of each document.
</p>
</section>
</section>
<section id="performance">
<title>Improving performance</title>
<p>
There are several options to consider:
</p>
<ul>
<li>
Whenever possible, try to use SAX to couple the individual components involved
(parser, XSL transformer, SQL datasource etc.).
</li>
<li>
Depending on the target OutputStream (in case of a FileOutputStream, but not
for a ByteArrayOutputStream, for example) it may improve performance considerably
if you buffer the OutputStream using a BufferedOutputStream:
<code>out = new java.io.BufferedOutputStream(out);</code>
<br/>
Make sure you properly close the OutputStream when FOP is finished.
</li>
<li>
Cache the stylesheet. If you use the same stylesheet multiple times
you can set up a JAXP <code>Templates</code> object and reuse it each time you do
the XSL transformation. (More information can be found
<a class="fork" href="http://www.javaworld.com/javaworld/jw-05-2003/jw-0502-xsl.html">here</a>.)
</li>
<li>
Use an XSLT compiler like <a class="fork" href="http://xml.apache.org/xalan-j/xsltc_usage.html">XSLTC</a>
that comes with Xalan-J.
</li>
<li>
Fine-tune your stylesheet to make the XSLT process more efficient and to create XSL-FO that can
be processed by FOP more efficiently. Less is more: Try to make use of property inheritance where possible.
</li>
<li>
You may also wish to consider trying to reduce <a href="http://xmlgraphics.apache.org/fop/trunk/running.html#memory">memory usage</a>.
</li>
</ul>
</section>
<section id="multithreading">
<title>Multithreading FOP</title>
<p>
Apache FOP may currently not be completely thread safe.
The code has not been fully tested for multi-threading issues, yet.
If you encounter any suspicious behaviour, please notify us.
</p>
<p>
There is also a known issue with fonts being jumbled between threads when using
the Java2D/AWT renderer (which is used by the -awt and -print output options).
In general, you cannot safely run multiple threads through the AWT renderer.
</p>
</section>
<section id="examples">
<title>Examples</title>
<p>
The directory "{fop-dir}/examples/embedding" contains several working examples.
</p>
<section id="ExampleFO2PDF">
<title>ExampleFO2PDF.java</title>
<p>This
<a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleFO2PDF.java?view=markup">
example</a>
demonstrates the basic usage pattern to transform an XSL-FO
file to PDF using FOP.
</p>
<figure src="images/EmbeddingExampleFO2PDF.png" alt="Example XSL-FO to PDF"/>
</section>
<section id="ExampleXML2FO">
<title>ExampleXML2FO.java</title>
<p>This
<a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleXML2FO.java?view=markup">
example</a>
has nothing to do with FOP. It is there to show you how an XML
file can be converted to XSL-FO using XSLT. The JAXP API is used to do the
transformation. Make sure you've got a JAXP-compliant XSLT processor in your
classpath (ex. <a href="http://xml.apache.org/xalan-j">Xalan</a>).
</p>
<figure src="images/EmbeddingExampleXML2FO.png" alt="Example XML to XSL-FO"/>
</section>
<section id="ExampleXML2PDF">
<title>ExampleXML2PDF.java</title>
<p>This
<a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleXML2PDF.java?view=markup">
example</a>
demonstrates how you can convert an arbitrary XML file to PDF
using XSLT and XSL-FO/FOP. It is a combination of the first two examples
above. The example uses JAXP to transform the XML file to XSL-FO and FOP to
transform the XSL-FO to PDF.
</p>
<figure src="images/EmbeddingExampleXML2PDF.png" alt="Example XML to PDF (via XSL-FO)"/>
<p>
The output (XSL-FO) from the XSL transformation is piped through to FOP using
SAX events. This is the most efficient way to do this because the
intermediate result doesn't have to be saved somewhere. Often, novice users
save the intermediate result in a file, a byte array or a DOM tree. We
strongly discourage you to do this if it isn't absolutely necessary. The
performance is significantly higher with SAX.
</p>
</section>
<section id="ExampleObj2XML">
<title>ExampleObj2XML.java</title>
<p>This
<a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleObj2XML.java?view=markup">
example</a>
is a preparatory example for the next one. It's an example that
shows how an arbitrary Java object can be converted to XML. It's an often
needed task to do this. Often people create a DOM tree from a Java object and
use that. This is pretty straightforward. The example here, however, shows how
to do this using SAX, which will probably be faster and not even more
complicated once you know how this works.
</p>
<figure src="images/EmbeddingExampleObj2XML.png" alt="Example Java object to XML"/>
<p>
For this example we've created two classes: ProjectTeam and ProjectMember
(found in xml-fop/examples/embedding/java/embedding/model). They represent
the same data structure found in
xml-fop/examples/embedding/xml/xml/projectteam.xml. We want to serialize to XML a
project team with several members which exist as Java objects.
Therefore we created the two classes: ProjectTeamInputSource and
ProjectTeamXMLReader (in the same place as ProjectTeam above).
</p>
<p>
The XMLReader implementation (regard it as a special kind of XML parser) is
responsible for creating SAX events from the Java object. The InputSource
class is only used to hold the ProjectTeam object to be used.
</p>
<p>
Have a look at the source of ExampleObj2XML.java to find out how this is
used. For more detailed information see other resources on JAXP (ex.
<a class="fork" href="http://java.sun.com/xml/jaxp/dist/1.1/docs/tutorial/xslt/3_generate.html">An older JAXP tutorial</a>).
</p>
</section>
<section id="ExampleObj2PDF">
<title>ExampleObj2PDF.java</title>
<p>This
<a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleObj2PDF.java?view=markup">
example</a>
combines the previous and the third to demonstrate
how you can transform a Java object to a PDF directly in one smooth run
by generating SAX events from the Java object that get fed to an XSL
transformation. The result of the transformation is then converted to PDF
using FOP as before.
</p>
<figure src="images/EmbeddingExampleObj2PDF.png" alt="Example Java object to PDF (via XML and XSL-FO)"/>
</section>
<section id="ExampleDOM2PDF">
<title>ExampleDOM2PDF.java</title>
<p>This
<a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleDOM2PDF.java?view=markup">
example</a>
has FOP use a DOMSource instead of a StreamSource in order to
use a DOM tree as input for an XSL transformation.
</p>
</section>
<section id="ExampleSVG2PDF">
<title>ExampleSVG2PDF.java (PDF Transcoder example)</title>
<p>This
<a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleSVG2PDF.java?view=markup">
example</a>
shows the usage of the PDF Transcoder, a sub-application within FOP.
It is used to generate a PDF document from an SVG file.
</p>
</section>
<section id="ExampleConcat">
<title>ExampleConcat.java (IF Concatenation example)</title>
<p>
This can be found in the <code>embedding.intermediate</code> package within the
examples and describes how IF can be concatenated to produce a document. Because
IF has been through FOPs layout engine, it should be visually consistent with FO
rendered documents while allowing the user to merge numerous documents together.
</p>
</section>
<section id="example-notes">
<title>Final notes</title>
<p>
These examples should give you an idea of what's possible. It should be easy
to adjust these examples to your needs. Also, if you have other examples that you
think should be added here, please let us know via either the fop-users or fop-dev
mailing lists. Finally, for more help please send your questions to the fop-users
mailing list.
</p>
</section>
</section>
</body>
</document>

+ 449
- 0
src/documentation/content/xdocs/1.1rc1/events.xml View File

@@ -0,0 +1,449 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!-- $Id$ -->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
<document>
<header>
<title>Apache™ FOP: Events/Processing Feedback</title>
<version>$Revision$</version>
</header>
<body>
<section id="introduction">
<title>Introduction</title>
<p>
In versions until 0.20.5, Apache™ FOP used
<a href="http://excalibur.apache.org/framework/index.html">Avalon-style Logging</a> where
it was possible to supply a logger per processing run. During the redesign
the logging infrastructure was switched over to
<a href="http://commons.apache.org/logging/">Commons Logging</a> which is (like Log4J or
java.util.logging) a "static" logging framework (the logger is accessed through static
variables). This made it very difficult in a multi-threaded system to retrieve information
for a single processing run.
</p>
<p>
With FOP's event subsystem, we'd like to close this gap again and even go further. The
first point is to realize that we have two kinds of "logging". Firstly, we have the logging
infrastructure for the (FOP) developer who needs to be able to enable finer log messages
for certain parts of FOP to track down a certain problem. Secondly, we have the user who
would like to be informed about missing images, overflowing lines or substituted fonts.
These messages (or events) are targeted at less technical people and may ideally be
localized (translated). Furthermore, tool and solution builders would like to integrate
FOP into their own solutions. For example, an FO editor should be able to point the user
to the right place where a particular problem occurred while developing a document template.
Finally, some integrators would like to abort processing if a resource (an image or a font)
has not been found, while others would simply continue. The event system allows to
react on these events.
</p>
<p>
On this page, we won't discuss logging as such. We will show how the event subsystem can
be used for various tasks. We'll first look at the event subsystem from the consumer side.
Finally, the production of events inside FOP will be discussed (this is mostly interesting
for FOP developers only).
</p>
</section>
<section id="consumer">
<title>The consumer side</title>
<p>
The event subsystem is located in the <code>org.apache.fop.events</code> package and its
base is the <code>Event</code> class. An instance is created for each event and is sent
to a set of <code>EventListener</code> instances by the <code>EventBroadcaster</code>.
An <code>Event</code> contains:
</p>
<ul>
<li>an event ID,</li>
<li>a source object (which generated the event),</li>
<li>a severity level (Info, Warning, Error and Fatal Error) and</li>
<li>a map of named parameters.</li>
</ul>
<p>
The <code>EventFormatter</code> class can be used to translate the events into
human-readable, localized messages.
</p>
<p>
A full example of what is shown here can be found in the
<code>examples/embedding/java/embedding/events</code> directory in the FOP distribution.
The example can also be accessed
<a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/examples/embedding/java/embedding/events/">via the web</a>.
</p>
<section id="write-listener">
<title>Writing an EventListener</title>
<p>
The following code sample shows a very simple EventListener. It basically just sends
all events to System.out (stdout) or System.err (stderr) depending on the event severity.
</p>
<source><![CDATA[import org.apache.fop.events.Event;
import org.apache.fop.events.EventFormatter;
import org.apache.fop.events.EventListener;
import org.apache.fop.events.model.EventSeverity;

/** A simple event listener that writes the events to stdout and stderr. */
public class SysOutEventListener implements EventListener {

/** {@inheritDoc} */
public void processEvent(Event event) {
String msg = EventFormatter.format(event);
EventSeverity severity = event.getSeverity();
if (severity == EventSeverity.INFO) {
System.out.println("[INFO ] " + msg);
} else if (severity == EventSeverity.WARN) {
System.out.println("[WARN ] " + msg);
} else if (severity == EventSeverity.ERROR) {
System.err.println("[ERROR] " + msg);
} else if (severity == EventSeverity.FATAL) {
System.err.println("[FATAL] " + msg);
} else {
assert false;
}
}
}]]></source>
<p>
You can see that for every event the method <code>processEvent</code> of the
<code>EventListener</code> will be called. Inside this method you can do whatever
processing you would like including throwing a <code>RuntimeException</code>, if you want
to abort the current processing run.
</p>
<p>
The code above also shows how you can turn an event into a human-readable, localized
message that can be presented to a user. The <code>EventFormatter</code> class does
this for you. It provides additional methods if you'd like to explicitly specify
the locale.
</p>
<p>
It is possible to gather all events for a whole processing run so they can be
evaluated afterwards. However, care should be taken about memory consumption since
the events provide references to objects inside FOP which may themselves have
references to other objects. So holding on to these objects may mean that whole
object trees cannot be released!
</p>
</section>
<section id="add-listener">
<title>Adding an EventListener</title>
<p>
To register the event listener with FOP, get the <code>EventBroadcaster</code> which
is associated with the user agent (<code>FOUserAgent</code>) and add it there:
</p>
<source><![CDATA[FOUserAgent foUserAgent = fopFactory.newFOUserAgent();
foUserAgent.getEventBroadcaster().addEventListener(new SysOutEventListener());]]></source>
<p>
Please note that this is done separately for each processing run, i.e. for each
new user agent.
</p>
</section>
<section id="listener-example1">
<title>An additional listener example</title>
<p>
Here's an additional example of an event listener:
</p>
<p>
By default, FOP continues processing even if an image wasn't found. If you have
more strict requirements and want FOP to stop if an image is not available, you can
do something like the following in the simplest case:
</p>
<source><![CDATA[public class MyEventListener implements EventListener {

public void processEvent(Event event) {
if ("org.apache.fop.ResourceEventProducer".equals(
event.getEventGroupID())) {
event.setSeverity(EventSeverity.FATAL);
} else {
//ignore all other events (or do something of your choice)
}
}
}]]></source>
<p>
Increasing the event severity to FATAL will signal the event broadcaster to throw
an exception and stop further processing. In the above case, all resource-related
events will cause FOP to stop processing.
</p>
<p>
You can also customize the exception to throw (you can may throw a RuntimeException
or subclass yourself) and/or which event to respond to:
</p>
<source><![CDATA[public class MyEventListener implements EventListener {

public void processEvent(Event event) {
if ("org.apache.fop.ResourceEventProducer.imageNotFound"
.equals(event.getEventID())) {
//Get the FileNotFoundException that's part of the event's parameters
FileNotFoundException fnfe = (FileNotFoundException)event.getParam("fnfe");

throw new RuntimeException(EventFormatter.format(event), fnfe);
} else {
//ignore all other events (or do something of your choice)
}
}
}]]></source>
<p>
This throws a <code>RuntimeException</code> with the <code>FileNotFoundException</code>
as the cause. Further processing effectively stops in FOP. You can catch the exception
in your code and react as you see necessary.
</p>
</section>
</section>
<section id="producer">
<title>The producer side (for FOP developers)</title>
<p>
This section is primarily for FOP and FOP plug-in developers. It describes how to use
the event subsystem for producing events.
</p>
<note>
The event package has been designed in order to be theoretically useful for use cases
outside FOP. If you think this is interesting independently from FOP, please talk to
<a href="mailto:fop-dev@xmlgraphics.apache.org">us</a>.
</note>
<section id="basic-event-production">
<title>Producing and sending an event</title>
<p>
The basics are very simple. Just instantiate an <code>Event</code> object and fill
it with the necessary parameters. Then pass it to the <code>EventBroadcaster</code>
which distributes the events to the interested listeneners. Here's a code example:
</p>
<source><![CDATA[Event ev = new Event(this, "complain", EventSeverity.WARN,
Event.paramsBuilder()
.param("reason", "I'm tired")
.param("blah", new Integer(23))
.build());
EventBroadcaster broadcaster = [get it from somewhere];
broadcaster.broadcastEvent(ev);
]]></source>
<p>
The <code>Event.paramsBuilder()</code> is a
<a href="http://en.wikipedia.org/wiki/Fluent_interface">fluent interface</a>
to help with the build-up of the parameters. You could just as well instantiate a
<code>Map</code> (<code>Map&lt;String, Object&gt;</code>) and fill it with values.
</p>
</section>
<section id="event-producer">
<title>The EventProducer interface</title>
<p>
To simplify event production, the event subsystem provides the <code>EventProducer</code>
interface. You can create interfaces which extend <code>EventProducer</code>. These
interfaces will contain one method per event to be generated. By contract, each event
method must have as its first parameter a parameter named "source" (Type Object) which
indicates the object that generated the event. After that come an arbitrary number of
parameters of any type as needed by the event.
</p>
<p>
The event producer interface does not need to have any implementation. The implementation
is produced at runtime by a dynamic proxy created by <code>DefaultEventBroadcaster</code>.
The dynamic proxy creates <code>Event</code> instances for each method call against
the event producer interface. Each parameter (except "source") is added to the event's
parameter map.
</p>
<p>
To simplify the code needed to get an instance of the event producer interface it is
suggested to create a public inner provider class inside the interface.
</p>
<p>
Here's an example of such an event producer interface:
</p>
<source><![CDATA[public interface MyEventProducer extends EventProducer {

public class Provider {
public static MyEventProducer get(EventBroadcaster broadcaster) {
return (MyEventProducer)broadcaster.getEventProducerFor(MyEventProducer.class);
}
}

/**
* Complain about something.
* @param source the event source
* @param reason the reason for the complaint
* @param blah the complaint
* @event.severity WARN
*/
void complain(Object source, String reason, int blah);
}]]></source>
<p>
To produce the same event as in the first example above, you'd use the following code:
</p>
<source><![CDATA[EventBroadcaster broadcaster = [get it from somewhere];
TestEventProducer producer = TestEventProducer.Provider.get(broadcaster);
producer.complain(this, "I'm tired", 23);]]></source>
</section>
<section id="event-model">
<title>The event model</title>
<p>
Inside an invocation handler for a dynamic proxy, there's no information about
the names of each parameter. The JVM doesn't provide it. The only thing you know is
the interface and method name. In order to properly fill the <code>Event</code>'s
parameter map we need to know the parameter names. These are retrieved from an
event object model. This is found in the <code>org.apache.fop.events.model</code>
package. The data for the object model is retrieved from an XML representation of the
event model that is loaded as a resource. The XML representation is generated using an
Ant task at build time (<code>ant resourcegen</code>). The Ant task (found in
<code>src/codegen/java/org/apache/fop/tools/EventProducerCollectorTask.java</code>)
scans FOP's sources for descendants of the <code>EventProducer</code> interface and
uses <a href="http://qdox.codehaus.org/">QDox</a> to parse these interfaces.
</p>
<p>
The event model XML files are generated during build by the Ant task mentioned above when
running the "resourcegen" task. So just run <code>"ant resourcegen"</code> if you receive
a <code>MissingResourceException</code> at runtime indicating that
<code>"event-model.xml"</code> is missing.
</p>
<p>
Primarily, the QDox-based collector task records the parameters' names and types.
Furthermore, it extracts additional attributes embedded as Javadoc comments from
the methods. At the moment, the only such attribute is "@event.severity" which indicates
the default event severity (which can be changed by event listeners). The example event
producer above shows the Javadocs for an event method.
</p>
<p>
There's one more information that is extracted from the event producer information for
the event model: an optional primary exception. The first exception in the "throws"
declaration of an event method is noted. It is used to throw an exception from
the invocation handler if the event has an event severity of "FATAL" when all
listeners have been called (listeners can update the event severity). Please note
that an implementation of
<code>org.apache.fop.events.EventExceptionManager$ExceptionFactory</code> has to be
registered for the <code>EventExceptionManager</code> to be able to construct the
exception from an event.
</p>
<p>
For a given application, there can be multiple event models active at the same time.
In FOP, each renderer is considered to be a plug-in and provides its own specific
event model. The individual event models are provided through an
<code>EventModelFactory</code>. This interface is implemented for each event model
and registered through the service provider mechanism
(see the <a href="#plug-ins">plug-ins section</a> for details).
</p>
</section>
<section id="event-severity">
<title>Event severity</title>
<p>
Four different levels of severity for events has been defined:
</p>
<ol>
<li>INFO: informational only</li>
<li>WARN: a Warning</li>
<li>ERROR: an error condition from which FOP can recover. FOP will continue processing.</li>
<li>FATAL: a fatal error which causes an exception in the end and FOP will stop processing.</li>
</ol>
<p>
Event listeners can choose to ignore certain events based on their event severity.
Please note that you may recieve an event "twice" in a specific case: if there is
a fatal error an event is generated and sent to the listeners. After that an exception
is thrown with the same information and processing stops. If the fatal event is
shown to the user and the following exception is equally presented to the user it
may appear that the event is duplicated. Of course, the same information is just
published through two different channels.
</p>
</section>
<section id="plug-ins">
<title>Plug-ins to the event subsystem</title>
<p>
The event subsystem is extensible. There are a number of extension points:
</p>
<ul>
<li>
<strong><code>org.apache.fop.events.model.EventModelFactory</code>:</strong> Provides
an event model to the event subsystem.
</li>
<li>
<strong><code>org.apache.fop.events.EventExceptionManager$ExceptionFactory</code>:</strong>
Creates exceptions for events, i.e. turns an event into a specific exception.
</li>
</ul>
<p>
The names in bold above are used as filenames for the service provider files that
are placed in the <code>META-INF/services</code> directory. That way, they are
automatically detected. This is a mechanism defined by the
<a href="http://java.sun.com/j2se/1.4.2/docs/guide/jar/jar.html#Service%20Provider">JAR file specification</a>.
</p>
</section>
<section id="l10n">
<title>Localization (L10n)</title>
<p>
One goal of the event subsystem was to have localized (translated) event messages.
The <code>EventFormatter</code> class can be used to convert an event to a
human-readable message. Each <code>EventProducer</code> can provide its own XML-based
translation file. If there is none, a central translation file is used, called
"EventFormatter.xml" (found in the same directory as the <code>EventFormatter</code>
class).
</p>
<p>
The XML format used by the <code>EventFormatter</code> is the same as
<a href="ext:cocoon">Apache Cocoon's</a> catalog format. Here's an example:
</p>
<source><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
<catalogue xml:lang="en">
<message key="locator">
[ (See position {loc})| (See {#gatherContextInfo})| (No context info available)]
</message>
<message key="org.apache.fop.render.rtf.RTFEventProducer.explicitTableColumnsRequired">
RTF output requires that all table-columns for a table are defined. Output will be incorrect.{{locator}}
</message>
<message key="org.apache.fop.render.rtf.RTFEventProducer.ignoredDeferredEvent">
Ignored deferred event for {node} ({start,if,start,end}).{{locator}}
</message>
</catalogue>
]]></source>
<p>
The example (extracted from the RTF handler's event producer) has message templates for
two event methods. The class used to do variable replacement in the templates is
<code>org.apache.fop.util.text.AdvancedMessageFormat</code> which is more powerful
than the <code>MessageFormat</code> classes provided by the Java class library
(<code>java.util.text</code> package).
</p>
<p>
"locator" is a template that is reused by the other message templates
by referencing it through "{{locator}}". This is some kind of include command.
</p>
<p>
Normal event parameters are accessed by name inside single curly braces, for example:
"{node}". For objects, this format just uses the <code>toString()</code> method to turn
the object into a string, unless there is an <code>ObjectFormatter</code> registered
for that type (there's an example for <code>org.xml.sax.Locator</code>).
</p>
<p>
The single curly braces pattern supports additional features. For example, it is possible
to do this: "{start,if,start,end}". "if" here is a special field modifier that evaluates
"start" as a boolean and if that is true returns the text right after the second comma
("start"). Otherwise it returns the text after the third comma ("end"). The "equals"
modifier is similar to "if" but it takes as an additional (comma-separated) parameter
right after the "equals" modifier, a string that is compared to the value of the variable.
An example: {severity,equals,EventSeverity:FATAL,,some text} (this adds "some text" if
the severity is not FATAL).
</p>
<p>
Additional such modifiers can be added by implementing the
<code>AdvancedMessageFormat$Part</code> and <code>AdvancedMessageFormat$PartFactory</code>
interfaces.
</p>
<p>
Square braces can be used to specify optional template sections. The whole section will
be omitted if any of the variables used within are unavailable. Pipe (|) characters can
be used to specify alternative sub-templates (see "locator" above for an example).
</p>
<p>
Developers can also register a function (in the above example:
<code>{#gatherContextInfo})</code>
to do more complex information rendering. These functions are implementations of the
<code>AdvancedMessageFormat$Function</code> interface. Please take care that this is
done in a locale-independent way as there is no locale information available, yet.
</p>
</section>
</section>
</body>
</document>

+ 339
- 0
src/documentation/content/xdocs/1.1rc1/extensions.xml View File

@@ -0,0 +1,339 @@
<?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>Standard Apache™ FOP Extensions</title>
<version>$Revision$</version>
</header>
<body>
<p>
By "extension", we mean any data that can be placed in the input XML document that
is not addressed by the XSL-FO standard.
By having a mechanism for supporting extensions, Apache™ FOP is able to add features that
are not covered in the specification.
</p>
<p>
The extensions documented here are included with FOP, and are automatically available
to you. If you wish to add an extension of your own to FOP, please see the
<a href="../dev/extensions.html">Developers' Extension Page</a>.
</p>
<note>All extensions require the correct use of an appropriate namespace in your input document.</note>
<section id="svg">
<title>SVG</title>
<p>
Please see the <a href="graphics.html#svg">SVG documentation</a> for more details.
</p>
</section>
<section id="fo-extensions">
<title>FO Extensions</title>
<section id="fox-namespace">
<title>Namespace</title>
<p>
By convention, FO extensions in FOP use the "fox" namespace prefix.
To use any of the FO extensions, add a namespace entry for
<code>http://xmlgraphics.apache.org/fop/extensions</code> to the root element:
</p>
<source><![CDATA[<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format"
xmlns:fox="http://xmlgraphics.apache.org/fop/extensions">]]></source>
</section>
<section id="bookmarks">
<title>PDF Bookmarks</title>
<p>
In old versions of Apache FOP there was a <code>fox:outline</code> element
which was used to create outlines in PDF files. The redesigned code makes use
of the <a href="http://www.w3.org/TR/xsl11/#fo_bookmark-tree">bookmark feature defined in the W3C XSL 1.1 standard</a>.
</p>
</section>
<section id="named-destinations">
<title>Anchors or Named Destinations</title>
<p>Use the fox:destination element to define "named destinations" inside a PDF document.
These are useful as fragment identifiers, e.g. "http://server/document.pdf#anchor-name".
fox:destination elements can be placed almost anywhere in the fo document, including a child of
root, a block-level element, or an inline-level element.
For the destination to actually work, it must correspond to an "id" attribute on some fo element
within the document. In other words, the "id" attribute actually creates the "view" within the
PDF document. The fox:destination simply gives that view an independent name.
</p>
<source><![CDATA[<fox:destination internal-destination="table-of-contents"/>
...
<fo:block id="table-of-contents">Table of Contents</fo:block>]]></source>
<warning>It is possible that in some future release of FOP, <em>all </em>elements with
"id" attributes will generate named-destinations, which will eliminate the need for
fox:destination.</warning>
</section>
<section id="table-continue-label">
<title>Table Continuation Label</title>
<p>This extension element hasn't been reimplemented for the redesigned code, yet.</p>
<!--p>Use the fox:continued-label element to create content in table-header and
table-footer cells that will appear only on pages after the first page that the table
appears. fox:continued-label is itself inline content, and is a container of fo:inline
content. This content will be laid out only if the table does not fit on a single page and flows
to following pages. Here is an example of FO code creating such a table-header:</p>
<source><![CDATA[<fo:table-header>
<fo:table-row>
<fo:table-cell>
<fo:block>Header column 1 with continued label
<fox:continued-label><fo:inline> (cont.)</fo:inline></fox:continued-label>
</fo:block>
</fo:table-cell>
<fo:table-cell>
<fo:block>Header column 2 with no continued label</fo:block>
</fo:table-cell>
</fo:table-row>
</fo:table-header>]]></source-->
</section>
<section id="widow-orphan-content-limit">
<title>fox:orphan-content-limit and fox:widow-content-limit</title>
<p>
The two proprietary extension properties, fox:orphan-content-limit and
fox:widow-content-limit, are used to improve the layout of list-blocks and tables.
If you have a table with many entries, you don't want a single row to be left over
on a page. You will want to make sure that at least two or three lines are kept
together. The properties take an absolute length which specifies the area at the
beginning (fox:widow-content-limit) or at the end (fox:orphan-content-limit) of a
table or list-block. The properties are inherited and only have an effect on fo:table
and fo:list-block. An example: fox:widow-content-limit="3 * 1.2em" would make sure
the you'll have at least three lines (assuming line-height="1.2") together on a table
or list-block.
</p>
</section>
<section id="external-document">
<title>fox:external-document</title>
<note>
This feature is incomplete. Support for multi-page documents will be added shortly.
At the moment, only single-page images will work. And this will not work with RTF output.
</note>
<p>
This is a proprietary extension element which allows to add whole images as pages to
an FO document. For example, if you have a scanned document or a fax as multi-page TIFF
file, you can append or insert this document using the <code>fox:external-document</code>
element. Each page of the external document will create one full page in the target
format.
</p>
<p>
The <code>fox:external-document</code> element is structurally a peer to
<code>fo:page-sequence</code>, so wherever you can put an <code>fo:page-sequence</code>
you could also place a <code>fox:external-document</code>.
Therefore, the specified contents for <code>fo:root</code> change to:
</p>
<p>
<code>
(layout-master-set, declarations?, bookmark-tree?, (page-sequence|page-sequence-wrapper|fox:external-document|fox:destination)+)
</code>
</p>
<section>
<title>Specification</title>
<p>
The <code>fox:external-document</code> extension formatting object is used to specify
how to create a (sub-)sequence of pages within a document. The content of these pages
comes from the individual subimages/pages of an image or paged document (for example:
multi-page TIFF in the form of faxes or scanned documents, or PDF files). The
formatting object creates the necessary areas to display one image per page.
</p>
<p>
In terms of page numbers, the behaviour is the same as for
<code>fo:page-sequence</code>. The placement of the image inside the page is similar
to that of <code>fo:external-graphic</code> or <code>fo:instream-foreign-object</code>,
i.e. the viewport (and therefore the page size) is defined by either the intrinsic
size of the image or by the size properties that apply to this formatting object.
</p>
<p>Content: EMPTY</p>
<p>The following properties apply to this formatting object:</p>
<ul>
<li>(Common Accessibility Properties) (not implemented, yet)</li>
<li>(Common Aural Properties) (not implemented, yet)</li>
<li>block-progression-dimension</li>
<li>content-height</li>
<li>content-type</li>
<li>content-width</li>
<li>display-align</li>
<li>height</li>
<li>id</li>
<li>inline-progression-dimension</li>
<li>overflow</li>
<li>pages: &lt;page-set&gt; (see below) (not implemented, yet)</li>
<li>reference-orientation</li>
<li>scaling</li>
<li>scaling-method</li>
<li>src</li>
<li>text-align</li>
<li>width</li>
</ul>
<p>
Datatype "page-set": Value: auto | &lt;integer-range&gt;,
Default: "auto" which means all pages/subimages of the document.
&lt;integer-range&gt; allows values such as "7" or "1-3"
</p>
<note>
<code>fox:external-document</code> is not suitable for concatenating FO documents.
For this, XInclude is recommended.
</note>
</section>
</section>
<section id="transform">
<title>Free-form Transformation for fo:block-container</title>
<p>
For <code>fo:block-container</code> elements whose <code>absolute-position</code> set to
"absolute" or "fixed" you can use the extension attribute <code>fox:transform</code>
to apply a free-form transformation to the whole block-container. The content of the
<code>fox:transform</code> attribute is the same as for
<a href="http://www.w3.org/TR/SVG/coords.html#TransformAttribute">SVG's transform attribute</a>.
The transformation specified here is performed in addition to other implicit
transformations of the block-container (resulting from top, left and other properties)
and after them.
</p>
<p>
Examples: <code>fox:transform="rotate(45)"</code> would rotate the block-container
by 45 degrees clock-wise around its upper-left corner.
<code>fox:transform="translate(10000,0)"</code> would move the block-container to the
right by 10 points (=10000 millipoints, FOP uses millipoints internally!).
</p>
<note>
This extension attribute doesn't work for all output formats! It's currently only
supported for PDF, PS and Java2D-based renderers.
</note>
</section>
<section id="color-functions">
<title>Color functions</title>
<p>
XSL-FO supports specifying color using the rgb(), rgb-icc() and system-color() functions.
Apache FOP provides additional color functions for special use cases. Please note that
using these functions compromises the interoperability of an FO document.
</p>
<section id="color-function-cmyk">
<title>cmyk()</title>
<p><code>color cmyk(numeric, numeric, numeric, numeric)</code></p>
<p>
This function will construct a color in device-specific CMYK color space. The numbers
must be between 0.0 and 1.0. For output formats that don't support device-specific
color space the CMYK value is converted to an sRGB value.
</p>
</section>
<section id="pseudo-color-profiles">
<title>#CMYK pseudo-profile</title>
<p><code>color rgb-icc(numeric, numeric, numeric, #CMYK, numeric, numeric, numeric, numeric)</code></p>
<p>
The <code>rgb-icc</code> function will respond to a pseudo-profile called "#CMYK"
which indicates a device-specific CMYK color space. The "#CMYK" profile is implicitely
available and doesn't have to be (and cannot be) defined through an
<code>fo:color-profile</code> element. It is provided for compatibility with certain
commercial XSL-FO implementations. Please note that this is not part of the official
specification but rather a convention. The following two color specifications are
equivalent:
</p>
<ul>
<li><code>cmyk(0%,0%,20%,40%)</code></li>
<li><code>rgb-icc(153, 153, 102, #CMYK, 0, 0, 0.2, 0.4)</code></li>
</ul>
</section>
</section>
<section id="prepress">
<title>Prepress Support</title>

<p>
This section defines a number of extensions related to
<a href="http://en.wikipedia.org/wiki/Prepress">prepress</a> support.
<code>fox:scale</code> defines a general scale factor for the generated pages.
<code>fox:bleed</code> defines the
<a href="http://en.wikipedia.org/wiki/Bleed_%28printing%29">bleed area</a> for a page.
<code>fox:crop-offset</code> defines the outer edges of the area in which crop marks,
registration marks, color bars and page information are placed.
For details, please read on below.
</p>
<note>
Those extensions have been implemented in the PDF and Java2D renderers only.
</note>

<section id="scale">
<title>fox:scale</title>
<p>Value: &lt;number&gt;{1,2}</p>
<p>Initial: 1</p>
<p>Applies to: fo:simple-page-master</p>
<p>
This property specifies a scale factor along resp. the x and y axes. If only one number
is provided it is used for both the x and y scales. A scale factor smaller than 1
shrinks the page. A scale factor greater than 1 enlarges the page.
</p>
</section>
<section id="bleed">
<title>fox:bleed</title>
<p>
Value: &lt;length&gt;{1,4}
</p>
<p>
Initial: 0pt
</p>
<p>Applies to: fo:simple-page-master</p>
<p>
If there is only one value, it applies to all sides. If there are two values, the top and bottom
bleed widths are set to the first value and the right and left bleed widths are set to the second.
If there are three values, the top is set to the first value, the left and right are set to the second,
and the bottom is set to the third. If there are four values, they apply to the top, right, bottom, and
left, respectively.
(Corresponds to <a href="http://www.w3.org/TR/xsl11/#padding">the definition of
padding</a>).
</p>
<p>
This extension indirectly defines the BleedBox and is calculated by expanding the TrimBox by
the bleed widths. The lengths must be non-negative.
</p>
</section>
<section id="cropOffset">
<title>fox:crop-offset</title>
<p>
Value: &lt;length&gt;{1,4}
</p>
<p>
Initial: bleed (see below)
</p>
<p>Applies to: fo:simple-page-master</p>
<p>
Same behaviour as with fox:bleed. The initial value is set to the same values as the
fox:bleed property.
</p>
<p>
This extension indirectly defines the MediaBox and is calculated by expanding
the TrimBox by the crop offsets. The lengths must be non-negative.
</p>
</section>
<section id="cropBox">
<title>fox:crop-box</title>
<p>
Value: [trim-box | bleed-box | media-box]
</p>
<p>
Initial: media-box
</p>
<p>Applies to: fo:simple-page-master</p>
<p>
The crop box controls how Acrobat displays the page (CropBox in PDF) or how the Java2DRenderer sizes
the output media. The PDF specification defines that the CropBox defaults to the MediaBox. This extension
follows that definition. To simplify usage and cover most use cases, the three supported enumeration
values "trim-box", "bleed-box" and "media-box" set the CropBox to one of those three other boxes.
</p>
<p>
If requested in the future, we could offer to specify the CropBox in absolute coordinates rather
than just by referencing another box.
</p>
</section>
</section>
</section>
</body>
</document>

+ 579
- 0
src/documentation/content/xdocs/1.1rc1/fonts.xml View File

@@ -0,0 +1,579 @@
<?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: Fonts</title>
<version>$Revision$</version>
<authors>
<person name="Jeremias M&#xE4;rki" email=""/>
<person name="Tore Engvig" email=""/>
<person name="Adrian Cumiskey" email=""/>
<person name="Max Berger" email=""/>
</authors>
</header>
<body>
<section id="intro">
<title>Summary</title>
<p>The following table summarizes the font capabilities of the various Apache� FOP renderers:</p>
<table>
<tr>
<th>Renderer</th>
<th>Base-14</th>
<th>AWT/OS</th>
<th>Custom</th>
<th>Custom Embedding</th>
</tr>
<tr>
<td>PDF</td>
<td>yes</td>
<td>no</td>
<td>yes</td>
<td>yes</td>
</tr>
<tr>
<td>PostScript</td>
<td>yes</td>
<td>no</td>
<td>yes</td>
<td>yes</td>
</tr>
<tr>
<td>PCL</td>
<td>yes (modified)</td>
<td>yes (painted as bitmaps)</td>
<td>yes (painted as bitmaps)</td>
<td>no</td>
</tr>
<tr>
<td>AFP</td>
<td>no</td>
<td>no</td>
<td>yes</td>
<td>yes</td>
</tr>
<tr>
<td>Java2D/AWT/Bitmap</td>
<td>if available from OS</td>
<td>yes</td>
<td>yes</td>
<td>n/a (display only)</td>
</tr>
<tr>
<td>Print</td>
<td>if available from OS</td>
<td>yes</td>
<td>yes</td>
<td>controlled by OS printer driver</td>
</tr>
<tr>
<td>RTF</td>
<td>n/a (font metrics not needed)</td>
<td>n/a</td>
<td>n/a</td>
<td>n/a</td>
</tr>
<tr>
<td>TXT</td>
<td>yes (used for layout but not for output)</td>
<td>no</td>
<td>yes (used for layout but not for output)</td>
<td>no</td>
</tr>
<!--tr> NOT AVAILABLE
<td>MIF</td>
<td>n/a (font metrics not needed)</td>
<td>n/a</td>
<td>n/a</td>
<td>n/a</td>
</tr-->
<!--tr> NOT AVAILABLE
<td>SVG</td>
<td>if available from OS</td>
<td>yes</td>
<td>no</td>
<td>no</td>
</tr-->
<tr>
<td>XML</td>
<td>yes</td>
<td>no</td>
<td>yes</td>
<td>n/a</td>
</tr>
</table>
</section>
<section>
<title>Base-14 Fonts</title>
<p>
The Adobe PostScript and PDF Specification specify a set of 14 fonts that must be
available to every PostScript interpreter and PDF reader:
Helvetica (normal, bold, italic, bold italic),
Times (normal, bold, italic, bold italic),
Courier (normal, bold, italic, bold italic),
Symbol and ZapfDingbats.
</p>
<p>
The following font family names are hard-coded into FOP for the Base-14 font set:
</p>
<table>
<tr>
<th>Base-14 font</th>
<th>font families</th>
</tr>
<tr>
<td>Helvetica</td>
<td>Helvetica, sans-serif, SansSerif</td>
</tr>
<tr>
<td>Times</td>
<td>Times, Times Roman, Times-Roman, serif, any</td>
</tr>
<tr>
<td>Courier</td>
<td>Courier, monospace, Monospaced</td>
</tr>
<tr>
<td>Symbol</td>
<td>Symbol</td>
</tr>
<tr>
<td>ZapfDingbats</td>
<td>ZapfDingbats</td>
</tr>
</table>
<p>
Please note that recent versions of Adobe Acrobat Reader replace
"Helvetica" with "Arial" and "Times" with "Times New Roman" internally.
GhostScript replaces "Helvetica" with "Nimbus Sans L" and "Times" with
"Nimbus Roman No9 L". Other document viewers may do similar font
substitutions. If you need to make sure that there are no such
substitutions, you need to specify an explicit font and embed it in
the target document.
</p>
</section>
<section id="missing-fonts">
<title>Missing Fonts</title>
<p>
When FOP does not have a specific font at its disposal (because it's
not installed in the operating system or set up in FOP's configuration),
the font is replaced with "any". "any" is internally mapped to the
Base-14 font "Times" (see above).
</p>
</section>
<section id="missing-glyphs">
<title>Missing Glyphs</title>
<p>
Every font contains a particular set of
<a href="http://en.wikipedia.org/wiki/Glyph">glyphs</a>. If no glyph can be found for
a given character, FOP will issue a warning and use the glpyh for "#" (if available)
instead. Before it does that, it consults a (currently hard-coded) registry of
glyph substitution groups (see Glyphs.java in Apache XML Graphics Commons).
This registry can supply alternative glyphs in some cases (like using space when a no-break
space is requested). But there's no guarantee that the result will be as expected (for
example, in the case of hyphens and similar glyphs). A better way is to use a font that
has all the necessary glyphs. This glyph substitution is only a last resort.
</p>
</section>
<section id="awt">
<title>Java2D/AWT/Operating System Fonts</title>
<p>
The Java2D family of renderers (Java2D, AWT, Print, TIFF, PNG), use the
Java AWT subsystem for font metric information. Through operating system
registration, the AWT subsystem knows what fonts are available on the system,
and the font metrics for each one.
</p>
<p>
When working with one of these output formats and you're missing a font, just
install it in your operating system and they should be available for these
renderers. Please note that this is not true for other output formats such as
PDF or PostScript.
</p>
</section>
<section id="custom">
<title>Custom Fonts</title>
<p>
Support for custom fonts is highly output format dependent (see above table).
This section shows how to add Type 1 and TrueType fonts to the PDF, PostScript and
Java2D-based renderers. Other renderers (like AFP) support other font formats. Details
in this case can be found on the page about <a href="output.html">output formats</a>.
</p>
<p>
In earlier FOP versions, it was always necessary to create an XML font metrics file
if you wanted to add a custom font. This unconvenient step has been removed and in
addition to that, FOP supports auto-registration of fonts, i.e. FOP can find fonts
installed in your operating system or can scan user-specified directories for fonts.
Font registration via XML font metrics file is still supported and may still be necessary
for some very special cases as fallback variant while we stabilize font auto-detection.
</p>
<p>
Basic information about fonts can be found at:
</p>
<ul>
<li>
<a href="http://partners.adobe.com/asn/developer/type/ftypes.html">Adobe font types</a>
</li>
<li>
<a href="http://partners.adobe.com/asn/developer/technotes/fonts.html">Adobe Font Technote</a>
</li>
</ul>
</section>
<section id="basics">
<title>Basic font configuration</title>
<p>
If you want FOP to use custom fonts, you need to tell it where to find them. This
is done in the configuration file and once per renderer (because each output format
is a little different). In the basic form, you can either tell FOP to find your
operating system fonts or you can specify directories that it will search for
support fonts. These fonts will then automatically be registered.
</p>
<source><![CDATA[
<renderers>
<renderer mime="application/pdf">
<fonts>
<!-- register all the fonts found in a directory -->
<directory>C:\MyFonts1</directory>
<!-- register all the fonts found in a directory and all of its sub directories (use with care) -->
<directory recursive="true">C:\MyFonts2</directory>

<!-- automatically detect operating system installed fonts -->
<auto-detect/>
</fonts>
</renderer>
</renderers>]]></source>
<note>
Review the documentation for <a href="configuration.html">FOP Configuration</a>
for instructions on making the FOP configuration available to FOP when it runs.
Otherwise, FOP has no way of finding your custom font information. It is currently
not possible to easily configure fonts from Java code.
</note>
</section>
<section id="advanced">
<title>Advanced font configuration</title>
<p>
The instructions found above should be sufficient for most users. Below are some
additional instructions in case the basic font configuration doesn't lead to
the desired results.
</p>
<section id="type1-metrics">
<title>Type 1 Font Metrics</title>
<p>FOP includes PFMReader, which reads the PFM file that normally comes with a Type 1 font, and generates an appropriate font metrics file for it.
To use it, run the class org.apache.fop.fonts.apps.PFMReader:</p>
<p>Windows:</p>
<source>java -cp build\fop.jar;lib\avalon-framework.jar;lib\commons-logging.jar;lib\commons-io.jar
org.apache.fop.fonts.apps.PFMReader [options] pfm-file xml-file</source>
<p>Unix:</p>
<source>java -cp build/fop.jar:lib/avalon-framework.jar:lib/commons-logging.jar:lib/commons-io.jar
org.apache.fop.fonts.apps.PFMReader [options] pfm-file xml-file</source>
<p>PFMReader [options]:</p>
<ul>
<li><strong>-fn &lt;fontname&gt;</strong> By default, FOP uses the fontname from the
.pfm file when embedding the font. Use the "-fn" option to override this name with one you have
chosen. This may be useful in some cases to ensure that applications using the output document
(Acrobat Reader for example) use the embedded font instead of a local font with the same
name.</li>
</ul>
<note>The classpath in the above example has been simplified for readability.
You will have to adjust the classpath to the names of the actual JAR files in the lib directory.
xml-apis.jar, xercesImpl.jar, xalan.jar and serializer.jar are not necessary for JDK version 1.4 or later.</note>
<note>The tool will construct some values (FontBBox, StemV and ItalicAngle) based on assumptions and calculations which are only an approximation to the real values.
FontBBox and Italic Angle can be found in the human-readable part of the PFB file or in the AFM file.
The PFMReader tool does not yet interpret PFB or AFM files, so if you want to be correct, you may have to adjust the values in the XML file manually.
The constructed values however appear to have no visible influence.</note>
</section>
<section id="truetype-metrics">
<title>TrueType Font Metrics</title>
<p>FOP includes TTFReader, which reads the TTF file and generates an appropriate font metrics file for it.
Use it in a similar manner to PFMReader.
For example, to create such a metrics file in Windows from the TrueType font at c:\myfonts\cmr10.ttf:</p>
<source>java -cp build\fop.jar;lib\avalon-framework.jar;lib\commons-logging.jar;lib\commons-io.jar
org.apache.fop.fonts.apps.TTFReader [options]
C:\myfonts\cmr10.ttf ttfcm.xml</source>
<p>TTFReader [options]:</p>
<ul>
<li><strong>-d &lt;DEBUG | INFO &gt;</strong> Sets the debug level (default is
INFO).</li>
<li><strong>-fn &lt;fontname&gt;</strong> Same as for PFMReader.</li>
<li><strong>-ttcname &lt;fontname&gt;</strong> If you're reading data from a
TrueType Collection (.ttc file) you must specify which font from the collection you will read
metrics from.
If you read from a .ttc file without this option, the fontnames will be listed for you.</li>
<li><strong>-enc ansi</strong> Creates a WinAnsi-encoded font metrics file.
Without this option, a CID-keyed font metrics file is created.
The table below summarizes the differences between these two encoding options as currently
used within FOP.
Please note that this information only applies to TrueType fonts and TrueType collections:</li>
</ul>
<table id="ttf-encoding">
<tr>
<th>Issue</th>
<th>WinAnsi</th>
<th>CID-keyed</th>
</tr>
<tr>
<td>Usable Character Set</td>
<td>Limited to WinAnsi character set, which is roughly equivalent to iso-8889-1.</td>
<td>Limited only by the characters in the font itself.</td>
</tr>
<tr>
<td>Embedding the Font</td>
<td>Optional.</td>
<td>Mandatory. Not embedding the font produces invalid PDF documents.</td>
</tr>
</table>
<warning>
You may experience failures with certain TrueType fonts, especially if they don't contain
the so-called Unicode "cmap" table. TTFReader can currently not deal with font like this.
</warning>
</section>
<section id="truetype-collections-metrics">
<title>TrueType Collections</title>
<p>TrueType collections (.ttc files) contain more than one font.
To create metrics files for these fonts, you must specify which font in the collection should be generated, by using the "-ttcname" option with the TTFReader.</p>
<p>To get a list of the fonts in a collection, just start the TTFReader as if it were a normal TrueType file (without the -ttcname option).
It will display all of the font names and exit with an Exception.</p>
<p>Here is an example of generating a metrics file for a .ttc file:</p>
<source>java -cp build\fop.jar;lib\avalon-framework.jar;lib\commons-logging.jar;lib\commons-io.jar
org.apache.fop.fonts.apps.TTFReader -ttcname "MS Mincho"
msmincho.ttc msminch.xml</source>
<p>
Alternatively, the individual sub-fonts of a TrueType Collections can be selected
using the "sub-font" attribute on the "font" element. That means that generating
an XML font metrics file for TrueType collections is not necessary anymore. Example:
</p>
<source><![CDATA[<font embed-url="gulim.ttc" sub-font="GulimChe">
<font-triplet name="GulimChe" style="normal" weight="normal"/>
</font>]]></source>
</section>
<section id="register">
<title>Register Fonts with FOP</title>
<p>You must tell FOP how to find and use the font metrics files by registering them in the <a href="configuration.html">FOP Configuration</a>. Add entries for your custom fonts, regardless of font type, to the configuration file in a manner similar to the following:</p>
<source><![CDATA[
<renderers>
<renderer mime="application/pdf">
<fonts>
<!-- register a particular font -->
<font metrics-url="file:///C:/myfonts/FTL_____.xml" kerning="yes"
embed-url="file:///C:/myfonts/FTL_____.pfb"
encoding-mode="single-byte">
<font-triplet name="FrutigerLight" style="normal" weight="normal"/>
</font>
<!-- register all the fonts found in a directory -->
<directory>C:\MyFonts1</directory>
<!-- register all the fonts found in a directory and all of its sub directories (use with care) -->
<directory recursive="true">C:\MyFonts2</directory>

<!-- automatically detect operating system installed fonts -->
<auto-detect/>
</fonts>
</renderer>
</renderers>]]></source>
<ul>
<li>
URLs are used to access the font metric and font files.
Relative URLs are resolved relative to the font-base property (or base) if available.
See <a href="configuration.html">FOP: Configuration</a> for more information.
</li>
<li>The "metrics-url" attribute is generally not necessary except if you run into problems with certain fonts.</li>
<li>Either an "embed-url" or a "metrics-url" must be specified for font tag configurations.</li>
<li>The font "kerning" attribute is optional. Default is "true".</li>
<li>If embedding is off (i.e. embed-url is not set), the output will position the text correctly (from the metrics file), but it will not be displayed or printed correctly unless the viewer has the applicable font available to their local system.</li>
<li>When setting the "embed-url" attribute for Type 1 fonts, be sure to specify the PFB (actual font data), not PFM (font metrics) file that you used to generate the XML font metrics file.</li>
<li>The attribute "encoding-mode" is optional an may have the following values:
<ul>
<li>auto: default font encoding mode ("cid" for Truetype, "single-byte" for Type 1)</li>
<li>single-byte: use single-byte encodings in the target format (if applicable)</li>
<li>cid: encode as CID-keyed font (currently only supported for PDF output with TrueType fonts)</li>
</ul>
</li>
<li>The fonts "directory" tag can be used to register fonts contained within a single or list of directory paths. The "recursive" attribute can be specified to recursively add fonts from all sub directories.</li>
<li>The fonts "auto-detect" tag can be used to automatically register fonts that are found to be installed on the native operating system.</li>
<li>Fonts registered with "font" tag configurations override fonts found by means of "directory" tag definitions.</li>
<li>Fonts found as a result of a "directory" tag configuration override fonts found as a result of the "auto-detect" tag being specified.</li>
<li>
If relative URLs are specified, they are evaluated relative to the value of the
"font-base" setting. If there is no "font-base" setting, the fonts are evaluated
relative to the base directory.
</li>
</ul>
<!--note>Cocoon users will need to setup the config, see FOPSerializer for more information.</note-->
</section>
<section id="autodetect">
<title>Auto-Detect and auto-embed feature</title>
<p>When the "auto-detect" flag is set in the configuration, FOP will automatically search for fonts in the default paths for your operating system.</p>
<p>FOP will also auto-detect fonts which are available in the classpath, if they are described as "application/x-font" in the MANIFEST.MF file. For example, if your .jar file contains font/myfont.ttf:</p>
<source>Manifest-Version: 1.0
Name: font/myfont.ttf
Content-Type: application/x-font</source>
<p>This feature allows you to create JAR files containing fonts. The JAR files can be added to fop by providem them in the classpath, e.g. copying them into the lib/ directory.</p>
<section id="font-cache">
<title>The font cache</title>
<p>
Apache FOP maintains a cache file that is used to speed up auto-detection. This file
is usually found in the ".fop" directory under the user's home directory. It's called
"fop-fonts.cache". When the user's home directory is not writable, the font cache file
is put in the directory for temporary files.
</p>
<p>
If there was a problem loading a particular font, it is flagged in the cache file so
it is not loaded anymore. So, if a font is actually around but is still not found
by Apache FOP, it's worth a try to delete the font cache file which forces Apache FOP
to reparse all fonts.
</p>
</section>
</section>
<section id="embedding">
<title>Embedding</title>
<p>
By default, all fonts are embedded if an output format supports font embedding. In some
cases, however, it is preferred that some fonts are only referenced. When working
with referenced fonts it is important to be in control of the target environment where
the produced document is consumed, i.e. the necessary fonts have to be installed there.
</p>
<p>
There are two different ways how you can specify that a font should be referenced:
</p>
<ol>
<li>
When using the old-style "font" element to configure a single font, font referencing
is controlled by the embed-url attribute. If you don't specify the embed-url attribute
the font will not be embedded, but will only be referenced.
</li>
<li>
For automatically configured fonts there's a different mechanism to specify which
fonts should be referenced rather than embedded. This is done in the "referenced-fonts"
element in the configuration. Here's an example:
</li>
</ol>
<source><![CDATA[
<fop version="1.0">
<fonts>
<referenced-fonts>
<match font-family="Helvetica"/>
<match font-family="DejaVu.*"/>
</referenced-fonts>
</fonts>
</fop>]]></source>
<p>
At the moment, you can only match fonts against their font-family. It is possible to use
regular expressions as is shown in the second example above ("DejaVu.*"). The syntax for
the regular expressions used here are the one used by the
<a href="http://java.sun.com/j2se/1.4/docs/api/java/util/regex/package-summary.html"><code>java.util.regex</code> package</a>.
So, in the above snippet "Helvetica" and all variants of the "DejaVu" font family are
referenced. If you want to reference all fonts, just specify <code>font-family=".*"</code>.
</p>
<p>
The <code>referenced-fonts</code> element can be placed either inside the general
<code>fonts</code> element (right under the root) or in the <code>fonts</code> element
under the renderer configuration. In the first case, matches apply to all renderers.
In the second case, matches only apply to the renderer where the element was specified.
Both cases can be used at the same time.
</p>
<p>
Various notes related to embedded fonts:
</p>
<ul>
<li>The PostScript renderer does not yet support TrueType fonts, but can embed Type 1 fonts.</li>
<li>The font is simply embedded into the PDF file, it is not converted.</li>
<li>When FOP embeds a font, it adds a prefix to the fontname to ensure that the name will not match the fontname of an installed font.
This is helpful with older versions of Acrobat Reader that preferred installed fonts over embedded fonts.</li>
<li>When embedding PostScript fonts, the entire font is always embedded.</li>
<li>When embedding TrueType fonts (ttf) or TrueType Collections (ttc), a subset of the
original font, containing only the glyphs used, is embedded in the output document.
That's the default, but if you specify encoding-mode="single-byte" (see above), the
complete font is embedded.</li>
</ul>
</section>
<section id="substitution">
<title>Substitution</title>
<p>When a &lt;substitutions/&gt; section is defined in the configuration, FOP will re-map any font-family references found in your FO input to a given substitution font.</p>
<ul>
<li>If a &lt;substitution/&gt; is declared, it is mandatory that both a &lt;from/&gt; and &lt;to/&gt; child element is declared with a font-family attribute.</li>
<li>Both font-weight and font-style are optional attributes, if they are provided then a value of 'normal' is assumed.</li>
</ul>
<p>For example you could make all FO font-family references to 'Arial' with weights between 700 and 900 reference the normal 'Arial Black' font.</p>
<source><![CDATA[
<fop version="1.0">
<fonts>
<substitutions>
<substitution>
<from font-family="Arial" font-weight="700..900"/>
<to font-family="Arial Black"/>
</substitution>
<substitution>
<from font-family="FrutigerLight"/>
<to font-family="Times" font-weight="bold" font-style="italic"/>
</substitution>
</substitutions>
</fonts>
</fop>]]></source>
</section>
<!-- The following section should no longer be required
<section id="embedding-base14">
<title>Explicitly embedding the base 14 fonts</title>
<p>
There are cases where you might want to force the embedding of one or more of the base 14 fonts that
can normally be considered available on the target platform (viewer, printer). One of these cases is
<a href="pdfa.html">PDF/A</a> which mandates the embedding of even the base 14 fonts. Embedding a font such as Helvetica or
Courier is straight-forward. The "Symbol" and "ZapfDingbats" fonts, however, currently present a
problem because FOP cannot correctly determine the encoding of these two single-byte fonts through
the PFM file. FOP now correctly interprets the "encoding" value in the XML font metrics file, but the
PFMReader application writes "UnknownEncoding" to the generated XML file. In order to embed "Symbol"
and "ZapfDingbats" you have to manually change the XML font metrics file and specify "SymbolEncoding"
or "ZapfdingbatsEncoding" encoding respectively as the value for the "encoding" element.
</p>
<p>Example:</p>
<source><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<font-metrics type="TYPE1">
<font-name>Symbol</font-name>
<embed/>
<encoding>SymbolEncoding</encoding>
<cap-height>673</cap-height>
<x-height>766</x-height>
[..]]]></source>
</section-->
</section>
<section id="selection">
<title>Font Selection Strategies</title>
<p>
There are two font selection strategies: character-by-character or auto. The default is auto.</p>
<p>Auto selected the first font from the list which is able to display the most characters in a given word. This means (assume font A has characters for abclmn, font B for lnmxyz, fontlist is A,B):</p>
<ul>
<li>aaa lll xxx would be displayed in fonts A A B</li>
<li>aaaxx would be displayed in font A</li>
<li>aaaxxx would be displayed in font A</li>
<li>aaaxxxx would be displayed in font B</li>
</ul>
<p>Character-by-Character is NOT yet supported!</p>
</section>
<section id="font-list">
<title>Font List Command-Line Tool</title>
<p>
FOP contains a small command-line tool that lets you generate a list of all configured
fonts. Its class name is: <code>org.apache.fop.tools.fontlist.FontListMain</code>.
Run it with the "-?" parameter to get help for the various options.
</p>
</section>
</body>
</document>

+ 31
- 0
src/documentation/content/xdocs/1.1rc1/fotree/disabled-testcases.xml View File

@@ -0,0 +1,31 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!-- $Id$ -->
<disabled-testcases>
<testcase>
<name>demo test failure</name>
<file>demo-test-failure.fo</file>
<description></description>
</testcase>
<testcase>
<name>Markers and core function evaluation</name>
<file>from-table-column_marker.fo</file>
<description>The code currently evaluates this function according to the column in which the
marker appears in the source document, rather than the column it is retrieved in.</description>
</testcase>
</disabled-testcases>

+ 590
- 0
src/documentation/content/xdocs/1.1rc1/graphics.xml View File

@@ -0,0 +1,590 @@
<?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: Graphics Formats</title>
<version>$Revision$</version>
</header>
<body>
<section id="introduction">
<title>Introduction</title>
<p>
Some noteworthy features of the image handling subsystem are:
</p>
<ul>
<li>
The image libraries Jimi and JAI are not supported. Instead, Apache™ FOP uses the
Image I/O API that was introduced with Java 1.4 for all bitmap codecs.
</li>
<li>
Some bitmap images are not converted to a standardized 24 bit RGB image but are
instead handled in their native format.
</li>
<li>
A plug-in mechanism offers a possibility to add support for new formats without changing
the FOP's source code.
</li>
</ul>
<p>
The actual <a href="http://xmlgraphics.apache.org/commons/image-loader.html">image loading framework</a>
does not reside in Apache FOP, but in
<a href="ext:xmlgraphics.apache.org/commons/">XML Graphics Commons</a>.
</p>
</section>
<section id="support-overview">
<title>Overview of Graphics Support</title>
<p>
The table below summarizes the <em>theoretical</em> support for graphical formats
within FOP. In other words, within the constraints of the limitations listed here,
these formats <em>should</em> work. However, many of them have not been tested,
and there may be limitations that have not yet been discovered or documented.
The packages needed to support some formats are not included in the FOP distribution
and must be installed separately. Follow the links in the "Support Through" columns
for more details.
</p>
<table>
<tr>
<th rowspan="2">Format</th>
<th rowspan="2">Type</th>
<th colspan="3">Support Through</th>
</tr>
<tr>
<th><a href="#native">Apache FOP (native)</a></th>
<th><a href="#batik">Apache Batik</a></th>
<th><a href="#imageio">Image I/O</a></th>
</tr>
<tr>
<td><a href="#bmp">BMP</a> (Microsoft Windows Bitmap)</td>
<td>bitmap</td>
<td/>
<td/>
<td>X [1]</td>
</tr>
<tr>
<td><a href="#emf">EMF</a> (Windows Enhanced Metafile)</td>
<td>vector (with embedded bitmaps)</td>
<td>(X)</td>
<td/>
<td/>
</tr>
<tr>
<td><a href="#eps">EPS</a> (Encapsulated PostScript)</td>
<td>metafile (both bitmap and vector), most frequently used for vector drawings</td>
<td>(X)</td>
<td/>
<td/>
</tr>
<tr>
<td>GIF (Graphics Interchange Format)</td>
<td>bitmap</td>
<td/>
<td/>
<td>X</td>
</tr>
<tr>
<td><a href="#jpeg">JPEG</a> (Joint Photographic Experts Group)</td>
<td>bitmap</td>
<td>(X)</td>
<td/>
<td>X</td>
</tr>
<tr>
<td><a href="#png">PNG</a> (Portable Network Graphic)</td>
<td>bitmap</td>
<td/>
<td/>
<td>X</td>
</tr>
<tr>
<td><a href="#svg">SVG</a> (Scalable Vector Graphics)</td>
<td>vector (with embedded bitmaps)</td>
<td/>
<td>X</td>
<td/>
</tr>
<tr>
<td><a href="#tiff">TIFF</a> (Tag Image Format File)</td>
<td>bitmap</td>
<td>(X)</td>
<td/>
<td>X [1]</td>
</tr>
<tr>
<td><a href="#wmf">WMF</a> (Windows Metafile)</td>
<td>vector (with embedded bitmaps)</td>
<td/>
<td>(X)</td>
<td/>
</tr>
</table>
<p>
Legend:
</p>
<ul>
<li>"(X)" means restricted support. Please see the details below.</li>
<li>
[1]: Requires the presence of <a href="http://jai-imageio.dev.java.net/">JAI Image I/O Tools</a>
(or an equivalent Image I/O compatible codec) in the classpath. JAI Image I/O Tools also
adds support for JPEG 2000, WBMP, RAW and PNM. Other Image I/O codecs may provide
support for additional formats.
</li>
</ul>
<note>
<a href="http://jai-imageio.dev.java.net/">JAI Image I/O Tools</a> is not the same as the
<a href="http://java.sun.com/javase/technologies/desktop/media/jai/">JAI library</a>! The
former simply exposes JAI's codecs using the Image&amp;nbsp;I/O API but does not include all
the image manipulation functionality.
</note>
<section id="format-map">
<title>Map of supported image formats by output format</title>
<p>
Not all image formats are supported for all output formats! For example, while you can
use EPS (Encapsulated PostScript) files when you generate PostScript output, this format
will not be supported by any other output format. Here's an overview of which image
formats are supported by which output format:
</p>
<table>
<tr>
<th>Image Format</th>
<th>PDF</th>
<th>PostScript</th>
<th>Java2D, PNG, TIFF, AWT</th>
<th>PCL</th>
<th>AFP</th>
<th>RTF</th>
</tr>
<tr>
<td><a href="#bmp">BMP</a> (Microsoft Windows Bitmap)</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
</tr>
<tr>
<td><a href="#emf">EMF</a> (Windows Enhanced Metafile)</td>
<td/>
<td/>
<td/>
<td/>
<td/>
<td>X [1]</td>
</tr>
<tr>
<td><a href="#eps">EPS</a> (Encapsulated PostScript)</td>
<td/>
<td>X [1]</td>
<td/>
<td/>
<td/>
<td/>
</tr>
<tr>
<td>GIF (Graphics Interchange Format)</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
</tr>
<tr>
<td><a href="#jpeg">JPEG</a> (Joint Photographic Experts Group)</td>
<td>X [1]</td>
<td>X [1]</td>
<td>X</td>
<td>X</td>
<td>X [1]</td>
<td>X</td>
</tr>
<tr>
<td><a href="#png">PNG</a> (Portable Network Graphic)</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
</tr>
<tr>
<td><a href="#svg">SVG</a> (Scalable Vector Graphics)</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
</tr>
<tr>
<td><a href="#tiff">TIFF</a> (Tag Image Format File)</td>
<td>X [2]</td>
<td>X [2]</td>
<td>X</td>
<td>X</td>
<td>X [2]</td>
<td>X</td>
</tr>
<tr>
<td><a href="#wmf">WMF</a> (Windows Metafile)</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
</tr>
</table>
<p>
Legend:
</p>
<ul>
<li>
[1]: Supported without the need to decode the image.
</li>
<li>
[2]: Supported without the need to decode the image, but only for certain subtypes.
</li>
</ul>
</section>
</section>
<section id="packages">
<title>Graphics Packages</title>
<section id="native">
<title>XML Graphics Commons Native</title>
<p>
<a href="ext:xmlgraphics.apache.org/commons">XML Graphics Commons</a> supports a number
of graphic file formats natively as basic functionality: all bitmap formats for which
there are Image I/O codecs available (JPEG, PNG, GIF, TIFF, etc.), EPS and EMF.
</p>
</section>
<section id="fop-native">
<title>FOP Native</title>
<p>
FOP has no native image plug-ins for the image loading framework of its own but currently
hosts the Batik-dependent SVG and WMF plug-ins until they can be moved to
<a href="ext:xmlgraphics.apache.org/batik">Apache Batik</a>.
</p>
</section>
<section id="batik">
<title>Apache Batik</title>
<p>
<a href="ext:xmlgraphics.apache.org/batik">Apache Batik</a> will later receive the
SVG and WMF plug-ins for the image loading framework that are currently hosted inside
FOP.
</p>
<p>
Current FOP distributions include a distribution of the
<a class="fork" href="ext:xmlgraphics.apache.org/batik">Apache Batik</a>.
Because Batik's API changes frequently, it is highly recommended that you use the
version that ships with FOP, at least when running FOP.
</p>
<warning>Batik must be run in a graphical environment.</warning>
<p>
Batik must be run in a graphical environment.
It uses AWT classes for rendering SVG, which in turn require an X server on Unixish
systems. If you run a server without X, or if you can't connect to the X server due to
security restrictions or policies (a so-called "headless" environment), SVG rendering
will fail.
</p>
<p>Here are some workarounds:</p>
<ul>
<li>
Start Java with the <code>-Djava.awt.headless=true</code> command line option.
</li>
<li>
Install an X server which provides an in-memory framebuffer without actually using a
screen device or any display hardware. One example is Xvfb.
</li>
<li>
Install a toolkit which emulates AWT without the need for an underlying X server. One
example is the <a href="http://www.eteks.com/pja/en">PJA toolkit</a>, which is free
and comes with detailed installation instructions.
</li>
</ul>
</section>
<section id="imageio">
<title>Image I/O</title>
<p>
The image loading framework in <a href="ext:xmlgraphics.apache.org/commons">XML Graphics Commons</a>
provides a wrapper to load images through the
<a class="fork" href="http://java.sun.com/j2se/1.4.2/docs/guide/imageio/index.html">JDK's Image I/O API</a> (JSR 015).
Image I/O allows to dynamically add additional image codecs. An example of such an
add-on library are the
<a class="fork" href="http://java.sun.com/products/java-media/jai/">JAI Image I/O Tools</a>
available from Sun.
</p>
</section>
</section>
<section id="image-formats">
<title>Details on image formats</title>
<section id="bmp">
<title>BMP</title>
<p>
BMP images are supported through an Image I/O codec. There may be limitations of the
codec which are outside the control of Apache FOP.
</p>
</section>
<section id="emf">
<title>EMF</title>
<p>
Windows Enhanced Metafiles (EMF) are only supported in RTF output where they are
embedded without decoding.
</p>
</section>
<section id="eps">
<title>EPS</title>
<p>Apache FOP allows to use EPS files when generating PostScript output only.</p>
<p>
Other output targets can't be supported at the moment because
FOP lacks a PostScript interpreter. Furthermore, FOP is currently not able
to parse the preview bitmaps sometimes contained in EPS files.
</p>
</section>
<section id="gif">
<title>GIF</title>
<p>
GIF images are supported through an Image&amp;nbsp;I/O codec. Transparency is supported but
not guaranteed to work with every output format.
</p>
</section>
<section id="jpeg">
<title>JPEG</title>
<p>
FOP native support (i.e. the handling of undecoded images) of JPEG does not include all
variants, especially those containing unusual color lookup tables and color profiles.
If you have trouble with a JPEG image in FOP, try opening it with an image processing
program (such as Photoshop or Gimp) and then saving it. Specifying 24-bit color output
may also help. For the PDF and PostScript renderers most JPEG images can be passed
through without decompression. User reports indicate that grayscale, RGB, and
CMYK color spaces are all rendered properly. However, for other output formats, the
JPEG images have to be decompressed. Tests have shown that there are some limitation
in some Image&amp;nbsp;I/O codecs concerning images in the CMYK color space. Work-arounds are
in place but may not always work as expected.
</p>
</section>
<section id="png">
<title>PNG</title>
<p>
PNG images are supported through an Image&amp;nbsp;I/O codec. Transparency is supported but
not guaranteed to work with every output format.
</p>
</section>
<section id="svg">
<title>SVG</title>
<section id="svg-intro">
<title>Introduction</title>
<p>FOP uses <a href="#batik"> Apache Batik</a> for SVG support.
This format can be handled as an <code>fo:instream-foreign-object</code> or in a separate
file referenced with <code>fo:external-graphic</code>.</p>
<note>
Batik's SVG Rasterizer utility may also be used to convert standalone SVG
documents into PDF. For more information please see the
<a href="http://xmlgraphics.apache.org/batik/svgrasterizer.html">SVG Rasterizer documentation</a>
on the Batik site.
</note>
</section>
<section id="svg-pdf-graphics">
<title>Placing SVG Graphics into PDF</title>
<p>
The SVG is rendered into PDF by using PDF commands to draw and fill
lines and curves. This means that the graphical objects created with
this remain as vector graphics. The same applies to PostScript output.
For other output formats the SVG graphic may be converted to a bitmap
image.
</p>
<p>
There are a number of SVG things that cannot be converted directly into
PDF. Parts of the graphic such as effects, patterns and images are inserted
into the PDF as a raster graphic. The resolution of these raster images can
be controlled through the "target resolution" setting in the
<a href="configuration.html">configuration</a>.</p>
<p>
Currently transparency is limited in PDF so some SVG images that
contain effects or graphics with transparent areas may not be displayed
correctly.
</p>
</section>
<section id="svg-pdf-text">
<title>Placing SVG Text into PDF and PostScript</title>
<p>If possible, Batik will use normal PDF or PostScript text when inserting text. It does
this by checking if the text can be drawn normally and the font is
supported. This example svg <a href="../dev/svg/text.svg">text.svg</a> /
<a href="../dev/svg/text.pdf">text.pdf</a> / <a href="../dev/svg/text.png">text.png</a>
shows how various types and effects with text are handled.
Note that SVG font support is not yet implemented. Furthermore, text handling in
PostScript output is inferior to PDF output - more text will be painted as shapes in
PS than in PDF.
</p>
<p>
When there's no support to paint text using native text operations,
text is converted and drawn as a set of shapes by Batik, using the
stroking text painter. This means that a typical character will
have about 10 curves (each curve consists of at least 20 characters).
This can make the output files large and when it is viewed the
viewer may not normally draw those fine curves very well (In Adobe Acrobat, turning on
"Smooth Line Art" in the preferences will fix this). Copy/paste functionality
will not be supported in this case.
If the text is inserted into the output file using the inbuilt text commands
it will use a single character.
</p>
<p>
Note that because SVG text can be rendered as either text or a vector graphic, you
may need to consider settings in your viewer for both. The Acrobat viewer has both
"smooth line art" and "smooth text" settings that may need to be set for SVG images
to be displayed nicely on your screen (see Edit / Preferences / Display).
This setting will not affect the printing of your document, which should be OK in
any case, but will only affect the quality of the screen display.
</p>
</section>
<section id="svg-font-selection">
<title>Font selection notes</title>
<p>
Apache Batik uses the AWT/Java2D subsystem as font source while FOP has its own font
subsystem. Great care has been taken that font selection does the best possible choices.
But it must be noted when creating PDF or PostScript that a font used in SVG graphics
needs to be registered with the operating system as well as in FOP's configuration.
By using FOP's font auto-detection, you simply have to install the font in the operating
system and not care about anything else. This is less of an issue if you create
formats like TIFFs, PNGs or PCL because in these cases SVG graphics are usually rendered
to bitmaps which means that on both sides (Batik and FOP), AWT/Java2D is used as the
single font source.
</p>
<p>
Whenever an SVG is converted into a PDF or PostScript file, the font that has been used
inside Batik has to be mapped to a font used by the actual output format. Features like
font substitution in FOP may need to be taken into account but can also be an advantage
when working around font mapping issues. Like for XSL-FO content, you'll get a warning
if a particular font could not be found and had to be substituted, or if a particular
glyph is missing in a font.
</p>
</section>
<section id="svg-scaling">
<title>Scaling</title>
<p>
Currently, SVG images are rendered with the dimensions specified <em>in the SVG
file</em>, within the viewport specified in the fo:external-graphic element.
For everything to work properly, the two should be equal. The SVG standard leaves
this issue as an implementation detail. Additional scaling options are available
through XSL-FO means.
</p>
<p>
If you use pixels to specify the size of an SVG graphic the "source resolution" setting
in the <a href="configuration.html">configuration</a> will be used to determine the
size of a pixel. The use of pixels to specify sizes is discouraged as they may
be interpreted differently in different environments.
</p>
</section>
<section id="svg-problems">
<title>Known Problems</title>
<ul>
<li>
Soft mask transparency is combined with white so that it looks better
on PDF 1.3 viewers but this causes the soft mask to be slightly lighter
or darker on PDF 1.4 viewers.
</li>
<li>
There is some problem with a gradient inside a pattern which may cause a PDF
error when viewed in Acrobat 5.
</li>
<li>
Text is not always handled correctly, it may select the wrong font
especially if characters have multiple fonts in the font list.
</li>
<li>
Uniform transparency for images and other SVG elements that are converted
into a raster graphic are not drawn properly in PDF. The image is opaque.
</li>
</ul>
</section>
</section>
<section id="tiff">
<title>TIFF</title>
<p>
FOP can embed TIFF images without decompression into PDF, PostScript and AFP if they
have either CCITT T.4, CCITT T.6, or JPEG compression. Otherwise, a TIFF-capable
Image&amp;nbsp;I/O codec is necessary for decoding the image.
</p>
<p>
There may be some limitation concerning images in the CMYK color space.
</p>
</section>
<section id="wmf">
<title>WMF</title>
<p>
Windows Metafiles (WMF) are supported through classes in
<a href="ext:xmlgraphics.apache.org/batik">Apache Batik</a>. At the moment, support
for this format is experimental and may not always work as expected.
</p>
</section>
</section>
<section id="resolution">
<title>Graphics Resolution</title>
<p>
Some bitmapped image file formats store a dots-per-inch (dpi) or other resolution
values. FOP tries to use this resolution information whenever possible to determine
the image's intrinsic size. This size is used during the layout process when it is not
superseded by an explicit size on fo:external-graphic (content-width and content-height
properties).
</p>
<p>
Please note that not all images contain resolution information. If it's not available
the source resolution set on the FopFactory (or through the user configuration XML) is used.
The default here is 72 dpi.
</p>
<p>
Bitmap images are generally embedded into the output format at their original resolution
(as is). No resampling of the image is performed. Explicit resampling is on our wishlist,
but hasn't been implemented, yet. Bitmaps included in SVG graphics may be resampled to
the resolution specified in the "target resolution" setting in the
<a href="configuration.html">configuration</a> if SVG filters are applied. This can be
used as a work-around to resample images in FO documents.
</p>
</section>
<section id="page-selection">
<title>Page selection for multi-page formats</title>
<p>
Some image formats such as TIFF support multiple pages/sub-images per file. You can
select a particular page using a special URI fragment in the form:
&lt;uri&gt;#page=&lt;nr&gt;
(for example: <code>http://localhost/images/myimage.tiff#page=3</code>)
</p>
</section>
<section id="caching">
<title>Image caching</title>
<p>
FOP caches images between runs. There is one cache per FopFactory instance. The URI is
used as a key to identify images which means that when a particular URI appears again,
the image is taken from the cache. If you have a servlet that generates a different
image each time it is called with the same URI you need to use a constantly
changing dummy parameter on the URI to avoid caching.
</p>
<p>
The image cache has been improved considerably in the redesigned code. Therefore,
resetting the image cache should be a thing of the past. If you
still experience OutOfMemoryErrors, please notify us.
</p>
<p>
If all else fails, the image cache can be cleared like this:
<code>fopFactory.getImageManager().getCache().clearCache();</code>
</p>
</section>
</body>
</document>

+ 237
- 0
src/documentation/content/xdocs/1.1rc1/hyphenation.xml View File

@@ -0,0 +1,237 @@
<?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: Hyphenation</title>
<version>$Revision$</version>
</header>
<body>
<section id="support">
<title>Hyphenation Support</title>
<section id="intro">
<title>Introduction</title>
<p>Apache™ FOP uses Liang's hyphenation algorithm, well known from TeX. It needs
language specific pattern and other data for operation.</p>
<p>Because of <a href="#license-issues">licensing issues</a> (and for
convenience), all hyphenation patterns for FOP are made available through
the <a class="fork" href="http://offo.sourceforge.net/hyphenation/index.html">Objects For
Formatting Objects</a> project.</p>
<note>If you have made improvements to an existing Apache™ FOP hyphenation pattern,
or if you have created one from scratch, please consider contributing these
to OFFO so that they can benefit other FOP users as well.
Please inquire on the <a href="../maillist.html#fop-user">FOP User
mailing list</a>.</note>
</section>
<section id="license-issues">
<title>License Issues</title>
<p>Many of the hyphenation files distributed with TeX and its offspring are
licenced under the <a class="fork" href="http://www.latex-project.org/lppl.html">LaTeX
Project Public License (LPPL)</a>, which prevents them from being
distributed with Apache software. The LPPL puts restrictions on file names
in redistributed derived works which we feel can't guarantee. Some
hyphenation pattern files have other or additional restrictions, for
example against use for commercial purposes.</p>
<p>Although Apache FOP cannot redistribute hyphenation pattern files that do
not conform with its license scheme, that does not necessarily prevent users
from using such hyphenation patterns with FOP. However, it does place on
the user the responsibility for determining whether the user can rightly use
such hyphenation patterns under the hyphenation pattern license.</p>
<warning>The user is responsible to settle license issues for hyphenation
pattern files that are obtained from non-Apache sources.</warning>
</section>
<section id="sources">
<title>Sources of Custom Hyphenation Pattern Files</title>
<p>The most important source of hyphenation pattern files is the
<a class="fork" href="http://www.ctan.org/tex-archive/language/hyphenation/">CTAN TeX
Archive</a>.</p>
</section>
<section id="install">
<title>Installing Custom Hyphenation Patterns</title>
<p>To install a custom hyphenation pattern for use with FOP:</p>
<ol>
<li>Convert the TeX hyphenation pattern file to the FOP format. The FOP
format is an xml file conforming to the DTD found at
<code>{fop-dir}/hyph/hyphenation.dtd</code>.</li>
<li>Name this new file following this schema:
<code>languageCode_countryCode.xml</code>. The country code is
optional, and should be used only if needed. For example:
<ul>
<li><code>en_US.xml</code> would be the file name for American
English hyphenation patterns.</li>
<li><code>it.xml</code> would be the file name for Italian
hyphenation patterns.</li>
</ul>
The language and country codes must match the XSL-FO input, which
follows <a href="http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt">ISO
639</a> (languages) and <a href="http://www.ics.uci.edu/pub/ietf/http/related/iso3166.txt">ISO
3166</a> (countries). NOTE: The ISO 639/ISO 3166 convention is that
language names are written in lower case, while country codes are written
in upper case. FOP does not check whether the language and country specified
in the FO source are actually from the current standard, but it relies
on it being two letter strings in a few places. So you can make up your
own codes for custom hyphenation patterns, but they should be two
letter strings too (patches for proper handling extensions are welcome)</li>
<li>There are basically three ways to make the FOP-compatible hyphenation pattern
file(s) accessible to FOP:
<ul>
<li>Download the precompiled JAR from <a class="fork" href="http://offo.sourceforge.net/hyphenation/index.html">OFFO
</a> and place it either in the <code>{fop-dir}/lib</code> directory, or
in a directory of your choice (and append the full path to the JAR to
the environment variable <code>FOP_HYPHENATION_PATH</code>).</li>
<li>Download the desired FOP-compatible hyphenation pattern file(s) from
<a class="fork" href="http://offo.sourceforge.net/hyphenation/index.html">OFFO</a>,
and/or take your self created hyphenation pattern file(s),
<ul>
<li>place them in the directory <code>{fop-dir}/hyph</code>, </li>
<li>or place them in a directory of your choice and set the Ant variable
<code>user.hyph.dir</code> to point to that directory (in
<code>build-local.properties</code>),</li>
</ul>
and run Ant with build target
<code>jar-hyphenation</code>. This will create a JAR containing the
compiled patterns in <code>{fop-dir}/build</code> that will be added to the
classpath on the next run.
(When FOP is built from scratch, and there are pattern source file(s)
present in the directory pointed to by the
<code>user.hyph.dir</code> variable, this JAR will automatically
be created from the supplied pattern(s)).</li>
<li>Put the pattern source file(s) into a directory of your choice and
configure FOP to look for custom patterns in this directory, by setting the
<a href="configuration.html">&lt;hyphenation-base&gt;</a>
configuration option.</li>
</ul>
</li>
</ol>
<warning>
Either of these three options will ensure hyphenation is working when using
FOP from the command-line. If FOP is being embedded, remember to add the location(s)
of the hyphenation JAR(s) to the CLASSPATH (option 1 and 2) or to set the
<a href="configuration.html#hyphenation-dir">&lt;hyphenation-dir&gt;</a>
configuration option programmatically (option 3).
</warning>
</section>
</section>
<section id="patterns">
<title>Hyphenation Patterns</title>
<p>If you would like to build your own hyphenation pattern files, or modify
existing ones, this section will help you understand how to do so. Even
when creating a pattern file from scratch, it may be beneficial to start
with an existing file and modify it. See <a class="fork" href="http://offo.sourceforge.net/hyphenation/index.html">
OFFO's Hyphenation page</a> for examples.
Here is a brief explanation of the contents of FOP's hyphenation patterns:</p>
<warning>The remaining content of this section should be considered "draft"
quality. It was drafted from theoretical literature, and has not been
tested against actual FOP behavior. It may contain errors or omissions.
Do not rely on these instructions without testing everything stated here.
If you use these instructions, please provide feedback on the
<a href="../maillist.html#fop-user">FOP User mailing list</a>, either
confirming their accuracy, or raising specific problems that we can
address.</warning>
<ul>
<li>The root of the pattern file is the &lt;hyphenation-info&gt; element.</li>
<li>&lt;hyphen-char&gt;: its attribute "value" contains the character signalling
a hyphen in the &lt;exceptions&gt; section. It has nothing to do with the
hyphenation character used in FOP, use the XSLFO hyphenation-character
property for defining the hyphenation character there. At some points
a dash U+002D is hardwired in the code, so you'd better use this too
(patches to rectify the situation are welcome). There is no default,
if you declare exceptions with hyphenations, you must declare the
hyphen-char too.</li>
<li>&lt;hyphen-min&gt; contains two attributes:
<ul>
<li>before: the minimum number of characters in a word allowed to exist
on a line immediately preceding a hyphenated word-break.</li>
<li>after: the minimum number of characters in a word allowed to exist
on a line immediately after a hyphenated word-break.</li>
</ul>
This element is unused and not even read. It should be considered a
documentation for parameters used during pattern generation.
</li>
<li>&lt;classes&gt; contains whitespace-separated character sets. The members
of each set should be treated as equivalent for purposes of hyphenation,
usually upper and lower case of the same character. The first character
of the set is the canonical character, the patterns and exceptions
should only contain these canonical representation characters (except
digits for weight, the period (.) as word delimiter in the patterns and
the hyphen char in exceptions, of course).</li>
<li>&lt;exceptions&gt; contains whitespace-separated words, each of which
has either explicit hyphen characters to denote acceptable breakage
points, or no hyphen characters, to indicate that this word should
never be hyphenated, or contain explicit &lt;hyp&gt; elements for specifying
changes of spelling due to hyphenation (like backen -&gt; bak-ken or
Stoffarbe -&gt; Stoff-farbe in the old german spelling). Exceptions override
the patterns described below. Explicit &lt;hyp&gt; declarations don't work
yet (patches welcome). Exceptions are generally a bit brittle, test
carefully.</li>
<li>&lt;patterns&gt; includes whitespace-separated patterns, which are what
drive most hyphenation decisions. The characters in these patterns are
explained as follows:
<ul>
<li>non-numeric characters represent characters in a sub-word to be
evaluated</li>
<li>the period character (.) represents a word boundary, i.e. either
the beginning or ending of a word</li>
<li>numeric characters represent a scoring system for indicating the
acceptability of a hyphen in this location. Odd numbers represent an
acceptable location for a hyphen, with higher values overriding lower
inhibiting values. Even numbers indicate an unacceptable location, with
higher values overriding lower values indicating an acceptable position.
A value of zero (inhibiting) is implied when there is no number present.
Generally patterns are constructed so that valuse greater than 4 are rare.
Due to a bug currently patterns with values of 8 and greater don't
have an effect, so don't wonder.</li>
</ul>
Here are some examples from the English patterns file:
<ul>
<li>Knuth (<em>The TeXBook</em>, Appendix H) uses the example <strong>hach4</strong>, which indicates that it is extremely undesirable to place a hyphen after the substring "hach", for example in the word "toothach-es".</li>
<li><strong>.leg5e</strong> indicates that "leg-e", when it occurs at the beginning of a word, is a very good place to place a hyphen, if one is needed. Words like "leg-end" and "leg-er-de-main" fit this pattern.</li>
</ul>
Note that the algorithm that uses this data searches for each of the word's substrings in the patterns, and chooses the <em>highest</em> value found for letter combination.
</li>
</ul>
<p>If you want to convert a TeX hyphenation pattern file, you have to undo
the TeX encoding for non-ASCII text. FOP uses Unicode, and the patterns
must be proper Unicode too. You should be aware of the XML encoding issues,
preferably use a good Unicode editor.</p>
<p>Note that FOP does not do Unicode character normalization. If you use
combining chars for accents and other character decorations, you must
declare character classes for them, and use the same sequence of base character
and combining marks in the XSLFO source, otherwise the pattern wouldn't match.
Fortunately, Unicode provides precomposed characters for all important cases
in common languages, until now nobody run seriously into this issue. Some dead
languages and dialects, especially ancient ones, may pose a real problem
though.</p>
<p>If you want to generate your own patterns, an open-source utility called
patgen can be used to assist in creating pattern files from dictionaries.
It is available in many Unix/Linux distributions and every TeX distribution.
Pattern creation for languages like english or german is an art. Read
Frank Liang's original paper <a class="fork" href="http://www.tug.org/docs/liang/">"Word
Hy-phen-a-tion by Com-pu-ter"</a> (yes, with hyphens) for details.
The original patgen.web source, included in the TeX source distributions,
contains valuable comments, unfortunately technical details often obscure the
high level issues. Another important source of information is
<a class="fork" href="http://mirrors.ctan.org/systems/knuth/dist/tex/texbook.tex">The
TeX Book</a>, appendix H (either read the TeX source, or run it through
TeX to typeset it). Secondary articles, for example the works by Petr Sojka,
may also give some much needed insight into problems arising in automated
hyphenation.</p>
</section>
</body>
</document>

+ 55
- 0
src/documentation/content/xdocs/1.1rc1/index.xml View File

@@ -0,0 +1,55 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!-- $Id$ -->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
<document>
<header>
<title>Apache™ FOP Version 1.1rc1</title>
<version>$Revision$</version>
</header>
<body>
<section id="intro">
<title>Introduction</title>
<p>
This is Release Candidate 1 (rc1) of an upcoming minor (dot) release of FOP. FOP 1.1rc1 contains many bux
fixes and a number of improvements, including
important features such as support for <a href="complexscripts.html">Complex Scripts</a>
(e.g., Arabic, Hebrew, Indic, and Southeast Asian scripts). To see what has changed since the last release,
please visit <a href="releaseNotes_1.1rc1.html">Release Notes</a>.
</p>
<p>
This release implements a substantial subset of the W3C XSL-FO 1.1
Recommendation. For a detailed overview of FOP's
compliance with this recommendation, see <a href="../compliance.html">Compliance</a>.
</p>
</section>
<section id="upgrading">
<title>Upgrading from an earlier version</title>
<p>
If you're upgrading to this version from an earlier version of FOP, please read the
information on <a href="upgrading.html">Upgrading</a>!
</p>
</section>
<section id="download">
<title>Download</title>
<p>
To download this version, please visit <a href="../download.html">Downloading</a>.
</p>
</section>
</body>
</document>

+ 331
- 0
src/documentation/content/xdocs/1.1rc1/intermediate.xml View File

@@ -0,0 +1,331 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!-- $Id$ -->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
<document>
<header>
<title>Apache™ FOP: Intermediate Format</title>
<version>$Revision$</version>
</header>
<body>
<note>
Please note that the intermediate formats described here are
<strong>advanced features</strong> and can be ignored by most users of Apache FOP.
</note>
<section id="introduction">
<title>Introduction</title>
<p>
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
<a href="http://www.w3.org/TR/2001/REC-xsl-20011015/slice1.html#section-N742-Formatting">XSL-FO specification in chapter 1.1.2</a>.
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).
</p>
<p>
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.
</p>
<p>
The intermediate format can be used to generate intermediate documents that are modified
before they are finally rendered to their ultimate output format. Modifications include
adjusting and changing trait values, adding or modifying area objects, inserting prefabricated
pages, overlays, imposition (n-up, rotation, scaling etc.). Multiple IF files can be combined
to a single output file.
</p>
</section>
<section id="which-if">
<title>Which Intermediate Format to choose?</title>
<p>
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:
</p>
<section id="strengths-at">
<title>Area Tree XML (AT XML)</title>
<ul>
<li>1:1 representation of FOP's area tree in XML.</li>
<li>Contains more structure information than the new intermediate format.</li>
<li>Used in FOP's layout engine test suite for regression testing.</li>
</ul>
</section>
<section id="strengths-if">
<title>Intermediate Format (IF)</title>
<ul>
<li>Highly optimized for speed.</li>
<li>Smaller XML files.</li>
<li>Easier to post-process.</li>
<li>XML Schema is available.</li>
<li>
Recommended for use cases where documents are formatted concurrently and later
concatenated to a single print job.
</li>
</ul>
</section>
<p>
More technical information about the two formats can be found on the
<a href="http://wiki.apache.org/xmlgraphics-fop/AreaTreeIntermediateXml/NewDesign">FOP Wiki</a>.
</p>
</section>
<section id="architecture">
<title>Architectural Overview</title>
<figure src="images/if-architecture-overview.png"
alt="Diagram with an architectural overview over the intermediate formats"/>
</section>
<section id="usage">
<title>Usage of the Area Tree XML format (AT XML)</title>
<p>
As already mentioned, the area tree XML format is generated by using the
<strong>XMLRenderer</strong> (MIME type: <strong>application/X-fop-areatree</strong>).
So, you basically set the right MIME type for the output format and process your FO files
as if you would create a PDF file.
</p>
<p>
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.
</p>
<p>
The second step is to reparse the file using the <strong>AreaTreeParser</strong> 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
<a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/"><code>examples/embedding</code></a>
directory in the FOP distribution.
</p>
<p>
The basic pattern to parse the area tree XML format looks like this:
</p>
<source><![CDATA[
FopFactory fopFactory = FopFactory.newInstance();
// Setup output
OutputStream out = new java.io.FileOutputStream(pdffile);
out = new java.io.BufferedOutputStream(out);
try {
//Setup fonts and user agent
FontInfo fontInfo = new FontInfo();
FOUserAgent userAgent = fopFactory.newFOUserAgent();

//Construct the AreaTreeModel that will received the individual pages
AreaTreeModel treeModel = new RenderPagesModel(userAgent,
MimeConstants.MIME_PDF, fontInfo, out);
//Parse the area tree file into the area tree
AreaTreeParser parser = new AreaTreeParser();
Source src = new StreamSource(myIFFile);
parser.parse(src, treeModel, userAgent);
//Signal the end of the processing. The renderer can finalize the target document.
treeModel.endDocument();
} finally {
out.close();
}]]></source>
<p>
This example simply reads an 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
<code>endDocument()</code> on the AreaTreeModel. This lets the Renderer know that the processing
is now finished.
</p>
<p>
The area tree XML format can also be used from the <a href="running.html#standalone-start">command-line</a>
by using the "-atin" parameter for specifying the area tree XML as input file. You can also
specify a "mimic renderer" by inserting a MIME type between "-at" and the output file.
</p>
<section id="concat">
<title>Concatenating Documents</title>
<p>
This initial example is obviously not very useful. It would be faster to create the PDF file
directly. As the <a href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/examples/embedding/java/embedding/atxml/ExampleConcat.java">ExampleConcat.java</a>
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.
</p>
</section>
<section id="modifying">
<title>Modifying Documents</title>
<p>
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.
</p>
<note>
The area tree XML format is sensitive to changes in whitespace. If you're not careful,
the modified file may not render correctly.
</note>
</section>
<section id="advanced">
<title>Advanced Use</title>
<p>
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 <code>setTransformerHandler()</code> on
XMLRenderer to give the XMLRenderer your own TransformerHandler instance in case you would like to
do custom serialization (to a W3C DOM, for example) and/or to directly modify the area tree using
XSLT. The AreaTreeParser on the other side allows you to retrieve a ContentHandler instance where
you can manually send SAX events to to start the parsing process (see <code>getContentHandler()</code>).
</p>
</section>
</section>
<section id="usage-if">
<title>Usage of the Intermediate Format (IF)</title>
<p>
The Intermediate Format (IF) is generated by the <strong>IFSerializer</strong>
(MIME type: <strong>application/X-fop-intermediate-format</strong>).
So, you basically set the right MIME type for the output format and process your FO files
as if you would create a PDF file.
</p>
<p>
The IFSerializer is an implementation of the <strong>IFDocumentHandler</strong> and
<strong>IFPainter</strong> interfaces. The <strong>IFRenderer</strong> class is responsible
for converting FOP's area tree into calls against these two interfaces.
</p>
<ul>
<li>
IFDocumentHandler: This interface is used on the document-level and defines the
overall structure of the Intermediate Format.
</li>
<li>
IFPainter: This interface is used to generate graphical page content like text, images
and borders.
</li>
</ul>
<p>
As with the AT XML, there is an important detail to consider: The various output
implementations don't all use the same font sources. To be able
to create the right IF for the ultimate output file, you need to create the IF file using
the right font setup. This is achieved by telling the IFRenderer (responsible for
converting the area tree into calls to the IFDocumentHandler and IFPainter interfaces)
to mimic another renderer. This is done by calling the IFSerializer's
mimicDocumentHandler() method with an instance of the ultimate target document handler
as the single parameter. This has a consequence: An IF file rendered with the
Java2DDocumentHandler may not look as expected when it was actually generated for the PDF
implementation. For implementations that use the same font setup,
this restriction does not apply (PDF and PS, for example). Generating the Intermediate
Format file is the first step.
</p>
<p>
The second step is to reparse the file using the <strong>IFParser</strong> which is
found in the org.apache.fop.render.intermediate package. The IFParser simply takes an
IFDocumentHandler instance against which it generates the appropriate calls. The IFParser
is implemented as a SAX ContentHandler so you're free to choose the method for
post-processing the IF file(s). You can use XSLT or write SAX- or DOM-based code to
manipulate the contents. You can find examples for the Intermediate Format
processing in the
<a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/"><code>examples/embedding</code></a>
directory in the FOP distribution.
</p>
<p>
The basic pattern to parse the intermediate format looks like this:
</p>
<source><![CDATA[
FopFactory fopFactory = FopFactory.newInstance();
// Setup output
OutputStream out = new java.io.FileOutputStream(pdffile);
out = new java.io.BufferedOutputStream(out);
try {
//Setup user agent
FOUserAgent userAgent = fopFactory.newFOUserAgent();

//Create IFDocumentHandler instance
IFDocumentHandler targetHandler;
String mime = MimeConstants.MIME_PDF;
targetHandler = fopFactory.getRendererFactory().createDocumentHandler(
userAgent, mime);

//Setup fonts
IFUtil.setupFonts(targetHandler);
//Tell the target handler where to write the PDF to
targetHandler.setResult(new StreamResult(pdffile));

//Parse the IF file
IFParser parser = new IFParser();
Source src = new StreamSource(myIFFile);
parser.parse(src, targetHandler, userAgent);
} finally {
out.close();
}]]></source>
<p>
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.
</p>
<section id="concat-if">
<title>Concatenating Documents</title>
<p>
This initial example is obviously not very useful. It would be faster to create the PDF file
directly (without the intermediate step). As the
<a href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/examples/embedding/java/embedding/intermediate/ExampleConcat.java">ExampleConcat.java</a>
example shows you can easily parse multiple 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.
</p>
</section>
<section id="modifying-if">
<title>Modifying Documents</title>
<p>
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.
</p>
<p>
There is an XML Schema (located under
<a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/documentation/intermediate-format-ng/">src/documentation/intermediate-format-ng</a>)
that helps you verify that your modified content is correct.
</p>
<p>
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.
</p>
</section>
<section id="advanced-if">
<title>Advanced Use</title>
<p>
The generation of the intermediate format as well as it parsing process has been
designed to allow for maximum flexibility and optimization. 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 <code>getContentHandler()</code>).
</p>
</section>
</section>
</body>
</document>

+ 54
- 0
src/documentation/content/xdocs/1.1rc1/known-issues.xml View File

@@ -0,0 +1,54 @@
<?xml version="1.0" encoding="UTF-8" ?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!-- $Id$ -->
<known-issues>
<known-issue>
Support for Unicode characters outside of the Base Multilingual Plane (BMP), i.e., characters
whose code points are greater than 65535, is not yet implemented.
See <link href="http://issues.apache.org/bugzilla/show_bug.cgi?id=51843">bug 51843</link>.
</known-issue>
<known-issue>
The writing-mode property does not produce the expected behavior when specified on
<code>fo:simple-page-master</code> or <code>fo:region-*</code> elements.
See <link href="http://issues.apache.org/bugzilla/show_bug.cgi?id=53276">bug 53276</link>.
</known-issue>
<known-issue>
Support for Devanagari and other Indic scripts is not yet complete.
</known-issue>
<known-issue>
Use of Unicode U+200C ZERO WIDTH NON-JOINER (ZWNJ) or U+200D ZERO WIDTH JOINER (ZWJ)
does not prevent or force contextual substitution, respectively, when used with Arabic script.
</known-issue>
<known-issue>
Use of Unicode U+200C ZERO WIDTH NON-JOINER (ZWNJ) or U+200D ZERO WIDTH JOINER (ZWJ)
does not affect conjunct formation or other special behavior prescribed when used with Indic scripts.
</known-issue>
<known-issue>
Support for automatic line breaking at orthographic syllable segment boundaries in Indic
or Southeast Asian scripts is not yet available. In the mean time, use U+200B ZERO WIDTH SPACE (ZWSP).
</known-issue>
<known-issue>
Complex script content is presently supported only with AT, IF, and PDF output formats.
</known-issue>
<known-issue>
When complex script text encounters an <code>fo:inline</code> or <code>fo:character</code> boundary,
contextual substitution and ligature formation will not occur across the boundary. This prevents,
for example, applying a different color to an Arabic Letter within an Arabic word, unless that letter
is a non-joining letter (on both sides).
</known-issue>
</known-issues>

+ 74
- 0
src/documentation/content/xdocs/1.1rc1/knownissues_overview.xml View File

@@ -0,0 +1,74 @@
<?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 xmlns:xi="http://www.w3.org/2001/XInclude">
<header>
<title>Apache™ FOP: Known Issues</title>
<version>$Revision$</version>
</header>
<body>
<section>
<title>Known issues</title>
<p>
This page lists currently known issues in the current release.
</p>
<note>
<p>
For additional information on known issues in Apache™ FOP, please have a look at the following pages, too:
</p>
<ul>
<li><a href="../bugs.html">the bug list in Bugzilla</a></li>
<li><a href="http://wiki.apache.org/xmlgraphics-fop/FOPProjectTasks">the task list in the Wiki</a></li>
</ul>
</note>
<p>
Apache™ FOP has an extensive automated testing infrastructure. Parts of this infrastructure are several
sets of test cases. When a test case is listed in disabled-testcases.xml it is disabled in the JUnit
tests during the normal build process. This indicates a problem in the current codebase. When a bug is
fixed or a missing feature is added the entry for the relevant test case(s) are removed.
</p>
<section>
<title>FO Tree</title>
<p>
This section lists disabled test cases in the test suite for the FO tree tests, at the time
of the release.
</p>
<xi:include href="cocoon://knownissues-raw-fotree_1.1rc1.xml#xpointer(/document/body/*)"/>
</section>
<section>
<title>Layout Engine</title>
<p>
This section lists disabled test cases in the test suite for the layout engine tests, at the
time of the release.
</p>
<xi:include href="cocoon://knownissues-raw-layoutengine_1.1rc1.xml#xpointer(/document/body/*)"/>
</section>
<section>
<title>Other known issues</title>
<p>This section lists some other issues that post-date the release of FOP 1.0. For known issues that pre-date FOP 1.0, see
<link href="http://issues.apache.org/bugzilla/buglist.cgi?chfieldto=2010-07-20&amp;chfield=%5BBug%20creation%5D&amp;query_format=advanced&amp;chfieldfrom=2001-01-01&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=NEEDINFO&amp;product=Fop">older bugs that remain open</link>.
For all open issues that post-date FOP 1.0, see
<link href="http://issues.apache.org/bugzilla/buglist.cgi?chfieldto=Now&amp;chfield=%5BBug%20creation%5D&amp;query_format=advanced&amp;chfieldfrom=2010-07-20&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=NEEDINFO&amp;product=Fop">newer bugs that remain open</link>.
</p>
<!-- See <root>/known-issues.xml for the source document of this section! -->
<xi:include href="cocoon://knownissues-raw-static_1.1rc1.xml#xpointer(/document/body/*)"/>
</section>
</section>
</body>
</document>

+ 223
- 0
src/documentation/content/xdocs/1.1rc1/layoutengine/disabled-testcases.xml View File

@@ -0,0 +1,223 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="disabled-testcases.xsl"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!-- $Id$ -->
<!--DOCTYPE disabled-testcases SYSTEM "disabled-testcases.dtd"-->
<disabled-testcases>
<testcase>
<name>Auto-height block-containers produce fences</name>
<file>block-container_space-before_space-after_3.xml</file>
<description>Block-containers with no height currently don't
create a fence for spaces as they should (they behave like a
normal block).</description>
</testcase>
<testcase>
<name>font-stretch NYI</name>
<file>block_font-stretch.xml</file>
<description>Font-stretch is not implemented, yet.</description>
</testcase>
<testcase>
<name>linefeed-treatment</name>
<file>block_linefeed-treatment.xml</file>
<description>Preserved linefeeds in a fo:character are not handled
correctly.</description>
</testcase>
<testcase>
<name>white-space-treatment</name>
<file>block_white-space-treatment_3.xml</file>
<description>White space handling incorrectly stops at fo:inline
boundaries when it comes to formatter generated line breaks.</description>
</testcase>
<testcase>
<name>Empty blocks produce fences</name>
<file>block_space-before_space-after_8.xml</file>
<description>An empty block currently produces a fence for
stacking constraints which it shouldn't.</description>
</testcase>
<testcase>
<name>block white-space nbsp 2</name>
<file>block_white-space_nbsp_2.xml</file>
<description>The nbsp given as an fo:character is not adjustable and therefore
the justification does not work in this case.</description>
</testcase>
<testcase>
<name>block word-spacing</name>
<file>block_word-spacing.xml</file>
<description>Word-spacing may not work as expected.</description>
</testcase>
<testcase>
<name>block word-spacing text-align justify</name>
<file>block_word-spacing_text-align_justify.xml</file>
<description>Word-spacing may not work as expected.</description>
</testcase>
<testcase>
<name>external-graphic don't shrink</name>
<file>external-graphic_oversized.xml</file>
<description>Images currently don't shrink so they fit on a page
when they are too big and shrinking is allowed to
happen (min/opt/max).</description>
</testcase>
<testcase>
<name>Test case with HTTP URL</name>
<file>external-graphic_src_uri.xml</file>
<description>Doesn't work behind a proxy which requires
authorization.</description>
</testcase>
<testcase>
<name>Space Resolution in foot note area</name>
<file>footnote_space-resolution.xml</file>
<description>Space resolution does not work between footnote
regions.</description>
</testcase>
<testcase>
<name>NPE for table inside an inline</name>
<file>inline_block_nested_3.xml</file>
<description>Placing a table as a child of an fo:inline produces a
NullPointerException.</description>
</testcase>
<testcase>
<name>inline-container is not implemented, yet.</name>
<file>inline-container_block_nested.xml</file>
<description>inline-container is not implemented, yet. Content of an
inline-container will get swallowed. The test case contains no checks.</description>
</testcase>
<testcase>
<name>inline-container is not implemented, yet.</name>
<file>inline-container_border_padding.xml</file>
<description>inline-container is not implemented, yet. Content of an
inline-container will get swallowed.</description>
</testcase>
<testcase>
<name>inline letter-spacing</name>
<file>inline_letter-spacing.xml</file>
<description>Letter-spacing may not work as
expected within fo:inline.</description>
</testcase>
<testcase>
<name>inline word-spacing</name>
<file>inline_word-spacing.xml</file>
<description>Word-spacing may not work as expected within
fo:inline.</description>
</testcase>
<testcase>
<name>inline word-spacing text-align justify</name>
<file>inline_word-spacing_text-align_justify.xml</file>
<description></description>
</testcase>
<testcase>
<name>leader-alignment NYI</name>
<file>leader-alignment.xml</file>
<description>Leader-alignment is not yet
implemented.</description>
</testcase>
<testcase>
<name>leader-pattern="use-content": Problem with line height</name>
<file>leader_leader-pattern_use-content_bug.xml</file>
<description>Line height is not correctly calculated for
use-content leaders whose height is larger than the rest of the
line.</description>
<reference>http://www.nabble.com/leaders-with-leader-pattern%3D%22use-content%22-t546244.html</reference>
</testcase>
<testcase>
<name>Page breaking doesn't deal with IPD changes</name>
<file>page-breaking_4.xml</file>
<description>Page breaking currently doesn't support changing available IPD
between pages of a single page-sequence. Element list generation has to be reset to
redetermine line breaks in this case.</description>
</testcase>
<testcase>
<name>Overflow handing is incomplete</name>
<file>page-breaking_6.xml</file>
<description>Line breaking is not 100% correct when there's too little space.
Overflows are not detected and warned.</description>
</testcase>
<testcase>
<name>Indefinite page height handling is imcomplete</name>
<file>page-height_indefinite_simple.xml</file>
<description>A RuntimeException is thrown for a page of indefinite height. Lots of warnings.</description>
</testcase>
<testcase>
<name>page-number-citation: Problem with background-image</name>
<file>page-number-citation_background-image.xml</file>
<description>Background-images on page-number-citations are not
placed correctly.</description>
</testcase>
<testcase>
<name>IDs are not working on all FO elements</name>
<file>page-number-citation_complex_1.xml</file>
<description>The "id" attributes are not properly handled for all block-level FO elements.</description>
</testcase>
<testcase>
<name>IDs are not working on all FO elements</name>
<file>page-number-citation_complex_2.xml</file>
<description>The "id" attributes are not properly handled for all inline-level FO elements.</description>
</testcase>
<testcase>
<name>Footnotes in multi-column documents</name>
<file>region-body_column-count_footnote.xml</file>
<description>Footnotes may overlap with text of the region-body in
multi-column documents.</description>
</testcase>
<testcase>
<name>Column Balancing problems</name>
<file>region-body_column-count_balance_4col.xml</file>
<description>Situation in a 4-column document where the column balancing doesn't work and even causes some
content to disappear.</description>
</testcase>
<testcase>
<name>Column Balancing problems</name>
<file>region-body_column-count_bug36356.xml</file>
<description>Column balancing doesn't work as expected.</description>
</testcase>
<testcase>
<name>table-cell empty area with marker.xml</name>
<file>table-cell_empty_area_with_marker.xml</file>
<description>A table-cell producing an empty area does currently not add any markers to a page.
See TODO entry in AreaAdditionUtil.</description>
</testcase>
<testcase>
<name>Border conditionality on table</name>
<file>table_border-width_conditionality.xml</file>
<description>The code should be ok, but the test case uses shorthands and therefore
is probably not expressing the indended outcome according to the spec. The test
case should be revisited.</description>
</testcase>
<testcase>
<name>Soft hyphen with normal hyphenation enabled</name>
<file>block_shy_linebreaking_hyph.xml</file>
<description>A soft hyphen should be a preferred as break compared to a
normal hyphenation point but is not.</description>
</testcase>
<testcase>
<name>Page-keep not respected in multi-column layout</name>
<file>keep_within-page_multi-column_overflow.xml</file>
<description>The block should cause overflow in the
last column on the page, rather than be broken.</description>
</testcase>
<testcase>
<name>Block Container Reference Orientation Bug</name>
<file>block-container_reference-orientation_bug36391.xml</file>
<description>An assert is failing</description>
</testcase>
<testcase>
<name>Writing mode problems</name>
<file>simple-page-master_writing-mode_rl_region-body_writing-mode-lr.xml</file>
<description>Test erroneously depends upon incorrect implementation of writing-mode trait
derivation on fo:region-*.</description>
</testcase>
</disabled-testcases>

+ 243
- 0
src/documentation/content/xdocs/1.1rc1/metadata.xml View File

@@ -0,0 +1,243 @@
<?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" "document-v20.dtd">
<document>
<header>
<title>Apache™ FOP: Metadata</title>
</header>
<body>
<section id="overview">
<title>Overview</title>
<p>
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
<a href="http://www.adobe.com/products/xmp/">XMP (eXtensible Metadata Platform, specified by Adobe)</a>.
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.
</p>
</section>
<section id="xmp-in-fo">
<title>Embedding XMP in an XSL-FO document</title>
<p>
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.
</p>
<p>
Document-level metadata can be specified in the <code>fo:declarations</code> element.
XMP specification recommends to use <code>x:xmpmeta</code>, <code>rdf:RDF</code>, and
<code>rdf:Description</code> elements as shown in example below. Both
<code>x:xmpmeta</code> and <code>rdf:RDF</code> elements are recognized as the top-level
element introducing an XMP fragment (as per the XMP specification).
</p>
<section id="xmp-example">
<title>Example</title>
<source><![CDATA[[..]
</fo:layout-master-set>
<fo:declarations>
<x:xmpmeta xmlns:x="adobe:ns:meta/">
<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
<rdf:Description rdf:about=""
xmlns:dc="http://purl.org/dc/elements/1.1/">
<!-- Dublin Core properties go here -->
<dc:title>Document title</dc:title>
<dc:creator>Document author</dc:creator>
<dc:description>Document subject</dc:description>
</rdf:Description>
<rdf:Description rdf:about=""
xmlns:xmp="http://ns.adobe.com/xap/1.0/">
<!-- XMP properties go here -->
<xmp:CreatorTool>Tool used to make the PDF</xmp:CreatorTool>
</rdf:Description>
</rdf:RDF>
</x:xmpmeta>
</fo:declarations>
<fo:page-sequence ...
[..]]]></source>
<note>
<code>fo:declarations</code> <strong>must</strong> be declared after
<code>fo:layout-master-set</code> and before the first <code>page-sequence</code>.
</note>
</section>
</section>
<section id="xmp-impl-in-fop">
<title>Implementation in Apache FOP</title>
<p>
Currently, XMP support is only available for PDF output.
</p>
<p>
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.
</p>
<p>
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.
</p>
<p>
The mapping between the Info and the Metadata object used by Apache FOP comes from
the <a href="http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=38920">PDF/A-1 specification</a>.
For convenience, here's the mapping table:
</p>
<table>
<tr>
<th colspan="2">Document information dictionary</th>
<th colspan="3">XMP</th>
</tr>
<tr>
<th>Entry</th>
<th>PDF type</th>
<th>Property</th>
<th>XMP type</th>
<th>Category</th>
</tr>
<tr>
<td>Title</td>
<td>text string</td>
<td>dc:title</td>
<td>Text</td>
<td>External</td>
</tr>
<tr>
<td>Author</td>
<td>text string</td>
<td>dc:creator</td>
<td>seq Text</td>
<td>External</td>
</tr>
<tr>
<td>Subject</td>
<td>text string</td>
<td>dc:description["x-default"]</td>
<td>Text</td>
<td>External</td>
</tr>
<tr>
<td>Keywords</td>
<td>text string</td>
<td>pdf:Keywords</td>
<td>Text</td>
<td>External</td>
</tr>
<tr>
<td>Creator</td>
<td>text string</td>
<td>xmp:CreatorTool</td>
<td>Text</td>
<td>External</td>
</tr>
<tr>
<td>Producer</td>
<td>text string</td>
<td>pdf:Producer</td>
<td>Text</td>
<td>Internal</td>
</tr>
<tr>
<td>CreationDate</td>
<td>date</td>
<td>xmp:CreationDate</td>
<td>Date</td>
<td>Internal</td>
</tr>
<tr>
<td>ModDate</td>
<td>date</td>
<td>xmp:ModifyDate</td>
<td>Date</td>
<td>Internal</td>
</tr>
</table>
<note>
"Internal" in the Category column means that the user should not set this value.
It is set by the application.
</note>
<note>
The "Subject" used to be mapped to <code>dc:subject</code> in the initial publication of
PDF/A-1 (ISO 19005-1). In the
<a href="http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=45613">Technical Corrigendum 1</a>
this was changed to map to <code>dc:description["x-default"]</code>.
</note>
<section id="namespaces">
<title>Namespaces</title>
<p>
Metadata is made of property sets where each property set uses a different namespace URI.
</p>
<p>
The following is a listing of namespaces that Apache FOP recognizes and acts upon,
mostly to synchronize the XMP metadata with the PDF Info dictionary:
</p>
<table>
<tr>
<th>Set/Schema</th>
<th>Namespace Prefix</th>
<th>Namespace URI</th>
</tr>
<tr>
<td>Dublin Core</td>
<td>dc</td>
<td>http://purl.org/dc/elements/1.1/</td>
</tr>
<tr>
<td>XMP Basic</td>
<td>xmp</td>
<td>http://ns.adobe.com/xap/1.0/</td>
</tr>
<tr>
<td>Adobe PDF Schema</td>
<td>pdf</td>
<td>http://ns.adobe.com/pdf/1.3/</td>
</tr>
</table>
<p>
Please refer to the <a href="http://partners.adobe.com/public/developer/en/xmp/sdk/XMPspecification.pdf">XMP Specification</a>
for information on other metadata namespaces.
</p>
<p>
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.
</p>
</section>
</section>
<section id="links">
<title>Links</title>
<ul>
<li><a href="http://www.adobe.com/products/xmp/">Adobe's Extensible Metadata Platform (XMP) website</a></li>
<li><a href="http://partners.adobe.com/public/developer/en/xmp/sdk/XMPspecification.pdf">Adobe XMP Specification</a></li>
<li><a href="http://partners.adobe.com/public/developer/en/xmp/sdk/XMPspecification.pdf">Adobe XMP Specification</a></li>
<li><a href="http://dublincore.org/">http://dublincore.org/</a></li>
</ul>
</section>
</body>
</document>

+ 1401
- 0
src/documentation/content/xdocs/1.1rc1/output.xml
File diff suppressed because it is too large
View File


+ 168
- 0
src/documentation/content/xdocs/1.1rc1/pdfa.xml View File

@@ -0,0 +1,168 @@
<?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" "document-v20.dtd">
<document>
<header>
<title>Apache™ FOP: PDF/A (ISO 19005)</title>
<version>$Revision$</version>
<authors>
<person name="Jeremias Märki" email="jeremias@apache.org"/>
</authors>
</header>
<body>
<section id="overview">
<title>Overview</title>
<p>
PDF/A is a standard which turns PDF into an "electronic document file
format for long-term preservation". PDF/A-1 is the first part of the
standard and is documented in
<a href="http://www.iso.org/iso/en/CatalogueDetailPage.CatalogueDetail?CSNUMBER=38920&amp;ICS1=37&amp;ICS2=100&amp;ICS3=99">ISO 19005-1:2005(E)</a>.
Work on PDF/A-2 is in progress at
<a href="http://www.aiim.org/standards.asp?ID=25013">AIIM</a>.
</p>
<p>
Design documentation on PDF/A can be found on FOP's Wiki on the
<a href="http://wiki.apache.org/xmlgraphics-fop/PDFA1ConformanceNotes">PDFA1ConformanceNotes</a> page.
</p>
</section>
<section id="status">
<title>Implementation Status</title>
<p>
<strong>PDF/A-1b</strong> is implemented to the degree that FOP supports
the creation of the elements described in ISO 19005-1.
</p>
<p>
Tests have been performed against jHove and Adobe Acrobat 7.0.7 (Preflight function).
FOP does not validate completely against Apago's PDF Appraiser. Reasons unknown due to
lack of a full license to get a detailed error protocol.
</p>
<p>
<strong>PDF/A-1a</strong> is based on PDF-A-1b and adds accessibility features
(such as Tagged PDF). This format is available within the limitation described on
the <a href="accessibility.html">Accessibility page</a>.
</p>
</section>
<section id="command-line">
<title>Usage (command line)</title>
<p>
To activate PDF/A-1b from the command-line, specify "-pdfprofile PDF/A-1b"
as a parameter. If there is a violation of one of the validation rules for
PDF/A, an error message is presented and the processing stops.
</p>
<p>
PDF/A-1a is enabled by specifying "-pdfprofile PDF/A-1a".
</p>
</section>
<section id="embedded">
<title>Usage (embedded)</title>
<p>
When FOP is embedded in another Java application you can set a special option
on the renderer options in the user agent to activate the PDF/A-1b profile.
Here's an example:
</p>
<source><![CDATA[
userAgent.getRendererOptions().put("pdf-a-mode", "PDF/A-1b");
Fop fop = fopFactory.newFop(MimeConstants.MIME_PDF, userAgent);
[..]]]></source>
<p>
If one of the validation rules of PDF/A is violated, an PDFConformanceException
(descendant of RuntimeException) is thrown.
</p>
<p>
For PDF/A-1a, just use the string "PDF/A-1a" instead of "PDF/A-1b".
</p>
</section>
<section id="rules">
<title>PDF/A in Action</title>
<p>
There are a number of things that must be looked after if you activate a PDF/A
profile. If you receive a PDFConformanceException, have a look at the following
list (not necessarily comprehensive):
</p>
<ul>
<li>
Make sure all (!) fonts are embedded. If you use base 14 fonts (like Helvetica)
you need to obtain a license for them and embed them like any other font.
</li>
<li>
Don't use PDF encryption. PDF/A doesn't allow it.
</li>
<li>
Don't use CMYK images without an ICC color profile. PDF/A doesn't allow mixing
color spaces and FOP currently only properly supports the sRGB color space. Please
note that FOP embeds a standard sRGB ICC profile (sRGB IEC61966-2.1) as the
primary output intent for the PDF if no other output intent has been specified
in the configuration.
</li>
<li>
Don't use non-RGB colors in SVG images. Same issue as with CMYK images.
</li>
<li>
Don't use EPS graphics with fo:external-graphic. Embedding EPS graphics in PDF
is deprecated since PDF 1.4 and prohibited by PDF/A.
</li>
<li>
PDF is forced to version 1.4 if PDF/A-1 is activated.
</li>
<li>
No filter must be specified explicitely for metadata objects. Metadata must be
embedded in clear text so non-PDF-aware applications can extract the XMP metadata.
</li>
</ul>
<note>
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 <a href="accessibility.html">Accessibility page</a> for details.
</note>
</section>
<section id="profile-compatibility">
<title>PDF profile compatibility</title>
<p>
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.
</p>
</section>
<section id="interoperability">
<title>Interoperability</title>
<p>
There has been some confusion about the namespace for the PDF/A indicator in the XMP
metadata. At least three variants have been seen in the wild:
</p>
<table>
<tr>
<td>http://www.aiim.org/pdfa/ns/id.html</td>
<td><strong>obsolete</strong>, from an early draft of ISO-19005-1, used by Adobe Acrobat 7.x</td>
</tr>
<tr>
<td>http://www.aiim.org/pdfa/ns/id</td>
<td><strong>obsolete</strong>, found in the original ISO 19005-1:2005 document</td>
</tr>
<tr>
<td>http://www.aiim.org/pdfa/ns/id/</td>
<td><strong>correct</strong>, found in the technical corrigendum 1 of ISO 19005-1:2005</td>
</tr>
</table>
<p>
If you get an error validating a PDF/A file in Adobe Acrobat 7.x it doesn't mean that
FOP did something wrong. It's Acrobat that is at fault. This is fixed in Adobe Acrobat 8.x
which uses the correct namespace as described in the technical corrigendum 1.
</p>
</section>
</body>
</document>

+ 301
- 0
src/documentation/content/xdocs/1.1rc1/pdfencryption.xml View File

@@ -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>

+ 136
- 0
src/documentation/content/xdocs/1.1rc1/pdfx.xml View File

@@ -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&amp;ICS1=37&amp;ICS2=100&amp;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>

+ 370
- 0
src/documentation/content/xdocs/1.1rc1/running.xml View File

@@ -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 &gt;=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 &lt;CLASSPATH&gt;
org.apache.fop.cli.Main &lt;arguments&gt;</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 &lt;arguments&gt;</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
&lt;arguments&gt;</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>

+ 325
- 0
src/documentation/content/xdocs/1.1rc1/servlets.xml View File

@@ -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&amp;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&amp;par2=b&amp;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>

+ 181
- 0
src/documentation/content/xdocs/1.1rc1/upgrading.xml View File

@@ -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>&lt;fo:table-cell&gt;&lt;/fo:table-cell&gt;</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>

+ 0
- 1
src/documentation/content/xdocs/bugs.xml View File

@@ -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>

+ 30
- 56
src/documentation/content/xdocs/compliance.ihtml View File

@@ -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>&nbsp;</td>
</tr>
<tr>
@@ -1439,7 +1439,7 @@
"http://www.w3.org/TR/xsl/#fo_wrapper">&sect;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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</td>
<td class="yes">yes</td>
<td class="yes">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">&sect;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>&nbsp;</td>
@@ -2755,7 +2737,7 @@
"http://www.w3.org/TR/xsl/#max-width">&sect;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>&nbsp;</td>
@@ -2765,7 +2747,7 @@
"http://www.w3.org/TR/xsl/#min-height">&sect;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>&nbsp;</td>
@@ -2775,7 +2757,7 @@
"http://www.w3.org/TR/xsl/#min-width">&sect;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>&nbsp;</td>
@@ -3164,7 +3146,6 @@
<td class="partial">partial</td>
<td>
<ul>
<li>[0.95] &lt;integer&gt; values are not supported.</li>
<li>[1.0 and later] minimal support for &lt;integer&gt; 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] &lt;integer&gt; values are not supported.</li>
<li>[1.0 and later] minimal support for &lt;integer&gt; 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] &lt;integer&gt; values are not supported.</li>
<li>[1.0 and later] minimal support for &lt;integer&gt; 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>&nbsp;</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>&nbsp;</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>&nbsp;</td>
</tr>

@@ -3852,7 +3829,7 @@
"http://www.w3.org/TR/xsl/#page-position">&sect;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>&nbsp;</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>&nbsp;</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>&nbsp;</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">&sect;5.10.1</a></td>

+ 24
- 5
src/documentation/content/xdocs/download.xml View File

@@ -84,6 +84,25 @@
</ul>
<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>
@@ -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> &amp;
<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$ -->
<!-- Last Line of $RCSfile$ -->

+ 8
- 8
src/documentation/content/xdocs/faq.xml View File

@@ -16,7 +16,7 @@
limitations under the License.
-->
<!-- $Id$ -->
<!DOCTYPE faqs PUBLIC "-//APACHE//DTD FAQ V1.3//EN" "http://forrest.apache.org/dtd/faq-v13.dtd">
<!DOCTYPE faqs PUBLIC "-//APACHE//DTD FAQ V1.3//EN" "http://forrest.apache.org/dtd/faq-v12.dtd">

<faqs title="FOP FAQ">
<part id="part-general">
@@ -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>

+ 3
- 4
src/documentation/content/xdocs/fo.xml View File

@@ -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 result in a Euro sign:
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 the after region and the bottom margin o
<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>

+ 10
- 14
src/documentation/content/xdocs/index.xml View File

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

+ 17
- 12
src/documentation/content/xdocs/knownissues.xml View File

@@ -16,7 +16,14 @@
limitations under the License.
-->
<!-- $Id$ -->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd" [
<!ATTLIST document
xmlns:xi CDATA #IMPLIED>
<!ELEMENT xi:include EMPTY>
<!ATTLIST xi:include
href CDATA #IMPLIED>
<!ENTITY % local.sections "|xi:include">
]>
<document xmlns:xi="http://www.w3.org/2001/XInclude">
<header>
<title>Apache™ FOP: Known Issues</title>
@@ -30,27 +37,25 @@
from data in FOP's code repository (Trunk) and may not exactly represent the list of issues in
the latest release.
</p>
<note>
<p>
For additional information on known issues in Apache FOP, please have a look at the following pages, too:
</p>
<ul>
<li><a href="bugs.html">the bug list in Bugzilla</a></li>
<li><a href="http://wiki.apache.org/xmlgraphics-fop/FOPProjectTasks">the task list in the Wiki</a></li>
</ul>
</note>
<p>
Apache™ FOP has an extensive automated testing infrastructure. Parts of this infrastructure are several
sets of test cases. When a test case is listed in disabled-testcases.xml it is disabled in the JUnit
tests during the normal build process. This indicates a problem in the current codebase. When a bug is
fixed or a missing feature is added the entry for the relevant test case(s) are removed.
</p>
<p>
For additional information on known issues in Apache FOP, please have a look at the following pages, too:
</p>
<ul>
<li><link href="bugs.html">the bug list in Bugzilla</link></li>
<li><link href="http://wiki.apache.org/xmlgraphics-fop/FOPProjectTasks">the task list in the Wiki</link></li>
</ul>
<section>
<title>FO Tree</title>
<p>
This section lists currently disabled test cases in the test suite for the FO tree tests.
The data for this section comes from
<a href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/test/fotree/disabled-testcases.xml">test/fotree/disabled-testcases.xml</a>.
<link href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/test/fotree/disabled-testcases.xml">test/fotree/disabled-testcases.xml</link>.
</p>
<xi:include href="cocoon://knownissues-raw-fotree.xml#xpointer(/document/body/*)"/>
</section>
@@ -59,7 +64,7 @@
<p>
This section lists currently disabled test cases in the test suite for the layout engine tests.
The data for this section comes from
<a href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/test/layoutengine/disabled-testcases.xml">test/layoutengine/disabled-testcases.xml</a>.
<link href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/test/layoutengine/disabled-testcases.xml">test/layoutengine/disabled-testcases.xml</link>.
</p>
<xi:include href="cocoon://knownissues-raw-layoutengine.xml#xpointer(/document/body/*)"/>
</section>

+ 1
- 2
src/documentation/content/xdocs/license.xml View File

@@ -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 License</title>
@@ -28,7 +27,7 @@
<title>License</title>
<p>
All new Apache™ FOP releases will be licensed under the <strong>Apache™ License, version 2.0</strong>.
Releases until version 0.20.5 are released unter the Apache™ License, version 1.1.
Releases up through version 0.20.5 were released under the Apache™ License, version 1.1.
</p>
<p>
To inspect the license terms please consult the LICENSE and NOTICE files in the root

+ 1
- 1
src/documentation/content/xdocs/maillist.xml View File

@@ -83,7 +83,7 @@ If you are using Microsoft Outlook, this setting can be found at the "Mail Forma
source, or other semantic XML? If so, the question is <em>almost certainly not
appropriate to this list</em>. In general, the only input documents that are
appropriate on this list are XSL-FO snippets. See <link
href="1.0/running.html#check-input">Running Xalan</link> for instructions about capturing the XSL-FO document that is actually submitted to FOP. If you haven't examined the XSL-FO document yourself, then you are not yet prepared to formulate a FOP-specific question.</li>
href="1.1rc1/running.html#check-input">Running Xalan</link> for instructions about capturing the XSL-FO document that is actually submitted to FOP. If you haven't examined the XSL-FO document yourself, then you are not yet prepared to formulate a FOP-specific question.</li>
<li>If you are providing one or more XSL-FO snippets:
<ul>
<li>Have you reduced them to the shortest possible complete, <strong>self-contained</strong> document that demonstrates the problem? Please do so.</li>

+ 9
- 0
src/documentation/content/xdocs/news-data.xml View File

@@ -17,6 +17,15 @@
-->
<!-- $Id$ -->
<news>
<item date="2012-07-02" title="Apache™ FOP 1.1rc1 Available">
<p>
This is a candidate release for an upcoming FOP Version 1.1 (stable) release.
release of the new FOP codebase. This release
contains bug fixes and new features. See
<a href="1.1rc1/releaseNotes_1.1rc1.html">Release Notes</a> for a list of
the most important changes.
</p>
</item>
<item date="2012-02-24" title="New committer">
<p>Welcome Glenn Adams!</p>
</item>

+ 11
- 4
src/documentation/content/xdocs/news.xml View File

@@ -16,17 +16,24 @@
limitations under the License.
-->
<!-- $Id$ -->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
<document>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd" [
<!ATTLIST document
xmlns:xi CDATA #IMPLIED>
<!ELEMENT xi:include EMPTY>
<!ATTLIST xi:include
href CDATA #IMPLIED>
<!ENTITY % local.sections "|xi:include">
]>
<document xmlns:xi="http://www.w3.org/2001/XInclude">
<header>
<title>Apache™ FOP News</title>
<version>$Revision$</version>
</header>
<body>
<p>
RSS Feed: <a href="subproject-news-feed.rss"><img src="feed-icon-14x14.png" alt="Subproject News Feed"/></a>
RSS Feed: <link href="subproject-news-feed.rss"><img src="feed-icon-14x14.png" alt="Subproject News Feed"/></link>
</p>
<xi:include href="cocoon://subproject-news-document.xml#xpointer(/document/body/*)" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="cocoon://subproject-news-document.xml#xpointer(/document/body/*)"/>
</body>
</document>


+ 7
- 7
src/documentation/content/xdocs/quickstartguide.xml View File

@@ -29,15 +29,15 @@
<p>The goal of this <strong>Quick Start Guide</strong> is to help novice users get Apache FOP up and running quickly. Typically, you'll need to:</p>
<ol>
<li><link href="download.html">Download FOP</link></li>
<li><link href="1.0/compiling.html">Build FOP</link> (you can skip this step if you download the binary distribution!)</li>
<li><link href="1.0/configuration.html">Configure FOP</link></li>
<li><link href="1.0/running.html">Run FOP</link></li>
<li><link href="1.1rc1/compiling.html">Build FOP</link> (you can skip this step if you download the binary distribution!)</li>
<li><link href="1.1rc1/configuration.html">Configure FOP</link></li>
<li><link href="1.1rc1/running.html">Run FOP</link></li>
</ol>
<p>Here are some links to help you find out what FOP can do, as well as how and where to get help:</p>
<ul>
<li><link href="1.0/embedding.html">Calling FOP from a Java Application</link></li>
<li><link href="1.0/servlets.html">Using FOP in Servlets</link></li>
<li><link href="1.0/anttask.html">Using FOP in an 'Ant' Build Script</link></li>
<li><link href="1.1rc1/embedding.html">Calling FOP from a Java Application</link></li>
<li><link href="1.1rc1/servlets.html">Using FOP in Servlets</link></li>
<li><link href="1.1rc1/anttask.html">Using FOP in an 'Ant' Build Script</link></li>
<li><link href="compliance.html" title="FOP Compliance">XSL-FO Compliance</link> (what FOP supports and what it doesn't)</li>
<li><link href="faq.html">FAQs</link></li>
<li><link href="gethelp.html">Getting Help</link></li>
@@ -45,7 +45,7 @@
</ul>
<p>
Once you've familiarized yourself with the basics, you can get more detailed information,
in the detailed FOP <link href="1.0/index.html">product documentation</link>.
in the detailed FOP <link href="1.1rc1/index.html">product documentation</link>.
</p>
</section>

+ 38
- 46
src/documentation/content/xdocs/site.xml View File

@@ -29,13 +29,9 @@
<faqs label="FAQs" href="faq.html"/>
<maillist label="Mailing Lists" href="maillist.html"/>
<license label="License" href="license.html"/>
<asf-sponsorship label="ASF Sponsorship Program" href="http://www.apache.org/foundation/sponsorship.html"/>"
<asf-thanks label="ASF Thanks" href="http://www.apache.org/foundation/thanks.html"/>"
<asf-security label="Security" href="http://www.apache.org/security/"/>
<!--
<all_site label="Full HTML" href="wholesite.html"/>
<all_sitePDF label="Full PDF" href="wholesite.pdf"/>
-->
<asf-sponsorship label="ASF Sponsorship Program" href="http://www.apache.org/foundation/sponsorship.html"/>
<asf-thanks label="ASF Thanks" href="http://www.apache.org/foundation/thanks.html"/>
<asf-security label="Security" href="http://www.apache.org/security/"/>
</about>

<resources label="Resources">
@@ -59,80 +55,82 @@
-->
<!--
BEGIN Version 0.95 documentation tab
BEGIN Version 1.0 documentation tab
-->
<trunk label="Apache™ FOP 0.95" href="0.95/" tab="previousversion">
<trunk label="Apache™ FOP 1.0" href="1.0/" tab="previousversion">
<about label="About" href="index.html"/>
<release label="Release Notes" href="releaseNotes_0.95.html"/>
<changes label="Changes (0.95)" href="changes_0.95.html"/>
<changes-beta label="Changes (0.95beta)" href="changes_0.95beta.html"/>
<release label="Release Notes" href="releaseNotes_1.0.html"/>
<changes label="Changes (1.0)" href="changes_1.0.html"/>
<knownissues label="Known Issues" href="knownissues_overview.html"/>
<upgrading label="Upgrading" href="upgrading.html"/>
<using label="Using Apache™ FOP">
<ant label="Ant Task" href="anttask.html"/>
<build label="Build" href="compiling.html"/>
<config label="Configure" href="configuration.html"/>
<run label="Run" href="running.html"/>
<embed label="Embed" href="embedding.html"/>
<run label="Run" href="running.html"/>
<servlet label="Servlets" href="servlets.html"/>
<ant label="Ant Task" href="anttask.html"/>
</using>

<features label="Features">
<accessibility label="Accessibility" href="accessibility.html"/>
<events label="Events" href="events.html"/>
<extensions label="Extensions" href="extensions.html"/>
<fonts label="Fonts" href="fonts.html"/>
<output label="Output Targets" href="output.html"/>
<if label="Intermediate Format" href="intermediate.html"/>
<pdfencryption label="PDF Encryption" href="pdfencryption.html"/>
<pdfa label="PDF/A" href="pdfa.html"/>
<pdfx label="PDF/X" href="pdfx.html"/>
<graphics label="Graphics" href="graphics.html"/>
<fonts label="Fonts" href="fonts.html"/>
<hyphenation label="Hyphenation" href="hyphenation.html"/>
<extensions label="Extensions" href="extensions.html"/>
<if label="Intermediate Format" href="intermediate.html"/>
<metadata label="Metadata" href="metadata.html"/>
<pdfa label="PDF/A" href="pdfa.html"/>
<pdfx label="PDF/X" href="pdfx.html"/>
<pdfencryption label="PDF Encryption" href="pdfencryption.html"/>
</features>
</trunk>
<!--
END Version 0.95 documentation tab
END Version 1.0 documentation tab
-->
<!--
BEGIN Version 1.0 documentation tab
BEGIN Version 1.1rc1 documentation tab
-->
<trunk label="Apache™ FOP 1.0" href="1.0/" tab="stableversion">
<trunk label="Apache™ FOP 1.1rc1" href="1.1rc1/" tab="stableversion">
<about label="About" href="index.html"/>
<release label="Release Notes" href="releaseNotes_1.0.html"/>
<changes label="Changes (1.0)" href="changes_1.0.html"/>
<release label="Release Notes" href="releaseNotes_1.1rc1.html"/>
<changes label="Changes (1.1rc1)" href="changes_1.1rc1.html"/>
<knownissues label="Known Issues" href="knownissues_overview.html"/>
<upgrading label="Upgrading" href="upgrading.html"/>
<using label="Using Apache™ FOP">
<ant label="Ant Task" href="anttask.html"/>
<build label="Build" href="compiling.html"/>
<config label="Configure" href="configuration.html"/>
<run label="Run" href="running.html"/>
<embed label="Embed" href="embedding.html"/>
<run label="Run" href="running.html"/>
<servlet label="Servlets" href="servlets.html"/>
<ant label="Ant Task" href="anttask.html"/>
</using>

<features label="Features">
<output label="Output Targets" href="output.html"/>
<if label="Intermediate Format" href="intermediate.html"/>
<pdfencryption label="PDF Encryption" href="pdfencryption.html"/>
<pdfa label="PDF/A" href="pdfa.html"/>
<pdfx label="PDF/X" href="pdfx.html"/>
<graphics label="Graphics" href="graphics.html"/>
<accessibility label="Accessibility" href="accessibility.html"/>
<complexscripts label="Complex Scripts" href="complexscripts.html"/>
<events label="Events" href="events.html"/>
<extensions label="Extensions" href="extensions.html"/>
<fonts label="Fonts" href="fonts.html"/>
<graphics label="Graphics" href="graphics.html"/>
<hyphenation label="Hyphenation" href="hyphenation.html"/>
<extensions label="Extensions" href="extensions.html"/>
<events label="Events" href="events.html"/>
<if label="Intermediate Format" href="intermediate.html"/>
<metadata label="Metadata" href="metadata.html"/>
<accessibility label="Accessibility" href="accessibility.html"/>
<output label="Output Targets" href="output.html"/>
<pdfa label="PDF/A" href="pdfa.html"/>
<pdfx label="PDF/X" href="pdfx.html"/>
<pdfencryption label="PDF Encryption" href="pdfencryption.html"/>
</features>
</trunk>
<!--
END Version 1.0 documentation tab
END Version 1.1rc1 documentation tab
-->

<!--
@@ -143,20 +141,14 @@
<upgrading label="Upgrading" href="upgrading.html"/>
<using label="Using Apache™ FOP">
<ant label="Ant Task" href="anttask.html"/>
<build label="Build" href="compiling.html"/>
<config label="Configure" href="configuration.html"/>
<run label="Run" href="running.html"/>
<embed label="Embed" href="embedding.html"/>
<run label="Run" href="running.html"/>
<servlet label="Servlets" href="servlets.html"/>
<ant label="Ant Task" href="anttask.html"/>
</using>

<!--
NOTA BENE NOTA BENE NOTA BENE
The following features should be maintained in alphabetic order by
(displayed) label value.
NOTA BENE NOTA BENE NOTA BENE
-->
<features label="Features">
<accessibility label="Accessibility" href="accessibility.html"/>
<complexscripts label="Complex Scripts" href="complexscripts.html"/>

+ 17
- 13
src/documentation/content/xdocs/status.xml View File

@@ -27,23 +27,27 @@
<body>
<section>
<title>Status</title>
<p>[last updated 5 July 2010]</p>
<p>Last updated 02 July 2012.</p>
<p>
Apache™ FOP version 0.95 was released on 5 August 2008. Apache™ FOP version 1.0 was released on 21 July 2010.
Apache™ FOP version 1.1rc1 (candidate) was released on 02 July 2012.
</p>
</section>
<section>
<title>Development Status</title>

<p>The FOP code base is gradually evolving, from version 0.90
released on 22 November 2005, to version 1.0 released on 21 July
2010. Further releases in the 1.x series may be expected.</p>
<p>FOP releases before version 0.90 were based on a different
code base. The last release in that series was version 0.20.5,
released on 18 July 2003. This series is no longer maintained.</p>
<p>
If you're looking for a long-term road-map we have to disappoint you. This is Open
Source and we're mostly volunteers working in their free time. What we have
The FOP code base is gradually evolving, from Version 0.90,
released on 22 November 2005, to Version 1.1, expected to be released during
the Summer of 2012. Further releases in the 1.x series and beyond are expected.
</p>
<p>
FOP releases prior to version 0.90 were based on a different
code base. The last release in that series was version 0.20.5,
released on 18 July 2003. This earlier series is no longer maintained.
</p>
<p>
If you are looking for future release dates, keep in mind that FOP is an Open
Source project and we're a combination of volunteers (working in our free time) and
sponsored contributors (generally focusing on our sponsor's needs). What we have
is an idea where we want to go. How fast we get there depends on the
available time, on how well our ideas work out while developing and on you!
There's a <a href="http://wiki.apache.org/xmlgraphics-fop/RoadMap">document in the Wiki</a>
@@ -82,11 +86,11 @@
</tr>
<tr>
<td>PDF (Library and Renderer)</td>
<td>stable (SVG: stable)</td>
<td>stable</td>
</tr>
<tr>
<td>PostScript</td>
<td>stable (SVG: stable with restrictions)</td>
<td>stable</td>
</tr>
<tr>
<td>Java2D, AWT, Bitmap Renderers</td>

+ 1
- 1
src/documentation/content/xdocs/tabs.xml View File

@@ -21,8 +21,8 @@

<tabs software="FOP" title="FOP" copyright="@year@ The Apache Software Foundation" xmlns:xlink="http://www.w3.org/1999/xlink">
<tab label="Home" dir=""/>
<tab label="Version 0.95" dir="0.95/"/>
<tab label="Version 1.0" dir="1.0/"/>
<tab label="Version 1.1rc1" dir="1.1rc1/"/>
<tab label="FOP Trunk" dir="trunk/"/>
<tab label="Development" dir="dev/"/>
</tabs>

+ 1
- 1
src/documentation/content/xdocs/team.xml View File

@@ -44,7 +44,7 @@
is an XP/Agile practitioner with interests in open source content management and electronic
document generation. He is a UK expat now residing in Singapore.</li>
<li id="ad"><link href="mailto:adelmelle@apache.org">Andreas Delmelle</link> (AD)</li>
<li id="pjfh"> <a href="mailto:phancock.at.apache.org">Peter Hancock</a>
<li id="pjfh"> <link href="mailto:phancock.at.apache.org">Peter Hancock</link>
(PH) is a Java developer from England.</li>
<li id="vh"><link href="mailto:vhennebert@apache.org">Vincent Hennebert</link>
(VH), a Java developer from France; with an interest in typography, and in using

+ 6
- 0
src/documentation/resources/stylesheets/known-issues2document.xsl View File

@@ -46,4 +46,10 @@
</li>
</xsl:template>
<xsl:template match="@*|*|text()|processing-instruction()|comment()">
<xsl:copy>
<xsl:apply-templates select="@*|*|text()|processing-instruction()|comment()"/>
</xsl:copy>
</xsl:template>

</xsl:stylesheet>

+ 0
- 1
src/java/org/apache/fop/afp/AFPGraphics2D.java View File

@@ -26,7 +26,6 @@ import java.awt.Dimension;
import java.awt.Font;
import java.awt.FontMetrics;
import java.awt.Graphics;
import java.awt.Graphics2D;
import java.awt.GraphicsConfiguration;
import java.awt.Image;
import java.awt.Paint;

+ 74
- 70
status.xml View File

@@ -16,8 +16,7 @@
limitations under the License.
-->
<!-- $Id$ -->
<!DOCTYPE status PUBLIC "-//APACHE//DTD Status V1.3//EN"
"http://forrest.apache.org/dtd/status-v13.dtd">
<!DOCTYPE status PUBLIC "-//APACHE//DTD Status V1.3//EN" "http://forrest.apache.org/dtd/status-v13.dtd">
<status>

<developers>
@@ -80,6 +79,8 @@
When restarting layout for the last page, discard glues and penalties at the beginning of
the restarted Knuth sequence.
</action>
</release>
<release version="1.1rc1" date="02 July 2012">
<action context="Test" dev="GA" type="fix">
Fix errors and warnings in example files. Add build.xml for documentation examples.
</action>
@@ -104,7 +105,7 @@
<action context="Images" dev="GA" type="update" fixes-bug="40676" due-to="Luis Bernardo">
Fix newly introduced findbugs warnings.
</action>
<action context="Images" dev="GA" type="fix" fixes-bug="40676" due-to="Luis Bernardo, Matthias Reischenbacher">
<action context="Images" dev="GA" type="fix" fixes-bug="40676" due-to="Luis Bernardo, Matthias Reischenbacher" importance="high">
Support use of ImageLoaderRawPNG decoder in order to prevent re-encoding of PNG images (and unnecssary output file bloat).
</action>
<action context="Code" dev="GA" type="fix" fixes-bug="53412" due-to="Alexios Giotis">
@@ -122,7 +123,7 @@
<action context="Renderers" dev="GA" type="fix" fixes-bug="53304,53306">
Add version attribute to AT and IF intermediate formats. Also eliminate redundant use of reversed attribute in AT format.
</action>
<action context="Renderers" dev="GA" type="fix" fixes-bug="53295" due-to="Luis Bernardo">
<action context="Renderers" dev="GA" type="fix" fixes-bug="53295" due-to="Luis Bernardo" importance="high">
Add extension to place code just before PostScript %PageTrailer.
</action>
<action context="Renderers" dev="GA" type="fix" fixes-bug="53294" due-to="Robert Meyer">
@@ -158,13 +159,14 @@
<action context="Layout" dev="GA" type="fix" fixes-bug="53185" due-to="Robert Meyer">
Unify date formatting between FOP and XGC as well as tidying the date format code.
</action>
<action context="Layout" dev="GA" type="fix" fixes-bug="45715" due-to="Luis Bernardo">
Break before (break-before) not respected on blocks nested in inlines.
<action context="Layout" dev="GA" type="fix" fixes-bug="45715" due-to="Luis Bernardo" importance="high">
Fix for break before (break-before) not respected on blocks nested in inlines.
</action>
<action context="Renderers" dev="GA" type="fix" fixes-bug="48723" due-to="Robert Meyer">
Fix for XGC when rendering PostScript using SVG being drawn upside down when using a custom affine transform.
</action>
<action context="Code" dev="GA" type="fix" fixes-bug="43940" due-to="Julien Aymé, Ognjen Blagojevic">
<!-- the following is also due to Julien Aymé, but due to a bug in forrest is not included here to prevent duplicate listing in contributors list -->
<action context="Code" dev="GA" type="fix" fixes-bug="43940" due-to="Ognjen Blagojevic">
Use new double format utility to improve thread safety and performance.
</action>
<action context="Fonts" dev="GA" type="fix" fixes-bug="53148" due-to="Tassos Charoulis">
@@ -205,16 +207,16 @@
<action context="Code" dev="GA" type="update" fixes-bug="51617">
Add run target for embedded examples. Add increased JVM memory heap flag for example8 in case font cache is rebuilt.
</action>
<action context="Code" dev="GA" type="fix" fixes-bug="53083">
Update to use of checkstyle-5.5 as default configuration. Remove checkstyle-4.0 configuration. Also, import environment build properties before local properties, so that latter can refer to former.'
<action context="Code" dev="GA" type="fix" fixes-bug="53083" importance="high">
Update to use of checkstyle-5.5 as default configuration. Remove checkstyle-4.0 configuration. Also, import environment build properties before local properties, so that latter can refer to former.
</action>
<action context="Code" dev="GA" type="fix" fixes-bug="52572" due-to="Pascal Sancho">
Prevent NPE on use of unsupported collapse-with-precedence; fall back to collapse. Fix checkstyle errors from prior commit.
</action>
<action context="Layout" dev="GA" type="fix" fixes-bug="52514" due-to="Luis Bernardo">
<action context="Layout" dev="GA" type="fix" fixes-bug="52514" due-to="Luis Bernardo" importance="high">
Ensure square image is appropriately scaled.
</action>
<action context="Code" dev="GA" type="fix" fixes-bug="50062">
<action context="Code" dev="GA" type="fix" fixes-bug="50062" importance="high">
Invoke JVM in headless mode from FOP command scripts and JS shell to prevent stealing focus from GUI applications.
</action>
<action context="Renderers" dev="GA" type="fix" fixes-bug="52114">
@@ -223,7 +225,7 @@
<action context="Code" dev="PH" type="add" fixes-bug="49893">
A global setting to wrap F11 images in page segments.
</action>
<action context="Code" dev="GA" type="fix" fixes-bug="52763">
<action context="Code" dev="GA" type="fix" fixes-bug="52763" importance="high">
Support list-block in marker, thus preventing NPE.
</action>
<action context="Code" dev="GA" type="fix">
@@ -243,7 +245,7 @@
<action context="Code" dev="GA" type="fix" fixes-bug="52966" due-to="Luis Bernardo">
How to use native text with EPSDocumentGraphics2D.
</action>
<action context="Code" dev="GA" type="fix" fixes-bug="51599" due-to="Paul Huemer">
<action context="Code" dev="GA" type="fix" fixes-bug="51599" due-to="Paul Huemer" importance="high">
Allow https scheme URI for PDF external action target.
</action>
<action context="Code" dev="GA" type="fix" fixes-bug="50901" due-to="Carsten Pfeiffer">
@@ -264,10 +266,10 @@
<action context="Code" dev="GA" type="fix" fixes-bug="47380" due-to="Georg Datterl">
Specified rule-thickness applies only when leader-pattern is rule, otherwise should use default thickness.
</action>
<action context="Code" dev="GA" type="fix" fixes-bug="49302" due-to="Julien Aymé">
<action context="Code" dev="GA" type="fix" fixes-bug="49302" due-to="Julien Aym&#x00E9;">
Eliminate duplicate code.
</action>
<action context="Code" dev="GA" type="fix" fixes-bug="49350" due-to="Julien Aymé">
<action context="Code" dev="GA" type="fix" fixes-bug="49350" due-to="Julien Aym&#x00E9;">
Correct coding error in AFPResourceLevel#equals.
</action>
<action context="Code" dev="GA" type="fix" fixes-bug="51836" due-to="Melanie Drake">
@@ -279,10 +281,11 @@
<action context="Code" dev="GA" type="fix" fixes-bug="51807" due-to="Sergey Vladimirov">
Fixed small memory waste in rowCells array construction.
</action>
<action context="Code" dev="GA" type="fix" fixes-bug="53005" due-to="Alberto Simões">
<action context="Code" dev="GA" type="fix" fixes-bug="53005" due-to="Alberto Simões" importance="high">
Fixed incorrect rejection of fo:wrapper inside fo:inline inside fo:footnote-body.
</action>
<action context="Code" dev="PH,VH" type="add">
<!-- the following is also due to Vincent Hennebert, but due to a bug in forrest is not included here to prevent duplicate listing in contributors list -->
<action context="Code" dev="VH" type="add" importance="high" due-to="Peter Hancock">
Added support for PDF Object Streams. When accessibility is enabled and PDF version 1.5
selected, the structure tree will be stored in object streams in order to reduce the size of
the final PDF.
@@ -290,31 +293,32 @@
<action context="Code" dev="VH" type="fix" fixes-bug="46962" due-to="Alexios Giotis">
Fixed deadlock in PropertyCache.
</action>
<action context="Code" dev="VH" type="add" fixes-bug="51385" due-to="Mehdi Houshmand">
<action context="Config" dev="VH" type="add" fixes-bug="51385" due-to="Mehdi Houshmand" importance="high">
Added configuration option to set the version of the output PDF document.
</action>
<action context="Code" dev="MH" type="fix" fixes-bug="52849" due-to="Luis Bernardo">
Fixed bug that caused a configured and installed SVG font to stroked,
<action context="Code" dev="MH" type="fix" fixes-bug="52849" due-to="Luis Bernardo" importance="high">
Fixed bug that caused a configured and installed SVG font to be stroked,
also added an event indicating when fonts are stroked.
</action>
<action context="Code" dev="PH" type="fix">
Fix of a bug introduced when merging ImproveAccessibility.
</action>
<action context="Code" dev="PH" type="add">
Improved support for empty flow-name mapping (see bugzilla#50391).
<action context="Code" dev="PH" type="add" fixes-bug="50391" importance="high">
Improved support for empty flow-name mapping.
</action>
<action context="Code" dev="GA" type="add" fixes-bug="32789, 49008, 49687" importance="high">
<action context="Layout" dev="GA" type="add" fixes-bug="32789, 49008, 49687" importance="high">
Add support for complex scripts, including: full bidi support, support for advanced
typographic tables, advanced support for number conversion.
</action>
<action context="Fonts" dev="GA" type="add">
<action context="Fonts" dev="GA" type="add" importance="high">
Add support for OpenType advanced typographic tables (GDEF, GSUB, GPOS).
</action>
<action context="Code" dev="VH" type="fix" fixes-bug="52655" due-to="Luis Bernardo">
Fixed rendering of special glyphs when using single-byte encoding mode.
</action>
<action context="Code" dev="PH" type="add" due-to="VH and PH">
Improvements of the Accessibility feature
<!-- the following is also due to Peter Hancock, but due to a bug in forrest is not included here to prevent duplicate listing in contributors list -->
<action context="Code" dev="PH" type="add" due-to="Vincent Hennebert">
Improvements of the Accessibility features.
</action>
<action context="Code" dev="CB" type="add" fixes-bug="52416" due-to="Luis Bernardo">
Suppress unnecessary "font not found warnings" when generating AFP with raster fonts
@@ -322,7 +326,7 @@
<action context="Code" dev="CB" type="add" fixes-bug="51209" due-to="Luis Bernardo">
SVG text in AFP creates miscoded GOCA text
</action>
<action context="Code" dev="CB" type="add" fixes-bug="50391" due-to="Peter Hancock">
<action context="Code" dev="CB" type="add" fixes-bug="50391" due-to="Peter Hancock" importance="high">
Add support for different flow-name of fo:region-body in FOP
</action>
<action context="Code" dev="CB" type="add" fixes-bug="51664" due-to="Mehdi Houshmand">
@@ -338,7 +342,7 @@
Added to build file JUnit target that uses a regex to run all of the test cases. This
reduces the risk that some of them are omitted when building FOP.
</action>
<action context="Code" dev="PH" type="add" fixes-bug="52089" due-to="JM, Mehdi Houshmand">
<action context="Code" dev="PH" type="add" fixes-bug="52089" due-to="Mehdi Houshmand" importance="high">
Allow JPEG images to be embedded in an AFP document as is, without being decoded and
encoded.
</action>
@@ -348,18 +352,18 @@
<action context="Renderers" dev="JM" type="add">
Various bugfixes to make PDFDocumentGraphics2D operational again.
</action>
<action context="Code" dev="PH" type="add" fixes-bug="51962" due-to="Mehdi Houshmand">
Bugfix for when the last simple-page-master referenced in a page-sequence-master is not
<action context="Code" dev="PH" type="add" fixes-bug="51962" due-to="Mehdi Houshmand" importance="high">
Fix for when the last simple-page-master referenced in a page-sequence-master is not
chosen when force-page-count=odd.
</action>
<action context="Code" dev="VH" type="add" fixes-bug="51928" due-to="Mehdi Houshmand">
<action context="Code" dev="VH" type="add" fixes-bug="51928" due-to="Mehdi Houshmand" importance="high">
Upgraded all tests to JUnit 4.
</action>
<action context="Fonts" dev="PH" type="fix" fixes-bug="48696">
Bugfix for color model in IOCA IDE structure parameter for 4- and 8-bit grayscale images.
Revision 4.
</action>
<action context="Fonts" dev="PH" type="fix" fixes-bug="51760" due-to="Mehdi Houshmand">
<action context="Fonts" dev="PH" type="fix" fixes-bug="51760" due-to="Mehdi Houshmand" importance="high">
Changes the way PostScript handles Graphics2D images such that if the language is set to
level 3, the image is stored as an embedded file which has no length limit. Previously it
was stored as an array which has a implementation limit of 65535 elements.
@@ -367,7 +371,7 @@
<action context="Fonts" dev="PH" type="fix" fixes-bug="51759" due-to="Mehdi Houshmand">
PDFFactory responsible for asdigning name to a subset font.
</action>
<action context="Fonts" dev="PH" type="fix" fixes-bug="51530" due-to="Mehdi Houshmand">
<action context="Fonts" dev="PH" type="fix" fixes-bug="51530" due-to="Mehdi Houshmand" importance="high">
Improved support for EBCDIC encoded double byte fonts fo AFP.
</action>
<action context="Fonts" dev="PH" type="fix" fixes-bug="51205" due-to="Mehdi Houshmand">
@@ -382,8 +386,8 @@
Fixed a bug in AFP where an ArrayOutofBoundsException is throwqn when embedding a Page
Segment.
</action>
<action context="Renderers" dev="VH" type="add">
Added support for 128bit encryption in PDF output. Based on work by Michael Rubin.
<action context="Renderers" dev="VH" type="add" due-to="Michael Rubin" importance="high">
Added support for 128bit encryption in PDF output.
</action>
<action context="Renderers" dev="PH" type="fix">
Fixed a bug in AFP where the object area axes of an Include Object was incorrectly set when
@@ -399,12 +403,12 @@
<action context="Renderers" dev="JM" type="fix">
Fixed a multi-threading bug for SVG images included through svg:image inside SVG documents.
</action>
<action context="Renderers" dev="PH" type="add">
<action context="Renderers" dev="PH" type="add" importance="high">
Added an IFDocumentHandler filter for triggering rendering events. Created an Event that
captures an end page event with the page number.
</action>
<action context="Renderers" dev="VH" type="fix">
Bugfix: alternative text not working in tagged PDF for TIFF images.
Fix for alternative text not working in tagged PDF for TIFF images.
</action>
<action context="Renderers" dev="PH" type="fix" fixes-bug="50909">
Fixed io exception in MODCAParser caused by the improper use of mark() and reset() on the
@@ -418,18 +422,18 @@
<action context="Renderers" dev="JM" type="fix">
AFP GOCA: fonts were not embedded from within AFPGraphics2D.
</action>
<action context="Renderers" dev="JM" type="fix">
<action context="Renderers" dev="JM" type="fix" importance="high">
AFP GOCA: Changed the way FOP fonts are selected based on Batik's GVT fonts to match
the behaviour of PDF/PS output.
</action>
<action context="Renderers" dev="JM" type="add">
<action context="Renderers" dev="JM" type="add" importance="high">
Added option to place AFP NOPs right before the end of a named page group (page-sequence),
rather than after the start.
</action>
<action context="Renderers" dev="JM" type="add">
<action context="Renderers" dev="JM" type="add" importance="high">
Added option for PostScript output to optimize for file size rather than quality.
</action>
<action context="Renderers" dev="JM" type="add">
<action context="Renderers" dev="JM" type="add" importance="high">
AFP GOCA: Added option to disable GOCA and to control text painting inside GOCA graphics.
</action>
<action context="Renderers" dev="JM" type="fix">
@@ -469,26 +473,26 @@
Bugzilla 50965: Fixed a regression in BlockContainerLayoutManager where margins were
no longer reset after forced breaks.
</action>
<action context="Layout" dev="VH" type="fix" fixex-bug="50763">
<action context="Layout" dev="VH" type="fix" fixex-bug="50763" importance="high">
Implemented non-standard behavior for basic-link areas, such that they take into account the
heights of their descendants areas.
</action>
<action context="Layout" dev="VH" type="fix">
Bugfix: keep-together does not apply to fo:table-cell.
<action context="Layout" dev="VH" type="fix" importance="high">
Fix for keep-together does not apply to fo:table-cell.
</action>
<action context="Layout" dev="VH" type="fix">
Bugfix: keep-together on a table containing row-spanning cells was not honored.
<action context="Layout" dev="VH" type="fix" importance="high">
Fix for keep-together on a table containing row-spanning cells that was not honored.
</action>
<action context="Layout" dev="VH" type="fix" fixes-bug="50196" due-to="Matthias Reischenbacher">
Bugzilla #50196: padding-start ignored when table-header/footer is repeated.
<action context="Layout" dev="VH" type="fix" fixes-bug="50196" due-to="Matthias Reischenbacher" importance="high">
Fix forpadding-start ignored when table-header/footer is repeated.
</action>
<action context="Renderers" dev="JM" type="fix">
<action context="Renderers" dev="JM" type="fix" importance="high">
Increased maximum possible PDF size from 2GB to around 9GB (hard maximum imposed by the PDF specification).
</action>
<action context="Renderers" dev="JM" type="add">
<action context="Renderers" dev="JM" type="add" importance="high">
Added support for CIE Lab colors (from XSL-FO 2.0 WD).
</action>
<action context="Renderers" dev="JM" type="add" fixes-bug="49403" due-to="Patrick Jaromin">
<action context="Renderers" dev="JM" type="add" fixes-bug="49403" due-to="Patrick Jaromin" importance="high">
Initial work on spot colors (aka named colors) for PDF output.
</action>
<action context="Renderers" dev="JM" type="fix" fixes-bug="50705" due-to="Mehdi Houshmand">
@@ -498,39 +502,39 @@
Added support for lookup of alternative glyphs when additional single-byte encodings are
used, ex. replacing "Omegagreek" by "Omega" and vice versa.
</action>
<action context="Code" dev="AD" type="add" fixes-bug="48334">
<action context="Code" dev="AD" type="add" fixes-bug="48334" importance="high">
Added support for resolution of relative URIs against a specified xml:base during
property refinement.
</action>
<action context="Renderers" dev="JM" type="add">
Allow afp:no-operation to also appear under fo:page-sequence and fo:declarations.
</action>
<action context="Code" dev="AD" type="fix" fixes-bug="50635" due-to="mkoegler.AT.auto.tuwien.ac.at">
Bugfix: fix issue in RenderPagesModel.checkPreparedPages() where the same page-sequence
<action context="Code" dev="AD" type="fix" fixes-bug="50635" due-to="Martin Koegler">
Fix for issue in RenderPagesModel.checkPreparedPages() where the same page-sequence
is potentially started multiple times.
</action>
<action context="Code" dev="AD" type="fix" fixes-bug="50636" due-to="mkoegler.AT.auto.tuwien.ac.at">
Bugfix: fix performance issue when adding pages, if the total number of pages
<action context="Code" dev="AD" type="fix" fixes-bug="50636" due-to="Martin Koegler">
Fix for performance issue when adding pages, if the total number of pages
is significantly large.
</action>
<action context="Code" dev="AD" type="fix" fixes-bug="50626" due-to="mkoegler.AT.auto.tuwien.ac.at">
Bugfix: fix performance issue when adding nodes, if the number of children
<action context="Code" dev="AD" type="fix" fixes-bug="50626" due-to="Martin Koegler">
Fix for performance issue when adding nodes, if the number of children
is significantly large.
</action>
<action context="Config" dev="SP" type="fix">
Bugfix: relative URIs in the configuration file (base, font-base, hyphenation-base) are evaluated relative to the base URI of the configuration file.
Fix for relative URIs in the configuration file (base, font-base, hyphenation-base) are evaluated relative to the base URI of the configuration file.
</action>
<action context="Layout" dev="AD" type="fix" fixes-bug="49848">
Bugfix: correct behavior of keep-together.within-line in case there are nested inlines
<action context="Layout" dev="AD" type="fix" fixes-bug="49848" importance="high">
Fix for correct behavior of keep-together.within-line in case there are nested inlines
</action>
<action context="Code" dev="AD" type="fix" fixes-bug="50471">
Bugfix: avoid ArrayIndexOutOfBoundsException for codepoints without a linebreak class
Fix for avoid ArrayIndexOutOfBoundsException for codepoints without a linebreak class
</action>
<action context="Layout" dev="AD" type="fix" fixes-bug="48380">
Bugfix: avoid ClassCastException when using fox:widow-content-limit
Fix for avoid ClassCastException when using fox:widow-content-limit
</action>
<action context="Layout" dev="VH" type="fix" fixes-bug="50089">
Bugfix: content after forced break in block-container is not rendered.
Fix for content after forced break in block-container is not rendered.
</action>
<action context="Layout" dev="JM" type="fix" fixes-bug="42034">
Fixed adjustment of inline parent area for justified text containing a forward page reference.
@@ -541,13 +545,13 @@
<action context="Code" dev="VH" type="fix" fixes-bug="49695" due-to="Joshua Marquart">
Replaced magic numbers with constants from UnitConv and GraphicsConstants.
</action>
<action context="Renderers" dev="JM" type="add" fixes-bug="42600" due-to="Maximilian Aster">
<action context="Renderers" dev="JM" type="add" fixes-bug="42600" due-to="Max Aster">
Added some support for break-before/-after for RTF output.
</action>
<action context="Renderers" dev="JM" type="add" fixes-bug="49379" due-to="Peter Hancock">
<action context="Renderers" dev="JM" type="add" fixes-bug="49379" due-to="Peter Hancock" importance="high">
Added ability to embed an external AFP page segment resource file (AFP output only).
</action>
<action context="Renderers" dev="JM" type="fix" fixes-bug="46360" due-to="Alexis Giotis">
<action context="Renderers" dev="JM" type="fix" fixes-bug="46360" due-to="Alexios Giotis">
Fixed a multi-threading issue when rendering SVG.
</action>
<action context="Layout" dev="JM" type="fix" fixes-bug="49885">
@@ -557,10 +561,10 @@
Removed old Renderer implementations for those output formats that have a version based on
the new DocumentHandler architecture available (AFP, PCL, PDF, PS).
</action>
<action context="Fonts" dev="AC" type="fix">
<action context="Fonts" dev="AC" type="fix" importance="high">
Reinstated support for being able to specify a font cache filepath in the fop user configuration.
</action>
<action context="Fonts" dev="AC" type="add">
<action context="Fonts" dev="AC" type="add" importance="high">
Added convenience support for the flushing of the Fop font cache file from the command line.
</action>
<action context="Renderers" dev="JM" type="add" fixes-bug="44460" due-to="Andrejus Chaliapinas">
@@ -1900,7 +1904,7 @@
Bugfix: NullPointerException in RTF output when a table does not contain
table-columns.
</action>
<action context="Code" dev="JM" type="fix" fixes-bug="39607" due-to="Julien Aymé">
<action context="Code" dev="JM" type="fix" fixes-bug="39607" due-to="Julien Aym&#x00E9;">
Bugfix: NullPointerException in RTF library when there are no borders on
the parent table.
</action>

Loading…
Cancel
Save