diff options
Diffstat (limited to 'src/documentation/content/xdocs/running.xml')
| -rw-r--r-- | src/documentation/content/xdocs/running.xml | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/src/documentation/content/xdocs/running.xml b/src/documentation/content/xdocs/running.xml new file mode 100644 index 000000000..9539db620 --- /dev/null +++ b/src/documentation/content/xdocs/running.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" standalone="no"?> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd"> + +<document> + <header> + <title>Running FOP</title> + </header> + + <body> +<section> + <title>Running FOP</title> + <section> + <title>Prerequisites</title> + <p>Following software must be installed:</p> + <p>a) Java 1.2.x or later</p> + <p>b) All libraries you need are part of the Fop distribution and + can be found in the xml-fop/lib directory. Look at the batch/shell script fop.bat/fop.sh + to see, how Fop can be invoked easily. These libraries are included: + </p> + <ul> + <li>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) + </li> + <li>An XSLT processor (Xalan is included) + </li> + <li>The SVG library batik.jar is the library from the <jump href="http://xml.apache.org/batik/">batik project</jump> at xml.apache.org. + </li> + </ul> + </section> + + <section> + <title>Starting FOP as an standalone application</title> + <p><code>Fop [options] [-fo|-xml] infile [-xsl file] [-awt|-pdf|-mif|-pcl|-txt|-svg|-at|-print] <outfile></code></p> + <p>[OPTIONS]</p> + <source> + -d debug mode<br/> + -x dump configuration settings<br/> + -q quiet mode<br/> + -c cfg.xml use additional configuration file cfg.xml<br/> + -l lang the language to use for user information<br/></source> + <p>[INPUT]</p> + <source> + infile xsl:fo input file (the same as the next)<br/> + -fo infile xsl:fo input file<br/> + -xml infile xml input file, must be used together with -xsl<br/> + -xsl stylesheet xslt stylesheet<br/></source> + + <p>[OUTPUT]</p> + <source> + outfile input will be rendered as pdf file into outfile<br/> + -pdf outfile input will be rendered as pdf file (outfile req'd)<br/> + -awt input will be displayed on screen<br/> + -mif outfile input will be rendered as mif file (outfile req'd)<br/> + -pcl outfile input will be rendered as pcl file (outfile req'd)<br/> + -txt outfile input will be rendered as text file (outfile req'd)<br/> -svg outfile input will be rendered as an svg slides file (outfile req'd) + -at outfile representation of area tree as XML (outfile req'd) + -print input file will be rendered and sent to the printer<br/> see options with "-print help"<br/></source> + + <p>[Examples]</p> + <source> + Fop foo.fo foo.pdf<br/> + Fop -fo foo.fo -pdf foo.pdf (does the same as the previous line)<br/> + Fop -xsl foo.xsl -xml foo.xml -pdf foo.pdf<br/> + Fop foo.fo -mif foo.mif<br/> + Fop foo.fo -print or Fop -print foo.fo<br/> + Fop foo.fo -awt<br/></source> + </section> + + <section> + <title>Problems</title> + <p>If you have problems running FOP, please have a look at the <jump href="gethelp.html">"How to get Help" page</jump>.</p> + </section> +</section> +</body> +</document> |