FOP 1.0 development

diff --git a/src/documentation/content/xdocs/dev/index.xml b/src/documentation/content/xdocs/dev/index.xml index dfb16c81d..fa56475d1 100644 --- a/src/documentation/content/xdocs/dev/index.xml +++ b/src/documentation/content/xdocs/dev/index.xml @@ -1,90 +1,23 @@ - - -

- FOP 1.0 development -

- -

- Introduction -

-These pages contain information that is relevant to the -current development of FOP. -

FOP is the world's first print formatter driven by XSL formatting - objects and the world's first output independent formatter. It is a - Java application that reads a formatting object tree and then - renders the resulting pages to a specified output. Output formats - currently supported are PDF, PCL, PS, SVG, XML (area tree representation), - Print, AWT, MIF and TXT. - The primary output target is PDF. -

- -FOP - someone who is overly concerned with style, also conveniently -can mean Formatting Object Processor. - -

The latest version of Fop is 0.20.4 and it supports the - XSL-FO Version 1.0 - W3C Recommendation. - You can download - Fop including a precompiled version, the source code and many example files to - get you started. Pointers to introductions into xsl:fo can be found in the - resources section. Please be aware, that - Fop is at the moment not a full implementation of the basic conformance level - of the xsl:fo standard. You can find a list of supported flow objects and properties - in the section Features and in section - Limitations in what way this support is - limited. -

FOP is part of Apache's XML project. The homepage of FOP is - http://xml.apache.org/fop. - Here you can find information about using and developing with FOP. -

Users can subscribe to fop-user@xml.apache.org by sending an email - to fop-user-subscribe@xml.apache.org - this is where user specific topics are discussed. -

- Formatting -

-This image is a demonstration of a two page document. The xml data on the left -is formatted into the two pages on the right. The document contains static areasthat appear on every page, an external graphic in this case an svg document. -There is a footnote on the first page and a table that goes across both pages. -

-The advantage of XSL is the ability to take an XML document and to format -the information into a page layout. The XML document can be generated -in any way, the most common would be to use XSLT. FOP takes the XML -and formats the data into pages. The pages are then rendered to the -requested output. -

-This is a real document. The image was created by rendering the document -to the svg renderer then putting the rendered pages into an svg document -along with the xml. -

- FOP Objectives -

-The goals of the Apache XML FOP Project are to deliver an XSL FO->PDF formatter that is compliant to at least the Basic - conformance level described in the W3C Recommendation from 15 October 2001, and that complies with the 11 March 1999 Portable Document - Format Specification (Version 1.3) from Adobe Systems. -

- -

Conformance to the XML 1.0 Recommendation, XSLT 1.0 Recommendation and the XML Namespaces Recommendation is - understood. Other relevant documents, such as the XPath and XLink Working Drafts, are referenced as necessary. The FOP - Project will attempt to use the latest version of evolving specifications. -

- -

To reach this aim currently the layout system is being redesigned to -better handle the formatting of all different types of formatting objects. -

- - + +

+ Information for FOP Developers +

+ +

+ Introduction +

These pages contain information that should be helpful for those developing FOP.

For basic and user information on FOP, please visit the FOP homepage.

It is important to understand that there are currently three lines of development on the FOP product:

The oldest is the one that releases are currently generated from, and is also called the "maintenance branch". Because of limitations in its design, the FOP committers decided to freeze new development on this branch, and are providing only bug fixes. This branch is tagged as "fop-0_20_2-maintain" in the CVS repository.
The main development line is the future of FOP. It was spawned from the "maintenance" branch, but had to quickly be "broken" so that the needed redesign could be dropped into place. It is currently not as mature as the "maintenance" branch, but has far greater long-term prospects. It is also known as the "root" or "trunk".
The "Alt Design" is exactly that: an alternative design approach. Because its efforts are largely complementary and parallel to the main development branch, and because it is expected to be merged at some point into the trunk, it is documented separately. The authors of this effort are currently in the process of merging their work into the trunk.

Please note that patches for enhancements to the maintenance branch will generally not be considered. Bug fixes are welcome there, but new developers are strongly encouraged to apply their efforts to the trunk development line.

Because there is a fair amount of common information between the maintenance and trunk development lines, we attempt to document them together, highlighting differences only where needed.

+ + diff --git a/src/documentation/content/xdocs/faq.xml b/src/documentation/content/xdocs/faq.xml index efee6e975..08963d65f 100644 --- a/src/documentation/content/xdocs/faq.xml +++ b/src/documentation/content/xdocs/faq.xml @@ -1660,11 +1660,14 @@ class rendtest {

- Something doesn't work with FOP but works with another formatter - (AntennaHouse, PassiveTex). Check whether this is already mentioned - in the release notes, the FOP limitations document or the FAQ. Post - to fop-dev or open a bug on bugzilla. + In the case where something works properly with another formatter, + (AntennaHouse, PassiveTex, etc.) but doesn't work with FOP, please + check the Release Notes, the + FOP Standards Compliance document, + and the remaining FAQ in this document. If not found there, look at the + list of Bugs Already Reported. + If not found there, please post a question on the fop-user mailing list + or Open a New Bug.

Question about how to use FOP, how to perform certain tasks with FOP diff --git a/src/documentation/content/xdocs/implemented.xml b/src/documentation/content/xdocs/implemented.xml deleted file mode 100644 index 7216669f7..000000000 --- a/src/documentation/content/xdocs/implemented.xml +++ /dev/null @@ -1,256 +0,0 @@ - - - - -

-Implemented -

- -

- Features -

- What's Implemented? -

The following formatting objects and properties of the XSL-FO 1.0 - W3C Recommendation are implemented. Please also have a look at the - section on limitations. -

- 1) Formatting Objects -

This section follows the tables in - Appendix B, "Formatting Object Summary" of the XSL-FO specification. - Items that are not currently implemented are listed at the end of each sub-section.

- B.1 Declaration and Pagination and Layout Formatting Objects -

root
page-sequence
page-sequence-master
single-page-master-reference
repeatable-page-master-reference
repeatable-page-master-alternatives
conditional-page-master-reference
layout-master-set
simple-page-master
region-body
region-before
region-after
region-start
region-end
flow
static-content

Not implemented: declarations, color-profile, title

- -

- B.2 Block Formatting Objects -

block
block-container (limited)

- -

- B.3 Inline Formatting Objects -

character
external-graphic
inline
instream-foreign-object
leader
page-number
page-number-citation, see limitations

Not implemented: bidi-override, initial-property-set, inline-container

- -

- B.4 Table Formatting Objects -

table
table-body
table-cell
table-column
table-footer
table-header
table-row

Not implemented: table-and-caption, table-caption

- -

- B.5 List Formatting Objects -

list-block
list-item
list-item-body
list-item-label

- -

- B.6 Link and Multi Formatting Objects -

basic-link (internal and external)

Not implemented: multi-switch, multi-case, multi-toggle, - multi-properties, multi-property-set

- -

- B.7 Out-of-line Formatting Objects -

footnote
footnote-body

Not implemented: float

- -

- B.8 Other Formatting Objects -

wrapper
marker, retrieve marker

- -

- 2) Properties -

Property values can be computed. Compound properties are also understood by FOP.

background-color
background-image
blank-or-not-blank
border-after-color
border-after-style
border-after-width
border-before-color
border-before-style
border-before-width
border-bottom
border-bottom-color
border-bottom-style
border-bottom-width
border-color (only one value allowed)
border-end-color
border-end-style
border-end-width
border-left
border-left-color
border-left-style
border-left-width
border-right
border-right-color
border-right-style
border-right-width
border-start-color
border-start-style
border-start-width
border-style
border-top
border-top-color
border-top-style
border-top-width
border-width
bottom
break-after
break-before
character
color
column-count
column-gap
column-width
country
end-indent
extent
external-destination
flow-name
font-family
font-size
font-style
font-weight
height
hyphenate
hyphenation-character
hyphenation-push-character-count
hyphenation-remain-character-count
id
initial-page-number
internal-destination
keep-with-next (broken)
language
leader-alignment (not value "page")
leader-length (see limitations)
leader-pattern (not value "use-content")
leader-pattern-width
left
letter-spacing
line-height
margin (only on pages and regions)
margin-bottom (only on pages and regions)
margin-left (only on pages and regions)
margin-right (only on pages and regions)
margin-top (only on pages and regions)
master-name
master-reference
maximum-repeats
number-columns-spanned
odd-or-even
padding (only one value allowed)
padding-after
padding-before
padding-bottom
padding-end
padding-left
padding-right
padding-start
padding-top
page-height
page-position
page-width
position (allowed values: "static" (default),"relative", "absolute", fixed )
provisional-distance-between-starts
provisional-label-separation
ref-id
region-name
right
rule-style
rule-thickness
space-after.optimum
space-before.optimum
span
src
start-indent
table-omit-footer-at-break
table-omit-header-at-break
text-align
text-align-last
text-decoration
text-indent
top
white-space-collapse
width
wrap-option

All other properties are not implemented.

- -

- 3) SVG Support -

-FOP uses Batik directly for its SVG support. Therefore FOP supports the same -elements and properties as are supported by Batik. Because FOP is designed for -rendering to a static medium, only static SVG is supported. -

-Due to certain PDF limitations, some SVG images, particularly those with filter effects -or transparency, may not come out correctly. However, these images should still be rendered correctly by the AWT and Print renderers. -

- - - diff --git a/src/documentation/content/xdocs/index.xml b/src/documentation/content/xdocs/index.xml index e19aa2ddf..59f462862 100644 --- a/src/documentation/content/xdocs/index.xml +++ b/src/documentation/content/xdocs/index.xml @@ -29,10 +29,9 @@ get you started. Pointers to introductions into xsl:fo can be found in the resources section. Please be aware, that FOP is at the moment not a full implementation of the basic conformance level - of the xsl:fo standard. You can find a list of supported flow objects and properties - in the section Features and in section - Limitations in what way this support is - limited. + of the xsl:fo standard. The FOP Compliance + page lists all objects and properties in the standard, and indicates + FOP's current compliance with those features.

FOP is part of Apache's XML project. The homepage of FOP is http://xml.apache.org/fop. diff --git a/src/documentation/content/xdocs/limitations.xml b/src/documentation/content/xdocs/limitations.xml deleted file mode 100644 index 4772555d0..000000000 --- a/src/documentation/content/xdocs/limitations.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - -

- Limitations -

- - -

- Limitations -

FOP implements the fo objects and properties listed - in features, sometimes it does so only in a limited way. -

- -

- fo:leader -

leader-length.minimum is not used at all

- -

- page-number-citation -

Only works for table of contents without any problems. The case where the page number doesn't - fit on a line isn't handled, and any text on the same line and after the page-number might not - appear exactly where you want it to. -

- -

- Padding -

Padding works in conjunction with indents and spaces. It is only implemented - for blocks. At the moment padding can't be used to make extra space (indents+spaces - must be used), but only to control how much the background-color extends beyond - the content rectangle. -

- Tables -

There two limitations for tables: 1) FOP needs you to explicitly specify column widths - 2) Cells have to contain block-level FOs. They can't contain straight character data. -

A working basic example of a table looks like this:

- - - - - - - text - - - text - - - - - text - - - text - - - - - text - - - text - - - -]]> -

- - - -- 2.39.5