Readme.html - tapestry4 - Git at Google

 <html>
 <!-- $Id$ -->
 <head>
 <title>Tapestry: Java Web Components</title>
 <link rel="STYLESHEET" type="text/css" href="web/scripts/style_virtlib_pcIE55.css">
 </head>

 <body leftmargin="0" topmargin="0" marginwidth="0" marginheight="0">
 <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="white">
 	<tr>
 		<td height="5"><IMG height=1 src="web/images/spacer.gif" width=1 border=0>
 		</td>
 	</tr>
 	<tr>
 		<td align="left" valign="top" height="20"><span class="release">Release @VERSION@</RELEASE></span>
 		</td>
 	</tr>
 	<tr bgcolor="#4b5887">
 		<td colspan="3" height="20"><IMG height=1 src="web/images/spacer.gif" width=1 border=0>
 		</td>
 	</tr>
 </table>

 <table width="100%" border="0" cellspacing="0" cellpadding="2">
 	<tr>
 		<td><IMG src="web/images/Tapestry-Banner.png" align=absMiddle border=0>
 <p>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!


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

 <p>This product includes software developed by the Apache Software Foundation
 (<a href="http://www.apache.org/">http://www.apache.org/</a>).


 <br><br>.....................................................<br><br>
 <h2>Configuration</h2>

 <p>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:
 			<ul>
 				<li>JDK 1.3 or newer JVM is installed, and the <tt>JAVA_HOME</tt> environment variable is set.</B>
 				<li><b><a href="http://jakarta.apache.org/ant">Ant</a></b> 1.5 or newer is installed, and is added
 to the system <tt>PATH</tt>.</li>
 			</ul>

 <p>
 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:
 <ul>
 <li><a href="http://sf.net/projects/jetty">Jetty</a> servlet container, release 4.2 or above.
 <li><a href="http://jakarta.apache.org/tomcat/index.html">Tomcat</a> servlet container, release 4.1 or above.
 <li><a href="http://www.jboss.org">JBoss</a> application server, release 3.0.6.
         Running the Virtual Library application requires JBoss.</li>

 </ul>

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

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

 <p>
 In addition, to run the Virtual Library application, you will need to download
 two additional libraries.  These
 files are placed into the
 <code>ext-dist</code>
 directory.  See the <A href="ext-dist/README.html">README.html</a> in that directory
 for more details.

 <h3>Configuring JBoss</h3>

 <p>To run the Tapestry Workbench and the Virtual Library applications with the
 <a href="http://sourceforge.net/projects/jboss">JBoss</a> server:
 			<ul>
 				<li>Download and install <a href="http://prdownloads.sourceforge.net/jboss/jboss-3.0.6.zip?download">JBoss 3.0.6</a>.
 				<br>JBoss is an open-source application server, used to run the database and Enterprise JavaBeans in the Virtual Library.
 <p><span class="hyper-em">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.</span></p>
 				<li>
 			Update <code>config/build.properties</code>
 			and set property
 			<b><code>jboss.dir</code></b>
 			to the absolute path name
 			of the JBoss installation directory.
 				<li>Download the external dependencies.
 				<li>Execute the command:
 				<br>
 			<b><code>ant -emacs configure run-jboss</code></b>

 			<br>This will copy and configure the necessary files in the JBoss installation directory, then
 run the JBoss server, automatically deploying the example applications.
  (The
 			<code>-emacs</code> option
         changes the Ant output format to be less verbose).</li>
 			</ul>

 		<blockquote>You can now run the
 <a href="http://localhost/workbench">Tapestry Workbench</a>
 or the
 <a href="http://localhost">Virtual Library</a> applications.</blockquote>


 <h3>Configuring Jetty</h3>

 <p>To run the Tapestry Workbench application with
 Jetty servlet container:
 			<ul>
 				<li>Obtain and install a copy of Jetty.
 				<li>
 			Update <code>config/build.properties</code>
 			and set property
 			<b><code>jetty.dir</code></b>
 			to the absolute path name
 			of the Jetty installation directory.

 				<li>Execute the command:
 				<br>
 				<b>
 			<code>ant -emacs run-workbench</code></b><br>This will run the embedded
 			Jetty server.
 			<br></li>
 			</ul>

 		<blockquote>You can now run the
 <a href="http://localhost:8080/workbench">Tapestry Workbench</a> application.
 </blockquote>

 			<h3>Configuring Tomcat</h3>

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

 <p>To run the Tapestry Workbench application with
 Tomcat servlet container:
 			<ul>
 				<li>Obtain and install a copy of Tomcat.
 				<li>
 			Update <code>config/build.properties</code>
 			and set property
 			<b><code>tomcat.dir</code></b>
 			to the absolute path name
 			of the Tomcat installation directory, for example <code>C:/Program Files/Apache Group/Tomcat 4.1</code>.

 				<li>Execute the command:
 				<br>
 				<b>
 			<code>ant -emacs deploy-tomcat</code></b>

 			<br>This will deploy the Workbench application into Tomcat.  If Tomcat is running, you will
 			be able to access the application immediately.
 			<br></li>
 			</ul>

 		<blockquote>You can then run the
 <a href="http://localhost:8080/workbench">Tapestry Workbench</a> application.
 </blockquote>

 <h2>Building from Source</h2>

 <p>To build from source, you must set additional properties inside
 <code>config/build.properties</code>:
 <ul>
 <li><code>j2ee.jar.path</code> - the path to the J2EE libraries (notably, javax.ejb).</li>
 <li><code>servlet.jar.path</code> - the path to the Servlet API libraries.</li>
 </ul>
 </p>

 <p>
 You may then execute <b><code>ant install</code></b> to compile all the frameworks and examples.
 Building documentation and running the unit tests requires some additional
 setup that is discussed in
 the <A href="web/doc/ContributorsGuide/ContributorsGuide.html">Tapestry Contributor's Guide</A>.
 </p>

 <h2>Documentation</h2>

 <p>


 	<table border="0" cellspacing="0" cellpadding="2">
 	<tr valign="top">
 		<td><IMG height=12 src="web/images/dots_leftnav.gif" width=14></td>
 		<td><A href="web/doc/api/index.html">Tapestry API Documentation</A>

 		<br><br>

 		Full documentation for the Tapestry framework, the <code>contrib</code>
 		framework (which contains additional components and classes),
 		and all the example code.
 		</td>
 	</tr>

 	<tr><td height="10" colspan="4"><IMG src="web/images/spacer.gif" width=1></td></tr>

 	<tr valign="top">
 		<td><IMG height=12 src="web/images/dots_leftnav.gif" width=14></td>
 		<td><A href="web/doc/ComponentReference/index.html">Tapestry Component Reference</A>

 		<br><br>

 		A handy refrence to the built-in Tapestry components, with example
 		specifications, HTML templates and code.
 		</td>
 	</tr>

 	<tr><td height="10" colspan="4"><IMG src="web/images/spacer.gif" width=1></td></tr>

 	<tr valign="top">
 		<td><IMG height=12 src="web/images/dots_leftnav.gif" width=14></td>
 		<td>
             <P><A href="web/doc/Tutorial/Tutorial.html">Tutorial</A>
 		<IMG height=12 src="web/images/dots_leftnav.gif" width=14>
 		<A href="web/doc/Tutorial/Tutorial.pdf">[PDF]</A>

 		<br><br>
 		The best way to begin
             learning about the Tapestry framework; this document eases the
             reader into basic Tapestry concepts.</P>
             <P><SPAN CLASS="note">This Tutorial is out of date, and&nbsp;work to replace it is
             currently taking place.</SPAN></P>


 		</td>
 	</tr>

 	<tr><td height="10" colspan="4"><IMG src="web/images/spacer.gif" width=1></td></tr>

 	<tr valign="top">
 		<td><IMG height=12 src="web/images/dots_leftnav.gif" width=14></td>
 		<td>
             <P><A href="web/doc/DevelopersGuide/DevelopersGuide.html">Tapestry Developer's Guide</A>
 		<IMG height=12 src="web/images/dots_leftnav.gif" width=14>
 		<A href="web/doc/DevelopersGuide/DevelopersGuide.pdf">[PDF]</A>

 		<br><br>
 		Exhaustive
             reference for Tapestry, in extreme detail.</P>
             <P><span class="note">This document is out of date, and is being replaced with a new
             User's Guide.</span></P>

 		</td>
 	</tr>

 		<tr><td height="10" colspan="4"><IMG src="web/images/spacer.gif" width=1></td></tr>

 	<tr valign="top">
 		<td><IMG height=12 src="web/images/dots_leftnav.gif" width=14></td>
 		<td>
             <P><A href="web/doc/TapestryUsersGuide/TapestryUsersGuide.html">Tapestry User's Guide</A>
 		<IMG height=12 src="web/images/dots_leftnav.gif" width=14>
 		<A href="web/doc/TapestryUsersGuide/TapestryUsersGuide.pdf">[PDF]</A>

 		<br><br>
 		Complete reference to the Tapestry framework.</P>
             <P><span class="note">This document is currently being constructed.</span></P>

 		</td>
 	</tr>


 	<tr><td height="10" colspan="4"><IMG src="web/images/spacer.gif" width=1></td></tr>

 	<tr valign="top">
 		<td><IMG height=12 src="web/images/dots_leftnav.gif" width=14></td>
 		<td><A href="web/doc/ContributorsGuide/ContributorsGuide.html">Tapestry Contributor's Guide</A>
 		<IMG height=12 src="web/images/dots_leftnav.gif" width=14>
 		<A href="web/doc/ContributorsGuide/ContributorsGuide.pdf">[PDF]</A>

 		<br><br>
 		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.
 		</td>
 	</tr>

 	<tr><td height="10" colspan="4"><IMG src="web/images/spacer.gif" width=1></td></tr>

 	<tr valign="top">
 		<td><IMG height=12 src="web/images/dots_leftnav.gif" width=14></td>
 		<td><A href="web/index.html">Tapestry Web Site</A>

 		<br><br>
 		A <A href="web/index.html">local copy</A>
 		of the <A href="@HOME_PAGE_URL@">Tapestry Home Page</A> is available
 		well.

 		</td>
 	</tr>

 	</table>


 		<br><br>
 		.....................................................
 		<br><br>

 <p>Tapestry is an open source project, hosted by
  <a href="http://jakarta.apache.org">The Jakarta Project</a>
        and distributed under the terms
 of the <A href="License.txt">Apache Software License 1.1</A>.</p></td></tr></table>

 <p>
 <a href="http://jakarta.apache.org"><IMG alt="Jakarta Banner" src="web/images/jakarta-banner.png" border=0 ></a>
 <br>©
 2003 Apache Software Foundation.</p>


 </body>

 </html>
	<html>
	<!-- $Id$ -->
	<head>
	<title>Tapestry: Java Web Components</title>
	<link rel="STYLESHEET" type="text/css" href="web/scripts/style_virtlib_pcIE55.css">
	</head>

	<body leftmargin="0" topmargin="0" marginwidth="0" marginheight="0">
	<table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="white">
	<tr>
	<td height="5"><IMG height=1 src="web/images/spacer.gif" width=1 border=0>
	</td>
	</tr>
	<tr>
	<td align="left" valign="top" height="20"><span class="release">Release @VERSION@</RELEASE></span>
	</td>
	</tr>
	<tr bgcolor="#4b5887">
	<td colspan="3" height="20"><IMG height=1 src="web/images/spacer.gif" width=1 border=0>
	</td>
	</tr>
	</table>

	<table width="100%" border="0" cellspacing="0" cellpadding="2">
	<tr>
	<td><IMG src="web/images/Tapestry-Banner.png" align=absMiddle border=0>
	<p>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!


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

	<p>This product includes software developed by the Apache Software Foundation
	(<a href="http://www.apache.org/">http://www.apache.org/</a>).


	<br><br>.....................................................<br><br>
	<h2>Configuration</h2>

	<p>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:
	<ul>
	<li>JDK 1.3 or newer JVM is installed, and the <tt>JAVA_HOME</tt> environment variable is set.</B>
	<li><b><a href="http://jakarta.apache.org/ant">Ant</a></b> 1.5 or newer is installed, and is added
	to the system <tt>PATH</tt>.</li>
	</ul>

	<p>
	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:
	<ul>
	<li><a href="http://sf.net/projects/jetty">Jetty</a> servlet container, release 4.2 or above.
	<li><a href="http://jakarta.apache.org/tomcat/index.html">Tomcat</a> servlet container, release 4.1 or above.
	<li><a href="http://www.jboss.org">JBoss</a> application server, release 3.0.6.
	Running the Virtual Library application requires JBoss.</li>

	</ul>

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

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

	<p>
	In addition, to run the Virtual Library application, you will need to download
	two additional libraries. These
	files are placed into the
	<code>ext-dist</code>
	directory. See the <A href="ext-dist/README.html">README.html</a> in that directory
	for more details.

	<h3>Configuring JBoss</h3>

	<p>To run the Tapestry Workbench and the Virtual Library applications with the
	<a href="http://sourceforge.net/projects/jboss">JBoss</a> server:
	<ul>
	<li>Download and install <a href="http://prdownloads.sourceforge.net/jboss/jboss-3.0.6.zip?download">JBoss 3.0.6</a>.
	<br>JBoss is an open-source application server, used to run the database and Enterprise JavaBeans in the Virtual Library.
	<p><span class="hyper-em">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.</span></p>
	<li>
	Update <code>config/build.properties</code>
	and set property
	<b><code>jboss.dir</code></b>
	to the absolute path name
	of the JBoss installation directory.
	<li>Download the external dependencies.
	<li>Execute the command:
	<br>
	<b><code>ant -emacs configure run-jboss</code></b>

	<br>This will copy and configure the necessary files in the JBoss installation directory, then
	run the JBoss server, automatically deploying the example applications.
	(The
	<code>-emacs</code> option
	changes the Ant output format to be less verbose).</li>
	</ul>

	<blockquote>You can now run the
	<a href="http://localhost/workbench">Tapestry Workbench</a>
	or the
	<a href="http://localhost">Virtual Library</a> applications.</blockquote>


	<h3>Configuring Jetty</h3>

	<p>To run the Tapestry Workbench application with
	Jetty servlet container:
	<ul>
	<li>Obtain and install a copy of Jetty.
	<li>
	Update <code>config/build.properties</code>
	and set property
	<b><code>jetty.dir</code></b>
	to the absolute path name
	of the Jetty installation directory.

	<li>Execute the command:
	<br>
	<b>
	<code>ant -emacs run-workbench</code></b><br>This will run the embedded
	Jetty server.
	<br></li>
	</ul>

	<blockquote>You can now run the
	<a href="http://localhost:8080/workbench">Tapestry Workbench</a> application.
	</blockquote>

	<h3>Configuring Tomcat</h3>

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

	<p>To run the Tapestry Workbench application with
	Tomcat servlet container:
	<ul>
	<li>Obtain and install a copy of Tomcat.
	<li>
	Update <code>config/build.properties</code>
	and set property
	<b><code>tomcat.dir</code></b>
	to the absolute path name
	of the Tomcat installation directory, for example <code>C:/Program Files/Apache Group/Tomcat 4.1</code>.

	<li>Execute the command:
	<br>
	<b>
	<code>ant -emacs deploy-tomcat</code></b>

	<br>This will deploy the Workbench application into Tomcat. If Tomcat is running, you will
	be able to access the application immediately.
	<br></li>
	</ul>

	<blockquote>You can then run the
	<a href="http://localhost:8080/workbench">Tapestry Workbench</a> application.
	</blockquote>

	<h2>Building from Source</h2>

	<p>To build from source, you must set additional properties inside
	<code>config/build.properties</code>:
	<ul>
	<li><code>j2ee.jar.path</code> - the path to the J2EE libraries (notably, javax.ejb).</li>
	<li><code>servlet.jar.path</code> - the path to the Servlet API libraries.</li>
	</ul>
	</p>

	<p>
	You may then execute <b><code>ant install</code></b> to compile all the frameworks and examples.
	Building documentation and running the unit tests requires some additional
	setup that is discussed in
	the <A href="web/doc/ContributorsGuide/ContributorsGuide.html">Tapestry Contributor's Guide</A>.
	</p>

	<h2>Documentation</h2>

	<p>



	<table border="0" cellspacing="0" cellpadding="2">
	<tr valign="top">
	<td><IMG height=12 src="web/images/dots_leftnav.gif" width=14></td>
	<td><A href="web/doc/api/index.html">Tapestry API Documentation</A>

	<br><br>

	Full documentation for the Tapestry framework, the <code>contrib</code>
	framework (which contains additional components and classes),
	and all the example code.
	</td>
	</tr>

	<tr><td height="10" colspan="4"><IMG src="web/images/spacer.gif" width=1></td></tr>

	<tr valign="top">
	<td><IMG height=12 src="web/images/dots_leftnav.gif" width=14></td>
	<td><A href="web/doc/ComponentReference/index.html">Tapestry Component Reference</A>

	<br><br>

	A handy refrence to the built-in Tapestry components, with example
	specifications, HTML templates and code.
	</td>
	</tr>

	<tr><td height="10" colspan="4"><IMG src="web/images/spacer.gif" width=1></td></tr>

	<tr valign="top">
	<td><IMG height=12 src="web/images/dots_leftnav.gif" width=14></td>
	<td>
	<P><A href="web/doc/Tutorial/Tutorial.html">Tutorial</A>
	<IMG height=12 src="web/images/dots_leftnav.gif" width=14>
	<A href="web/doc/Tutorial/Tutorial.pdf">[PDF]</A>

	<br><br>
	The best way to begin
	learning about the Tapestry framework; this document eases the
	reader into basic Tapestry concepts.</P>
	<P><SPAN CLASS="note">This Tutorial is out of date, and work to replace it is
	currently taking place.</SPAN></P>


	</td>
	</tr>

	<tr><td height="10" colspan="4"><IMG src="web/images/spacer.gif" width=1></td></tr>

	<tr valign="top">
	<td><IMG height=12 src="web/images/dots_leftnav.gif" width=14></td>
	<td>
	<P><A href="web/doc/DevelopersGuide/DevelopersGuide.html">Tapestry Developer's Guide</A>
	<IMG height=12 src="web/images/dots_leftnav.gif" width=14>
	<A href="web/doc/DevelopersGuide/DevelopersGuide.pdf">[PDF]</A>

	<br><br>
	Exhaustive
	reference for Tapestry, in extreme detail.</P>
	<P><span class="note">This document is out of date, and is being replaced with a new
	User's Guide.</span></P>

	</td>
	</tr>

	<tr><td height="10" colspan="4"><IMG src="web/images/spacer.gif" width=1></td></tr>

	<tr valign="top">
	<td><IMG height=12 src="web/images/dots_leftnav.gif" width=14></td>
	<td>
	<P><A href="web/doc/TapestryUsersGuide/TapestryUsersGuide.html">Tapestry User's Guide</A>
	<IMG height=12 src="web/images/dots_leftnav.gif" width=14>
	<A href="web/doc/TapestryUsersGuide/TapestryUsersGuide.pdf">[PDF]</A>

	<br><br>
	Complete reference to the Tapestry framework.</P>
	<P><span class="note">This document is currently being constructed.</span></P>

	</td>
	</tr>


	<tr><td height="10" colspan="4"><IMG src="web/images/spacer.gif" width=1></td></tr>

	<tr valign="top">
	<td><IMG height=12 src="web/images/dots_leftnav.gif" width=14></td>
	<td><A href="web/doc/ContributorsGuide/ContributorsGuide.html">Tapestry Contributor's Guide</A>
	<IMG height=12 src="web/images/dots_leftnav.gif" width=14>
	<A href="web/doc/ContributorsGuide/ContributorsGuide.pdf">[PDF]</A>

	<br><br>
	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.
	</td>
	</tr>

	<tr><td height="10" colspan="4"><IMG src="web/images/spacer.gif" width=1></td></tr>

	<tr valign="top">
	<td><IMG height=12 src="web/images/dots_leftnav.gif" width=14></td>
	<td><A href="web/index.html">Tapestry Web Site</A>

	<br><br>
	A <A href="web/index.html">local copy</A>
	of the <A href="@HOME_PAGE_URL@">Tapestry Home Page</A> is available
	well.

	</td>
	</tr>

	</table>


	<br><br>
	.....................................................
	<br><br>

	<p>Tapestry is an open source project, hosted by
	<a href="http://jakarta.apache.org">The Jakarta Project</a>
	and distributed under the terms
	of the <A href="License.txt">Apache Software License 1.1</A>.</p></td></tr></table>

	<p>
	<a href="http://jakarta.apache.org"><IMG alt="Jakarta Banner" src="web/images/jakarta-banner.png" border=0 ></a>
	<br>©
	2003 Apache Software Foundation.</p>


	</body>

	</html>