Area Tree

From: Keiron Liddle Date: Tue, 19 Nov 2002 07:57:29 +0000 (+0000) Subject: The attached patch file contains: X-Git-Tag: Alt-Design-integration-base~320 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=c525b8cd71144ff2c6dfec6b302ac13abafaecf1;p=xmlgraphics-fop.git The attached patch file contains: 1. Valid URIs for all xdoc DTD declarations. 2. Some minor changes for xdoc documents that were discovered to be invalid after the DTD declarations were fixed. 3. Changed tabs.xml so that the 2nd tab on our site will now read "Redesign" instead of "dev" (this was discussed in a recent thread). Submitted By: vic@outfitr.com (Victor Mote) git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@195562 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/src/documentation/content/xdocs/book.xml b/src/documentation/content/xdocs/book.xml index c1a85cc9d..fb9334be6 100644 --- a/src/documentation/content/xdocs/book.xml +++ b/src/documentation/content/xdocs/book.xml @@ -1,5 +1,7 @@ - + + - +

diff --git a/src/documentation/content/xdocs/compiling.xml b/src/documentation/content/xdocs/compiling.xml index 61baf4c12..9026af99e 100644 --- a/src/documentation/content/xdocs/compiling.xml +++ b/src/documentation/content/xdocs/compiling.xml @@ -1,5 +1,6 @@ - +

diff --git a/src/documentation/content/xdocs/compliance.xml b/src/documentation/content/xdocs/compliance.xml index 0290c7097..26e829118 100644 --- a/src/documentation/content/xdocs/compliance.xml +++ b/src/documentation/content/xdocs/compliance.xml @@ -1,5 +1,6 @@ - + diff --git a/src/documentation/content/xdocs/configuration.xml b/src/documentation/content/xdocs/configuration.xml index eddf1ea18..d5924cd25 100644 --- a/src/documentation/content/xdocs/configuration.xml +++ b/src/documentation/content/xdocs/configuration.xml @@ -1,5 +1,6 @@ - +

diff --git a/src/documentation/content/xdocs/design/architecture.xml b/src/documentation/content/xdocs/design/architecture.xml index 2adab8f1b..f76fc9273 100644 --- a/src/documentation/content/xdocs/design/architecture.xml +++ b/src/documentation/content/xdocs/design/architecture.xml @@ -1,5 +1,6 @@ - +

diff --git a/src/documentation/content/xdocs/design/areas.xml b/src/documentation/content/xdocs/design/areas.xml index 38e3e7c2e..9d30e0dc1 100644 --- a/src/documentation/content/xdocs/design/areas.xml +++ b/src/documentation/content/xdocs/design/areas.xml @@ -1,16 +1,17 @@ - + -

- Area Tree - Area Tree Design for FOP - - - -

+ Area Tree + Area Tree Design for FOP + + + +

- +

Area Tree

@@ -169,21 +170,13 @@ Inline

The renderer will need to be able to: +

-render each individual page -
-clip and align child areas to a viewport -
-handle all types of inline area, text, image etc. -
-draw various lines and rectangles -
render each individual page
clip and align child areas to a viewport
handle all types of inline area, text, image etc.
draw various lines and rectangles

An abstract renderer will be able to handle the generic positioning of child areas, iterating through areas that have child areas. @@ -191,6 +184,6 @@ of child areas, iterating through areas that have child areas.

- + diff --git a/src/documentation/content/xdocs/design/book.xml b/src/documentation/content/xdocs/design/book.xml index 6f8fa0d98..43e5e4834 100644 --- a/src/documentation/content/xdocs/design/book.xml +++ b/src/documentation/content/xdocs/design/book.xml @@ -1,5 +1,6 @@ - + - +

diff --git a/src/documentation/content/xdocs/design/embedding.xml b/src/documentation/content/xdocs/design/embedding.xml index 2572c74af..42812b063 100644 --- a/src/documentation/content/xdocs/design/embedding.xml +++ b/src/documentation/content/xdocs/design/embedding.xml @@ -1,5 +1,6 @@ - +

@@ -34,52 +35,44 @@ specific information. The list of user agent values can be found on the

Logging -

logging level
logging messages of various levels
error handling
Logging setup (LogKit, Log4J, JDK14Logging)

XML input -

various ways to supply FOP with the xsl:fo file, fo, xml+xsl
sax handler

general options -

base directory
uri resolvers
which implementation of a particular
LayoutManager to use

Rendering Options -

embedding fonts
compression in pdf
image embedding

for the PS renderer (eventually): +

PostScript Level
PPD to use
binary/ascii switch

User Agent diff --git a/src/documentation/content/xdocs/design/extending.xml b/src/documentation/content/xdocs/design/extending.xml index d0a954586..35d468422 100644 --- a/src/documentation/content/xdocs/design/extending.xml +++ b/src/documentation/content/xdocs/design/extending.xml @@ -1,5 +1,6 @@ - +

@@ -85,12 +86,12 @@ document into PDF markup.

eg. - +Search -]]> +]]> to result in a text box referencing the following PDF action: ->]]> +>]]>

diff --git a/src/documentation/content/xdocs/design/fotree.xml b/src/documentation/content/xdocs/design/fotree.xml index e2d7c15f6..a4c5c0c1d 100644 --- a/src/documentation/content/xdocs/design/fotree.xml +++ b/src/documentation/content/xdocs/design/fotree.xml @@ -1,5 +1,6 @@ - +

@@ -57,7 +58,7 @@ nodes have attributes) are also a concern of FOTreeBuilder. It accomplishes this by using a PropertyListBuilder. There is a separate PropertyListBuilder for each namespace encountered while building the FO tree. Each Builder object contains a hash of -property names and their respective makers. It may also +property names and their respective makers. It may also contain element-specific property maker hashes; these are based on the local name of the flow object, ie. table-row, not fo:table-row. If an element-specific property mapping exists, diff --git a/src/documentation/content/xdocs/design/index.xml b/src/documentation/content/xdocs/design/index.xml index d17304e34..039d35d6d 100644 --- a/src/documentation/content/xdocs/design/index.xml +++ b/src/documentation/content/xdocs/design/index.xml @@ -1,5 +1,6 @@ - +

@@ -32,7 +33,6 @@ process files of any size. In achieving this aim we need to understand the problem and break it into small problems that can be solved.

use SAX as input
process FO elements ASAP
renderers are totally responsible for their output format
output is sent to a stream

diff --git a/src/documentation/content/xdocs/design/layout.xml b/src/documentation/content/xdocs/design/layout.xml index 0f08bcb66..1d99728f3 100644 --- a/src/documentation/content/xdocs/design/layout.xml +++ b/src/documentation/content/xdocs/design/layout.xml @@ -1,5 +1,6 @@ - +

@@ -119,7 +120,7 @@ n(orphans) + n(widows) in total. This will only be relevant for areas at the start or end of a particular reference area.

- + Diagram of Page Layout

The spacing between the areas (including spacing in block areas inside @@ -267,7 +268,7 @@ also effected as there must be enough space on the page to fit the side float.

- + Diagram of Float

@@ -369,27 +370,15 @@ when the value is resolved. Block Areas

The block area has info about the following: +

-all anchors including which lines they are on -
-unresolved page references with line info -
-id and link areas -
-height (min/max/optimum) or area including floats -
-holds space before/after and keep information -
-widows and orphans -
all anchors including which lines they are on
unresolved page references with line info
id and link areas
height (min/max/optimum) or area including floats
holds space before/after and keep information
widows and orphans

Once the layout has been finalised then this information can be discarded. diff --git a/src/documentation/content/xdocs/design/optimise.xml b/src/documentation/content/xdocs/design/optimise.xml index b65f35dcb..0bb51ea90 100644 --- a/src/documentation/content/xdocs/design/optimise.xml +++ b/src/documentation/content/xdocs/design/optimise.xml @@ -1,5 +1,6 @@ - +

diff --git a/src/documentation/content/xdocs/design/properties.xml b/src/documentation/content/xdocs/design/properties.xml index f905f9fa9..bcc4983ce 100644 --- a/src/documentation/content/xdocs/design/properties.xml +++ b/src/documentation/content/xdocs/design/properties.xml @@ -1,5 +1,6 @@ - +

diff --git a/src/documentation/content/xdocs/design/renderers.xml b/src/documentation/content/xdocs/design/renderers.xml index be491f420..01b9e53cc 100644 --- a/src/documentation/content/xdocs/design/renderers.xml +++ b/src/documentation/content/xdocs/design/renderers.xml @@ -1,5 +1,6 @@ - +

diff --git a/src/documentation/content/xdocs/design/status.xml b/src/documentation/content/xdocs/design/status.xml index 2d9857e8a..fcc24db07 100644 --- a/src/documentation/content/xdocs/design/status.xml +++ b/src/documentation/content/xdocs/design/status.xml @@ -1,5 +1,6 @@ - + @@ -26,7 +27,6 @@ A number of issues have been dealt with in the redesigned code.

Features TODO -

avalon integration - logging, configuration, component management, caching, uri resolver
improved interfaces @@ -37,7 +37,6 @@ A number of issues have been dealt with in the redesigned code.
better commandline handling

Done/Started Features @@ -45,6 +44,7 @@ A number of issues have been dealt with in the redesigned code. Many of these changes will make FOP much better to use and develop. So if you help out with the development you can get to use these things sooner. +

better layout design - that can handle keeps and spacing better
changed area tree xml format to match the area tree hierarchy

diff --git a/src/documentation/content/xdocs/design/useragent.xml b/src/documentation/content/xdocs/design/useragent.xml index e6dffe3d9..3a64366c7 100644 --- a/src/documentation/content/xdocs/design/useragent.xml +++ b/src/documentation/content/xdocs/design/useragent.xml @@ -1,5 +1,6 @@ - +

@@ -39,137 +40,57 @@ resolution layout process and the renderer.

Standard Features: +

-error handling, what to do if fo markup is invalid -
-auto overflow value and handling error-if-overflow -
-adjusting length values (eg. for borders) to renderable values -
-available fonts -
-converting cm/in to pt (dpi) -
-active state for multi properties -
-title, used to identify a set of pages (in a page sequence) -
-the width (in inline-progression-dimension) of a character with -treat-word-as-space true -
-maximum space used by conditional areas from region-reference-area -
-if there should be "hot links" to before floats or footnotes -
-when to clear side floats if space in inline-progression-dimension -is not enough -
-placement of left over footnotes on a page with a region-body -
-using color property as border colour -
-interpretting all border styles (except outset) as solid -
-thin, medium and thick values for border width -
-initial font-family value -
-absolute font sizes (eg, xx-small, x-small etc.) -
-relative font sizes (eg. larger, smaller) -
-small caps simulation -
-font weight mapping -
-baseline info for a font if not available -
-determining sub/superscript when another baseline is dominant -
-scaling method for external-graphic and instream-foreign-object -
-the width of a replaced element -
-"normal" line height value -
-text alignment (stretching the line with letter and word spacing) -
-text transform -
-initial color -
-rendering intent of auto -
-dot character for leader -
-line breaking with leaders, use optimum length when breaking the line -
-page height/width of auto -
-left and right caption widths -
-glyph orientation vertical of auto -
-rendering processor of content-type (mime type) -
error handling, what to do if fo markup is invalid
auto overflow value and handling error-if-overflow
adjusting length values (eg. for borders) to renderable values
available fonts
converting cm/in to pt (dpi)
active state for multi properties
title, used to identify a set of pages (in a page sequence)
the width (in inline-progression-dimension) of a character with +treat-word-as-space true
maximum space used by conditional areas from region-reference-area
if there should be "hot links" to before floats or footnotes
when to clear side floats if space in inline-progression-dimension +is not enough
placement of left over footnotes on a page with a region-body
using color property as border colour
interpretting all border styles (except outset) as solid
thin, medium and thick values for border width
initial font-family value
absolute font sizes (eg, xx-small, x-small etc.)
relative font sizes (eg. larger, smaller)
small caps simulation
font weight mapping
baseline info for a font if not available
determining sub/superscript when another baseline is dominant
scaling method for external-graphic and instream-foreign-object
the width of a replaced element
"normal" line height value
text alignment (stretching the line with letter and word spacing)
text transform
initial color
rendering intent of auto
dot character for leader
line breaking with leaders, use optimum length when breaking the line
page height/width of auto
left and right caption widths
glyph orientation vertical of auto
rendering processor of content-type (mime type)

Interactive Features: +

-inline and block scroll amount -
-dynamic effects, links and property sets -
-initial "pause-after", "pause-before" and "voice-family" value -
-treating fixed as scroll on background attachement -
-media usage of auto -
inline and block scroll amount
dynamic effects, links and property sets
initial "pause-after", "pause-before" and "voice-family" value
treating fixed as scroll on background attachement
media usage of auto

diff --git a/src/documentation/content/xdocs/dev/book.xml b/src/documentation/content/xdocs/dev/book.xml index 44c8096cc..7d4a73c43 100644 --- a/src/documentation/content/xdocs/dev/book.xml +++ b/src/documentation/content/xdocs/dev/book.xml @@ -1,5 +1,6 @@ - + - - -

- Configuration -

- -

- Configuring FOP -

+ + + +

+ Configuration +

+ +

+ Configuring FOP +

In the directory xml-fop/conf you will find an example configuration file. It contains the default values of various configurable options available in FOP. @@ -40,6 +42,7 @@ configurable options available in FOP. and rebuild Fop. The file will be picked up and added to the fop.jar.

- - +

+ + + diff --git a/src/documentation/content/xdocs/dev/examples.xml b/src/documentation/content/xdocs/dev/examples.xml index 008f04537..210f42c5a 100644 --- a/src/documentation/content/xdocs/dev/examples.xml +++ b/src/documentation/content/xdocs/dev/examples.xml @@ -1,5 +1,7 @@ - + +

FO Examples @@ -15,6 +17,7 @@ Images Examples

Embedding images in FO: +

@@ -38,15 +41,15 @@ Embedding images in FO:

Images in FO
size.fo.pdf

Instream Foreign Object Examples

Instream Foreign Object images in FO, there are more on the SVG Page: +

- + @@ -58,7 +61,7 @@ Instream Foreign Object images in FO, there are more on the

Images in FO
description	fo file	embed.fo.pdf

+ diff --git a/src/documentation/content/xdocs/dev/extensions.xml b/src/documentation/content/xdocs/dev/extensions.xml index bc13d0f3f..e49d8161f 100644 --- a/src/documentation/content/xdocs/dev/extensions.xml +++ b/src/documentation/content/xdocs/dev/extensions.xml @@ -1,13 +1,15 @@ - - -

- Extensions to FOP -

- -

- Overview -

+ + + +

+ Extensions to FOP +

+ +

+ Overview +

If the default funtionality of FOP needs to be extended for some reason then you can write an extensions.

@@ -89,8 +91,8 @@ show how this can be done.

Put your jar file in the classpath and then run fop over the fo file. -

- - +

+ + diff --git a/src/documentation/content/xdocs/dev/faq.xml b/src/documentation/content/xdocs/dev/faq.xml index 138416210..f85536048 100644 --- a/src/documentation/content/xdocs/dev/faq.xml +++ b/src/documentation/content/xdocs/dev/faq.xml @@ -1,5 +1,7 @@ - + + General questions diff --git a/src/documentation/content/xdocs/dev/index.xml b/src/documentation/content/xdocs/dev/index.xml index b9279daa7..d73c1bd85 100644 --- a/src/documentation/content/xdocs/dev/index.xml +++ b/src/documentation/content/xdocs/dev/index.xml @@ -1,5 +1,7 @@ - + +

FOP 1.0 development @@ -23,9 +25,7 @@ current development of FOP. 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. @@ -50,9 +50,7 @@ can mean Formatting Object Processor.

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. diff --git a/src/documentation/content/xdocs/dev/svg.xml b/src/documentation/content/xdocs/dev/svg.xml index 16a664c01..5ed6ab728 100644 --- a/src/documentation/content/xdocs/dev/svg.xml +++ b/src/documentation/content/xdocs/dev/svg.xml @@ -1,13 +1,15 @@ - - -

- SVG in FOP -

- -

- Introduction -

+ + + +

+ SVG in FOP +

+ +

+ Introduction +

FOP uses the SVG library from Batik to handle SVG. This format can be handled as an fo:instream-foreign-object @@ -63,6 +65,7 @@ for how transcoders work.

These examples illustrate a number of issues relating to conversion to PDF: +

@@ -105,11 +108,9 @@ to PDF:

As can be seen most of the specific issues are handled.

You will need Acrobat 5.0 to see transparency. -

@@ -123,7 +124,6 @@ You will need Acrobat 5.0 to see transparency.

XSL:FO to PDF examples
embedding.fo.pdf

Important Notes @@ -160,7 +160,6 @@ for PDF it will use a single character.

Known Problems -

soft mask transparency is combined with white so that it looks better @@ -190,7 +189,6 @@ Uniform transparency for images and other svg elements that are converted into a raster graphic are not drawn properly in PDF. The image is opaque.

Developer Notes @@ -206,7 +204,6 @@ into PDF markup.

These are the relevant classes, found in the package org.apache.fop.svg :

PDFGraphics2D
@@ -225,7 +222,6 @@ used by Batik to transcode an svg document into a standalone pdf, via PDFDocumentGraphics2D.

Ideas @@ -233,8 +229,9 @@ PDFDocumentGraphics2D. Batik can convert ttf to svg font. This svg font could be converted into a pdf stroked font (type 3 font). -

- - +

+ + + + diff --git a/src/documentation/content/xdocs/download.xml b/src/documentation/content/xdocs/download.xml index 8af11e354..0a158021a 100644 --- a/src/documentation/content/xdocs/download.xml +++ b/src/documentation/content/xdocs/download.xml @@ -1,5 +1,6 @@ - +

diff --git a/src/documentation/content/xdocs/embedding.xml b/src/documentation/content/xdocs/embedding.xml index 47a94129a..bb85d3d36 100644 --- a/src/documentation/content/xdocs/embedding.xml +++ b/src/documentation/content/xdocs/embedding.xml @@ -1,5 +1,6 @@ - + diff --git a/src/documentation/content/xdocs/examples.xml b/src/documentation/content/xdocs/examples.xml index 476c66bf4..d29906585 100644 --- a/src/documentation/content/xdocs/examples.xml +++ b/src/documentation/content/xdocs/examples.xml @@ -1,5 +1,6 @@ - +

diff --git a/src/documentation/content/xdocs/extensions.xml b/src/documentation/content/xdocs/extensions.xml index 1c4a873df..4a8e75c78 100644 --- a/src/documentation/content/xdocs/extensions.xml +++ b/src/documentation/content/xdocs/extensions.xml @@ -1,5 +1,6 @@ - +

diff --git a/src/documentation/content/xdocs/faq.xml b/src/documentation/content/xdocs/faq.xml index 8b45b9cd4..5535db6a4 100644 --- a/src/documentation/content/xdocs/faq.xml +++ b/src/documentation/content/xdocs/faq.xml @@ -1,5 +1,7 @@ - + + General questions diff --git a/src/documentation/content/xdocs/fonts.xml b/src/documentation/content/xdocs/fonts.xml index 91e5d45c7..aa8ccf0fa 100644 --- a/src/documentation/content/xdocs/fonts.xml +++ b/src/documentation/content/xdocs/fonts.xml @@ -1,5 +1,6 @@ - +

diff --git a/src/documentation/content/xdocs/gethelp.xml b/src/documentation/content/xdocs/gethelp.xml index 3634fec51..b7587e61f 100644 --- a/src/documentation/content/xdocs/gethelp.xml +++ b/src/documentation/content/xdocs/gethelp.xml @@ -1,5 +1,6 @@ - + diff --git a/src/documentation/content/xdocs/implemented.xml b/src/documentation/content/xdocs/implemented.xml index 9262a322b..7f690f6ee 100644 --- a/src/documentation/content/xdocs/implemented.xml +++ b/src/documentation/content/xdocs/implemented.xml @@ -1,5 +1,6 @@ - +

diff --git a/src/documentation/content/xdocs/index.xml b/src/documentation/content/xdocs/index.xml index b18609647..3d77556dd 100644 --- a/src/documentation/content/xdocs/index.xml +++ b/src/documentation/content/xdocs/index.xml @@ -1,12 +1,14 @@ - - -

- FOP -

- -

- Introduction + + + +

+ FOP +

+ +

+ Introduction

FOP (Formatting Objects Processor) 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 @@ -40,7 +42,7 @@ to fop-user-subscribe@xml.apache.org this is where user specific topics are discussed.

Formatting @@ -79,5 +81,6 @@ along with the xml. better handle the formatting of all different types of formatting objects.

- - + + + diff --git a/src/documentation/content/xdocs/involved.xml b/src/documentation/content/xdocs/involved.xml index 995313877..af3d8fb90 100644 --- a/src/documentation/content/xdocs/involved.xml +++ b/src/documentation/content/xdocs/involved.xml @@ -1,5 +1,6 @@ - +

diff --git a/src/documentation/content/xdocs/license.xml b/src/documentation/content/xdocs/license.xml index a89f295ec..52fb41edc 100644 --- a/src/documentation/content/xdocs/license.xml +++ b/src/documentation/content/xdocs/license.xml @@ -1,5 +1,6 @@ - +

diff --git a/src/documentation/content/xdocs/limitations.xml b/src/documentation/content/xdocs/limitations.xml index c6bf9ee27..4772555d0 100644 --- a/src/documentation/content/xdocs/limitations.xml +++ b/src/documentation/content/xdocs/limitations.xml @@ -1,5 +1,6 @@ - +

diff --git a/src/documentation/content/xdocs/news.xml b/src/documentation/content/xdocs/news.xml index dcaf72893..9a45b8c14 100644 --- a/src/documentation/content/xdocs/news.xml +++ b/src/documentation/content/xdocs/news.xml @@ -1,5 +1,6 @@ - +

diff --git a/src/documentation/content/xdocs/output.xml b/src/documentation/content/xdocs/output.xml index 6383dac07..528c01605 100644 --- a/src/documentation/content/xdocs/output.xml +++ b/src/documentation/content/xdocs/output.xml @@ -1,5 +1,6 @@ - + diff --git a/src/documentation/content/xdocs/relnotes.xml b/src/documentation/content/xdocs/relnotes.xml index 2022de1e3..3f38ac19b 100644 --- a/src/documentation/content/xdocs/relnotes.xml +++ b/src/documentation/content/xdocs/relnotes.xml @@ -1,5 +1,6 @@ - +

diff --git a/src/documentation/content/xdocs/resources.xml b/src/documentation/content/xdocs/resources.xml index 64e98f065..1fdc4126e 100644 --- a/src/documentation/content/xdocs/resources.xml +++ b/src/documentation/content/xdocs/resources.xml @@ -1,14 +1,15 @@ - + -

- Resources - Resources useful for developing and using FOP -

+ Resources + Resources useful for developing and using FOP +

- +

FOP Relevant Specifications and Links @@ -91,6 +92,6 @@ post processing of the generated PDF files: - +

diff --git a/src/documentation/content/xdocs/status.xml b/src/documentation/content/xdocs/status.xml index e7311064c..21598288f 100644 --- a/src/documentation/content/xdocs/status.xml +++ b/src/documentation/content/xdocs/status.xml @@ -1,5 +1,6 @@ - + diff --git a/src/documentation/content/xdocs/svg.xml b/src/documentation/content/xdocs/svg.xml index 94580a310..346e297b4 100644 --- a/src/documentation/content/xdocs/svg.xml +++ b/src/documentation/content/xdocs/svg.xml @@ -1,5 +1,6 @@ - + diff --git a/src/documentation/content/xdocs/tabs.xml b/src/documentation/content/xdocs/tabs.xml index c431ae015..65ea245a0 100644 --- a/src/documentation/content/xdocs/tabs.xml +++ b/src/documentation/content/xdocs/tabs.xml @@ -1,5 +1,6 @@ - + - + diff --git a/src/documentation/content/xdocs/testing.xml b/src/documentation/content/xdocs/testing.xml index c43f9e7f2..219953d5a 100644 --- a/src/documentation/content/xdocs/testing.xml +++ b/src/documentation/content/xdocs/testing.xml @@ -1,5 +1,6 @@ - +