new README that mentions AWT Viewer, need for DOM to compile and the new properties supported

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@193257 13f79535-47bb-0310-9956-ffa450edef68

2 files changed, 99 insertions, 16 deletions

diff --git a/README b/README
index fe30d5a8e..571acbc67 100644
--- a/README
+++ b/README
@@ -31,15 +31,23 @@
 
 
 
+
+
   2) Compiling FOP
   
     1. Prerequisites
-
+    
       a) Java 1.1.x or later
       
     
     
-      b) XT from James Clark
+      b) An XML parser
+      An XML parser which supports DOM like 
+         Xerces-J (http://xml.apache.org/xerces-j/index.html)
+.
+    
+    
+      c) 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
@@ -58,7 +66,7 @@
       
     
     
-      c) make
+      d) 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 (http://sourceware.cygnus.com/cygwin/)
@@ -69,12 +77,15 @@
 
 
 
+
+
   3) Running FOP
   
     1) Prerequisites
     Following software must be installed:
     a) Java 1.1.x or later
-    b) A sax parser like XP (http://www.jclark.com/xml/xp/index.html)
+    b) An XML parser which supports SAX and DOM like 
+          Xerces-J (http://xml.apache.org/xerces-j/index.html)
 .
     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. 
@@ -87,7 +98,15 @@
   
   
     2) Starting FOP as an standalone application
-    There are two ways of running FOP from the command line.
+    There are three ways of running FOP from the command line.
+    a) Batch processing formatting object 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
+    c) Previewing the fo-file:
+    java org.apache.fop.apps.AWTCommandLine fo-file
+    Each method uses next to the fop classes other packages. The following describes 
+       each method in detail.
     
       a) Method One
       One is to first use an XSLT engine to produce the formatting object tree as an 
@@ -98,8 +117,12 @@
       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.
+         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: 
       
+      java -Dorg.xml.sax.parser=org.apache.xerces.parsers.SAXParser 
+      -cp fop_x_xx_x.jar;xerces.jar
+      org.apache.fop.apps.AWTCommandLine formatting-tree-file pdf-file
     
     
       b) Method Two
@@ -115,16 +138,26 @@
       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.
       
+    
+    
+      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 
+      
+      java org.apache.fop.apps.AWTCommandLine formatting-tree-file 
       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
+      java org.apache.fop.apps.CommandLine fo-file pdf-file
     
   
 
 
 
+
+
   4) What's Implemented?
       Also see STATUS for what is being worked on.
   
@@ -200,16 +233,25 @@
       text-indent 
       href
       column-width
+      background-color
+      padding-top (only in conjunction with background color)
+      padding-left (only in conjunction with background color)
+      padding-bottom (only in conjunction with background color)
+      padding-right (only in conjunction with background color)
     
   
 
 
 
+
+
   5) Bugs
   see STATUS file
 
 
 
+
+
   6) FOP Relevant Specifications
   
     XML Recommendation (http://www.w3.org/TR/REC-xml)
@@ -235,6 +277,6 @@
 
 
 
-Version: 1.3 1999/11/23 03:31:30 - 
+Version: 1.4 1999/11/29 19:45 - 
 Contact: James Tauber (jtauber@jtauber.com)
 
diff --git a/docs/readme.xml b/docs/readme.xml
index c8916fb3e..08f9b0082 100644
--- a/docs/readme.xml
+++ b/docs/readme.xml
@@ -17,7 +17,7 @@ Usage of attributes:
 
 <head>
    <title>FOP: An Open-Source XSL Formatter and Renderer</title>
-   <version>1.3 1999/11/23 03:31:30</version>
+   <version>1.4 1999/11/29 19:45</version>
    <maintain>
       <name>James Tauber</name> 
       <name>Fotis Jannidis</name> 
@@ -43,16 +43,23 @@ Usage of attributes:
   </p>
 </section>
 
+<!-- Compiling FOP -->
+
 <section  class="level1">
   <title>Compiling FOP</title>
   <section class="level2">
     <title>1. Prerequisites</title>
-<section class="level3">
+    <section class="level3">
       <title>a) Java 1.1.x or later</title>
       <p></p>
     </section>
     <section class="level3">
-      <title>b) XT from James Clark</title>
+      <title>b) An XML parser</title>
+      <p>An XML parser which supports DOM like 
+         <link href="http://xml.apache.org/xerces-j/index.html">Xerces-J</link>.</p>
+    </section>
+    <section class="level3">
+      <title>c) XT from James Clark</title>
       <p>Some of the Java source code in FOP is generated from XML using
          XSLT. XT must be used to generate this code.</p>
       <p>XT is an XSL stylesheet processor written in java. At the moment you
@@ -69,7 +76,7 @@ Usage of attributes:
       </p>
     </section>
     <section class="level3">
-      <title>c) make</title>
+      <title>d) make</title>
       <p>Under windows it has been reported that the use of the cygnus solutions port 
          of the GNU utilities works. You can find it at 
          <link href="http://sourceware.cygnus.com/cygwin/">Cygnus Solutions</link>
@@ -78,13 +85,16 @@ Usage of attributes:
   </section>
 </section>
 
+<!-- Running FOP -->
+
 <section  class="level1">
   <title>Running FOP</title>
   <section class="level2">
     <title>1) Prerequisites</title>
     <p>Following software must be installed:</p>
     <p>a) Java 1.1.x or later</p>
-    <p>b) A sax parser like <link href="http://www.jclark.com/xml/xp/index.html">XP</link>.</p>
+    <p>b) An XML parser which supports SAX and DOM like 
+          <link href="http://xml.apache.org/xerces-j/index.html">Xerces-J</link>.</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 
@@ -94,7 +104,15 @@ Usage of attributes:
   </section>
   <section class="level2">
     <title>2) Starting FOP as an standalone application</title>
-    <p>There are two ways of running FOP from the command line.</p>
+    <p>There are three ways of running FOP from the command line.</p>
+    <p>a) Batch processing formatting object files: </p>
+    <p class="pre">java org.apache.fop.apps.CommandLine fo-file pdf-file</p>
+    <p>b) Batch processing xml files (includes production of the fo-files):</p>
+    <p class="pre">java org.apache.fop.apps.CommandLine xml-file xsl-file pdf-file</p>
+    <p>c) Previewing the fo-file:</p>
+    <p class="pre">java org.apache.fop.apps.AWTCommandLine fo-file</p>
+    <p>Each method uses next to the fop classes other packages. The following describes 
+       each method in detail.</p>
     <section class="level3">
       <title>a) Method One</title>
       <p>One is to first use an XSLT engine to produce the formatting object tree as an 
@@ -105,8 +123,12 @@ Usage of attributes:
       <p class="pre">java -cp fop_x_xx_x.jar;sax.jar;xp.jar</p>
       <p class="pre">org.apache.fop.apps.CommandLine formatting-tree-file pdf-file</p>
       <p>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.
+         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: 
       </p>
+      <p class="pre">java -Dorg.xml.sax.parser=org.apache.xerces.parsers.SAXParser </p>
+      <p class="pre">-cp fop_x_xx_x.jar;xerces.jar</p>
+      <p class="pre">org.apache.fop.apps.AWTCommandLine formatting-tree-file pdf-file</p>
     </section>
     <section class="level3">
       <title>b) Method Two</title>
@@ -122,15 +144,25 @@ Usage of attributes:
       <p>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.
       </p>
+    </section>
+    <section class="level3">
+      <title>c) Method Three</title>
+      <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, SAX and your SAX Parser in your classpath 
+      </p>
+      <p class="pre">java org.apache.fop.apps.AWTCommandLine formatting-tree-file </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 class="pre">java org.apache.fop.apps.CommandLine formatting-tree-file pdf-file</p>
+      <p class="pre">java org.apache.fop.apps.CommandLine fo-file pdf-file</p>
     </section>
   </section>
 </section>
 
+<!-- What's Implemented? -->
+
 <section  class="level1">
   <title>What's Implemented?</title>
       <p>Also see STATUS for what is being worked on.</p>
@@ -207,15 +239,24 @@ Usage of attributes:
       <p class="li">text-indent </p>
       <p class="li">href</p>
       <p class="li">column-width</p>
+      <p class="li">background-color</p>
+      <p class="li">padding-top (only in conjunction with background color)</p>
+      <p class="li">padding-left (only in conjunction with background color)</p>
+      <p class="li">padding-bottom (only in conjunction with background color)</p>
+      <p class="li">padding-right (only in conjunction with background color)</p>
     </div>
   </section>
 </section>
 
+<!-- Bugs -->
+
 <section class="level1">
   <title>Bugs</title>
   <p>see STATUS file</p>
 </section>
 
+<!-- FOP Relevant Specifications -->
+
 <section class="level1">
   <title>FOP Relevant Specifications</title>
   <div class="list">