Date: Fri, 26 Nov 1999 05:18:06 +0000 Subject: [PATCH] added docs directory with readme and faq marked up in qaml and xslt for producing ascii, html and pdf. Contributed by Fotis Jannidis git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@193245 13f79535-47bb-0310-9956-ffa450edef68 --- docs/faq.xml | 67 ++++++++++ docs/qaml-html.css | 43 +++++++ docs/qaml-xml.dtd | 303 +++++++++++++++++++++++++++++++++++++++++++++ docs/readme.xml | 225 +++++++++++++++++++++++++++++++++ docs/xml2ascii.xsl | 86 +++++++++++++ docs/xml2html.xsl | 173 ++++++++++++++++++++++++++ docs/xml2pdf.xsl | 193 +++++++++++++++++++++++++++++ 7 files changed, 1090 insertions(+) create mode 100644 docs/faq.xml create mode 100644 docs/qaml-html.css create mode 100644 docs/qaml-xml.dtd create mode 100644 docs/readme.xml create mode 100644 docs/xml2ascii.xsl create mode 100644 docs/xml2html.xsl create mode 100644 docs/xml2pdf.xsl diff --git a/docs/faq.xml b/docs/faq.xml new file mode 100644 index 000000000..cf4f56c29 --- /dev/null +++ b/docs/faq.xml @@ -0,0 +1,67 @@ + + + + + + + + + + FOP - Frequently Asked Questions + 1.0 1999/11/24 + + James Tauber + Fotis Jannidis + jtauber@jtauber.com + jannidis@lrz.uni-muenchen.deFOP + + + + + +

+ FAQ - Running FOP + + + Q: Running FOP I get the following messages or something similar: + "WARNING: Unknown formatting object http://www.w3.org/XSL/Format/1.0^root" + and then a FATAL Error "Root element must be root, not default FO". + +

A: Make sure that you have specified as the namespace for fo the + following string: "http://www.w3.org/1999/XSL/Format". It is analogous + to the xslt namespace "http://www.w3.org/1999/XSL/Transform" +

+ + + + + +

+ + + + + + + diff --git a/docs/qaml-html.css b/docs/qaml-html.css new file mode 100644 index 000000000..66ddc4059 --- /dev/null +++ b/docs/qaml-html.css @@ -0,0 +1,43 @@ +/* Use Times New Roman for default font */ + + +body { + background-color:#FFFF99; + font-family: serif,Times,"Times New Roman"; + font-size: 12pt; + margin-left: 20%; + margin-right: 20%; +} + +h1 { + font-size: 16pt; + margin-top: 5pt; + margin-bottom: 5pt; + +} + +h1.title { + font-size: 18pt; + margin-top: 10pt; + margin-bottom: 10pt; +} + +h2 { + font-size: 14pt; +} + +h3 { + font-size: 12pt; + font-weight: bold; +} + + +p.pre { + font-family: monospace,Courier,"Courier New"; + font-size: 10pt; +} + +p.contact { + font-size: 9pt; + text-align= right; +} diff --git a/docs/qaml-xml.dtd b/docs/qaml-xml.dtd new file mode 100644 index 000000000..5159a02a1 --- /dev/null +++ b/docs/qaml-xml.dtd @@ -0,0 +1,303 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/readme.xml b/docs/readme.xml new file mode 100644 index 000000000..1edceeeda --- /dev/null +++ b/docs/readme.xml @@ -0,0 +1,225 @@ + + + + + + + + + + FOP + 1.0 1999/11/24 + + James Tauber + Fotis Jannidis + jtauber@jtauber.com + jannidis@lrz.uni-muenchen.deFOP + + + + + +

+ 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 tree and then turns it into a PDF document. + The formatting object tree, can be in the form of an XML + document (output by an XSLT engine like XT or Xalan) or can be + passed in memory as a DOM Document or (in the case of + XT or Xalan) SAX events. +

FOP is part of Apache's XML project. The homepage of FOP is + http:/xml.apache.org/fop. +

+ +

+ Compiling FOP +

+ 1. Prerequisites +

+ a) Java 1.1.x or later +

+ b) XT from James Clark +

Some of the Java source code in FOP is generated from XML using + XSLT. XT must be used to generate this code.

XT is an XSL stylesheet processor written in java. At the moment you + can't use any other processor, because the make file makes use of some + proprietary features of Clark's xt which allow to write output in more + then one document. You can find XT at + James Clark's website. You have to use XT version 19991105 or later.

(Under windows you shouldn't use the prepackaged xt.exe but also the + generic jar file, otherwise make won't work) +

XT relies on an sax parser like XP (also J. Clark), which can be + downloaded at James + Clark's Website +

+ c) make +

Under windows it has been reported that the use of the cygnus solutions port + of the GNU utilities works. You can find it at + Cygnus Solutions +

+ +

+ Running FOP +

+ 1) Prerequisites +

Following software must be installed:

a) Java 1.1.x or later

b) A sax parser like XP.

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. +

+ 2) Starting FOP as an standalone application +

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

+ a) Method One +

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 +

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 + org.xml.sax.parser to the SAX Parser class to use. +

+ b) Method Two +

Rather than performing transformation with an XSLT before invoking FOP, it is + possible, if you use XT as your XSLT engine, to just call FOP and have it call + XT for you. To do this, run the class org.apache.fop.apps.CommandLine with the + source XML file name, XSL file name and PDF file name as arguments. You will + 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

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 + org.xml.sax.parser to the SAX Parser class to use. +

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 formatting-tree-file pdf-file

+ +

+ What's Implemented? +

+ a) Formatting Objects +

root

layout-master-set

simple-page-master

region-body

region-before

region-after

page-sequence

sequence-specification

sequence-specifier-single

sequence-specifier-repeating

sequence-specifier-alternating

flow

static-content

block

list-block

list-item

list-item-label

list-item-body

page-number

display-sequence

inline-sequence

display-rule

display-graphic

+ b) Properties +

end-indent

page-master-name

page-master-first

page-master-repeating

page-master-odd

page-master-even

margin-top

margin-bottom

margin-left

margin-right

extent

page-width

page-height

flow-name

font-family

font-style

font-weight

font-size

line-height

text-align

text-align-last

space-before.optimum

space-after.optimum

start-indent

end-indent

provisional-distance-between-starts

provisional-label-separation

rule-thickness

color

wrap-option

white-space-treatment

break-before

break-after

text-indent

href

+ +

+ Bugs +

+ +

+ FOP Relevant Specifications +

XML Recommendation

XSL-FO Working Draft

XSLT Recommandation

PDF Documentation

Simple API for XML (SAX)

Document Object Model (DOM)

Namespaces in XML Recommendation

Java JDK 1.1 Documentation

+ + + diff --git a/docs/xml2ascii.xsl b/docs/xml2ascii.xsl new file mode 100644 index 000000000..10db33af8 --- /dev/null +++ b/docs/xml2ascii.xsl @@ -0,0 +1,86 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ) + + + + + + + +Version: - +Contact: () + + + + +) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + () + + + + + diff --git a/docs/xml2html.xsl b/docs/xml2html.xsl new file mode 100644 index 000000000..a18ad762e --- /dev/null +++ b/docs/xml2html.xsl @@ -0,0 +1,173 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <xsl:apply-templates/> + + + + + + + + +

+ + +

+ +) + + +# + + + +
+ +

+ + + + +

+Version: - +Contact: + + +mailto: + + + +

+ + + + + +

+ + + + + +) + +

+ + + + +

+ +

+ + + + +

+ +

+ + + + +

+ +

+ + + + + + + + + +

+ +

+ + + + + + + + + +

+ + + + +

+ +

+ + + + + +

+ + + + +

+ + + + + +

+ +

+ + + + + + + + + + + + + + + diff --git a/docs/xml2pdf.xsl b/docs/xml2pdf.xsl new file mode 100644 index 000000000..2389546ee --- /dev/null +++ b/docs/xml2pdf.xsl @@ -0,0 +1,193 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +FOP - p. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +* + + + + + + + + + + + + + + + + + + + + + + + + + + + + +() + + + -- 2.39.5