docs/xml-docs/fop/running.xml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

<?xml version="1.0" standalone="no"?>


<!-- Running FOP -->

<s1 title="Running FOP">
  <s2 title="Prerequisites">
    <p>Following software must be installed:</p>
    <p>a) Java 1.1.x or later (If you want to use the previewer (option -awt), you need Swing or Java 2)</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:
          <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 
            </li>
            <li>The SVG library batik.jar is the library from the batik project at xml.apache.org.
            </li>
            <li>The imaging library Jimi from Sun
            </li>
          </ul>
    </p>
  </s2>

  <s2 title="Starting FOP as an standalone application">
    <p><code>Fop [options] [-fo|-xml] infile [-xsl file] [-awt|-pdf|-mif|-pcl|-txt|-print] &lt;outfile></code></p>
     <p>[OPTIONS]<br/>
     <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>
    <p>[INPUT]<br/>
    <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>

    <p>[OUTPUT]<br/>
    <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/>
      -print            input file will be rendered and sent to the printer<br/>
                        see options with "-print help"<br/>
    </source>
    </p>

    <p>[Examples]<br/>
    <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>
    </p>
  </s2>

  <s2 title="Problems">
    <p>If you have problems running FOP, please have a look at the 
       <jump href="http://www.owal.co.uk:8090/asf/servlet/asf/screen/DisplayTopics/action/SetAll/project_id/18/faq_id/276">FOP FAQ</jump>. If you don't find a solution there,
       you can ask for help on the list fop-dev@xml.apache.org. Maybe it is a bug and 
       maybe somebody is already working on it. 
    </p>
  </s2>
</s1>