aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorfotis <fotis@unknown>2000-08-07 22:34:08 +0000
committerfotis <fotis@unknown>2000-08-07 22:34:08 +0000
commita692c9b1e3837bc8f2da5eabe023bffebdccfc97 (patch)
tree43c5b3b8c13ebb27e54a99e75e6ddf1b34006823 /docs
parenta2e99f7fa0db347857bc06df9c3e0b70e5bf39e4 (diff)
downloadxmlgraphics-fop-a692c9b1e3837bc8f2da5eabe023bffebdccfc97.tar.gz
xmlgraphics-fop-a692c9b1e3837bc8f2da5eabe023bffebdccfc97.zip
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
Diffstat (limited to 'docs')
-rw-r--r--docs/html-docs/compiling.html8
-rw-r--r--docs/html-docs/examples.html10
-rw-r--r--docs/html-docs/implemented.html3
-rw-r--r--docs/html-docs/limitations.html10
-rw-r--r--docs/html-docs/running.html40
-rw-r--r--docs/html-docs/specs.html2
-rw-r--r--docs/xml-docs/fop/compiling.xml8
-rw-r--r--docs/xml-docs/fop/examples.xml10
-rw-r--r--docs/xml-docs/fop/limitations.xml2
-rw-r--r--docs/xml-docs/fop/running.xml41
-rw-r--r--docs/xml-docs/fop/specs.xml6
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 @@
<P>A help screen is shown by calling &quot;build usage&quot;.
</P>
</FONT></TD></TR></TABLE><BR>
+ <TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="666699" colspan="2" width="494"><TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#039acc" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#039acc" height="1" width="492"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#039acc" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#0086b2" width="492"><FONT color="#ffffff" face="arial,helvetica,sanserif" size="+1"><IMG border="0" height="2" hspace="0" src="resources/void.gif" vspace="0" width="2"><B>Problems</B></FONT></TD><TD bgcolor="#017299" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#017299" height="1" width="492"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#017299" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR></TABLE></TD></TR><TR><TD width="10">&nbsp;</TD><TD width="484"><FONT color="#000000" face="arial,helvetica,sanserif">
+ <P>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 <A href="bugs.html">bugs</A>, for further help.
+ </P>
+ </FONT></TD></TR></TABLE><BR>
+
<TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="666699" colspan="2" width="494"><TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#039acc" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#039acc" height="1" width="492"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#039acc" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#0086b2" width="492"><FONT color="#ffffff" face="arial,helvetica,sanserif" size="+1"><IMG border="0" height="2" hspace="0" src="resources/void.gif" vspace="0" width="2"><B>Compiling FOP on MacOS</B></FONT></TD><TD bgcolor="#017299" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#017299" height="1" width="492"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#017299" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR></TABLE></TD></TR><TR><TD width="10">&nbsp;</TD><TD width="484"><FONT color="#000000" face="arial,helvetica,sanserif">
<P>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 @@
</LI>
<LI>list.fo - a simple list
</LI>
- <LI>images.fo - shows how to embed gif and jpg images into the xsl:fo file using inline-graphic.
+ <LI>images.fo - shows how to embed gif and jpg images into the xsl:fo file using external-graphic.
</LI>
<LI>border.fo - a not so simple example how to use borders in tables
</LI>
<LI>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.
</LI>
+ <LI>leader.fo - a very simple example of a rule
+ </LI>
+ <LI>Look also into the directory examples/svg. There you find some very extensive svg examples.
+ Just start makedoc.
+ </LI>
+ <LI>In the directory examples/pagination you find a suite of examples showing the use
+ of xsl:fo pagination.
+ </LI>
</UL>
<P>Developers will find the first steps to a test suite for all implemented formatting objects and
properties in xml-fop/docs/bugtests.</P>
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 @@
<UL>
<LI>block </LI>
<LI>conditional-page-master-reference</LI>
- <LI>display-rule </LI>
<LI>display-sequence </LI>
<LI>external-graphic</LI>
<LI>flow</LI>
<LI>inline-sequence </LI>
+ <LI>instream-foreign-object</LI>
<LI>layout-master-set </LI>
+ <LI>leader, but see <A href="limitations.html">limitations</A></LI>
<LI>list-block </LI>
<LI>list-item </LI>
<LI>list-item-body </LI>
diff --git a/docs/html-docs/limitations.html b/docs/html-docs/limitations.html
index d40ad5d8b..f2f194b1c 100644
--- a/docs/html-docs/limitations.html
+++ b/docs/html-docs/limitations.html
@@ -19,11 +19,17 @@
<A href="license.html" onMouseOut="rolloverOff('side-license');" onMouseOver="rolloverOn('side-license');"><IMG alt="License" border="0" height="12" hspace="0" name="side-license" onLoad="rolloverLoad('side-license','graphics/license-label-2.jpg','graphics/license-label-3.jpg');" src="graphics/license-label-3.jpg" vspace="0" width="120"></A><BR>
<IMG border="0" height="14" hspace="0" src="resources/close.gif" vspace="0" width="120"><BR></TD><TD align="left" valign="top" width="500"><TABLE border="0" cellpadding="3" cellspacing="0"><TR><TD>
- <P>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
+ <P>FOP implements the fo objects and properties listed
in <A href="implemented.html">features</A>, sometimes it does so only in a limited way.
</P>
+ <TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="666699" colspan="2" width="494"><TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#039acc" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#039acc" height="1" width="492"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#039acc" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#0086b2" width="492"><FONT color="#ffffff" face="arial,helvetica,sanserif" size="+1"><IMG border="0" height="2" hspace="0" src="resources/void.gif" vspace="0" width="2"><B>leader</B></FONT></TD><TD bgcolor="#017299" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#017299" height="1" width="492"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#017299" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR></TABLE></TD></TR><TR><TD width="10">&nbsp;</TD><TD width="484"><FONT color="#000000" face="arial,helvetica,sanserif">
+ <P>fo:leader is only supported in a very limited way: you can use it to draw simple rules.
+ Only the property value leader-pattern=&quot;rule&quot; is supported. leader-length can be set,
+ but the value is not used. You should wrap leader into a block element.
+ </P>
+ </FONT></TD></TR></TABLE><BR>
+
<TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="666699" colspan="2" width="494"><TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#039acc" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#039acc" height="1" width="492"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#039acc" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#0086b2" width="492"><FONT color="#ffffff" face="arial,helvetica,sanserif" size="+1"><IMG border="0" height="2" hspace="0" src="resources/void.gif" vspace="0" width="2"><B>page-number-citation</B></FONT></TD><TD bgcolor="#017299" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#017299" height="1" width="492"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#017299" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR></TABLE></TD></TR><TR><TD width="10">&nbsp;</TD><TD width="484"><FONT color="#000000" face="arial,helvetica,sanserif">
<P>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 @@
<P>a) Java 1.1.x or later (If you want to use AWTCommandLine, you need Swing)</P>
<P>b) An XML parser which supports SAX and DOM like
<A href="http://xml.apache.org/xerces-j/index.html">Xerces-J</A>.
- (Xerces is the default xml parser)</P>
- <P>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
- <A href="http://www.jclark.com/xml/xt.html">XT</A>
- or <A href="http://xml.apache.org/xalan/index.html">XALAN</A>.
+ (Xerces is the default xml parser)
+ </P>
+ <P>c) Fop supports SVG (see <A href="implemented.html">Features</A> for further information) and
+ needs the w3c.jar library. This library comes with Fop (xml-fop/lib) and must
+ be included in your classpath
+ </P>
+ <P>d) Optional: Fop supports the jimi library for image processing, if it is in your classpath
+ when you build Fop.
</P>
</FONT></TD></TR></TABLE><BR>
<TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="666699" colspan="2" width="494"><TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#039acc" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#039acc" height="1" width="492"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#039acc" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#0086b2" width="492"><FONT color="#ffffff" face="arial,helvetica,sanserif" size="+1"><IMG border="0" height="2" hspace="0" src="resources/void.gif" vspace="0" width="2"><B>Starting FOP as an standalone application</B></FONT></TD><TD bgcolor="#017299" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#017299" height="1" width="492"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#017299" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR></TABLE></TD></TR><TR><TD width="10">&nbsp;</TD><TD width="484"><FONT color="#000000" face="arial,helvetica,sanserif">
<P>There are two ways to run FOP from the command line.</P>
<P>a) Batch processing formatting objects (fo) files: </P>
<P><CODE><FONT face="courier, monospaced">java org.apache.fop.apps.CommandLine fo-file pdf-file</FONT></CODE></P>
-
- <P>b) Previewing the fo-file:</P>
+ <P>b) Batch processing xml files (includes production of the fo-files):</P>
+ <P><CODE><FONT face="courier, monospaced">java org.apache.fop.apps.XalanCommandLine xml-file xsl-file pdf-file</FONT></CODE></P>
+ <P>c) Previewing the fo-file:</P>
<P><CODE><FONT face="courier, monospaced">java org.apache.fop.apps.AWTCommandLine fo-file</FONT></CODE></P>
<P>Each method uses next to the fop classes other packages. The following describes
each method in detail.</P>
@@ -61,8 +64,20 @@
<P><CODE><FONT face="courier, monospaced">org.apache.fop.apps.CommandLine fo-file pdf-file</FONT></CODE></P>
<P>Note: The xerces jar file must be included, because xp has no dom support.</P>
</FONT></TD></TR></TABLE><BR>
-
- <TABLE border="0" cellpadding="0" cellspacing="0" width="484"><TR><TD bgcolor="666699" colspan="2" width="484"><TABLE border="0" cellpadding="0" cellspacing="0" width="484"><TR><TD bgcolor="#039acc" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#039acc" height="1" width="482"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="482"></TD><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#039acc" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#0086b2" width="482"><FONT color="#ffffff" face="arial,helvetica,sanserif"><IMG border="0" height="2" hspace="0" src="resources/void.gif" vspace="0" width="2"><B>Method Two</B></FONT></TD><TD bgcolor="#017299" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#017299" height="1" width="482"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="482"></TD><TD bgcolor="#017299" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR></TABLE></TD></TR><TR><TD width="10">&nbsp;</TD><TD width="474"><FONT color="#000000" face="arial,helvetica,sanserif" size="-1">
+- <TABLE border="0" cellpadding="0" cellspacing="0" width="484"><TR><TD bgcolor="666699" colspan="2" width="484"><TABLE border="0" cellpadding="0" cellspacing="0" width="484"><TR><TD bgcolor="#039acc" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#039acc" height="1" width="482"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="482"></TD><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#039acc" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#0086b2" width="482"><FONT color="#ffffff" face="arial,helvetica,sanserif"><IMG border="0" height="2" hspace="0" src="resources/void.gif" vspace="0" width="2"><B>Method Two</B></FONT></TD><TD bgcolor="#017299" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#017299" height="1" width="482"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="482"></TD><TD bgcolor="#017299" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR></TABLE></TD></TR><TR><TD width="10">&nbsp;</TD><TD width="474"><FONT color="#000000" face="arial,helvetica,sanserif" size="-1">
+ <P>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
+ </P>
+ <P><CODE><FONT face="courier, monospaced">java -cp fop.jar;xalan.jar;xerces.jar;w3c.jar</FONT></CODE></P>
+ <P><CODE><FONT face="courier, monospaced">org.apache.fop.apps.XalanCommandLine xml-file xsl-file pdf-file</FONT></CODE></P>
+ <P>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.
+ </P>
+ </FONT></TD></TR></TABLE><BR>
+ <TABLE border="0" cellpadding="0" cellspacing="0" width="484"><TR><TD bgcolor="666699" colspan="2" width="484"><TABLE border="0" cellpadding="0" cellspacing="0" width="484"><TR><TD bgcolor="#039acc" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#039acc" height="1" width="482"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="482"></TD><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#039acc" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#0086b2" width="482"><FONT color="#ffffff" face="arial,helvetica,sanserif"><IMG border="0" height="2" hspace="0" src="resources/void.gif" vspace="0" width="2"><B>Method Three</B></FONT></TD><TD bgcolor="#017299" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#017299" height="1" width="482"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="482"></TD><TD bgcolor="#017299" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR></TABLE></TD></TR><TR><TD width="10">&nbsp;</TD><TD width="474"><FONT color="#000000" face="arial,helvetica,sanserif" size="-1">
<P>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 @@
<P><CODE><FONT face="courier, monospaced">java -cp fop.jar;xerces.jar;w3c.jar</FONT></CODE></P>
<P><CODE><FONT face="courier, monospaced">org.apache.fop.apps.AWTCommandLine fo-file </FONT></CODE></P>
<P>The viewer uses the swing classes.</P>
- <P>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:
- </P>
- <P><CODE><FONT face="courier, monospaced">java org.apache.fop.apps.CommandLine fo-file pdf-file</FONT></CODE></P>
</FONT></TD></TR></TABLE><BR>
</FONT></TD></TR></TABLE><BR>
<TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="666699" colspan="2" width="494"><TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#039acc" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#039acc" height="1" width="492"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#039acc" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#0086b2" width="492"><FONT color="#ffffff" face="arial,helvetica,sanserif" size="+1"><IMG border="0" height="2" hspace="0" src="resources/void.gif" vspace="0" width="2"><B>Running FOP on MacOS</B></FONT></TD><TD bgcolor="#017299" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#017299" height="1" width="492"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#017299" height="1" width="1"><IMG border="0" height="1" hspace="0" src="resources/void.gif" vspace="0" width="1"></TD></TR></TABLE></TD></TR><TR><TD width="10">&nbsp;</TD><TD width="484"><FONT color="#000000" face="arial,helvetica,sanserif">
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 @@
-<HTML><HEAD><SCRIPT language="JavaScript" src="resources/script.js" type="text/javascript"></SCRIPT><TITLE>FOP Relevant Specifications</TITLE></HEAD><BODY alink="#ff0000" bgcolor="#ffffff" leftmargin="4" link="#0000ff" marginheight="4" marginwidth="4" text="#000000" topmargin="4" vlink="#0000aa"><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD align="left" height="60" rowspan="3" valign="top" width="135"><IMG border="0" height="60" hspace="0" src="resources/logo.gif" vspace="0" width="135"></TD><TD align="left" colspan="4" height="5" valign="top" width="456"><IMG border="0" height="5" hspace="0" src="resources/line.gif" vspace="0" width="456"></TD><TD align="left" height="60" rowspan="3" valign="top" width="29"><IMG border="0" height="60" hspace="0" src="resources/right.gif" vspace="0" width="29"></TD></TR><TR><TD align="left" bgcolor="#0086b2" colspan="4" height="35" valign="top" width="456"><IMG alt="" border="0" height="35" hspace="0" src="graphics/specs-header.jpg" vspace="0" width="456"></TD></TR><TR><TD align="left" height="20" valign="top" width="168"><IMG border="0" height="20" hspace="0" src="resources/bottom.gif" vspace="0" width="168"></TD><TD align="left" height="20" valign="top" width="96"><A href="http://xml.apache.org/" onMouseOut="rolloverOff('xml');" onMouseOver="rolloverOn('xml');" target="new"><IMG alt="http://xml.apache.org/" border="0" height="20" hspace="0" name="xml" onLoad="rolloverLoad('xml','resources/button-xml-hi.gif','resources/button-xml-lo.gif');" src="resources/button-xml-lo.gif" vspace="0" width="96"></A></TD><TD align="left" height="20" valign="top" width="96"><A href="http://www.apache.org/" onMouseOut="rolloverOff('asf');" onMouseOver="rolloverOn('asf');" target="new"><IMG alt="http://www.apache.org/" border="0" height="20" hspace="0" name="asf" onLoad="rolloverLoad('asf','resources/button-asf-hi.gif','resources/button-asf-lo.gif');" src="resources/button-asf-lo.gif" vspace="0" width="96"></A></TD><TD align="left" height="20" valign="top" width="96"><A href="http://www.w3.org/" onMouseOut="rolloverOff('w3c');" onMouseOver="rolloverOn('w3c');" target="new"><IMG alt="http://www.w3.org/" border="0" height="20" hspace="0" name="w3c" onLoad="rolloverLoad('w3c','resources/button-w3c-hi.gif','resources/button-w3c-lo.gif');" src="resources/button-w3c-lo.gif" vspace="0" width="96"></A></TD></TR></TABLE><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD align="left" valign="top" width="120"><IMG border="0" height="14" hspace="0" src="resources/join.gif" vspace="0" width="120"><BR>
+<HTML><HEAD><SCRIPT language="JavaScript" src="resources/script.js" type="text/javascript"></SCRIPT><TITLE>FOP Relevant Specifications and Links</TITLE></HEAD><BODY alink="#ff0000" bgcolor="#ffffff" leftmargin="4" link="#0000ff" marginheight="4" marginwidth="4" text="#000000" topmargin="4" vlink="#0000aa"><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD align="left" height="60" rowspan="3" valign="top" width="135"><IMG border="0" height="60" hspace="0" src="resources/logo.gif" vspace="0" width="135"></TD><TD align="left" colspan="4" height="5" valign="top" width="456"><IMG border="0" height="5" hspace="0" src="resources/line.gif" vspace="0" width="456"></TD><TD align="left" height="60" rowspan="3" valign="top" width="29"><IMG border="0" height="60" hspace="0" src="resources/right.gif" vspace="0" width="29"></TD></TR><TR><TD align="left" bgcolor="#0086b2" colspan="4" height="35" valign="top" width="456"><IMG alt="" border="0" height="35" hspace="0" src="graphics/specs-header.jpg" vspace="0" width="456"></TD></TR><TR><TD align="left" height="20" valign="top" width="168"><IMG border="0" height="20" hspace="0" src="resources/bottom.gif" vspace="0" width="168"></TD><TD align="left" height="20" valign="top" width="96"><A href="http://xml.apache.org/" onMouseOut="rolloverOff('xml');" onMouseOver="rolloverOn('xml');" target="new"><IMG alt="http://xml.apache.org/" border="0" height="20" hspace="0" name="xml" onLoad="rolloverLoad('xml','resources/button-xml-hi.gif','resources/button-xml-lo.gif');" src="resources/button-xml-lo.gif" vspace="0" width="96"></A></TD><TD align="left" height="20" valign="top" width="96"><A href="http://www.apache.org/" onMouseOut="rolloverOff('asf');" onMouseOver="rolloverOn('asf');" target="new"><IMG alt="http://www.apache.org/" border="0" height="20" hspace="0" name="asf" onLoad="rolloverLoad('asf','resources/button-asf-hi.gif','resources/button-asf-lo.gif');" src="resources/button-asf-lo.gif" vspace="0" width="96"></A></TD><TD align="left" height="20" valign="top" width="96"><A href="http://www.w3.org/" onMouseOut="rolloverOff('w3c');" onMouseOver="rolloverOn('w3c');" target="new"><IMG alt="http://www.w3.org/" border="0" height="20" hspace="0" name="w3c" onLoad="rolloverLoad('w3c','resources/button-w3c-hi.gif','resources/button-w3c-lo.gif');" src="resources/button-w3c-lo.gif" vspace="0" width="96"></A></TD></TR></TABLE><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD align="left" valign="top" width="120"><IMG border="0" height="14" hspace="0" src="resources/join.gif" vspace="0" width="120"><BR>
<A href="../index.html" onMouseOut="rolloverOff('side-ext-2');" onMouseOver="rolloverOn('side-ext-2');"><IMG alt="Home" border="0" height="12" hspace="0" name="side-ext-2" onLoad="rolloverLoad('side-ext-2','graphics/ext-2-label-2.jpg','graphics/ext-2-label-3.jpg');" src="graphics/ext-2-label-3.jpg" vspace="0" width="120"></A><BR>
<IMG border="0" height="6" hspace="0" src="resources/separator.gif" vspace="0" width="120"><BR>
<A href="index.html" onMouseOut="rolloverOff('side-index');" onMouseOver="rolloverOn('side-index');"><IMG alt="Readme" border="0" height="12" hspace="0" name="side-index" onLoad="rolloverLoad('side-index','graphics/index-label-2.jpg','graphics/index-label-3.jpg');" src="graphics/index-label-3.jpg" vspace="0" width="120"></A><BR>
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 @@
<p>A help screen is shown by calling "build usage".
</p>
</s2>
+ <s2 title="Problems">
+ <p>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 <jump href="bugs.html">bugs</jump>, for further help.
+ </p>
+ </s2>
+
<s2 title="Compiling FOP on MacOS">
<!-- contributed by Arved Sandstrom who also manages the webpage the jump points to -->
<p>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 @@
</li>
<li>list.fo - a simple list
</li>
- <li>images.fo - shows how to embed gif and jpg images into the xsl:fo file using inline-graphic.
+ <li>images.fo - shows how to embed gif and jpg images into the xsl:fo file using external-graphic.
</li>
<li>border.fo - a not so simple example how to use borders in tables
</li>
<li>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.
</li>
+ <li>leader.fo - a very simple example of a rule
+ </li>
+ <li>Look also into the directory examples/svg. There you find some very extensive svg examples.
+ Just start makedoc.
+ </li>
+ <li>In the directory examples/pagination you find a suite of examples showing the use
+ of xsl:fo pagination.
+ </li>
</ul>
<p>Developers will find the first steps to a test suite for all implemented formatting objects and
properties in xml-fop/docs/bugtests.</p>
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 @@
</p>
<s2 title="leader">
- <p>fo:leader is only supported in a very limited way: you can use it to draw simple rule .
+ <p>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.
</p>
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 @@
<p>a) Java 1.1.x or later (If you want to use AWTCommandLine, you need Swing)</p>
<p>b) An XML parser which supports SAX and DOM like
<jump href="http://xml.apache.org/xerces-j/index.html">Xerces-J</jump>.
- (Xerces is the default xml parser)</p>
- <p>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
- <jump href="http://www.jclark.com/xml/xt.html">XT</jump>
- or <jump href="http://xml.apache.org/xalan/index.html">XALAN</jump>.
+ (Xerces is the default xml parser)
+ </p>
+ <p>c) Fop supports SVG (see <jump href="implemented.html">Features</jump> for further information) and
+ needs the w3c.jar library. This library comes with Fop (xml-fop/lib) and must
+ be included in your classpath
+ </p>
+ <p>d) Optional: Fop supports the jimi library for image processing, if it is in your classpath
+ when you build Fop.
</p>
</s2>
<s2 title="Starting FOP as an standalone application">
<p>There are two ways to run FOP from the command line.</p>
<p>a) Batch processing formatting objects (fo) files: </p>
<p><code>java org.apache.fop.apps.CommandLine fo-file pdf-file</code></p>
-<!-- <p>b) Batch processing xml files (includes production of the fo-files):</p>
- <p><code>java org.apache.fop.apps.XTCommandLine xml-file xsl-file pdf-file</code></p> -->
- <p>b) Previewing the fo-file:</p>
+ <p>b) Batch processing xml files (includes production of the fo-files):</p>
+ <p><code>java org.apache.fop.apps.XalanCommandLine xml-file xsl-file pdf-file</code></p>
+ <p>c) Previewing the fo-file:</p>
<p><code>java org.apache.fop.apps.AWTCommandLine fo-file</code></p>
<p>Each method uses next to the fop classes other packages. The following describes
each method in detail.</p>
@@ -47,20 +49,20 @@
<p><code>org.apache.fop.apps.CommandLine fo-file pdf-file</code></p>
<p>Note: The xerces jar file must be included, because xp has no dom support.</p>
</s3>
-<!-- <s3 title="Method Two">
+- <s3 title="Method Two">
<p>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
+ 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 XT in your classpath and so you might invoke
+ need to include Xalan in your classpath and so you might invoke
</p>
- <p><code>java -cp fop.jar;xt.jar;xerces.jar;w3c.jar</code></p>
- <p><code>org.apache.fop.apps.XTCommandLine xml-file xsl-file pdf-file</code></p>
+ <p><code>java -cp fop.jar;xalan.jar;xerces.jar;w3c.jar</code></p>
+ <p><code>org.apache.fop.apps.XalanCommandLine xml-file xsl-file pdf-file</code></p>
<p>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.
</p>
- </s3>-->
- <s3 title="Method Two">
+ </s3>
+ <s3 title="Method Three">
<p>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
@@ -68,11 +70,6 @@
<p><code>java -cp fop.jar;xerces.jar;w3c.jar</code></p>
<p><code>org.apache.fop.apps.AWTCommandLine fo-file </code></p>
<p>The viewer uses the swing classes.</p>
- <p>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:
- </p>
- <p><code>java org.apache.fop.apps.CommandLine fo-file pdf-file</code></p>
</s3>
</s2>
<s2 title="Running FOP on MacOS">
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 @@
<?xml version="1.0" standalone="no"?>
-<!-- FOP Relevant Specifications -->
+<!-- FOP Relevant Specifications and links -->
-<s1 title="FOP Relevant Specifications">
+<s1 title="FOP Relevant Specifications and Links">
<ul>
<li><jump href="http://www.w3.org/TR/WD-xsl/">Latest XSL-FO Working Draft (27 March 2000)</jump></li>
<li><jump href="http://www.renderx.com/Tests/validator/fo2000.dtd.html">A dtd for the XSL-FO Working Draft (27 March 2000) provided by N. Grigoriev from RenderX</jump></li>
@@ -19,3 +19,5 @@
<li><jump href="http://java.sun.com/products/jdk/1.1/docs/index.html">Java JDK 1.1 Documentation</jump></li>
</ul>
</s1>
+
+