You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xmlgraphics.apache.org by vh...@apache.org on 2014/07/24 18:21:24 UTC
svn commit: r1613173 [12/15] - in /xmlgraphics/site/trunk/content: ./ batik/
batik/dev/ batik/tools/ batik/using/ batik/using/scripting/ commons/ fop/
fop/0.95/ fop/1.0/ fop/1.1/ fop/dev/ fop/dev/design/ fop/trunk/
Modified: xmlgraphics/site/trunk/content/fop/dev/faq.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/dev/faq.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/dev/faq.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/dev/faq.mdtext Thu Jul 24 16:21:20 2014
@@ -3,9 +3,9 @@ Title: Apache(tm) FOP Development: FAQ
#Apache™ FOP Development: FAQ
-## 1. General Questions {#part_general}
+## 1. General Questions { #part_general}
-### 1.1. How can I contribute? {#faq-N1000D}
+### 1.1. How can I contribute? { #faq-N1000D}
There are many ways that you can help:
@@ -18,18 +18,18 @@ There are many ways that you can help:
- You can help us document FOP better.
-## 2. Documentation {#part_documentation}
+## 2. Documentation { #part_documentation}
-### 2.1. How do I get the javadocs for FOP? {#javadoc_location}
+### 2.1. How do I get the javadocs for FOP? { #javadoc_location}
Currently, the only way to get FOP javadocs is to [Download the source code](../download.html) and then [Build FOP](../trunk/compiling.html) using the ant build task "javadocs".
-### 2.2. Where can I learn how the FOP docs and web site are built? {#doc-mgt}
+### 2.2. Where can I learn how the FOP docs and web site are built? { #doc-mgt}
See FOP [Doc Management](doc.html). ;-)
-## 3. Further Help {#part_further_help}
+## 3. Further Help { #part_further_help}
-### 3.1. I don't see my question addressed here. Are there other FAQs? {#other_faqs}
+### 3.1. I don't see my question addressed here. Are there other FAQs? { #other_faqs}
Yes. See also the [FOP General FAQs](../faq.html).
Modified: xmlgraphics/site/trunk/content/fop/dev/implement.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/dev/implement.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/dev/implement.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/dev/implement.mdtext Thu Jul 24 16:21:20 2014
@@ -5,11 +5,11 @@ Title: Apache(tm) FOP Development: Imple
The purpose of this document is to tie together the Apache™ FOP design (interface) with some of the key points where control is passed within FOP (implementation), so that developers can quickly find the section of code that is relevant to their needs. The process described is for a "typical" command-line document. All classes are in org.apache.fop unless otherwise designated.
-## Overview {#Overview}
+## Overview { #Overview}
The input FO document is sent to the FO tree builder via SAX events. Fragments of an FO Tree are built from this process. As each page-sequence element is completed, it is passed to a layout processor, which in turn converts it into an Area Tree. The Area Tree is then given to the Renderer, which converts it into a stream of data containing the output document. The sections below will provide additional details. Where needed differences between the trunk and maintenance branches are shown in tabular format.
-## Startup {#Startup}
+## Startup { #Startup}
- The job starts in *apps.Fop.main()*.
@@ -18,7 +18,7 @@ The input FO document is sent to the FO
- Control is passed to *apps.Driver.render()*. This class fires up a SAX parser, the events from which indirectly control the remaining processing, including building the FO Tree, building the Area Tree, rendering, output and logging.
-## Formatting Object Tree {#Formatting-Object-Tree}
+## Formatting Object Tree { #Formatting-Object-Tree}
| Trunk | Maintenance |
|-------|-------------|
@@ -28,17 +28,17 @@ The input FO document is sent to the FO
| . | `fo.pagination.PageSequence.makePage()` creates a BodyArea and passes it to *fo.Flow.layout* |
| . | the layout process is then driven from `fo.pagination.PageSequence.format()`. |
-## Layout {#Layout}
+## Layout { #Layout}
There are layout managers for each type of layout decision. They take an FO Tree as input and build a laid-out Area Tree from it. The layout process involves finding out where line breaks and page breaks should be made, then creating the areas on the page. Static areas can then be added for any static regions. As pages are completed, they are added to the Area Tree.
-## Area Tree {#Area-Tree}
+## Area Tree { #Area-Tree}
The area tree is a data structure designed to hold the page areas. These pages are then filled with the page regions and various areas. The area tree is used primarily as a minimal structure that can be rendered by the renderers.
The area tree is supported by an area tree model. This model handles the adding of pages to the area tree. It also handles page sequence starts, document level extensions, id references and unresolved id areas. This model allows the pages to be handled directly by a renderer or to store the pages for later use.
-## Rendering {#Rendering}
+## Rendering { #Rendering}
The renderer receives pages from the area tree and renders those pages. If a renderer supports out of order rendering then it will either render or prepare a page in the correct order. Otherwise the pages are rendered in order. The task of the renderer is to take the pages and output them to the requested type. In the case of the AWTRenderer it needs to be able to view any page.
Modified: xmlgraphics/site/trunk/content/fop/dev/index.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/dev/index.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/dev/index.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/dev/index.mdtext Thu Jul 24 16:21:20 2014
@@ -3,25 +3,25 @@ Title: Apache(tm) FOP Development: Gener
#Apache™ FOP Development: General Information
-## Introduction {#intro}
+## Introduction { #intro}
These pages contain information that should be helpful for those developing Apache™ FOP. This certainly includes programmers, but may also include those contributing to the project in other ways.
For basic and user information on FOP, please visit the [Apache™ FOP homepage](http://xml.apache.org/fop).
-## Development {#lines}
+## Development { #lines}
The main development happens on "FOP Trunk".
<note>The SVN repository URL for the trunk is:<br/>`http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/`</note>
-## Getting Involved {#involved}
+## Getting Involved { #involved}
-### Understand Apache Roles {#apache-roles}
+### Understand Apache Roles { #apache-roles}
Review the [Apache Project Roles and Responsibilities](http://xml.apache.org/roles.html) document for an understanding of the various roles of contributors within the community.
-### How you can help {#fop-tasks}
+### How you can help { #fop-tasks}
There are many different ways that you can help with FOP development. The following is a non-exhaustive list of ways that *non-programmers* can help. Remember that an hour spent on the tasks below is an hour that a programmer can devote to fixing bugs or adding features instead:
@@ -49,13 +49,13 @@ Of course, we're glad to have programmer
- Implementing new features.
-### Understand FOP-related standards {#fop-standards}
+### Understand FOP-related standards { #fop-standards}
At the moment FOP is mainly a tool to render XSL-FO files to pdf. Therefore if you want to contribute to FOP you should become familiar with these standards. You can find links at [Specifications](../resources.html#specs).
-### Review the Developer Documentation {#doc}
+### Review the Developer Documentation { #doc}
-### Understand FOP's Design {#design}
+### Understand FOP's Design { #design}
The design for FOP is specified under the [Design](design/index.html) section. This is where the information on how FOP is developed and designed internally will be kept.
@@ -63,7 +63,7 @@ Another place where we write design docu
<note>Our design documentation may not always be up to date!</note>
-### Subscribe to the fop-dev Mailing List {#mail-fop-dev}
+### Subscribe to the fop-dev Mailing List { #mail-fop-dev}
Use this forum to discuss topics related to FOP development, including patch submissions, bug reports, and design issues. Please *do not* use it for XML support, XSLT support, XSL-FO support, or even FOP support. Appropriate mailing lists for these topics can be found on the [FOP Mailing List](../maillist.html) page.
@@ -97,7 +97,7 @@ Use this forum to discuss topics related
- To unsubscribe: Send email to [fop-dev-unsubscribe@xmlgraphics.apache.org](mailto:fop-dev-unsubscribe@xmlgraphics.apache.org).
-### Subscribe to the fop-commits Mailing List {#mail-fop-cvs}
+### Subscribe to the fop-commits Mailing List { #mail-fop-cvs}
When changes are committed to the code repository, a record of the diffs is emailed to the fop-cvs mailing list. FOP developers are encouraged to subscribe to this list because it helps in following the progress of the project.
@@ -119,11 +119,11 @@ When changes are committed to the code r
- Subscribe by sending an email to [fop-commits-subscribe@xmlgraphics.apache.org](mailto:fop-commits-subscribe@xmlgraphics.apache.org).
-### Download and Use the Developers' Code Using Subversion {#dev-code}
+### Download and Use the Developers' Code Using Subversion { #dev-code}
Between releases the newest code can be accessed via SVN. To do this you need to install a SVN client on your computer, if it is not already there. An explanation how to connect to the FOP source repository can be found at [http://xmlgraphics.apache.org/repo.html](http://xmlgraphics.apache.org/repo.html). More information can be found on the [Tools page](tools.html).
-### Submitting Patches {#patches}
+### Submitting Patches { #patches}
If you have useful changes to source code (bugfixes or enhancements), test files, or documentation that you would like to contribute to the project, please do the following:
Modified: xmlgraphics/site/trunk/content/fop/dev/release.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/dev/release.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/dev/release.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/dev/release.mdtext Thu Jul 24 16:21:20 2014
@@ -3,13 +3,13 @@ Title: Apache(tm) FOP Development: Relea
#Apache™ FOP Development: Release Process
-## Introduction {#intro}
+## Introduction { #intro}
This page documents the process of creating a Apache™ FOP release. FOP releases are coordinated by some designated member of the team. The purpose of documenting it here is to facilitate consistency, ensure that the process is captured, and to allow others to comment on the process.
The checklist below is based on a combination of input from from Christian Geisert and Simon Pepping.
-## 1. Define the new release {#define}
+## 1. Define the new release { #define}
- Determine which open bugs must be solved before a release can take place (release critical bugs). Make this bug depend on each release critical bug and write a short argument why the bug is release critical.
@@ -19,7 +19,7 @@ The checklist below is based on a combin
- Commit any outstanding changes
-## 2. Prepare the new release {#prepare}
+## 2. Prepare the new release { #prepare}
- Create a branch called `branches/fop-v_vv`
@@ -47,7 +47,7 @@ The checklist below is based on a combin
- Create signatures. Don't forget to upload your KEY: `gpg -a -b --force-v3-sigs fop-1.0-src.tar.gz` etc.
-## 3. Publish the new release {#publish}
+## 3. Publish the new release { #publish}
- Upload the dist and signature files to your web directory on people.apache.org (An account on minotaur is needed): `scp fop-1.0*.tar.gz* chrisg@people.apache.org:public_html/`
@@ -57,7 +57,7 @@ The checklist below is based on a combin
- Make a test download.
-## 4. Vote for the new release {#vote}
+## 4. Vote for the new release { #vote}
- Start a vote for the release on `general@xmlgraphics.apache.org`. The message should point to the release files and list the MD5 sums (`cat *.md5`). The vote should remain open for 72hrs.
@@ -67,13 +67,13 @@ The checklist below is based on a combin
- Wait 24 hours (for the mirrors to catch up).
-## 5. Update material {#update}
+## 5. Update material { #update}
-### 5.1 Subversion {#svn}
+### 5.1 Subversion { #svn}
- Merge the changes of the subversion release branch back into trunk (not the version number in the build file) and delete the branch.
-### 5.2 Jira {#jira}
+### 5.2 Jira { #jira}
- Ask an FOP Jira admin to
- rename trunk entry into the new release name,
@@ -83,7 +83,7 @@ The checklist below is based on a combin
- create an issue at [Jira-INFRA](https://issues.apache.org/jira/browse/INFRA).
-### 5.3 CMS {#cms}
+### 5.3 CMS { #cms}
- Copy trunk directory to a new release directory with the new version number.
@@ -110,11 +110,11 @@ The checklist below is based on a combin
- Publish the updated documentation to the FOP website.
-### 5.4 Maven {#maven}
+### 5.4 Maven { #maven}
- Deploy the maven bundle.
-## 6. Announce the new release {#announce}
+## 6. Announce the new release { #announce}
Post announcements on following suggested lists:
@@ -132,7 +132,7 @@ Post announcements on following suggeste
- http://www.w3.org/Style/XSL/
- http://freshmeat.net/projects/fop/
-## Resources {#resources}
+## Resources { #resources}
The following is a sample of some other project release checklists, which might be consulted for ideas:
Modified: xmlgraphics/site/trunk/content/fop/dev/rtflib.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/dev/rtflib.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/dev/rtflib.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/dev/rtflib.mdtext Thu Jul 24 16:21:20 2014
@@ -3,9 +3,9 @@ Title: Apache(tm) FOP Development: RTFLi
#Apache™ FOP Development: RTFLib (jfor)
-## General Information {#general}
+## General Information { #general}
-### Introduction {#intro}
+### Introduction { #intro}
The RTFLib package is an open-source, *independent* package suitable for writing RTF files in a java environment. By *independent* we mean:
@@ -16,17 +16,17 @@ The RTFLib package is an open-source, *i
The FOP development team intends to keep the RTFLib package independent so that it can be used for other purposes.
-### History {#history}
+### History { #history}
RTFLib was originally developed by [Bertrand Delacrétaz](mailto:bdelacretaz@apache.org) and the [jfor](http://www.jfor.org) team. jfor was written under an Apache-style license, and the jfor team contributed the code to the Apache Software Foundation in June, 2003. RTFLib is a subset of the original jfor project, which also includes an XSL-FO parsing mechanism for a complete XSL-FO to RTF solution.
-### Status {#status}
+### Status { #status}
Although FOP's implementation of the RTFLib package is very incomplete, the RTFLib package itself is relatively mature. RTFLib is only available in the trunk [line of FOP development](index.html#lines).
<warning>This documentation is a work in progress. If you see errors or omissions, please report them to the [fop-dev mailing list](index.html#mail-fop-dev).</warning>
-# User Documentation {#userdoc}
+# User Documentation { #userdoc}
-### Overview {#userdoc-overview}
+### Overview { #userdoc-overview}
Perhaps the easiest way to see how to use RTFLib is by looking at an example. A set of test documents is part of the package, and can be [viewed online](http://cvs.apache.org/viewcvs.cgi/xml-fop/src/java/org/apache/fop/rtf/rtflib/testdocs/). A quick look at the Abstract [TestDocument](http://cvs.apache.org/viewcvs.cgi/xml-fop/src/java/org/apache/fop/rtf/rtflib/testdocs/TestDocument.java?rev=HEAD&content-type=text/vnd.viewcvs-markup) class, and one of the Concrete subclasses, [SimpleDocument](http://cvs.apache.org/viewcvs.cgi/xml-fop/src/java/org/apache/fop/rtf/rtflib/testdocs/SimpleDocument.java?rev=HEAD&content-type=text/vnd.viewcvs-markup) will provide the basics of how to use the package.
@@ -39,7 +39,7 @@ There are two basic concepts you will ne
RTFLib handles the process of converting to and writing the RTF content as the document is created. All you need to do is flush the document at the end to make sure that the last pieces get written.
-### Document Structure {#userdoc-structure}
+### Document Structure { #userdoc-structure}
<warning>This section is very incomplete.</warning>
The documentation in this section is intended to provide a high-level view of the process of building an RTF document. For more detailed API documentation of the various methods, be sure to consult the Javadocs for RTFLib.
@@ -59,24 +59,24 @@ The following table summarizes the vario
| JforCmd | RtfSection.newJforCmd | . | . |
| Text | RtfParagraph.newText() | Character Formatting | N/A |
-### Attributes {#userdoc-attributes}
+### Attributes { #userdoc-attributes}
<warning>This section is very incomplete.</warning>
Attributes can be set for each container and piece of content in the document. The general approach is to build an RtfAttributes object containing the various attributes, then pass that RtfAttributes object to the method that creates the new container or content. See the Javadoc API documentation for RtfAttributes for details on the syntax for creating an RtfAttributes object. The following information lists the various attributes that can be set for each type of container.
-#### Information Group {#userdoc-attr-ig}
+#### Information Group { #userdoc-attr-ig}
These attributes are set when creating a Document.
-#### Document Formatting {#userdoc-attr-df}
+#### Document Formatting { #userdoc-attr-df}
These attributes are set when creating a Document.
-#### Section Formatting {#userdoc-attr-sf}
+#### Section Formatting { #userdoc-attr-sf}
These attributes are set when creating a Section.
-#### Paragraph Formatting {#userdoc-attr-pf}
+#### Paragraph Formatting { #userdoc-attr-pf}
These attributes are set when creating a Paragraph.
@@ -104,7 +104,7 @@ These attributes are set when creating a
| bottom dotted border | RtfText.BDR_BOTTOM_DOTTED | Boolean? | brdrb\\brsp40\\brdrdot |
| bottom dashed border | RtfText.BDR_BOTTOM_DASH | Boolean? | brdrb\\brsp40\\brdrdash |
-#### Character Formatting {#userdoc-attr-cf}
+#### Character Formatting { #userdoc-attr-cf}
These attributes are set when creating a Paragraph, or Text.
Modified: xmlgraphics/site/trunk/content/fop/dev/svg.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/dev/svg.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/dev/svg.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/dev/svg.mdtext Thu Jul 24 16:21:20 2014
@@ -5,7 +5,7 @@ Title: Apache(tm) FOP Development: SVG I
See also [SVG User Documentation](../trunk/graphics.html#svg) for more information.
-## Examples {#Examples}
+## Examples { #Examples}
These examples illustrate a number of issues relating to conversion to PDF:
@@ -25,11 +25,11 @@ As can be seen most of the specific issu
|--|---------|------------|
| embedding svg | [embedding.fo](fo/embedding.fo) | [embedding.fo.pdf](fo/embedding.fo.pdf) |
-## Developer Notes {#Developer-Notes}
+## Developer Notes { #Developer-Notes}
For most output formats in FOP the SVG is simply drawn into an image with Batik. For PDF there are a set of classes to handle drawing the [GVT (Graphic Vector Toolkit)](http://xml.apache.org/batik/architecture.html) into PDF markup.
-### Classes {#Classes}
+### Classes { #Classes}
These are the relevant classes, found in the package org.apache.fop.svg:
@@ -46,6 +46,6 @@ These are the relevant classes, found in
used by Batik to transcode an svg document into a standalone pdf, via PDFDocumentGraphics2D.
-### Ideas {#Ideas}
+### Ideas { #Ideas}
Batik can convert ttf to svg font. This svg font could be converted into a pdf stroked font (type 3 font).
Modified: xmlgraphics/site/trunk/content/fop/dev/testing.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/dev/testing.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/dev/testing.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/dev/testing.mdtext Thu Jul 24 16:21:20 2014
@@ -3,7 +3,7 @@ Title: Apache(tm) FOP Development: Testi
#Apache™ FOP Development: Testing
-## "Build" Testing {#build}
+## "Build" Testing { #build}
Apache™ projects use an automated build tool called "gump" to create nightly builds from the SVN repository. Gump sends "nag" messages if the build fails. This can be considered a sort of basic test of the build process. To view the most recent logs of the gump builds:
@@ -12,17 +12,17 @@ Apache™ projects use an automated
- [Gump build for the Maintenance Branch](http://gump.cocoondev.org/xml-fop-maintenance.html)
-## Basic/API Testing {#basic}
+## Basic/API Testing { #basic}
There is a group of basic API tests that are included in the build process. For these tests to occur, JUnit must be available to Ant (simply copy junit.jar into Ant's lib directory). The build will then report error(s) if the high-level APIs for Driver and the Transcoders fail. The tests do not check the output, but only ensure that something is generated and without exceptions.
-## Layout Engine Testing {#layoutengine}
+## Layout Engine Testing { #layoutengine}
The [http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/test/layoutengine/](http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/test/layoutengine/) directory in the repository contains a test suite for checking the functionality of Apache™ FOP's layout engine. For information on how to create test cases for the layout engine, please visit the [Wiki page](http://wiki.apache.org/xmlgraphics-fop/HowToCreateLayoutEngineTests).
-## Functional Testing {#functional}
+## Functional Testing { #functional}
<warning>The "functional" testing section on this page is currently inoperative.</warning>
-## Running and Using Tests {#Running-and-Using-Tests}
+## Running and Using Tests { #Running-and-Using-Tests}
Testing is an important part of getting FOP to operate correctly and conform to the necessary standards.
@@ -30,11 +30,11 @@ A testing system has been set up that wo
To setup the testing the developer must place a reference fop.jar in the "<cvs_repository>/test/reference/" directory. This jar will be dynamically loaded to create the reference output.
-### W3C TestSuite {#W3C-TestSuite}
+### W3C TestSuite { #W3C-TestSuite}
The testing is set up so that you can download the testsuite from [http://www.w3.org/Style/XSL/TestSuite/](http://www.w3.org/Style/XSL/TestSuite/), unzip the file into the base directory of FOP. Then you can uncomment the lines in the build.xml file in the test target and itwill run through all the tests in the testsuite distribution.
-### Writing a Test {#Writing-a-Test}
+### Writing a Test { #Writing-a-Test}
A test belongs to one of a few catagories. A basic test should excercise one element in a number of situations such as changing a property. This should have at least one normal value, one border value and one invalid value. If the property can be of different types then this should also be included.
@@ -44,11 +44,11 @@ A system test is one that tests the abit
A test can consist of a complete fo document or a part of the document such as some elements that will be placed into the flow of a standard document.
-### Submitting a Test {#Submitting-a-Test}
+### Submitting a Test { #Submitting-a-Test}
If you have a test which you think would be useful you should supply the test and a diff to the appropriate test suite xml file. Make sure that the test works as would be expected against the current build.
-### How Testing Works {#How-Testing-Works}
+### How Testing Works { #How-Testing-Works}
The tests are stored in the "<svn_repository>/test" directory.
@@ -64,6 +64,6 @@ The testing is done by reading a test su
For FOP the testing is done by rendering all the testing documents using the XML renderer. The XML files are then compared to see if there are any differences.
-### SVG Testing {#SVG-Testing}
+### SVG Testing { #SVG-Testing}
The testing of SVG is not part of this testing system. SVG is tested for its rendering accuracy by using the transcoding mechanism via [Apache Batik](http://xmlgraphics.apache.org/batik/). So that the only part that needs testing is how the SVG image is embedded inside the flow of the fo document.
Modified: xmlgraphics/site/trunk/content/fop/dev/tools.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/dev/tools.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/dev/tools.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/dev/tools.mdtext Thu Jul 24 16:21:20 2014
@@ -5,7 +5,7 @@ Title: Apache(tm) FOP Development: Devel
This page documents items that may be helpful to other developers, especially to those who are new to Apache™ FOP. Exhaustive treatment of these topics is better suited to other fora, but the information presented here is intended to deal with FOP-specific issues related to these tools, especially "gotchas", and to help developers get jump-started.
-## Developer Checklist {#checklist}
+## Developer Checklist { #checklist}
Here is a (probably not comprehensive) list of tools you will need to be a successful FOP developer:
@@ -20,19 +20,19 @@ Here is a (probably not comprehensive) l
- JUnit (see [Basic Testing](testing.html#basic)).
-## General Developer Information {#general}
+## General Developer Information { #general}
See [the Apache Contributors Tech Guide](http://www.apache.org/dev/contributors.html) for useful information and links for Apache developers, including help with tools and procedures.
-## Subversion (SVN) {#svn}
+## Subversion (SVN) { #svn}
-### General {#svn_general}
+### General { #svn_general}
Visit [Apache XML Graphics Code Repositories](http://xmlgraphics.apache.org/repo.html) for useful information.
You will need a SVN client to be able to gain access to the FOP repository. For general SVN information, visit [Subversion Home](http://subversion.tigris.org). A comprehensive list of clients for all operating systems and many IDEs can be found at [the Subversion Links page](http://subversion.tigris.org/project_links.html). For Microsoft Windows we recommend [TortoiseSVN](http://tortoisesvn.tigris.org). The command-line client that comes with Subversion is also very easy to use.
-### Step-by-step instruction for downloading FOP using the SVN command-line client {#svn_download}
+### Step-by-step instruction for downloading FOP using the SVN command-line client { #svn_download}
On the command-line (Windows or Unix), simply run:
@@ -40,7 +40,7 @@ On the command-line (Windows or Unix), s
This will download the FOP trunk into the directory "fop-trunk".
-### Step-by-step instructions for downloading FOP using TortoiseSVN (on Windows) {#tortoisesvn_download}
+### Step-by-step instructions for downloading FOP using TortoiseSVN (on Windows) { #tortoisesvn_download}
- Create a new, empty directory in a place of your choice.
@@ -51,7 +51,7 @@ This will download the FOP trunk into th
- Click "OK" and the download should begin.
-### Creating Patches {#patches}
+### Creating Patches { #patches}
- `cd` to a directory that contains all of the changes that you wish to include in the patch. To comprehend the entire distribution, `cd` to the top directory where you checked out the sources.
@@ -64,7 +64,7 @@ This will download the FOP trunk into th
- If you are running TortoiseSVN, you can select "Create Patch..." in the TortoiseSVN context menu.
-### Documentation {#svn-doc}
+### Documentation { #svn-doc}
- [online resource] [The Subversion Home Page](http://subversion.tigris.org).
@@ -73,7 +73,7 @@ This will download the FOP trunk into th
- [online resource] [Comprehensive list of links to documentation and Subversion clients and plugins.](http://subversion.tigris.org/project_links.html)
-## Integrated Development Environments (IDEs) {#ide}
+## Integrated Development Environments (IDEs) { #ide}
An IDE is not required, but will generally be found to be helpful, especially for serious debugging and refactoring.
Modified: xmlgraphics/site/trunk/content/fop/download.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/download.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/download.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/download.mdtext Thu Jul 24 16:21:20 2014
@@ -3,7 +3,7 @@ Title: Apache(tm) FOP: Downloading A Dis
#Apache™ FOP: Downloading A Distribution
-## Binary or Source? {#dist-type}
+## Binary or Source? { #dist-type}
Most Apache™ FOP users will want to download the latest binary distribution, which is ready to run "out of the box." However, a source distribution will be preferable if you fall into one of the following categories:
@@ -14,11 +14,11 @@ Most Apache™ FOP users will want t
- You wish to build a local copy of the API documentation (javadocs).
-## Binary Download {#binary}
+## Binary Download { #binary}
Binary distributions include "-bin" in their names, and can be downloaded from a [FOP Distribution mirror](http://www.apache.org/dyn/closer.cgi/xmlgraphics/fop).
-## Source Download {#source}
+## Source Download { #source}
There are several ways to obtain a source distribution. Please note that they are listed from least current to most current:
@@ -59,6 +59,6 @@ There are several ways to obtain a sourc
With any source distribution, you will need to build FOP from the source files. For details please see the "Build" page on the documentation tab for the version you've downloaded.
-## Archive Download {#archives}
+## Archive Download { #archives}
FOP Archive distributions are linked from the upper portion of the Apache FOP Download Mirror Page and can be downloaded from the FOP Archives [binaries](http://archive.apache.org/dist/xmlgraphics/fop/binaries/) & [source](http://archive.apache.org/dist/xmlgraphics/fop/source/) links.
Modified: xmlgraphics/site/trunk/content/fop/examples.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/examples.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/examples.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/examples.mdtext Thu Jul 24 16:21:20 2014
@@ -3,7 +3,7 @@ Title: Apache(tm) FOP Examples
#Apache™ FOP Examples
-## Example Documents Using Apache™ FOP {#Example-Documents-Using-Apache-FOP}
+## Example Documents Using Apache™ FOP { #Example-Documents-Using-Apache-FOP}
These examples have been rendered using Apache™ FOP:
@@ -33,7 +33,7 @@ Also, in the directory examples/fo/pagin
Developers will find the first steps to a test suite for all implemented formatting objects and properties in test/xml in the source distribution.
-## Images Examples {#Images-Examples}
+## Images Examples { #Images-Examples}
Embedding images in FO:
@@ -45,7 +45,7 @@ Embedding images in FO:
Look also into the directory examples/fo/svg. There you find some very extensive SVG examples.
-## Instream Foreign Object Examples {#Instream-Foreign-Object-Examples}
+## Instream Foreign Object Examples { #Instream-Foreign-Object-Examples}
Instream Foreign Object images in FO, there are more on the [SVG Page](dev/svg.html):
Modified: xmlgraphics/site/trunk/content/fop/faq.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/faq.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/faq.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/faq.mdtext Thu Jul 24 16:21:20 2014
@@ -25,15 +25,15 @@ Title: FOP FAQ
#FOP FAQ
-## 1. Apache™ FOP: General questions {#part-general}
+## 1. Apache™ FOP: General questions { #part-general}
-### 1.1. What is Apache™ FOP? {#fop-general}
+### 1.1. What is Apache™ FOP? { #fop-general}
FOP is a print formatter for [XSL formatting objects](#xslfo).
It can be used to render an XML file containing XSL formatting objects into a page layout. The main target is PDF but other rendering targets are supported, such as AWT, PCL, text and direct printing.
-### 1.2. What can I do with FOP? {#fop-functions}
+### 1.2. What can I do with FOP? { #fop-functions}
FOP provides both an application and a library that converts an XSL FO document into paginated output.
@@ -41,11 +41,11 @@ The FOP command line application can be
The library can be used in servlets and other Java applications.
-### 1.3. What does "FOP" stand for? {#fop-acronym}
+### 1.3. What does "FOP" stand for? { #fop-acronym}
FOP is an acronym for **F**ormatting **O**bject **P**rocessor
-### 1.4. How does FOP interact with other Apache Projects? {#fop-other-apache}
+### 1.4. How does FOP interact with other Apache Projects? { #fop-other-apache}
FOP is distributed with [Cocoon](http://cocoon.apache.org/) as a PDF serializer for XSL (FO) documents.
@@ -60,11 +60,11 @@ FOP also makes use of the following Apac
- [Commons Logging](http://commons.apache.org/logging/)
- [Xalan-J](http://xalan.apache.org)
-### 1.5. What is XSL? {#xsl-def}
+### 1.5. What is XSL? { #xsl-def}
XSL is a W3C standard concerned with publishing XML documents. It consists of two parts: [XSLT](#XSLT) and [XSL-FO](#xslfo). The acronym expands to e **X**tensible **S**tylesheet **L**anguage.
-### 1.6. What is XSL-FO? {#xslfo}
+### 1.6. What is XSL-FO? { #xslfo}
XSLFO (aka XSL-FO) is an XML vocabulary, defined by W3C Recommendation [Extensible Stylesheet Language (XSL) Version 1.1](http://www.w3.org/TR/xsl/), that is used to specify a pagination and other styling for page layout output. The acronym âFOâ stands for **F**ormatting **O**bjects. XSLFO can be used in conjunction with [XSLT](#XSLT) to convert from any XML format into a paginated layout ready for printing or displaying.
@@ -72,21 +72,21 @@ XSLFO defines a set of elements in XML t
Synonyms: XSL FO, XSL (FO), XSL:FO, XSL-FO, Formatting Objects
-### 1.7. What is XSLT? {#XSLT}
+### 1.7. What is XSLT? { #XSLT}
XSLT describes the transformation of arbitrary XML input into other XML (like XSLFO), HTML or plain text. The âTâ comes from **T**ransformation. For historical reasons, a transformation is often also called a âstyle sheetâ.
Synonyms: XSL transformation, XSL:T, XSL style sheet.
-### 1.8. When will feature X be implemented? {#when}
+### 1.8. When will feature X be implemented? { #when}
The short answer is "Don't ask." For more details, see [Understand FOP's Limitations](gethelp.html#limitations).
-### 1.9. When is the next released planned? {#next-release}
+### 1.9. When is the next released planned? { #next-release}
Version 1.1 of FOP was released on 20 October 2012. Work on a new Version 1.2 of Apache FOP is underway at this time, with no fixed date set for its release. If you want to speed up the process, consider [contributing](dev/index.html#involved) to FOP.
-### 1.10. Why did you redesign FOP? {#redesign}
+### 1.10. Why did you redesign FOP? { #redesign}
The code redesign of FOP was necessary in order to be able to adress following issues:
@@ -101,19 +101,19 @@ The code redesign of FOP was necessary i
- Table Layout
-### 1.11. How can I contribute? {#contribute}
+### 1.11. How can I contribute? { #contribute}
There are numerous ways that you can help. They are outlined in the [Developer's Introduction](dev/index.html) page.
-## 2. Problems running FOP {#part-running}
+## 2. Problems running FOP { #part-running}
-### 2.1. I get the error: [ERROR]: 'master-reference' for 'fo:page-sequence' matches no 'simple-page-master' or 'page-sequence-master' {#no-page-master}
+### 2.1. I get the error: [ERROR]: 'master-reference' for 'fo:page-sequence' matches no 'simple-page-master' or 'page-sequence-master' { #no-page-master}
FOP was changed to be in accordance with the latest standard (see [XSL standard](resources.html#specs-xslfo)).The page master for a fo:page-sequence is now referenced by the master-reference attribute. Replace the master-name attributes of your fo:page-sequence elements by master-reference attributes. You have to do this also for fo:single-page-master-reference, fo:repeatable-page-master-reference and fo:conditional-page-master-reference elements in you page master definitions.
Update your FO documents and style sheets.
-### 2.2. I get a NoClassDefFound exception. {#NoClassDefFound}
+### 2.2. I get a NoClassDefFound exception. { #NoClassDefFound}
This is typically a problem with your classpath.
@@ -128,17 +128,17 @@ If you run FOP embedded in your servlet,
If you downloaded the source distribution, or a snapshop from the repository, remember you have to build the FOP jars first.
-### 2.3. I get a NoSuchMethodException or a NoSuchFieldException exception. {#NoSuchMethodException}
+### 2.3. I get a NoSuchMethodException or a NoSuchFieldException exception. { #NoSuchMethodException}
This is usually caused by an older version of one of the FOP jars or old XML tools in the classpath.
Incompatible versions of Batik may also cause this problem. Use the version of Batik that comes with FOP. It is not always possible to use a more recent version of Batik.
-### 2.4. I get an OutOfMemoryException. {#OutOfMemoryException}
+### 2.4. I get an OutOfMemoryException. { #OutOfMemoryException}
See [FOP Memory][currentFop_running_memory].
-### 2.5. I get a MalformedURLException. {#MalformedURL}
+### 2.5. I get a MalformedURLException. { #MalformedURL}
What you probably think of as "file names" are usually URLs, in particular the `src` attribute of fo:external-graphic.
Because usage of URLs is growing, you should make yourself familiar with it. The relevant specification is [RFC 2396](http://www.rfc-editor.org/rfc/rfc2396.txt).
@@ -147,15 +147,15 @@ In a nutshell, the correct syntax for an
A relative file URL starts with anything but a slash, and doesn't have the `file:` prefix, for example `file.ext`, `path/file.ext` or `../file.ext`. The string `file:path/file.ext` is *not* a relative URL, in fact, it isn't a valid URL at all. A relative URL is subject to a resolving process, which transforms it into an absolute URL.
-### 2.6. I get an "[ERROR]: null", or a NullPointerException. {#NullPointerException}
+### 2.6. I get an "[ERROR]: null", or a NullPointerException. { #NullPointerException}
This is very likely a bug in FOP. If you encounter this error, please [Open a New Bug](bugs.html#issues_new).
-### 2.7. FOP returns the message "[ERROR] object|property - 'x' is not implemented yet." When will it be implemented? {#not-implemented}
+### 2.7. FOP returns the message "[ERROR] object|property - 'x' is not implemented yet." When will it be implemented? { #not-implemented}
See FOP's Standards [Compliance](compliance.html) page.
-### 2.8. FOP hangs. FOP does not exit. {#fop-hangs}
+### 2.8. FOP hangs. FOP does not exit. { #fop-hangs}
The most likely reason is a known problem with the Java run time environment which is triggered by rendering SVGs. Sun's JDK 1.4 and later do not have this problem. See also [FOP does not exit if a SVG is included](#svghangs).
@@ -166,15 +166,15 @@ If you called the FOP command line appli
If you can reproduce this problem given a specific input and configuration,
then please [Open a New Bug](bugs.html#issues_new).
-### 2.9. FOP runs forever, writing lots of ">" to the log. {#boxoverflow}
+### 2.9. FOP runs forever, writing lots of ">" to the log. { #boxoverflow}
There is something too large to fit into the intended place, usually a large image, a table whose rows are kept together or a block with a space-before or space-after larger than the page size. Catch the first page showing this phenomenon and check it. If it is not obvious which element causes the trouble, remove stuff until the problem goes away. Decrease the dimensions of the offending element or property, or increase the dimension of the enclosing element or container, or remove keep-with-* properties.
-### 2.10. FOP cannot find a file for fo:external-graphics. {#cannot-find-external-graphics}
+### 2.10. FOP cannot find a file for fo:external-graphics. { #cannot-find-external-graphics}
The src attribute of the `fo:external-graphics` element requires a URI, not a file name. See [External Resources](fo.html#external-resources) for more information about specifying URIs.
-### 2.11. FOP does not find my fonts. {#fonts-not-found}
+### 2.11. FOP does not find my fonts. { #fonts-not-found}
Did you get: âFailed to read font metrics file C:\foo\arial.xml: File "C:\foo\arial.xml" not foundâ? The value for the metrics-file attribute in the user config file is actually an URL, not a file name. Use "file:///C:/foo/arial.xml" instead.
@@ -182,7 +182,7 @@ If you used a relative URL, make sure yo
Try also setting the [font-base configuration][currentFop_config_general].
-### 2.12. I get a SAXException: Mismatch: page-sequence vs. root (or similar). {#saxexception-mismatch}
+### 2.12. I get a SAXException: Mismatch: page-sequence vs. root (or similar). { #saxexception-mismatch}
The full exception usually looks similar to this:
@@ -214,15 +214,15 @@ The work-around is to set an explicit `E
}
-### 2.13. The following message appears after recently upgrading FOP: "I/O exception while reading font cache (org.apache.fop.fonts.EmbedFontInfo; local class incompatible: stream classdesc serialVersionUID = -9075848379822693399, local class serialVersionUID = 8755432068669997367). Discarding font cache file." {#faq-N1026C}
+### 2.13. The following message appears after recently upgrading FOP: "I/O exception while reading font cache (org.apache.fop.fonts.EmbedFontInfo; local class incompatible: stream classdesc serialVersionUID = -9075848379822693399, local class serialVersionUID = 8755432068669997367). Discarding font cache file." { #faq-N1026C}
This message is a warning that FOP failed to read from the Font cache. Which means any Font auto detection or Font directories will be re-scanned. So this failure doesn't break anything.
To avoid the warning you can simply delete the old Font Cache file, which lives in ${base}\conf\font.cache (see [font-base configuration][currentFop_config_general]).
-## 3. Problems with FOP output {#part-output}
+## 3. Problems with FOP output { #part-output}
-### 3.1. Leaders don't work in current FOP. Instead of filling the line, only three dots or a short ruler is output. {#leader-expansion}
+### 3.1. Leaders don't work in current FOP. Instead of filling the line, only three dots or a short ruler is output. { #leader-expansion}
Leaders still work, in fact they work better than ever before. You'll just have to add `text-align="justify"` and/or `text-align-last="justify"` to the block with the leader. Be sure you haven't accidentally overridden the `leader-length.maximum="100%"` default value.
@@ -234,7 +234,7 @@ Actually due to the fuzzyness of the spe
If you want to have a longer ruler or space in a non-justified line, you have to increase the leader-length.optimum property.
-### 3.2. Why does FOP insert a blank page between my page sequences? {#blank-page-between-page-sequences}
+### 3.2. Why does FOP insert a blank page between my page sequences? { #blank-page-between-page-sequences}
This is because spec conformance has been improved.
@@ -242,7 +242,7 @@ The [force-page-count property](http://w
If you don't want to have this blank page, use `force-page-count="no-force"`.
-### 3.3. Why is my graphic not rendered? {#graphic-not-displayed}
+### 3.3. Why is my graphic not rendered? { #graphic-not-displayed}
Most commonly, the external file is not being found by FOP. Check the following:
@@ -262,15 +262,15 @@ Other possibilities:
- There may be something (static content) that is obscuring the graphic. (This is very rare).
-### 3.4. My graphical images do not work properly. {#png-fails}
+### 3.4. My graphical images do not work properly. { #png-fails}
See [FOP Graphics Formats][currentFop_graphics] for a list of supported graphics formats and related issues.
-### 3.5. Why is my graphic rendered at a different resolution than it was created? {#graphic-resolution}
+### 3.5. Why is my graphic rendered at a different resolution than it was created? { #graphic-resolution}
See [Graphics Resolution][currentFop_graphics_resol].
-### 3.6. Keep-with-next, keep-with-previous, keep-together don't work. {#keep-with}
+### 3.6. Keep-with-next, keep-with-previous, keep-together don't work. { #keep-with}
Current FOP releases have extensive support for these properties. The current release, FOP 1.0, still supports the values "always" and "never" only, no numerical values. There may be a few places where keep-* still don't work, this should be very rare.
@@ -299,13 +299,13 @@ An example of an image and the image cap
Consider upgrading to the latest version which supports keeps.
-### 3.7. My tables are missing, or missing their content. {#table-missing}
+### 3.7. My tables are missing, or missing their content. { #table-missing}
Check for `fo:table-body` around the rows. Usually FOP will catch this problem.
Also, the `fo:table-with-caption` element is not implemented, tables within such an element are dropped too. FOP generates an error message for this problem. Older DocBook style sheets generate `fo:table-with-caption` elements, so watch out.
-### 3.8. Text overflowing table cells and the like is not clipped. Long text flows into adjacent cells/block, obscuring stuff there. {#cells-overflow}
+### 3.8. Text overflowing table cells and the like is not clipped. Long text flows into adjacent cells/block, obscuring stuff there. { #cells-overflow}
Since the `overflow` property doesn't apply to table-cell, you can wrap the cell content in a block-container and specify `overflow="hidden"` there. Alternatively, if you have long words overflowing table cells, try to get them hyphenated. Artificial names like product identifications or long numbers usually aren't hyphenated. You can try special processing at XSLT level, like
@@ -318,27 +318,27 @@ Since the `overflow` property doesn't ap
Check the [XSL FAQ](http://dpawson.co.uk/xsl) and the [XSL list archive](http://www.mulberrytech.com/xsl/xsl-list/) for how to perform these tasks.
-### 3.9. The contents of table cells donât wrap {#table-cell-wrap}
+### 3.9. The contents of table cells donât wrap { #table-cell-wrap}
You probably have `keep-together="always"` set on the table cell. See [next question](#keep-together).
-### 3.10. FOP behaves differently from earlier versions when keep-together="always" is set on table cells {#keep-together}
+### 3.10. FOP behaves differently from earlier versions when keep-together="always" is set on table cells { #keep-together}
Support for inline-level keeps has been added in FOP 0.95, and setting `keep-together="always"` also implicitly sets `keep-together.within-line="always"`, which forbids FOP to break the text into multiple lines. Set `keep-together.within-column="always"` on table-cell instead. Itâs a good idea not to use the shorthand `keep-together="always"` at all!
-### 3.11. FOP tells me: "The contents of row 1 are taller than they should be". What does that mean? {#row-height-constraint}
+### 3.11. FOP tells me: "The contents of row 1 are taller than they should be". What does that mean? { #row-height-constraint}
This is usually caused by setting a "height" on a table-row or table-cell and when the content is higher than the specified height. By setting "height" (a so-called corresponding property) you [implicitely set](http://www.w3.org/TR/xsl11/#d0e4413) block-progression-dimension.minimum, block-progression-dimension.optimum and block-progression-dimension.maximum to the same value. You'll get some information about that in the warning message. Look for something like: "MinOptMax[min=opt=max=14000]".
Assuming you set the height on the table-row to 14pt and your content is 75pt high, a constraint (maximum=14pt) is violated. Normally, you just want to make sure with the "height" property that the row has a minimum height. If that is so, the right solution is to specify block-progression-dimension.minimum="14pt" instead of height="14pt".
-### 3.12. Page numbers are not properly right aligned. {#page-number-align}
+### 3.12. Page numbers are not properly right aligned. { #page-number-align}
This happens for `fo:page-number-citation` elements if the citation occurs before FOP formatted the requested page, usually in TOC or index pages. It is caused by the problem that FOP has to guess how much space the yet unknown page number will occupy, and usually the guesses are somewhat off.
The most recent FOP releases should have this problem fixed. Check whether you can upgrade.
-### 3.13. Hyphenation does not work. {#hyphenation-fails}
+### 3.13. Hyphenation does not work. { #hyphenation-fails}
Make sure you have set the language and optionally the country attributes for an appropriate XSL-FO element (fo:page-sequence, fo:block or fo:character):
@@ -352,63 +352,63 @@ Explicitly enable hyphenation for an app
:::xml
<fo:block hyphenate="true">
-### 3.14. When I use margins, my content in a nested table or block-containers gets indented twice. Is this a bug? {#indent-inheritance}
+### 3.14. When I use margins, my content in a nested table or block-containers gets indented twice. Is this a bug? { #indent-inheritance}
No, although you might easily think so. The problem has to do with property inheritance of the start-indent and end-indent properties to which the margin properties are mapped. Apache FOP strictly adheres to the XSL-FO specification here which many other commercial FO implementations don't do to better meet end-user expectations. You can make FOP behave like these if you set `setBreakIndentInheritanceOnReferenceAreaBoundary(true)` on the FOUserAgent. The better way is to reset `start-indent` and `end-indent` to "0pt" on table-body or block-container. For further details, please consult the [Wiki page on Indent Inheritance](http://wiki.apache.org/xmlgraphics-fop/IndentInheritance).
-### 3.15. Why is the output of Java2D/AWT-based renderers different than, for example, PDF or PS? {#pdf-ps-java2d-differences}
+### 3.15. Why is the output of Java2D/AWT-based renderers different than, for example, PDF or PS? { #pdf-ps-java2d-differences}
If you render the same document once to a PNG or TIFF and once into a PDF, the output may not be the same, i.e. line breaks are different or lines may have different heights. The reason for this: The Java2D-based renderers use the font subsystem of Java2D/AWT. The PDF and PS renderers use FOP's own font subsystem which provides much better font metrics than Java2D. These can lead to different layout decisions when the same document is rendered with different renderers. An alternative approach to fix this problem might be available but it hasn't been tested, yet. See also the [notes on fonts in the various output formats][currentFop_output_generalFonts].
-## 4. Embedding FOP. Using FOP in a servlet. {#part-embedding}
+## 4. Embedding FOP. Using FOP in a servlet. { #part-embedding}
-### 4.1. How do I use FOP in a servlet? {#servlet}
+### 4.1. How do I use FOP in a servlet? { #servlet}
See [Using FOP in a Servlet][currentFop_servlets].
-### 4.2. How do I use FOP in a servlet with an XSLT transformation? {#servlet-with-xslt}
+### 4.2. How do I use FOP in a servlet with an XSLT transformation? { #servlet-with-xslt}
See [Using FOP in a Servlet with XSLT Transformation][currentFop_servlets_xslt].
-### 4.3. How do I pass parameters to the XSLT transformation? {#servlet-xslt-params}
+### 4.3. How do I pass parameters to the XSLT transformation? { #servlet-xslt-params}
See [Using FOP in a Servlet with XSLT Transformation][currentFop_servlets_xslt].
-### 4.4. How do I use my own fonts when running FOP from a servlet? {#servlet-nonstd-fonts}
+### 4.4. How do I use my own fonts when running FOP from a servlet? { #servlet-nonstd-fonts}
Declare the fonts in the `userconfig.xml` file as usual. See [loading the user configuration file](#usercfg) for further details.
-### 4.5. How do I set the baseDir property in a servlet environment? {#servlet-baseDir}
+### 4.5. How do I set the baseDir property in a servlet environment? { #servlet-baseDir}
See [Setting the Configuration Programmatically][currentFop_embedding_configInt].
-### 4.6. How do I use a user configuration file from a servlet? {#usercfg}
+### 4.6. How do I use a user configuration file from a servlet? { #usercfg}
See [Using a Configuration File in an Embedded App][currentFop_embedding_configExt].
-### 4.7. I keep getting NoClassDefFound and other exceptions. How do I get FOP working for various servlet engines? {#servlet-NoClassDefFound}
+### 4.7. I keep getting NoClassDefFound and other exceptions. How do I get FOP working for various servlet engines? { #servlet-NoClassDefFound}
See [Servlet Engines][currentFop_servlets_engine].
-### 4.8. Can FOP be used in multithreaded environments? {#multithreaded}
+### 4.8. Can FOP be used in multithreaded environments? { #multithreaded}
See [Multithreading FOP][currentFop_embedding_multithreading].
-## 5. SVG specific questions {#part-svg}
+## 5. SVG specific questions { #part-svg}
-### 5.1. The rendering of SVG text in my PDF is of poor quality. Can I control this? {#svg-text}
+### 5.1. The rendering of SVG text in my PDF is of poor quality. Can I control this? { #svg-text}
See [Placing SVG Text into PDF][currentFop_graphics_svgPdfText].
-### 5.2. How do I use FOP with SVG on headless servers? {#svg-headless}
+### 5.2. How do I use FOP with SVG on headless servers? { #svg-headless}
See [FOP: Graphics (Batik)][currentFop_graphics_batik].
-### 5.3. FOP does not exit if a SVG is included. {#svghangs}
+### 5.3. FOP does not exit if a SVG is included. { #svghangs}
Applies to older FOP versions and JDK 1.3 and older. That's because there is an AWT thread hanging around. The solution is to put a System.exit(0) somewhere.
-### 5.4. I have problems with SVG referring to gradients etc. using "uri(#stuff)". I get a MalformedURLException. {#svg-url}
+### 5.4. I have problems with SVG referring to gradients etc. using "uri(#stuff)". I get a MalformedURLException. { #svg-url}
This is really a "resolving relative URI" problem with some twists. The problem is that the `#stuff` URL fragment identifier is resolved within the current SVG document. So the reference must be valid within the XML subset and it cannot reference other SVG documents in the same XML file. Some options to try:
@@ -427,11 +427,11 @@ Ultimately, both FOP and especially Bati
See also [MalformedURLException](#MalformedURL)
-### 5.5. Why is my SVG rendered at a size different from that specified in my fo:external-graphic element? {#svg-scaling}
+### 5.5. Why is my SVG rendered at a size different from that specified in my fo:external-graphic element? { #svg-scaling}
See [SVG Scaling][currentFop_graphics_svgScaling].
-### 5.6. FOP fails with something like "The attribute "width" of the element <rect> is required". What's wrong? {#svg-attribute-required}
+### 5.6. FOP fails with something like "The attribute "width" of the element <rect> is required". What's wrong? { #svg-attribute-required}
This phenomenon is not a bug in FOP, but rather in the dependent packages: Apache Batik, Apache Xalan-J and SAXON. The bug in Apache Batik will be fixed in the next release. In the latest release of Apache Xalan-J, the bug is already fixed. It only occurs in the Xalan version bundled with Sun's JVM, because Sun uses a rather old version.
@@ -439,13 +439,13 @@ Bug description: In a namespace-enabled
Work-around: Use the latest version of Apache Xalan-J. Note that starting with JDK 1.4 it's not enough to replace Xalan-J on the normal application classpath and you need to override the Xalan-J version bundled with the Sun JVM using the [Endorsed Standards Override Mechanism](http://java.sun.com/j2se/1.4.2/docs/guide/standards/), i.e. you must place Xalan-J in the `"lib/endorsed"` directory of your JRE.
-## 6. PDF specific (includes Acrobat peculiarities) {#part-pdf}
+## 6. PDF specific (includes Acrobat peculiarities) { #part-pdf}
-### 6.1. How do I embed fonts in PDF? {#pdf-embed-font}
+### 6.1. How do I embed fonts in PDF? { #pdf-embed-font}
See the [Fonts][currentFop_fonts] page for information about embedding fonts.
-### 6.2. Some characters are not displayed, or displayed incorrectly, or displayed as â#â. {#pdf-characters}
+### 6.2. Some characters are not displayed, or displayed incorrectly, or displayed as â#â. { #pdf-characters}
This usually means the selected font doesn't have a glyph for the character.
@@ -463,31 +463,31 @@ The "`#`" shows up if the selected font
:::xml
<fo:inline font-family="Helvetica">∅</fo:inline>
-### 6.3. What tools are available for post-processing my PDF document? {#pdf-postprocess}
+### 6.3. What tools are available for post-processing my PDF document? { #pdf-postprocess}
See [PDF Post-processing][currentFop_output_pdfPostProcess].
-### 6.4. How do I add security features (encryption, disable printing) to my PDF document? {#pdf-security}
+### 6.4. How do I add security features (encryption, disable printing) to my PDF document? { #pdf-security}
See [PDF Encryption][currentFop_pdfencryption]. See also [PDF Post-processing][currentFop_output_pdfPostProcess].
-### 6.5. How do I add document properties (title, author, etc.) to my PDF document? {#pdf-doc-properties}
+### 6.5. How do I add document properties (title, author, etc.) to my PDF document? { #pdf-doc-properties}
See [Metadata][currentFop_metadata].
-### 6.6. How do I add watermarks to my PDF document? {#pdf-watermark}
+### 6.6. How do I add watermarks to my PDF document? { #pdf-watermark}
See [PDF Watermarks][currentFop_output_pdfWatermark].
-### 6.7. The PDF is printed contorted! {#pdf-print-contortion}
+### 6.7. The PDF is printed contorted! { #pdf-print-contortion}
Check the paper size in Acrobat settings and the "fit to page" print setting. Contorted printing is often caused by a mismatched paper format, for example if the setting is "US Letter" but the PDF was made for A4. Sometimes also the printer driver interferes, check its settings too.
-### 6.8. How do I control the Acrobat bookmark display? {#pdf-bookmark-display}
+### 6.8. How do I control the Acrobat bookmark display? { #pdf-bookmark-display}
FOP supports the starting-state property of the XSL 1.1 [fo:bookmark](http://www.w3.org/TR/xsl11/#fo_bookmark) element which can be used for this. The color, font-style and font-weight properties on [fo:bookmark-title](http://www.w3.org/TR/xsl11/#fo_bookmark-title) are not yet supported, though.
-### 6.9. How can I get rid of strange single-pixel lines inside table borders or between table cells in Adobe Acrobat? {#acrobat-anti-aliasing}
+### 6.9. How can I get rid of strange single-pixel lines inside table borders or between table cells in Adobe Acrobat? { #acrobat-anti-aliasing}
Since Apache FOP supports the collapsed border model, every border segment consists of two separate shapes. This is due to the fact that each side of the border segment can have a different color. Now, Adobe Acrobat may display thin (1 pixel wide) lines inside the border segment or sometimes even between to adjacent colored rectangles making up the background of a block or table cell. This effect is due to the way Adobe Acrobat does anti-aliasing. Adobe's algorithm seems to cause these artifacts. Other PDF viewers don't have that problem. Or at least we haven't had any reports in that direction.
@@ -501,13 +501,13 @@ Here an example of how the effect can lo
Unfortunately, it is not possible to control the above settings from within the PDF file. The user has to change these settings himself. Improving FOP to avoid this kind of problem would be possible although rather hard to achieve because we'd need to add a considerable amount of code to combine the various line segments. Something like that has been tried already years ago showing that this is a tricky task. Also, the improvement may not justify the amount of effort required.
-## 7. IEx specific stuff {#part-iex}
+## 7. IEx specific stuff { #part-iex}
-### 7.1. The FOP servlet is called multiple times! {#iex-servlet-multiple}
+### 7.1. The FOP servlet is called multiple times! { #iex-servlet-multiple}
This is a problem of Internet Explorer requesting the content several times. Please see the [notes on Internet Explorer][currentFop_servlets_ie] for more information.
-### 7.2. How do I print PDF directly from the browser? {#iex-pdf-print-from-browser}
+### 7.2. How do I print PDF directly from the browser? { #iex-pdf-print-from-browser}
It depends whether you mean "printing to a printer under control of the server" or "printing on the client's printer".
@@ -517,97 +517,97 @@ For the second task, you can use some cl
See also [http://marc.theaimsgroup.com/?l=fop-dev&m=101065988325115&w=2](http://marc.theaimsgroup.com/?l=fop-dev&m=101065988325115&w=2)
-## 8. General questions regarding XSLT, XSLFO, and basic XML {#part-input}
+## 8. General questions regarding XSLT, XSLFO, and basic XML { #part-input}
-### 8.1. (FO) How do I vertically center an image or a table (or whatever)? {#fo-center}
+### 8.1. (FO) How do I vertically center an image or a table (or whatever)? { #fo-center}
See [XSL-FO Vertical Centering](fo.html#fo-center-vertical).
-### 8.2. (FO) How do I center a table horizontally? {#fo-center-table-horizon}
+### 8.2. (FO) How do I center a table horizontally? { #fo-center-table-horizon}
See [XSL-FO Horizontal Centering (Tables)](fo.html#fo-center-table-horizon).
-### 8.3. (FO) How to get page numbers printed on the "outer side" of the page (for books, for example)? {#fo-page-outer}
+### 8.3. (FO) How to get page numbers printed on the "outer side" of the page (for books, for example)? { #fo-page-outer}
See [Recto/Verso Static Content Differences](fo.html#fo-oddeven).
-### 8.4. (FO) How do I use different static content for odd and even pages? {#oddeven}
+### 8.4. (FO) How do I use different static content for odd and even pages? { #oddeven}
See [Recto/Verso Static Content Differences](fo.html#fo-oddeven).
-### 8.5. (FO) How do I get a special header on the first page? {#fo-first-page-header}
+### 8.5. (FO) How do I get a special header on the first page? { #fo-first-page-header}
See [Making the First Page Special](fo.html#fo-first-page).
-### 8.6. (FO) How do I omit my headers on a blank page? How do I write "This page is left blank" on an intentionally blank page? {#fo-omit-headers}
+### 8.6. (FO) How do I omit my headers on a blank page? How do I write "This page is left blank" on an intentionally blank page? { #fo-omit-headers}
See [Blank Pages](fo.html#fo-blank-pages).
-### 8.7. (FO) How do I print an Euro sign, a checkbox or other some other special symbols? {#fo-special-symbols}
+### 8.7. (FO) How do I print an Euro sign, a checkbox or other some other special symbols? { #fo-special-symbols}
See [Special Characters](fo.html#xml-special-chars).
-### 8.8. (FO) How do I keep linebreaks and hard spaces? How do I get preformatted text displayed as expected? {#fo-preformat}
+### 8.8. (FO) How do I keep linebreaks and hard spaces? How do I get preformatted text displayed as expected? { #fo-preformat}
See [Preformatting Content](fo.html#fo-preformat).
-### 8.9. (FO) How do I print the total number of pages, for example "page 1 of 12" {#fo-total-pages}
+### 8.9. (FO) How do I print the total number of pages, for example "page 1 of 12" { #fo-total-pages}
See [Total Document Pages](fo.html#fo-total-pages).
-### 8.10. (FO) The header overlaps body content. The body extends into the footer. {#fo-region-overlap}
+### 8.10. (FO) The header overlaps body content. The body extends into the footer. { #fo-region-overlap}
See [Aligning Regions](fo.html#fo-region-align).
-### 8.11. (FO) How do I get lines in the document, as separators, side bars or folding marks? {#fo-lines}
+### 8.11. (FO) How do I get lines in the document, as separators, side bars or folding marks? { #fo-lines}
See [Drawing Lines](fo.html#fo-lines).
-### 8.12. (FO) How do I validate my FO document? {#fo-validate}
+### 8.12. (FO) How do I validate my FO document? { #fo-validate}
See [Validating XSL-FO](fo.html#fo-validate).
-### 8.13. (XML) How do I get a non-breaking space in FO? There are complaints about . {#xml-non-breaking-space}
+### 8.13. (XML) How do I get a non-breaking space in FO? There are complaints about . { #xml-non-breaking-space}
See [XML Special Characters](fo.html#xml-special-chars).
-### 8.14. (XML) How do I enter special characters in XML? There are complaints about undefined entities, such as ü, which work in HTML. {#xml-undefined-entities}
+### 8.14. (XML) How do I enter special characters in XML? There are complaints about undefined entities, such as ü, which work in HTML. { #xml-undefined-entities}
See [XML Special Characters](fo.html#xml-special-chars).
-### 8.15. (XML) There are complaints about illegal characters and entities in the input. {#xml-illegal-entities}
+### 8.15. (XML) There are complaints about illegal characters and entities in the input. { #xml-illegal-entities}
See [Using HTML Character Names](fo.html#xml-entity-chars).
-### 8.16. (XML) There are complaints about illegal bytes or characters in the input. There are odd characters in the result. {#xml-illegal-chars}
+### 8.16. (XML) There are complaints about illegal bytes or characters in the input. There are odd characters in the result. { #xml-illegal-chars}
See [XML Encoding Issues](fo.html#xml-encoding).
-### 8.17. (XSLT) How can I use the current date and time in my document? {#xslt-current-date}
+### 8.17. (XSLT) How can I use the current date and time in my document? { #xslt-current-date}
See [Current Date and Time](fo.html#xslt-date).
-### 8.18. Can I use FOP to convert XHTML or HTML files to PDF? {#xhtml-to-pdf}
+### 8.18. Can I use FOP to convert XHTML or HTML files to PDF? { #xhtml-to-pdf}
You will get better results if you transform your source XML directly into XSLFO. It is tempting to use the XML->XHTML->XSLFO approach, because this apparently means there's only one transformation to maintain, but XHTML and publishing grade PDF are dissimilar enough that an "generic" XHTML->XSLFO(PDF) usually wont cut it, because the XHTML already lacks information from the original XML. It may be worthwhile to go from the source XML to an intermediate custom XML which on one hand is close enough to representation to allow simple transformation to either XHTML or XSLFO for most of the structure, but on the other hand retains enough semantic from the original XML that elements which must be handled differently in the two representations can be handled differently. Setting this up requires experience and most likely extensive prototyping.
-### 8.19. I know it may be a bad idea to use FOP to convert XHTML or HTML files to PDF, but I want to do it anyway. Are there any tools available to help me? {#xhtml-to-pdf2}
+### 8.19. I know it may be a bad idea to use FOP to convert XHTML or HTML files to PDF, but I want to do it anyway. Are there any tools available to help me? { #xhtml-to-pdf2}
The [FOP Resources page](resources.html) has links to a tool called [html2fo](http://html2fo.sourceforge.net/) which can be used to make such a transformation. In addition, there are tools on the Antenna House [XSL-FO Tutorial and Sample](http://www.antennahouse.com/XSLsample/XSLsample.htm) page.
-## 9. Development-related Questions. {#dev-help}
+## 9. Development-related Questions. { #dev-help}
-### 9.1. Where can I learn how the FOP docs and web site are built? {#doc-mgt}
+### 9.1. Where can I learn how the FOP docs and web site are built? { #doc-mgt}
See FOP [Doc Management](dev/doc.html). ;-)
-## 10. General suggestions. How to solve problems. {#part-help}
+## 10. General suggestions. How to solve problems. { #part-help}
-### 10.1. I think I have found a bug in FOP. What should I do? {#bugs}
+### 10.1. I think I have found a bug in FOP. What should I do? { #bugs}
See [the Bugs page](bugs.html) for information about bugs already reported and how to report new ones.
-### 10.2. I have questions that are not addressed in this FAQ. Where should I post them? {#postquestions}
+### 10.2. I have questions that are not addressed in this FAQ. Where should I post them? { #postquestions}
- If your question is a development-related question, please see the [Developer FAQs](dev/faq.html).
Modified: xmlgraphics/site/trunk/content/fop/fo.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/fo.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/fo.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/fo.mdtext Thu Jul 24 16:21:20 2014
@@ -5,13 +5,13 @@ Title: Apache(tm) FOP: XSL-FO Input
#Apache™ FOP: XSL-FO Input
<subtitle>Basic Help for Using XML, XSLT, and XSL-FO</subtitle>
-## Overview {#overview}
+## Overview { #overview}
Apache™ FOP uses XSL-FO as input. It is the responsibility of the user to make sure that the XSL-FO submitted to FOP is correct. The tutorial items presented here are not comprehensive, but are of the FAQ variety. Another good FAQ is [Dave Pawson's XSL FAQ](http://www.dpawson.co.uk/xsl/).
-## XML Issues {#xml}
+## XML Issues { #xml}
-### Special Characters {#xml-special-chars}
+### Special Characters { #xml-special-chars}
When entering special (non-ASCII) characters in XML, the general rule is to use the applicable Unicode character instead of trying to use a character entity as you would with HTML. Remember that HTML is an SGML document type. SGML has a limited character set, which requires it to use character entities to represent special characters. One of the improvements of XML over SGML (and thus HTML) is native support for Unicode. Basic XML has only a handful of character entities, primarily because it doesn't really need more.
@@ -29,7 +29,7 @@ Getting your XML correctly encoded is on
An alternative to encoding the character and making it available through a font is to use an embedded graphic to represent the character: GIF, PNG, SVG, etc.
-### Entity Characters {#xml-entity-chars}
+### Entity Characters { #xml-entity-chars}
The handful of basic XML character entities that do exist are the ampersand, apostrophe, less-than, greater-than, and single-quote characters. These are needed to distinguish markup tags from content, and to distinguish character entities from content. To avoid parser complaints about illegal characters and entities in your input, ensure that ampersands in text and attributes are written as `&`, "<" is written as `<`, and ">" as `>`. It is not necessary everywhere, but it is wise to do so anyway, just to be sure.
@@ -37,13 +37,13 @@ Most XML parsers will provide a line num
Review the [XML Specification](http://www.w3.org/XML/) or a good tutorial for details of the XML file format.
-### Encoding Issues {#xml-encoding}
+### Encoding Issues { #xml-encoding}
If the parser complains about illegal bytes or characters in the input, or there are unexpected characters in the output, this is usually the result of a character encoding problem. See the [XSL FAQ](http://www.dpawson.co.uk/xsl) for additional information. Many software packages that produce XML, including XSLT processors, use UTF-8 encoding as a default. If you view their output with something not aware of the encoding, like Notepad for Win95/98/ME/NT, funny characters are displayed. A � is a giveaway.
-## XSLT Issues {#xslt}
+## XSLT Issues { #xslt}
-### Current Date and Time {#xslt-date}
+### Current Date and Time { #xslt-date}
XSL-FO does not currently have a function for retrieving the current date and time. However, in some cases, XSLT can be used to place the current date and time into the XSL-FO document as it is generated.
@@ -66,9 +66,9 @@ Next, use the java language to retrieve
('MMMM d, yyyy, h:mm:ss a (zz)'), java:java.util.Date.new())"/>
</xsl:template>
-## XSL-FO Issues {#xsl-fo}
+## XSL-FO Issues { #xsl-fo}
-### Vertical Centering {#fo-center-vertical}
+### Vertical Centering { #fo-center-vertical}
To vertically center an image, table, or other item, use display-align="center". See [display-align Compliance](compliance.html#fo-property-display-align) for implementation status. Here is a small, self-contained document centering an image on a page:
@@ -99,7 +99,7 @@ To vertically center an image, table, or
</fo:page-sequence>
</fo:root>
-### Horizontal Centering (Tables) {#fo-center-table-horizon}
+### Horizontal Centering (Tables) { #fo-center-table-horizon}
To center a table horizontally, one possibility is to add one column on the left and one on the right which pad the table so that the visible part is centered:
@@ -132,11 +132,11 @@ To center a table horizontally, one poss
If your table is more complicated, or if defining borders on individual cells becomes too much work, use the code above and nest your table within the middle cell.
-### Right-Aligning (Tables) {#fo-right-align-table-horizon}
+### Right-Aligning (Tables) { #fo-right-align-table-horizon}
To right-align a table, you can use the same approach as above for centering tables. Just remove the last table-column element which causes all the left-over space not used by the columns with a fixed column-width to be assigned to the first column which effectively right-aligns the table.
-### Recto/Verso Static Content Differences {#fo-oddeven}
+### Recto/Verso Static Content Differences { #fo-oddeven}
One frequent request is that static content be different between recto pages (right-side or odd-numbered pages typically) and verso pages(left-side or even-numbered pages typically). For example, you may wish to place the page number on the "outer" side of each page. There are examples in the FO distribution and in the [XSL FAQ FO section](http://www.dpawson.co.uk/xsl/sect3/index.html).
@@ -183,7 +183,7 @@ First, define a page master with alterna
</fo:page-sequence>
</fo:root>
-### Making the First Page Special {#fo-first-page}
+### Making the First Page Special { #fo-first-page}
To get a special header on the first page, one possibility is to insert it into the flow instead of the static content. Alternatively, use a page master referring to different page masters for the first page and the rest. Here is a code sample:
@@ -229,7 +229,7 @@ To get a special header on the first pag
</fo:page-sequence>
</fo:root>
-### Blank Pages {#fo-blank-pages}
+### Blank Pages { #fo-blank-pages}
Sometimes it is desirable to insert blank pages within your output, starting, for example, a new chapter on an odd page or an even page. A blank page can be forced by using `break-before="page-even"` or similar properties, or by a force-page-count="end-on-odd" on a page sequence.
@@ -276,11 +276,11 @@ To write "This page is intentionally lef
</fo:page-sequence>
</fo:root>
-### Preformatting Content {#fo-preformat}
+### Preformatting Content { #fo-preformat}
Sometimes it is desirable to retain linebreaks and hard spaces, and to get preformatted text to pass through without being changed. The XSL-FO specification provides some properties for this: [white-space-collapse](http://www.w3.org/TR/xsl11/#white-space-collapse) and [linefeed-treatment](http://www.w3.org/TR/2001/REC-xsl-20011015/slice7.html#white-space-collapse). In FOP, use white-space-collapse="false" on an enclosing block.
-### Total Document Pages {#fo-total-pages}
+### Total Document Pages { #fo-total-pages}
It is frequently desirable to know the total number of pages in a document and to use that number within the document. For example, you might wish to show the page number on the first page as being "page 1 of 12".
@@ -369,13 +369,13 @@ Declare and use the parameter "page-coun
<warning>It is possible to run into a convergence problem with this solution. Replacing the "#" placeholder in the first run with the actual page count in the second run, may change the total number of pages in the document.</warning>
-### Aligning Regions {#fo-region-align}
+### Aligning Regions { #fo-region-align}
Although it may seem counterintuitive, the regions on a page may overlap. Defining a certain body region does not automatically constrain other regions. Instead, this has to be done explicitly. Sometimes for creative reasons it may be desirable to have the regions overlap. Otherwise, you will want to set them up so that the header does not overlap body content or the body extend into the footer.
Assuming you wish to keep the regions separate, if you have a header region with an extent of 20mm, you should define a margin for the body region of at least 20mm too. Otherwise the header content may overwrite some stuff in the body region. This applies similarly to the extent of the after region and the bottom margin of the body region.
-### Drawing Lines {#fo-lines}
+### Drawing Lines { #fo-lines}
It is frequently desirable to draw lines in a document, as separators, side bars or folding marks. There are several possibilities:
@@ -386,13 +386,13 @@ It is frequently desirable to draw lines
- Insert a graphic. GIF, PNG SVG, whatever.
-### Validating XSL-FO {#fo-validate}
+### Validating XSL-FO { #fo-validate}
[RenderX](http://www.renderx.com) has provided an [Unofficial DTD for FO Documents](http://www.renderx.com/Tests/validator/fo.dtd.html), which may be helpful in validating general FO issues.
FOP also maintains an [Unofficial FOP Schema](http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/foschema/fop.xsd?view=co) in the FOP Subversion Repository. This document can be used either to validate against the FO standard, or against the actual FOP implementation. See the notes near the beginning of the document for instructions on how to use it.
-### Producing landscape pages {#landscape}
+### Producing landscape pages { #landscape}
Pages in landscape format can easily be produced by exchanging the page-height and page-width values of a simple-page-master element.
@@ -406,7 +406,7 @@ Pages in landscape format can easily be
</fo:simple-page-master>
</fo:layout-master-set>
-### External Resources {#external-resources}
+### External Resources { #external-resources}
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 [Section 5.11 Property Datatypes](http://www.w3.org/TR/xsl11/#datatype), which includes a link to the URI standard itself. Refer to the XSL-FO and URI standards themselves for more detailed instructions.
Modified: xmlgraphics/site/trunk/content/fop/fop-pdf-images.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/fop-pdf-images.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/fop-pdf-images.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/fop-pdf-images.mdtext Thu Jul 24 16:21:20 2014
@@ -18,7 +18,7 @@ Notice: Licensed to the Apache Softwa
#Apache™ FOP: PDF Images Plug-In
-## Overview {#overview}
+## Overview { #overview}
The *fop-pdf-images* plug-in extends FOP in order to add support for using PDF images in fo:external-graphic elements when
generating PDF files. This means one can write something like:
@@ -31,14 +31,14 @@ and
:::xml
<fox:external-document src="my-doc.pdf"/>
-## Download {#download}
+## Download { #download}
Snapshot development source and binary packages are available [here](https://dist.apache.org/repos/dist/dev/xmlgraphics/). If using
the binary package, the four jar files should be placed in the *lib* directory of your FOP installation.
The current source can also be retrieved from the [svn repository](http://svn.apache.org/repos/asf/xmlgraphics/fop-pdf-images/).
-## Older Releases {#older_releases}
+## Older Releases { #older_releases}
The fop-pdf-images plug-in was donated by Jeremias Märki to the XMLGraphics project in 2012. Older releases can
be obtained from his plug-in [page](http://www.jeremias-maerki.ch/development/fop/index.html).
\ No newline at end of file
Modified: xmlgraphics/site/trunk/content/fop/gethelp.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/gethelp.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/gethelp.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/gethelp.mdtext Thu Jul 24 16:21:20 2014
@@ -5,11 +5,11 @@ Title: Apache(tm) FOP: Getting Help
The Apache™ FOP developer community is eager to help you maximize the usefulness of FOP. However, to make wise use of its limited resources, support must be primarily self-service. Go through the following checklist sequentially to determine what kind of help you need, and where to get it:
-## Understand Underlying Technologies {#underlying}
+## Understand Underlying Technologies { #underlying}
If you have a questions about XML, XSLT, or XSL-FO that are not directly related to FOP, please consult resources that are appropriate for those questions. FOP is an implementation of these technologies, and when you use FOP, there is a presumption that you have a working understanding of them. We have included several useful links on our [Resources](resources.html) page that may help you get started.
-## Understand FOP's Limitations {#limitations}
+## Understand FOP's Limitations { #limitations}
FOP is a work in progress, and has some limitations.
@@ -17,35 +17,35 @@ FOP does not yet fully comply with the W
Please especially do not submit questions asking when a particular feature will be implemented. There are too many unknowns to make even a reasonable estimate. Every time a developer stops to answer such a question, the answer will inevitably be "I don't know", but the time taken to respond is time spent away from development. The only sure way to get a feature implemented is to [pitch in and help](#how-to-help).
-## Read the Documentation {#doc}
+## Read the Documentation { #doc}
Review the documentation pages on this site. There is information about how to run FOP, how to embed it, how to add custom fonts etc.
-## Check the FAQs {#faq}
+## Check the FAQs { #faq}
Consult the [Frequently Asked Questions (FAQ)](faq.html) to see if your question has already been answered.
-## Review FOP User Mailing List Archive {#user-archive}
+## Review FOP User Mailing List Archive { #user-archive}
It is possible that your question has already been answered but has not yet found its way into the FAQ. Links to the FOP User mailing list archives are on the [Mailing List](maillist.html#fop-user) page.
-## Look for an Existing Issue Report {#existing-issue}
+## Look for an Existing Issue Report { #existing-issue}
See [Reported Issues](bugs.html#issues_existing) for instructions on how to use the list of open issues. Review these open issues to see if any match your concerns. If so, please do not post a mailing list question or report another issue, as these will only slow the development team down.
-## Submit Question to FOP User Mailing List {#user-mailing-list}
+## Submit Question to FOP User Mailing List { #user-mailing-list}
See [FOP User Mailing List](maillist.html#fop-user) for details.
<note label="Important">Please don't write to any developer directly. Only if you submit questions to the [FOP User Mailing List](maillist.html#fop-user) will other FOP users be able to profit from answers given to your question. Another point is that a developer may have gone inactive or is on holidays in which case you may not get an answer in time.</note>
-## Enter an Issue Report {#enter-issue}
+## Enter an Issue Report { #enter-issue}
If, and only if, you have followed all of the above steps, and believe that there is a bug or needed feature that you would like to report, please enter an issue in Jira. Never use Jira to post questions, only to enter issues that have already been asked on the user mailing list.
See [Reporting New Issues](bugs.html#issues_new) for detailed instructions on how to enter an issue.
-## Find Out How You Can Help {#how-to-help}
+## Find Out How You Can Help { #how-to-help}
As stated above, the FOP development team is a limited resource. Most make their livings doing things other than writing and supporting FOP. Perhaps you need a feature from the XSL-FO standard to be implemented right away, or a bug fixed, or a new output format, or .... If so, there are several ways that you can help:
Modified: xmlgraphics/site/trunk/content/fop/index.mdtext
URL: http://svn.apache.org/viewvc/xmlgraphics/site/trunk/content/fop/index.mdtext?rev=1613173&r1=1613172&r2=1613173&view=diff
==============================================================================
--- xmlgraphics/site/trunk/content/fop/index.mdtext (original)
+++ xmlgraphics/site/trunk/content/fop/index.mdtext Thu Jul 24 16:21:20 2014
@@ -5,7 +5,7 @@ Title: Apache(tm) FOP - a print formatte
#Apache™ FOP
-## Introduction {#intro}
+## Introduction { #intro}
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. [Output formats][fopLatest_ouput] 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.
@@ -19,7 +19,7 @@ Support for each of the standard's objec
FOP is proud to be part of [Apache's XML Graphics project](http://xmlgraphics.apache.org).
-## Demonstration {#demo}
+## Demonstration { #demo}
@@ -27,7 +27,7 @@ This image is a demonstration of a real
FOP uses the standard XSL-FO file format as input, lays the content out into pages, then renders it to the requested output. One great advantage of using XSL-FO as input is that XSL-FO is itself an XML file, which means that it can be conveniently created from a variety of sources. The most common method is to convert semantic XML to XSL-FO, using an XSLT transformation.
-## FOP Objectives {#objectives}
+## FOP Objectives { #objectives}
The goals of the Apache FOP project are to deliver an XSL-FO to PDF formatter that is compliant to at least the Basic conformance level described in the W3C Recommendation from 05 December 2006, and that complies with the November 2001 Portable Document Format Specification (Version 1.4) from Adobe Systems.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: commits-help@xmlgraphics.apache.org