FOP Relevant Specifications

From a692c9b1e3837bc8f2da5eabe023bffebdccfc97 Mon Sep 17 00:00:00 2001 From: fotis Date: Mon, 7 Aug 2000 22:34:08 +0000 Subject: [PATCH] updates docs for coming release 0.14 git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@193610 13f79535-47bb-0310-9956-ffa450edef68 --- docs/html-docs/compiling.html | 8 ++++++ docs/html-docs/examples.html | 10 +++++++- docs/html-docs/implemented.html | 3 ++- docs/html-docs/limitations.html | 10 ++++++-- docs/html-docs/running.html | 40 +++++++++++++++++++----------- docs/html-docs/specs.html | 2 +- docs/xml-docs/fop/compiling.xml | 8 ++++++ docs/xml-docs/fop/examples.xml | 10 +++++++- docs/xml-docs/fop/limitations.xml | 2 +- docs/xml-docs/fop/running.xml | 41 ++++++++++++++----------------- docs/xml-docs/fop/specs.xml | 6 +++-- 11 files changed, 94 insertions(+), 46 deletions(-) diff --git a/docs/html-docs/compiling.html b/docs/html-docs/compiling.html index be76a281d..1e9f7c8e8 100644 --- a/docs/html-docs/compiling.html +++ b/docs/html-docs/compiling.html @@ -66,6 +66,14 @@

A help screen is shown by calling "build usage".


	Problems

If you have problems compiling Fop, please try this first: delete the build directory completely and + try a new build from scratch. Check, whether you have all necessary libraries in your classpath: + xerces.jar, xalan.jar, bsf.jar, jimi.jar (optional). If you still have problems, please look at the + page bugs, for further help. +


	Compiling FOP on MacOS

We strongly recommend the use of Codewarrior Java. You will find diff --git a/docs/html-docs/examples.html b/docs/html-docs/examples.html index b4a705863..239740f66 100644 --- a/docs/html-docs/examples.html +++ b/docs/html-docs/examples.html @@ -31,13 +31,21 @@

list.fo - a simple list

images.fo - shows how to embed gif and jpg images into the xsl:fo file using inline-graphic. +

images.fo - shows how to embed gif and jpg images into the xsl:fo file using external-graphic.

border.fo - a not so simple example how to use borders in tables

extensive.fo - a longer test file containing a lot of different flow objects and properties. A good candidate to test your bugfix or new Fop code.

leader.fo - a very simple example of a rule +

Look also into the directory examples/svg. There you find some very extensive svg examples. + Just start makedoc. +

In the directory examples/pagination you find a suite of examples showing the use + of xsl:fo pagination. +

Developers will find the first steps to a test suite for all implemented formatting objects and properties in xml-fop/docs/bugtests.

diff --git a/docs/html-docs/implemented.html b/docs/html-docs/implemented.html index df68c75c0..c12b5d6c0 100644 --- a/docs/html-docs/implemented.html +++ b/docs/html-docs/implemented.html @@ -29,12 +29,13 @@

block
conditional-page-master-reference
display-rule
display-sequence
external-graphic
flow
inline-sequence
instream-foreign-object
layout-master-set
leader, but see limitations
list-block
list-item
list-item-body

The main limitation at the moment is: FOP only supports the XSL working draft 21 Apr 1999, - not the latest from 27 March 2000. FOP implements the fo objects and properties listed +

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


	leader

fo:leader is only supported in a very limited way: you can use it to draw simple rules. + Only the property value leader-pattern="rule" is supported. leader-length can be set, + but the value is not used. You should wrap leader into a block element. +


	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 diff --git a/docs/html-docs/running.html b/docs/html-docs/running.html index a5213a955..f2e3b20d7 100644 --- a/docs/html-docs/running.html +++ b/docs/html-docs/running.html @@ -24,20 +24,23 @@

a) Java 1.1.x or later (If you want to use AWTCommandLine, you need Swing)

b) An XML parser which supports SAX and DOM like Xerces-J. - (Xerces is the default xml parser)

c) If you have to produce the flow objects files, which are the input for FOP, - you need a transformation utility to create this files from your xml files. - Normally this is an XSLT stylesheet processor like - XT - or XALAN. + (Xerces is the default xml parser) +

c) Fop supports SVG (see Features for further information) and + needs the w3c.jar library. This library comes with Fop (xml-fop/lib) and must + be included in your classpath +

d) Optional: Fop supports the jimi library for image processing, if it is in your classpath + when you build Fop.


	Starting FOP as an standalone application

There are two ways to run FOP from the command line.

a) Batch processing formatting objects (fo) files:

java org.apache.fop.apps.CommandLine fo-file pdf-file

- -

b) Previewing the fo-file:

b) Batch processing xml files (includes production of the fo-files):

java org.apache.fop.apps.XalanCommandLine xml-file xsl-file pdf-file

c) Previewing the fo-file:

java org.apache.fop.apps.AWTCommandLine fo-file

Each method uses next to the fop classes other packages. The following describes each method in detail.

@@ -61,8 +64,20 @@

org.apache.fop.apps.CommandLine fo-file pdf-file

Note: The xerces jar file must be included, because xp has no dom support.

- -


	Method Two


	Method Two

Rather than performing transformation with an XSLT before invoking FOP, it is + possible, if you use Xalan as your XSLT engine, to just call FOP and have it call + Xalan for you. To do this, run the class org.apache.fop.apps.XalanCommandLine with the + source XML file name, XSL file name and PDF file name as arguments. You will + need to include Xalan in your classpath and so you might invoke +

java -cp fop.jar;xalan.jar;xerces.jar;w3c.jar

org.apache.fop.apps.XalanCommandLine xml-file xsl-file pdf-file

Again, if your SAX Parser is other than Xerces, you will need to set the property + org.xml.sax.parser to the SAX Parser class to use. +


	Method Three

If you already produced the FO file, you can preview the results of your transformation without using any pdf viewer by invoking FOP with the viewer application. You will need to include FOP and your XML Parser in your classpath @@ -70,11 +85,6 @@

java -cp fop.jar;xerces.jar;w3c.jar

org.apache.fop.apps.AWTCommandLine fo-file

The viewer uses the swing classes.

Note: If you are using java 2 or later (i.e. jdk 1.2. or later) you can put all - needed jar files into the subdirectory jdk1.2.x\jre\lib\ext (windows example). Then - FOP can be started without classpath: -

java org.apache.fop.apps.CommandLine fo-file pdf-file


	Running FOP on MacOS

diff --git a/docs/html-docs/specs.html b/docs/html-docs/specs.html index 790968e29..54bfba28d 100644 --- a/docs/html-docs/specs.html +++ b/docs/html-docs/specs.html @@ -1,4 +1,4 @@ -FOP Relevant Specifications

+FOP Relevant Specifications and Links

diff --git a/docs/xml-docs/fop/compiling.xml b/docs/xml-docs/fop/compiling.xml index 3b84fde7d..108b05575 100644 --- a/docs/xml-docs/fop/compiling.xml +++ b/docs/xml-docs/fop/compiling.xml @@ -51,6 +51,14 @@

A help screen is shown by calling "build usage".

+ +

We strongly recommend the use of Codewarrior Java. You will find diff --git a/docs/xml-docs/fop/examples.xml b/docs/xml-docs/fop/examples.xml index 7b5d4e1dc..3ca98aa6e 100644 --- a/docs/xml-docs/fop/examples.xml +++ b/docs/xml-docs/fop/examples.xml @@ -16,13 +16,21 @@

list.fo - a simple list

images.fo - shows how to embed gif and jpg images into the xsl:fo file using inline-graphic. +

images.fo - shows how to embed gif and jpg images into the xsl:fo file using external-graphic.

border.fo - a not so simple example how to use borders in tables

extensive.fo - a longer test file containing a lot of different flow objects and properties. A good candidate to test your bugfix or new Fop code.

leader.fo - a very simple example of a rule +

Look also into the directory examples/svg. There you find some very extensive svg examples. + Just start makedoc. +

In the directory examples/pagination you find a suite of examples showing the use + of xsl:fo pagination. +

Developers will find the first steps to a test suite for all implemented formatting objects and properties in xml-fop/docs/bugtests.

diff --git a/docs/xml-docs/fop/limitations.xml b/docs/xml-docs/fop/limitations.xml index 1c7c53eca..d4a88e966 100644 --- a/docs/xml-docs/fop/limitations.xml +++ b/docs/xml-docs/fop/limitations.xml @@ -10,7 +10,7 @@

fo:leader is only supported in a very limited way: you can use it to draw simple rule . +

fo:leader is only supported in a very limited way: you can use it to draw simple rules. Only the property value leader-pattern="rule" is supported. leader-length can be set, but the value is not used. You should wrap leader into a block element.

diff --git a/docs/xml-docs/fop/running.xml b/docs/xml-docs/fop/running.xml index 4eedf1a19..049fe4f22 100644 --- a/docs/xml-docs/fop/running.xml +++ b/docs/xml-docs/fop/running.xml @@ -9,21 +9,23 @@

a) Java 1.1.x or later (If you want to use AWTCommandLine, you need Swing)

b) An XML parser which supports SAX and DOM like Xerces-J. - (Xerces is the default xml parser)

c) Fop supports SVG (see Features for further information) and + needs the w3c.jar library. This library comes with Fop (xml-fop/lib) and must + be included in your classpath +

d) Optional: Fop supports the jimi library for image processing, if it is in your classpath + when you build Fop.

There are two ways to run FOP from the command line.

a) Batch processing formatting objects (fo) files:

java org.apache.fop.apps.CommandLine fo-file pdf-file

- -

b) Previewing the fo-file:

b) Batch processing xml files (includes production of the fo-files):

java org.apache.fop.apps.XalanCommandLine xml-file xsl-file pdf-file

c) Previewing the fo-file:

java org.apache.fop.apps.AWTCommandLine fo-file

Each method uses next to the fop classes other packages. The following describes each method in detail.

@@ -47,20 +49,20 @@

org.apache.fop.apps.CommandLine fo-file pdf-file

Note: The xerces jar file must be included, because xp has no dom support.

- - + +

java -cp fop.jar;xerces.jar;w3c.jar

org.apache.fop.apps.AWTCommandLine fo-file

The viewer uses the swing classes.

java org.apache.fop.apps.CommandLine fo-file pdf-file

diff --git a/docs/xml-docs/fop/specs.xml b/docs/xml-docs/fop/specs.xml index 5353b177a..ba7b94032 100644 --- a/docs/xml-docs/fop/specs.xml +++ b/docs/xml-docs/fop/specs.xml @@ -1,9 +1,9 @@ - + - +

Latest XSL-FO Working Draft (27 March 2000)
A dtd for the XSL-FO Working Draft (27 March 2000) provided by N. Grigoriev from RenderX
Java JDK 1.1 Documentation

+ + -- 2.39.5