WebCal readme
-------------

[ $Revision: 1.1 $ $Date: 2002/03/09 13:59:26 $ ]


Installation instructions
-------------------------

1. Get the source

The following directory structure should be set up before compiling the project:

WebCal root              (contains: this file, setenv.cmd, compile.cmd)
+- classes               (empty)
+- data                  (empty)
|  +- html               (contains: navigation.xml)
+- jars                  (contains: jars needed to for compilation in addition to JDK)
+- java                  (empty)
|  +- com                (empty)
|     +- ibm             (empty)
|        +- almaden      (empty)
|           +- webcal    (contains: Source files for package com.ibm.almaden.webcal)
|              +- action (contains: Source files for package com.ibm.almaden.webcal.action)
+- web                   (empty)
   +- html               (contains: XSL style sheet files for transformation to HTML)
      +- images          (contains: Images for HTML)


2. Compile the project

Open a command line / terminal window and go to the WebCal root directory.

Make sure that, if you use JDK 1.1, the environment variable JAVA_HOME points 
to the root of your JDK.

Make sure the following directories / jar files are in your classpath 

./java             (source)
./classes          (destination for .class files)
./jars/servlet.jar (from JSDK 2.1)
./jars/xml4j.jar   (from XML4J 3.1.0)
./jars/xerces.jar  (from XML4J 3.1.0)
./jars/xt.jar      (from XT 19991105)

Make sure you do not have any conflicting directories / jars in your
classpath before those listed above. If you use Windows, you can use setenv.cmd
to set the classpath.

Compile the project to the ./classes directory:

java -d classes java/com/ibm/almaden/webcal/*.java
java -d classes java/com/ibm/almaden/webcal/action/*.java

If you use Windows, you can use compile.cmd to do this.

3. Setup the runtime environment

Choose a directory which WebCal will use to store its data. Copy the contents
of the ./data directory to that directory and set the environment variable
WEBCAL_DATA_PATH to that directory.

Copy the contents of the ./web directory to a directory that is available
through a Web server (you may be able to use your servlet engine) as
http://localhost/webcal/

Copy the contents of the ./classes directory to your servlet engine's classes
directory or point the servlet engine's classpath to the ./classes directory.

Set up your servlet engine to run the servlet
com.ibm.almaden.webcal.WebCalServlet
with Web path set to [host]/webcal/WebCalServlet (you may specify additional
Web paths for the servlet, but this one is required)

Make sure your servlet engine's classpath includes all .jar files in the ./jars
directory and does not contain conflicting .jars or directories before them. 

4. Run the application

Start your servlet engine.

Access the application at http://[your machine]/webcal/WebCalServlet

Have fun!


History of changes
------------------

2000-11-09 Version 1