From 78f92bdee60faf0480ea6a2751c3501b9a43c9ff Mon Sep 17 00:00:00 2001
From: fotis <fotis@unknown>
Date: Thu, 14 Dec 2000 18:11:45 +0000
Subject: documentation: spreading the word about configuration

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@193873 13f79535-47bb-0310-9956-ffa450edef68
---
 docs/xml-docs/fop/configuration.xml | 14 ++++++++++++--
 docs/xml-docs/fop/embedding.xml     |  2 +-
 docs/xml-docs/fop/running.xml       | 15 +++++++++++++--
 3 files changed, 26 insertions(+), 5 deletions(-)

(limited to 'docs/xml-docs')

diff --git a/docs/xml-docs/fop/configuration.xml b/docs/xml-docs/fop/configuration.xml
index c5b896f51..6404485bb 100644
--- a/docs/xml-docs/fop/configuration.xml
+++ b/docs/xml-docs/fop/configuration.xml
@@ -1,9 +1,19 @@
 <?xml version="1.0" standalone="no"?>
 
 
-
 <s1 title="Configuration">
   <s2 title="How to configure Fop">
+    <p>In the directory xml-fop/conf you will find two configuration files. One of them,
+       config.xml, is only intended for Fop developers, who want to add new default values 
+       to some Fop feature. Don't change this file. For user configuration there is a file called
+       userconfig.xml. It contains templates for all settings a user can change. Most of them are 
+       commented out. Uncomment the entry you want to set and change the value according to 
+       your wishes. Please regard any comments which specify the value range. And, well, the 
+       configuration files are xml files, so keep them at least well-formed ;-)
+    </p>
+    <p>The file userconfig.xml is not read automatically, but the user must specify its use on 
+       the command line. See <jump href="running.html">Running Fop</jump> for details. 
+    </p>
   </s2>
   <s2 title="setting up hyphenation">
     <p>Fop comes already with some hyphenation pattern. If you need a hyphenation pattern
@@ -28,7 +38,7 @@
       be picked up and added to the fop.jar.
     </p>
     <p>   b) Put the file into a directory of your choice and specify this directory
-      in the userconfig.xml in the entry <hyphenation-dir>. 
+      in the userconfig.xml in the entry &lt;hyphenation-dir>. 
     </p>
   </s2>
 </s1>
diff --git a/docs/xml-docs/fop/embedding.xml b/docs/xml-docs/fop/embedding.xml
index dbed2a95b..90c319f49 100644
--- a/docs/xml-docs/fop/embedding.xml
+++ b/docs/xml-docs/fop/embedding.xml
@@ -22,7 +22,7 @@
      buildFOTree(Parser, InputSource) respectively.
   </p>
   <p>A third possibility may be used to build the FO Tree, namely
-     calling getDocumentHandler() and firing the SAX events yourself.
+     calling getContentHandler() and firing the SAX events yourself.
   </p>
   <p>Once the FO Tree is built, the format() and render() methods may be
      called in that order.
diff --git a/docs/xml-docs/fop/running.xml b/docs/xml-docs/fop/running.xml
index 4eea85359..b78212e6d 100644
--- a/docs/xml-docs/fop/running.xml
+++ b/docs/xml-docs/fop/running.xml
@@ -24,7 +24,7 @@
     </p>
   </s2>
   <s2 title="Starting FOP as an standalone application">
-    <p>There are two ways to run FOP from the command line.</p>
+    <p>There are three 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>
@@ -32,7 +32,7 @@
     <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>
+       each method in detail. </p>
     <s3 title="Method One">
       <p>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
@@ -76,6 +76,17 @@
       <p>The viewer uses the swing classes.</p> 
     </s3>
   </s2>
+  <s2 title="Commandline switches">
+      <p>Fop supports at the moment following commandline switches: </p>
+      <s3 title="-d">
+      <p>This switch informs you in case of an error of the method stack</p>
+      </s3>
+      <s3 title="-cUserconfig.xml">
+      <p>The switch '-c' immediately followed by a file name, p.e. Userconfig.xml, tells Fop to use this 
+         user configuration file. 
+      </p>
+      </s3>
+  </s2>
   <s2 title="Running FOP on MacOS">  
     <!-- Contributed by Arved Sandstrom -->
     <p>Ensure that you have a recent MRJ, and that you have downloaded and
-- 
cgit v1.2.3