Tapestry is a component based framework for creating sophisticated web applications. It's used with existing application servers, acting as a kind of "super servlet". Tapestry applications are built by configuring and combining components to form pages. You get surprisingly large amounts of robust functionality for startingly small amounts of effort and code!

The JARs were created on @OS_NAME@ @OS_VERSION@ using the @JAVA_VENDOR@ JDK @JAVA_VM_VERSION@ compiler.

This product includes software developed by the Apache Software Foundation (http://www.apache.org/).

.....................................................

Configuration

Tapestry ships with the the Tapestry Workbench and the Virtual Library example applications, which are easy to configure and run. To run these Tapestry applications please ensure:

• JDK 1.3 or newer JVM is installed, and the JAVA_HOME environment variable is set.
• Ant 1.5 or newer is installed, and is added to the system PATH.

Basic setup: The demos require several external dependencies that cannot be distributed with Tapestry because of licensing conflicts. You will need one of the following:

• Jetty servlet container, release 4.2 or above.
• Tomcat servlet container, release 4.1 or above.
• JBoss application server, release 3.0.6. Running the Virtual Library application requires JBoss.

In each case you will create the file config/build.properties and put an absolute path to the installation directory (of Jetty, JBoss or Tomcat). Always use only forward slashes in the path name.

A sample file, config/build.properties.template is provided. You can simply edit and rename this file.

In addition, to run the Virtual Library application, you will need to download two additional libraries. These files are placed into the ext-dist directory. See the README.html in that directory for more details.

Configuring JBoss

To run the Tapestry Workbench and the Virtual Library applications with the JBoss server:

• Download and install JBoss 3.0.6.
  JBoss is an open-source application server, used to run the database and Enterprise JavaBeans in the Virtual Library.

  This auto-configuration requires JBoss 3.0.6 exactly, not a later release. This only affects these turn-key demos, not deployment of your own Tapestry applications.

• Update config/build.properties and set property jboss.dir to the absolute path name of the JBoss installation directory.
• Download the external dependencies.
• Execute the command:
  ant -emacs configure run-jboss
  This will copy and configure the necessary files in the JBoss installation directory, then run the JBoss server, automatically deploying the example applications. (The -emacs option changes the Ant output format to be less verbose).

You can now run the Tapestry Workbench or the Virtual Library applications.

Configuring Jetty

To run the Tapestry Workbench application with Jetty servlet container:

• Obtain and install a copy of Jetty.
• Update config/build.properties and set property jetty.dir to the absolute path name of the Jetty installation directory.
• Execute the command:
  ant -emacs run-workbench
  This will run the embedded Jetty server.
  

You can now run the Tapestry Workbench application.

Configuring Tomcat

To deploy the Tapestry Workbench application onto an existing Tomcat installation:

To run the Tapestry Workbench application with Tomcat servlet container:

• Obtain and install a copy of Tomcat.
• Update config/build.properties and set property tomcat.dir to the absolute path name of the Tomcat installation directory, for example C:/Program Files/Apache Group/Tomcat 4.1.
• Execute the command:
  ant -emacs deploy-tomcat
  This will deploy the Workbench application into Tomcat. If Tomcat is running, you will be able to access the application immediately.
  

You can then run the Tapestry Workbench application.

Building from Source

To build from source, you must set additional properties inside config/build.properties:

• j2ee.jar.path - the path to the J2EE libraries (notably, javax.ejb).
• servlet.jar.path - the path to the Servlet API libraries.

You may then execute ant install to compile all the frameworks and examples. Building documentation and running the unit tests requires some additional setup that is discussed in the Tapestry Contributor's Guide.

Documentation

	Tapestry API Documentation Full documentation for the Tapestry framework, the contrib framework (which contains additional components and classes), and all the example code.
	Tapestry Component Reference A handy refrence to the built-in Tapestry components, with example specifications, HTML templates and code.
	Tutorial [PDF] The best way to begin learning about the Tapestry framework; this document eases the reader into basic Tapestry concepts. This Tutorial is out of date, and work to replace it is currently taking place.
	Tapestry Developer's Guide [PDF] Exhaustive reference for Tapestry, in extreme detail. This document is out of date, and is being replaced with a new User's Guide.
	Tapestry User's Guide [PDF] Complete reference to the Tapestry framework. This document is currently being constructed.
	Tapestry Contributor's Guide [PDF] A guide for advanced developers who want to contribute code back to the Tapestry framework. Discusses coding conventions, CVS access procedures, documentation standards and the like.
	Tapestry Web Site A local copy of the Tapestry Home Page is available well.

.....................................................

Tapestry is an open source project, hosted by The Jakarta Project and distributed under the terms of the Apache Software License 1.1.