From d08acd57bae9a4969595aa38148e7ac8199e81e4 Mon Sep 17 00:00:00 2001 From: fotis Date: Fri, 3 Dec 1999 12:31:27 +0000 Subject: [PATCH] New sections: How to get involved. Problems. Points to Xerces-J as standard parser. Mentions swing classes. git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@193268 13f79535-47bb-0310-9956-ffa450edef68 --- docs/readme.xml | 88 ++++++++++++++++++++++++++++++++++++------------- 1 file changed, 66 insertions(+), 22 deletions(-) diff --git a/docs/readme.xml b/docs/readme.xml index 08f9b0082..4af694b70 100644 --- a/docs/readme.xml +++ b/docs/readme.xml @@ -10,25 +10,27 @@ Usage of attributes: p: attr "class" can have "pre" (for code) or "li" for lists. No class attr is the normal --> - + FOP: An Open-Source XSL Formatter and Renderer - 1.4 1999/11/29 19:45 + 1.5 1999/12/01 16:00 James Tauber Fotis Jannidis jtauber@jtauber.com - jannidis@lrz.uni-muenchen.deFOP + fotis.jannidis@lrz.uni-muenchen.de + FOP
+ What is FOP?

FOP is the world's first print formatter driven by XSL formatting objects. It is a Java 1.1 application that reads a formatting object @@ -51,7 +53,11 @@ Usage of attributes: 1. Prerequisites

a) Java 1.1.x or later -

+

If you use Java 1.1.x you must also seperately include the swing classes, which can + be found at the + Sun website. From Java 1.2 on (aka Java 2) they are part of the standard + distribution. +

b) An XML parser @@ -93,6 +99,12 @@ Usage of attributes: 1) Prerequisites

Following software must be installed:

a) Java 1.1.x or later

+

For the fo-file viewer mode of FOP (see below) you must have the swing classes installed. + From Java 1.2 on (aka Java 2) they are part of the standard java distribution. + If you use Java 1.1.x you must seperately include the swing classes, which can + be found at the + Sun website. +

b) An XML parser which supports SAX and DOM like Xerces-J.

c) If you have to produce the flow objects files, which are the input for FOP, @@ -104,8 +116,8 @@ Usage of attributes:

2) Starting FOP as an standalone application -

There are three ways of running FOP from the command line.

-

a) Batch processing formatting object files:

+

There are three 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) Batch processing xml files (includes production of the fo-files):

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

@@ -118,17 +130,18 @@ Usage of attributes:

One is to first use an XSLT engine to produce the formatting object tree as an XML document and then running the class org.apache.fop.apps.CommandLine with the formatting object file name and PDF filename as arguments. You will need to include - FOP, SAX and your SAX Parser in your classpath and so you might invoke + FOP and your XML Parser in your classpath and so you might invoke

-

java -cp fop_x_xx_x.jar;sax.jar;xp.jar

-

org.apache.fop.apps.CommandLine formatting-tree-file pdf-file

-

If your SAX Parser is other than XP, you will need to set the property +

java -cp fop_x_xx_x.jar;xerces.jar

+

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

+

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. The following example shows - the command line, if you use Xerces, the xml parser from xml.apache.org: + the command line, if you use XP, the XML parser from James Clark:

-

java -Dorg.xml.sax.parser=org.apache.xerces.parsers.SAXParser

-

-cp fop_x_xx_x.jar;xerces.jar

+

java -Dorg.xml.sax.parser=com.jclark.xml.sax.Driver

+

-cp fop_x_xx_x.jar;sax.jar;xt.jar;xp.jar;xerces.jar

org.apache.fop.apps.AWTCommandLine formatting-tree-file pdf-file

+

(You have to include xerces.jar or another xml parser which supports DOM in your classpath.)

b) Method Two @@ -139,9 +152,10 @@ Usage of attributes: need to include FOP, SAX, your SAX Parser and XT in your classpath and so you might invoke

-

java -cp fop_x_xx_x.jar;sax.jar;xp.jar;xt.jar

+

java -Dorg.xml.sax.parser=com.jclark.xml.sax.Driver

+

-cp fop_x_xx_x.jar;xt.jar;xerces.jar

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

-

Again, if your SAX Parser is other than XP, you will need to set the property +

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.

@@ -149,9 +163,11 @@ Usage of attributes: c) 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, SAX and your SAX Parser in your classpath + application. You will need to include FOP and your XML Parser in your classpath

-

java org.apache.fop.apps.AWTCommandLine formatting-tree-file

+

java -cp fop_x_xx_x.jar;xerces.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: @@ -159,6 +175,14 @@ Usage of attributes:

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

+
+ 3) Problems +

If you have problems running FOP, please have a look at the + FOP FAQ. If you don't find a solution there, + you can ask for help on the list fop-dev@xml.apache.org. Maybe it's bug and + maybe somebody is already working on it. +

+
@@ -167,7 +191,7 @@ Usage of attributes: What's Implemented?

Also see STATUS for what is being worked on.

- a) Formatting Objects + 1) Formatting Objects

root

layout-master-set

@@ -197,11 +221,11 @@ Usage of attributes:

table-body (minimal support)

table-row (minimal support)

table-cell (minimal support)

- -
+
+
- b) Properties + 2) Properties

end-indent

page-master-name

@@ -255,6 +279,26 @@ Usage of attributes:

see STATUS file

+ + +
+ Getting involved +

1. Subscribe to fop-dev@xml.apache.org by sending an email + to fop-dev-subscribe@xml.apache.org

+

2. Read the archives to fop-dev to get an idea of the issues being + discussed.

+

3. Subscribe to fop-cvs@xml.apache.org by sending an email to + fop-cvs-subscribe@xml.apache.org (it is important + that you follow changes being made).

+

4. Try :-) to wrap your head around the XSL working draft.

+

5. Get CVS working on your system.

+

6. Ask, on fop-dev, any questions you have at all about the code, design, etc.

+

7. When you feel comfortable modifying the code, send diffs to + fop-dev with your contributions.

+

8. Have fun!

+
+ +
@@ -262,7 +306,7 @@ Usage of attributes:

XML Recommendation

XSL-FO Working Draft

-

XSLT Recommandation

+

XSLT Recommendation

PDF Documentation

Simple API for XML (SAX)

Document Object Model (DOM)

-- 2.39.5