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

5 files changed, 41 insertions, 26 deletions

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