From fb3a5e56c7aa0719a5f8e87fe6f2b0cd480e8467 Mon Sep 17 00:00:00 2001 From: fotis Date: Tue, 14 Nov 2000 15:22:14 +0000 Subject: [PATCH] updating docs for v 0.15 git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@193802 13f79535-47bb-0310-9956-ffa450edef68 --- docs/html-docs/compiling.html | 92 ++++++++++-------------- docs/html-docs/examples.html | 20 +++++- docs/html-docs/implemented.html | 121 ++++++++++++++++++++++---------- 3 files changed, 140 insertions(+), 93 deletions(-) diff --git a/docs/html-docs/compiling.html b/docs/html-docs/compiling.html index 1e9f7c8e8..e431b7f66 100644 --- a/docs/html-docs/compiling.html +++ b/docs/html-docs/compiling.html @@ -19,66 +19,50 @@ License

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

-

-
An XML parser
  -

An XML parser which supports Sax and DOM like - Xerces-J. - The parser must be in your classpath

-

-
The xslt processor Xalan
  -

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

-

Xalan is an XSL stylesheet processor written in java. At the moment you - can't use any other processor, because the make process makes use of some - proprietary features of Xalan which allow to write output in more - then one document. You can find Xalan also at - xml.apache.org. You have to use Xalan version 0.19.5 or later. - Xalan.jar must be in your classpath and also the file bsf.jar, which comes with Xalan.

-

-
Setting of JAVA_HOME
  -

You have to set the enviroment variable JAVA_HOME. It must point to your local JDK - root directory. This is true, even if you use JDK 1.2 or above, which don't need this - setting. It is used by the compilation software.

-

-
Settings in your classpath
  -

If you want Fop to use the image library jimi, it should be in your classpath during - compilation. -

-

A CLASSPATH for a complete compilation of Fop could look like this, if all these jar files are in +

Compilation is started by executing build, either as a batch file on win32 (build.bat) or as a shell script on unix. Before you + can start one of these scripts, you have to setup your classpath and the environment variable JAVA_HOME (see below).

+

The compilation uses Ant, + a replacement of make (you can find more information about Ant at + jakarte.apache.org). + build.xml is the replacement of makefile. Look there for detailed information on the build + process and different targets.

+

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

+

If you only want to use Fop, you don't need to build it. A fop.jar comes with the distribution.

+
Setting up your classpath
  +

The build process relies on finding following libraries in your classpath (the version numbers indicate that building with them has been successfully tested, other, later versions may work too:

+
    +
  • Xerces-J version 1.2.1 (xml parser)
    • +
  • Xalan version 1.2 (xslt processor)
    • +
  • bsf.jar (comes with Xalan)
    • +
  • jimi.jar (image processing library) this file is optional
    • +
+

Other needed libraries and classes come with Fop (in xml-fop/lib), but the build script sets the path to + them, so you only need to care about them, if you build Fop in any other way. See build.bat/build.sh for + details. +

+

A classpath for a complete compilation of Fop could look like this, if all these jar files are in a directory called jars (example uses windows syntax):

-

set CLASSPATH=\jars\xalan.jar;\jars\xerces.jar;\jars\bsf.jar;\jars\jimi.jar; +

set CLASSPATH=\jars\xalan.jar; \jars\xerces.jar; \jars\bsf.jar; \jars\jimi.jar;


+
Setting of JAVA_HOME
  +

You have to set the enviroment variable JAVA_HOME. It must point to your local JDK + root directory. This is true, even if you use JDK 1.2 or above, which normally don't need this + setting. It is used by Ant, the compilation software.


-
Compiling
  -

Compilation is started by executing build, either as a batch file on win32 (build.bat) or as a shell script on unix. The compilation uses Ant, - a replacement of make (you can find more information about Ant at - jakarte.apache.org). - build.xml is the replacement of makefile. Look there for further information.

-

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 - a link to more information in the near future. -

+

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)
    • +
  • check, whether you have the required versions of Xerces (>= 1.2.1) and Xalan (>=1.2)
    • +
  • check, whether you have an older version of xerces.jar, xalan.jar, w3c.jar somewhere in + you classpath.
    • +
+

If you still have problems, please look at the + page bugs, for further help.



Copyright © 1999 The Apache Software Foundation. diff --git a/docs/html-docs/examples.html b/docs/html-docs/examples.html index 5c578028d..8148c93c3 100644 --- a/docs/html-docs/examples.html +++ b/docs/html-docs/examples.html @@ -21,16 +21,21 @@

Examples for the use of xsl:fo can be found in the Fop distribution in the subdirectory xml-fop/docs/examples/fo. You can start transformation of all fo files into pdf - files by starting xml-fop/docs/examples/runtests. + files by starting xml-fop/docs/examples/runtests. The resulting test files can be found in + xml-fop/docs/examples/tests

At the moment the following files are part of the distribution:

    -
  • normal.fo - a very simple file showing the use of a 2 level of headings, normal text and a header. +
  • simple.fo - a very simple file which gives use a first impression of the structure of an fo file +
    • +
  • normal.fo - a simple file showing the use of a 2 level of headings, normal text and a header.
  • table.fo - a simple table
  • list.fo - a simple list
    • +
  • list2.fo - some list examples +
  • 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 @@ -40,6 +45,17 @@
  • leader.fo - a very simple example of a rule
    • +
  • normalex.fo - shows the use of computed property values +
    • +
  • inhprop.fo - shows the use of inherited property values +
    • +
  • instream.fo - shows the use of fo:instream-foreign-object together with svg +
    • +
  • inhprop.fo - shows the use of inherited property values +
    • +
  • textdeko.fo - shows the use of the property textdecoration +
    • +
  • Look also into the directory examples/svg. There you find some very extensive svg examples. Just start makedoc.
    • diff --git a/docs/html-docs/implemented.html b/docs/html-docs/implemented.html index c12b5d6c0..7a99f330a 100644 --- a/docs/html-docs/implemented.html +++ b/docs/html-docs/implemented.html @@ -21,48 +21,93 @@
What's Implemented?
 

The following formatting objects and properties of the xsl-fo - working draft (27 March 2000) are implemented. Please have also a look at the + working draft (12 October 2000) are implemented.Please have also a look at the section on limitations


1) Formatting Objects
  -
    -
  • block
    • -
  • conditional-page-master-reference
    • -
  • display-sequence
    • -
  • external-graphic
    • -
  • flow
    • -
  • inline-sequence
    • -
  • instream-foreign-object
    • -
  • layout-master-set
    • -
  • leader, but see limitations
    • -
  • list-block
    • -
  • list-item
    • -
  • list-item-body
    • -
  • list-item-label
    • -
  • page-number
    • -
  • page-number-citation, see limitations
    • -
  • page-sequence
    • -
  • page-sequence-master
    • -
  • region-after
    • -
  • region-before
    • -
  • region-body
    • -
  • repeatable-page-master-alternatives
    • -
  • repeatable-page-master-reference
    • -
  • root
    • -
  • simple-page-master
    • -
  • simple-link (internal and external)
    • -
  • single-page-master-reference
    • -
  • static-content
    • -
  • table (minimal support)
    • -
  • table-body (minimal support)
    • -
  • table-cell (minimal support)
    • -
  • table-column (minimal support)
    • -
  • table-row (minimal support)
    • -
+

This section follows the table "B Formatting Object Summary" in the xsl:fo specification. At the + end of each sub-section you find listed what is not implemented.

+ +
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
    • +
  • flow
    • +
  • static-content
    • +
+

Not implemented: region-start, region-end, declarations, color-profile, title

+

+ +
B.2 Block Formatting Objects
  +
    +
  • block
    • +
+

Not implemented: block-container

+

+ +
B.3 Inline Formatting Objects
  +
    +
  • external-graphic
    • +
  • inline
    • +
  • instream-foreign-object
    • +
  • leader, but see limitations
    • +
  • page-number
    • +
  • page-number-citation, see limitations
    • +
+

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

+

+ +
B.4 Table Formatting Objects
  +
    +
  • table (minimal support)
    • +
  • table-column (minimal support)
    • +
  • table-body (minimal support)
    • +
  • table-row (minimal support)
    • +
  • table-cell (minimal support)
    • +
+

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

+

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

Not implemented: float, footnote, footnote-body

+

+ +
B.8 Other Formatting Objects
  +

Not implemented: wrapper, marker, retrieve-marker

+


+
2) Properties
  +

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

  • background-color
  • blank-or-not-blank
    • @@ -114,7 +159,7 @@
  • id
  • initial-page-number
  • internal-destination
    • -
  • keep-with-next
    • +
  • keep-with-next (broken)
  • left
  • line-height
  • margin-bottom (only on pages and regions)
    • @@ -146,14 +191,16 @@
  • space-before.optimum
  • src
  • start-indent
    • +
  • textdecoration (only value 'underline' is supported)
  • text-align
  • text-align-last
  • text-indent
  • top
    • -
  • white-space-treatment
    • +
  • white-space-treatment (broken)
  • width
  • wrap-option
+

All other properties are not implemented.


3) SVG elements supported
  -- 2.39.5