From 78f92bdee60faf0480ea6a2751c3501b9a43c9ff Mon Sep 17 00:00:00 2001 From: fotis 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/html-docs/architecture.html | 1 + docs/html-docs/bugs.html | 1 + docs/html-docs/compiling.html | 1 + docs/html-docs/download.html | 1 + docs/html-docs/embedding.html | 3 ++- docs/html-docs/examples.html | 1 + docs/html-docs/faq-running.html | 1 + docs/html-docs/faqs.html | 1 + docs/html-docs/implemented.html | 9 ++++++++- docs/html-docs/index.html | 1 + docs/html-docs/involved.html | 1 + docs/html-docs/license.html | 1 + docs/html-docs/limitations.html | 1 + docs/html-docs/running.html | 16 ++++++++++++++-- docs/html-docs/specs.html | 1 + docs/xml-docs/fop/configuration.xml | 14 ++++++++++++-- docs/xml-docs/fop/embedding.xml | 2 +- docs/xml-docs/fop/running.xml | 15 +++++++++++++-- 18 files changed, 62 insertions(+), 9 deletions(-) (limited to 'docs') diff --git a/docs/html-docs/architecture.html b/docs/html-docs/architecture.html index 25d77cd45..dd4afc780 100644 --- a/docs/html-docs/architecture.html +++ b/docs/html-docs/architecture.html @@ -7,6 +7,7 @@ Features
Limitations
Bugs
+ Configuration
Examples

Compiling
diff --git a/docs/html-docs/bugs.html b/docs/html-docs/bugs.html index 4896707d1..959d9d848 100644 --- a/docs/html-docs/bugs.html +++ b/docs/html-docs/bugs.html @@ -7,6 +7,7 @@ Features
Limitations
Bugs
+ Configuration
Examples

Compiling
diff --git a/docs/html-docs/compiling.html b/docs/html-docs/compiling.html index e431b7f66..e085812a3 100644 --- a/docs/html-docs/compiling.html +++ b/docs/html-docs/compiling.html @@ -7,6 +7,7 @@ Features
Limitations
Bugs
+ Configuration
Examples

Compiling
diff --git a/docs/html-docs/download.html b/docs/html-docs/download.html index c0ad4248f..dc1094f66 100644 --- a/docs/html-docs/download.html +++ b/docs/html-docs/download.html @@ -7,6 +7,7 @@ Features
Limitations
Bugs
+ Configuration
Examples

Compiling
diff --git a/docs/html-docs/embedding.html b/docs/html-docs/embedding.html index 5f145e2c9..8a0d8b777 100644 --- a/docs/html-docs/embedding.html +++ b/docs/html-docs/embedding.html @@ -7,6 +7,7 @@ Features
Limitations
Bugs
+ Configuration
Examples

Compiling
@@ -36,7 +37,7 @@ buildFOTree(Parser, InputSource) respectively.

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.

Once the FO Tree is built, the format() and render() methods may be called in that order. diff --git a/docs/html-docs/examples.html b/docs/html-docs/examples.html index 5e31f7146..132f47b3a 100644 --- a/docs/html-docs/examples.html +++ b/docs/html-docs/examples.html @@ -7,6 +7,7 @@ Features
Limitations
Bugs
+ Configuration
Examples

Compiling
diff --git a/docs/html-docs/faq-running.html b/docs/html-docs/faq-running.html index cde3fc048..6017e19c2 100644 --- a/docs/html-docs/faq-running.html +++ b/docs/html-docs/faq-running.html @@ -7,6 +7,7 @@ Features
Limitations
Bugs
+ Configuration
Examples

Compiling
diff --git a/docs/html-docs/faqs.html b/docs/html-docs/faqs.html index a001d49d3..620d638ff 100644 --- a/docs/html-docs/faqs.html +++ b/docs/html-docs/faqs.html @@ -7,6 +7,7 @@ Features
Limitations
Bugs
+ Configuration
Examples

Compiling
diff --git a/docs/html-docs/implemented.html b/docs/html-docs/implemented.html index 90fc8f4fe..5f1b17eae 100644 --- a/docs/html-docs/implemented.html +++ b/docs/html-docs/implemented.html @@ -7,6 +7,7 @@ Features
Limitations
Bugs
+ Configuration
Examples

Compiling
@@ -147,6 +148,7 @@

  • break-before
  • color
  • column-width
    • +
  • country
  • end-indent
  • extent
  • external-destination
    • @@ -156,10 +158,15 @@
  • font-style
  • font-weight
  • height
    • +
  • hyphenate
    • +
  • hyphenation-character
    • +
  • hyphenation-push-character-count
    • +
  • hyphenation-remain-character-count
  • id
  • initial-page-number
  • internal-destination
  • keep-with-next (broken)
    • +
  • language
  • leader-alignment (not value "page")
  • leader-length (no percentage values)
  • leader-pattern (not value "use-content")
    • @@ -196,9 +203,9 @@
  • space-before.optimum
  • src
  • start-indent
    • -
  • textdecoration (only value "underline")
  • text-align
  • text-align-last
    • +
  • textdecoration (only value "underline")
  • text-indent
  • top
  • white-space-collapse
    • diff --git a/docs/html-docs/index.html b/docs/html-docs/index.html index 5f6b8bd18..7c76d4179 100644 --- a/docs/html-docs/index.html +++ b/docs/html-docs/index.html @@ -7,6 +7,7 @@ Features
    Limitations
    Bugs
    + Configuration
    Examples

    Compiling
    diff --git a/docs/html-docs/involved.html b/docs/html-docs/involved.html index cc89680d5..5815f9f29 100644 --- a/docs/html-docs/involved.html +++ b/docs/html-docs/involved.html @@ -7,6 +7,7 @@ Features
    Limitations
    Bugs
    + Configuration
    Examples

    Compiling
    diff --git a/docs/html-docs/license.html b/docs/html-docs/license.html index a7497aa72..e545b404c 100644 --- a/docs/html-docs/license.html +++ b/docs/html-docs/license.html @@ -7,6 +7,7 @@ Features
    Limitations
    Bugs
    + Configuration
    Examples

    Compiling
    diff --git a/docs/html-docs/limitations.html b/docs/html-docs/limitations.html index f06f30429..73d6f1d7c 100644 --- a/docs/html-docs/limitations.html +++ b/docs/html-docs/limitations.html @@ -7,6 +7,7 @@ Features
    Limitations
    Bugs
    + Configuration
    Examples

    Compiling
    diff --git a/docs/html-docs/running.html b/docs/html-docs/running.html index 6d50d7292..2edb9207b 100644 --- a/docs/html-docs/running.html +++ b/docs/html-docs/running.html @@ -7,6 +7,7 @@ Features
    Limitations
    Bugs
    + Configuration
    Examples

    Compiling
    @@ -39,7 +40,7 @@


    Starting FOP as an standalone application
      -

    There are two ways to run FOP from the command line.

    +

    There are three ways to run FOP from the command line.

    a) Batch processing formatting objects (fo) files:

    java org.apache.fop.apps.CommandLine fo-file pdf-file

    b) Batch processing xml files (includes production of the fo-files):

    @@ -47,7 +48,7 @@

    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.

    + each method in detail.

    Method One
     

    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 @@ -91,6 +92,17 @@

    The viewer uses the swing classes.



    +
    Commandline switches
      +

    Fop supports at the moment following commandline switches:

    +
    -d
      +

    This switch informs you in case of an error of the method stack

    +

    +
    -cUserconfig.xml
      +

    The switch '-c' immediately followed by a file name, p.e. Userconfig.xml, tells Fop to use this + user configuration file. +

    +

    +

    Running FOP on MacOS
     

    Ensure that you have a recent MRJ, and that you have downloaded and diff --git a/docs/html-docs/specs.html b/docs/html-docs/specs.html index 0dd6afbd1..2deb284d7 100644 --- a/docs/html-docs/specs.html +++ b/docs/html-docs/specs.html @@ -7,6 +7,7 @@ Features
    Limitations
    Bugs
    + Configuration
    Examples

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

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

    +

    The file userconfig.xml is not read automatically, but the user must specify its use on + the command line. See Running Fop for details. +

    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.

    b) Put the file into a directory of your choice and specify this directory - in the userconfig.xml in the entry . + in the userconfig.xml in the entry <hyphenation-dir>.

    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.

    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.

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

    -

    There are two ways to run FOP from the command line.

    +

    There are three ways to run FOP from the command line.

    a) Batch processing formatting objects (fo) files:

    java org.apache.fop.apps.CommandLine fo-file pdf-file

    b) Batch processing xml files (includes production of the fo-files):

    @@ -32,7 +32,7 @@

    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.

    + each method in detail.

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

    The viewer uses the swing classes.

         + +

    Fop supports at the moment following commandline switches:

    + +

    This switch informs you in case of an error of the method stack

    +     + +

    The switch '-c' immediately followed by a file name, p.e. Userconfig.xml, tells Fop to use this + user configuration file. +

    +     +

    Ensure that you have a recent MRJ, and that you have downloaded and -- cgit v1.2.3