Slide
			         =====


This subproject contains the source code for the Slide content management API
and WebDAV servlet engine.


Installing and Building Slide
==============================

In order to successfully build Slide, you will need to do the following.  In
the instructions below, $JAKARTA_HOME is assumed to be the directory into which
you are installing all of the required distributions.

* Download and install a version 1.1 or later Java Development Kit
  implementation for your operating system platform.  Set a "JAVA_HOME"
  environment variable to point at the directory where your JDK is installed,
  and add "$JAVA_HOME/bin" to your PATH.  Configure the CLASSPATH environment
  variable as well, if required.

* Download and install the Java API for XML Parsing implementation (current
  version number is 1.0) from <http://java.sun.com/xml>.  Make sure that the
  "jaxp.jar" and "parser.jar" files are on your class path.  (NOTE:  In the
  future it will be possible to use any JAXP-compliant parser).

* Download and install the Java Transaction API (current version number is 
  1.0.1) from <http://java.sun.com/products/jta/>.  Make sure that the
  "jta.jar" is in the "lib" directory in the Slide source distribution.

* Download and install the Ant distribution (subproject "jakarta-ant") into
  a directory named "$JAKARTA_HOME/jakarta-ant".  If you have downloaded the
  source distribution, you will need to build the executable version by
  executing the following commands:
  
	cd $JAKARTA_HOME/jakarta-ant
	./bootstrap.sh		<-- Unix
	bootstrap		<-- Windows
  
  This should result in the creation of a file "ant.jar" in the "lib"
  subdirectory, which will be used when building Watchdog.

* Download and install the Servletapi distribution (subproject
  "jakarta-servletapi") into a subdirectory named
  "$JAKARTA_HOME/jakarta-servletapi".  If you have downloaded the source
  distribution, you will need to build the executable version by
  executing the following commands:
  
	cd $JAKARTA_HOME/jakarta-servletapi
	./build.sh dist		<-- Unix
	build dist		<-- Windows
  
  This should result in the creation of a file "servlet.jar" in the "lib"
  subdirectory, which will be used when building Watchdog.

* It is also recommended that you download and install a JDBC compliant 
  database. I recommend using Hypersonic SQL, which is a very handy tool for
  small applications.
  You can download it at http://hsql.oron.ch/

* Download the source distribution of Slide (subpackage "jakarta-slide"),
  or check it out via anonymous CVS, into a subdirectory named
  "$JAKARTA_HOME/jakarta-slide".
  
	cd $JAKARTA_HOME/jakarta-slide
	./build.sh full-dist    <-- Unix
	build full-dist         <-- Windows

* A web application which can be used in any Servlet 2.2 compliant can be found 
  $JAKARTA_HOME/dist/slide-1.0dev/webapp/slide.war.

* You can delete the generated files in the "build/slide" and "dist/slide"
  directories by executing the following:
  
	cd $JAKARTA_HOME/jakarta-slide
	./build.sh clean	<-- Unix
	build clean		<-- Windows


Additional Information
======================

See HTML documentation, or the Slide website.


Before Committing Changes
=========================

Before committing any changes to the Slide CVS repository, you MUST do a
"build clean" followed by a "build full-dist" to ensure that the build process 
runs cleanly, and you must ensure that the tests run correctly.