README
1XML-ApacheFOP version 0.03
2==========================
3
4XML::ApacheFOP allows you to use the Apache foundation's
5FOP implementation with Perl.
6
7Since FOP is written in Java, this module relies on Java.pm.
8You will need to have FOP, Java2, and Java.pm
9installed before installing this module. This README
10provides some guidance for meeting each of those requirements.
11
12This module has only been tested with Unix and its variants
13(Linux, Solaris, etc.) If you get this module working with
14Windows I would love to hear about it (along with how you did it.)
15
16
17JAVA2 INSTALLATION
18
19If you do not already have Java2 installed,
20you can download it here:
21http://java.sun.com/j2se/
22
23See the Sun documentation for installation details.
24
25This module has been tested with
26Java2 (Standard Edition) version 1.4.x.
27
28
29FOP INSTALLATION
30
31You can download FOP at the following link:
32http://xmlgraphics.apache.org/fop/
33
34See the FOP documentation for installation details.
35
36
37JAVA.PM INSTALLATION
38
39You can download and/or read the docs for Java.pm at:
40http://search.cpan.org/perldoc?Java
41
42In my experience, Java.pm must be installed manually
43and not from CPAN. If you must install it via CPAN
44you will need to enter "force install Java" in the
45CPAN shell. This will install the module even if the
46tests fail (which they usually do).
47
48You may also have to do a force install of Java.pm
49if you are installing the module remotely. The tests
50try to popup GUI windows that will simply
51not work when installing remotely.
52
53If you want to get Java.pm to pass all of the
54installation tests, you will need to install
55the module manually.
56
57After downloading the module, you will find a file
58called JavaServer.jar. Note the location of the module,
59then start the JavaServer with the following command:
60/path/to/java -classpath /path/to/JavaServer.jar \
61com.zzo.javaserver.JavaServer
62
63Once the JavaServer is running you can proceed to
64install Java.pm.
65
66There is also a SourceForge page for JavaServer at:
67http://sourceforge.net/projects/javaserver/
68
69
70XML::ApacheFOP INSTALLATION
71
72XML::ApacheFOP can be installed via CPAN or
73by building it manually using the standard commands:
74
75perl Makefile.PL
76make
77make test
78make install
79
80
81JavaServer SETUP
82
83To use XML::ApacheFOP you will need to include the FOP jar
84files in the classpath of the JavaServer startup command.
85
86The -classpath will need to be tailored to suit your system.
87Hopefully the following example will help you get it right though.
88
89Here is the command I use:
90
91/path/to/java -classpath \
92/path/to/JavaServer.jar\
93:/usr/local/xml-fop/build/fop.jar\
94:/usr/local/xml-fop/lib/avalon-framework-cvs-20020806.jar\
95:/usr/local/xml-fop/lib/batik.jar\
96:/usr/local/xml-fop/lib/xalan-2.4.1.jar\
97:/usr/local/xml-fop/lib/xercesImpl-2.2.1.jar \
98com.zzo.javaserver.JavaServer
99
100Once the JavaServer is running you will be ready to start using XML::ApacheFOP.
101See the pod documentation for details on the interface usage.
102
103DEBIAN INSTALLATION
104
105Ken Neighbors has created Debian packages for Java.pm/JavaServer and XML::ApacheFOP.
106This greatly eases the installation for the Debian platform.
107
108You can get them at:
109http://www.nsds.com/software/
110
111SECURITY
112
113JavaServer runs on port 2000 by default.
114I highly recommend you firewall off this port from outside access.
115
116It is also a good idea to use the authfile and allowed_paths options.
117See the pod for details on how to do this.
118
119
120AUTHOR
121
122Ken Prows (perl@xev.net)
123
124
125COPYRIGHT AND LICENSE
126
127Copyright (C) 2005 Online-Rewards. All rights reserved.
128
129This module is free software; you can redistribute it and/or modify
130it under the same terms as Perl itself.
131