You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tapestry.apache.org by hl...@apache.org on 2003/03/06 20:19:35 UTC
cvs commit: jakarta-tapestry/doc/src/Tutorial Tutorial.xml
hlship 2003/03/06 11:19:35
Modified: doc/src/UsersGuide state.xml configuration.xml
doc/src/DevelopersGuide coding-components.xml jars.xml
faq.xml engine.xml
doc/src/common TapestryLinks.xml
. Readme.html
doc/src/ContributorsGuide ContributorsGuide.xml
web new.html
doc/src/Tutorial Tutorial.xml
Log:
Patch up the documentation.
Revision Changes Path
1.5 +4 -4 jakarta-tapestry/doc/src/UsersGuide/state.xml
Index: state.xml
===================================================================
RCS file: /home/cvs/jakarta-tapestry/doc/src/UsersGuide/state.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- state.xml 7 Feb 2003 04:28:12 -0000 1.4
+++ state.xml 6 Mar 2003 19:19:33 -0000 1.5
@@ -179,7 +179,7 @@
constructor. In this case, the complete class name of the
Visit is specified as
<link linkend="configuration.search-path">configuration property</link>
-<literal>net.sf.tapestry.visit-class</literal>.
+<literal>org.apache.tapestry.visit-class</literal>.
</para>
<para>
@@ -191,7 +191,7 @@
<programlisting>
<![CDATA[
<application name="Tapestry Component Workbench">
- <property name="net.sf.tapestry.visit-class" value="tutorial.workbench.Visit"/>
+ <property name="org.apache.tapestry.visit-class" value="tutorial.workbench.Visit"/>
...
]]>
@@ -246,7 +246,7 @@
in many threads) will access it simulatenously. The default Global object is a synchronized
&HashMap;. This can be overriden with
<link linkend="configuration.search-path">configuration property</link>
-<literal>net.sf.tapestry.global-class</literal>.
+<literal>org.apache.tapestry.global-class</literal>.
</para>
<para>
1.6 +19 -19 jakarta-tapestry/doc/src/UsersGuide/configuration.xml
Index: configuration.xml
===================================================================
RCS file: /home/cvs/jakarta-tapestry/doc/src/UsersGuide/configuration.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- configuration.xml 7 Feb 2003 04:28:12 -0000 1.5
+++ configuration.xml 6 Mar 2003 19:19:33 -0000 1.6
@@ -22,9 +22,9 @@
<display-name>Tapestry Virtual Library Demo</display-name>
<servlet>
<servlet-name>vlib</servlet-name> <co id="configuration.web.servlet-name"/>
- <servlet-class>net.sf.tapestry.&ApplicationServlet;</servlet-class> <co id="configuration.web.servlet-class"/>
+ <servlet-class>org.apache.tapestry.&ApplicationServlet;</servlet-class> <co id="configuration.web.servlet-class"/>
<init-param>
- <param-name>net.sf.tapestry.application-specification</param-name> <co id="configuration.web.spec-path"/>
+ <param-name>org.apache.tapestry.application-specification</param-name> <co id="configuration.web.spec-path"/>
<param-value>/net/sf/tapestry/vlib/Vlib.application</param-value>
</init-param>
<load-on-startup>0</load-on-startup>
@@ -103,7 +103,7 @@
<orderedlist>
<listitem>
<para>
- On the classpath, as defined by the <literal>net.sf.tapestry.application-specification</literal>
+ On the classpath, as defined by the <literal>org.apache.tapestry.application-specification</literal>
configuration parameter.
</para>
</listitem>
@@ -206,7 +206,7 @@
<title>Configuration Values</title>
<varlistentry>
- <term>net.sf.tapestry.template-extension</term>
+ <term>org.apache.tapestry.template-extension</term>
<listitem>
<para>
@@ -227,8 +227,8 @@
</varlistentry>
<varlistentry>
- <term>net.sf.tapestry.asset.dir</term>
- <term>net.sf.tapestry.asset.URL</term>
+ <term>org.apache.tapestry.asset.dir</term>
+ <term>org.apache.tapestry.asset.URL</term>
<listitem>
<para>
@@ -245,7 +245,7 @@
</varlistentry>
<varlistentry>
- <term>net.sf.tapestry.visit-class</term>
+ <term>org.apache.tapestry.visit-class</term>
<listitem>
<para>
@@ -262,7 +262,7 @@
<varlistentry>
- <term>net.sf.tapestry.default-page-class</term>
+ <term>org.apache.tapestry.default-page-class</term>
<listitem>
<para>
@@ -276,7 +276,7 @@
</varlistentry>
<varlistentry>
- <term>net.sf.tapestry.engine-class</term>
+ <term>org.apache.tapestry.engine-class</term>
<listitem>
<para>
@@ -290,7 +290,7 @@
</varlistentry>
<varlistentry>
- <term>net.sf.tapestry.global-class</term>
+ <term>org.apache.tapestry.global-class</term>
<listitem>
<para>
@@ -304,7 +304,7 @@
</varlistentry>
<varlistentry>
- <term>net.sf.tapestry.default-script-language</term>
+ <term>org.apache.tapestry.default-script-language</term>
<listitem>
<para>
@@ -318,7 +318,7 @@
</varlistentry>
<varlistentry>
- <term>net.sf.tapestry.enable-reset-service</term>
+ <term>org.apache.tapestry.enable-reset-service</term>
<listitem>
<para>
@@ -338,7 +338,7 @@
</varlistentry>
<varlistentry>
- <term>net.sf.tapestry.disable-caching</term>
+ <term>org.apache.tapestry.disable-caching</term>
<listitem>
<para>
@@ -355,7 +355,7 @@
<para>
This should never be enabled in production; the performance hit is too large.
- Like <literal>net.sf.tapestry.enable-reset-service</literal>, this must
+ Like <literal>org.apache.tapestry.enable-reset-service</literal>, this must
be specified as a JVM system property.
</para>
</listitem>
@@ -393,7 +393,7 @@
<title>Application Extension Points</title>
<varlistentry>
- <term>net.sf.tapestry.property-source (&IPropertySource;)</term>
+ <term>org.apache.tapestry.property-source (&IPropertySource;)</term>
<listitem>
<para>
This extension
@@ -405,7 +405,7 @@
</varlistentry>
<varlistentry>
- <term>net.sf.tapestry.request-decoder (&IRequestDecoder;)</term>
+ <term>org.apache.tapestry.request-decoder (&IRequestDecoder;)</term>
<listitem>
<para>
A request decoder is used
@@ -418,7 +418,7 @@
</varlistentry>
<varlistentry>
- <term>net.sf.tapestry.monitor (&IMonitor;)</term>
+ <term>org.apache.tapestry.monitor (&IMonitor;)</term>
<listitem>
<para>A monitor is informed
@@ -429,7 +429,7 @@
</varlistentry>
<varlistentry>
- <term>net.sf.tapestry.value-persister (&IValuePersister;)</term>
+ <term>org.apache.tapestry.value-persister (&IValuePersister;)</term>
<listitem>
<para>
1.3 +2 -2 jakarta-tapestry/doc/src/DevelopersGuide/coding-components.xml
Index: coding-components.xml
===================================================================
RCS file: /home/cvs/jakarta-tapestry/doc/src/DevelopersGuide/coding-components.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- coding-components.xml 30 Aug 2002 23:32:56 -0000 1.2
+++ coding-components.xml 6 Mar 2003 19:19:33 -0000 1.3
@@ -107,7 +107,7 @@
<para>
The call to <function>getBinding()</function> is relatively expensive, since
it involves rummaging around in a ⤅ and then
-casting the result from <classname>java.lang.Object</classname> to <classname>net.sf.tapestry.IBinding</classname>.
+casting the result from <classname>java.lang.Object</classname> to <classname>org.apache.tapestry.IBinding</classname>.
</para>
<para>
Because bindings are typically set once and then read frequently by the component,
1.9 +20 -130 jakarta-tapestry/doc/src/DevelopersGuide/jars.xml
Index: jars.xml
===================================================================
RCS file: /home/cvs/jakarta-tapestry/doc/src/DevelopersGuide/jars.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- jars.xml 3 Mar 2003 17:34:59 -0000 1.8
+++ jars.xml 6 Mar 2003 19:19:33 -0000 1.9
@@ -3,106 +3,33 @@
<appendix id="jars">
<title>Tapestry JAR files</title>
-<para>
-The Tapestry distribution includes a number of JAR files, some of which are needed to compile the framework (and
-examples), others are used at runtime (and must be added to the servlet container's classpath).
-</para>
-
<variablelist>
-
-
- <varlistentry>
- <term><filename>commons-lang-<replaceable>x.x</replaceable></filename></term>
- <term><filename>commons-logging-<replaceable>x.x.x</replaceable></filename></term>
- <listitem>
- <para>
- Support classes for Tapestry, from the Jakarta Commons subproject. These
- libraries are needed at runtime.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><filename>jakarta-oro-<replaceable>x.x.x</replaceable>.jar</filename></term>
- <listitem>
- <para>
- Regular expression library, used to validate specification ids.
- Needed by Tapestry at runtime.
- </para>
- </listitem>
- </varlistentry>
<varlistentry>
- <term><filename>javax.servlet.jar</filename></term>
- <listitem>
- <para>
- Defines the Java Servlet API. Again, these classes and interfaces are needed by Tapestry
- at runtime, but are almost always provided by the servlet container.
- </para>
- </listitem>
- </varlistentry>
-
-
- <varlistentry>
- <term><filename>javax.xml.jaxp.jar</filename></term>
+ <term><filename>lib/runtime/<replaceable>*</replaceable>.jar</filename></term>
<listitem>
<para>
- The Java API for XML Processing. Needed at runtime to allow Tapestry to locate an XML
- processor, used to parse application and component specifications. These may be
- provided by the servlet container or application server, or even be
- directly provided by the JDK.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><filename>jcommon-<replaceable>x.x.x</replaceable>.jar</filename></term>
- <term><filename>jfreechart-<replaceable>x.x.x</replaceable>.jar</filename></term>
- <listitem>
- <para>
- The <ulink url="http://www.object-refinery.com/jfreechart/">JFreeChart</ulink> libraries,
- which are used in the Tapestry Workbench tutorial to generate a dynamic pie chart.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><filename>log4j-<replaceable>x.x.x</replaceable>.jar</filename></term>
- <listitem>
- <para>
- The &Log4J; logging framework. This is used by Tapestry at runtime
- (via the <filename>commons-logging-<replaceable>x.x.x</replaceable></filename>
- library).
+ Frameworks that are usually needed at runtime (but not at framework build time) and
+ are not always supplied by the servlet container. This currently
+ is just the &Log4J; framework.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><filename>mcoidb.jar</filename></term>
+ <term><filename>lib/ext/<replaceable>*</replaceable>.jar</filename></term>
<listitem>
<para>
- The <ulink url="http://mckoi.com/database/">McKoi SQL Database</ulink>, a GPL Java database.
- This is used by the Virtual Library demonstration.
+ Frameworks needed when compiling the framework and at runtime. This is
+ several other &Jakarta; frameworks (including &BSF; and &BCEL;), plus
+ the &OGNL; framework.
</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term><filename>ognl-<replaceable>x.x.x</replaceable>-opt.jar</filename></term>
- <listitem>
- <para>
- The <ulink url="http://www.ognl.org">Object Graph Navigation Library</ulink>,
- which provides dynamic evaluation of JavaBeans property expressions. This
- is used by Tapestry at runtime.
- </para>
- </listitem>
- </varlistentry>
-
- <!-- alphabetize as "net.sf.tapestry...." -->
-
- <varlistentry>
+ <varlistentry>
<term>&TapestryFrameworkJar;</term>
<listitem>
<para>
@@ -119,61 +46,24 @@
<listitem>
<para>
Contains additional components and tools that are not integral to the framework itself, such
- as the Palette. Needed at runtime if any such components are used in an application.
+ as the &Palette;. Needed at runtime if any such components are used in an application.
The framework release number is integrated into the file name.
</para>
</listitem>
</varlistentry>
-
- <varlistentry>
- <term><filename>org.apache.crimson.jar</filename></term>
- <listitem>
- <para>
- An XML parser that can be used by Tapestry unless a different one is configured.
- </para>
- </listitem>
- </varlistentry>
-
-
- <varlistentry>
- <term><filename>org.mortbay.jetty-jdk1.2.jar</filename></term>
- <listitem>
- <para>
- The &Jetty; servlet container, used to execute the Tapestry examples, tutorials and demostrations.
- </para>
- </listitem>
- </varlistentry>
-
-
-
- <varlistentry>
- <term><filename>Tutorial.war</filename></term>
- <term><filename>Vlib.ear</filename></term>
- <term><filename>Vlib.war</filename></term>
- <term><filename>Wap.war</filename></term>
- <listitem>
- <para>
- Example Tapestry applications. <filename>Vlib.war</filename> is
- incorporated into <filename>Vlib.ear</filename>.
- </para>
- </listitem>
- </varlistentry>
-
-
- <varlistentry>
- <term><filename>VlibBeans.jar</filename></term>
- <listitem>
- <para>
- An EJB JAR, containing entity and session EJBs for deployment with &JBoss;.
- <filename>VlibBeans.jar</filename> is incorporated into
- <filename>Vlib.ear</filename>.
- </para>
- </listitem>
- </varlistentry>
+
</variablelist>
+
+<para>
+In addition, Tapestry applications may need the packages
+<class>javax.servlet</class> and
+<class>javax.xml.</class> at compile time and an XML parser at runtime. These
+are usually provided by the servlet container or application server.
+</para>
+
</appendix>
1.5 +2 -2 jakarta-tapestry/doc/src/DevelopersGuide/faq.xml
Index: faq.xml
===================================================================
RCS file: /home/cvs/jakarta-tapestry/doc/src/DevelopersGuide/faq.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- faq.xml 17 Sep 2002 14:36:24 -0000 1.4
+++ faq.xml 6 Mar 2003 19:19:33 -0000 1.5
@@ -337,7 +337,7 @@
<qandaentry>
<question>
<para>
-I've fixed all my imports to use <filename>net.sf.tapestry</filename>, but
+I've fixed all my imports to use <filename>org.apache.tapestry</filename>, but
my &DirectLink; listener methods no longer work. How do I fix things?
</para>
</question>
1.6 +7 -7 jakarta-tapestry/doc/src/DevelopersGuide/engine.xml
Index: engine.xml
===================================================================
RCS file: /home/cvs/jakarta-tapestry/doc/src/DevelopersGuide/engine.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- engine.xml 10 Dec 2002 16:43:11 -0000 1.5
+++ engine.xml 6 Mar 2003 19:19:33 -0000 1.6
@@ -44,7 +44,7 @@
<para>
The servlet determines the location of the application specification from the
-web deployment descriptor. A servlet initialization property, <varname>net.sf.tapestry.application-specification</varname>
+web deployment descriptor. A servlet initialization property, <varname>org.apache.tapestry.application-specification</varname>
provides the locations of the specificiation as a path.
</para>
@@ -59,9 +59,9 @@
<display-name>Tapestry Virtual Library Demo</display-name>
<servlet>
<servlet-name>vlib</servlet-name>
- <servlet-class>net.sf.tapestry.ApplicationServlet</servlet-class>
+ <servlet-class>org.apache.tapestry.ApplicationServlet</servlet-class>
<init-param>
- <param-name>net.sf.tapestry.application-specification</param-name>
+ <param-name>org.apache.tapestry.application-specification</param-name>
<param-value>/net/sf/tapestry/vlib/Vlib.application</param-value>
</init-param>
<load-on-startup>0</load-on-startup>
@@ -212,7 +212,7 @@
</para>
<para>
The <classname>StaleSession</classname> page is displayed when a
-<classname>net.sf.tapestry.StaleSessionException</classname>
+<classname>org.apache.tapestry.StaleSessionException</classname>
is thrown. This exception is thrown when the component
is configured to be stateful (which is the default)
and the <classname>HttpSession</classname> doesn't exist, or is
@@ -456,7 +456,7 @@
<title>JVM System Properties</title>
<varlistentry>
<term>
- <varname>net.sf.tapestry.asset.dir</varname>
+ <varname>org.apache.tapestry.asset.dir</varname>
</term>
<listitem>
<para>
@@ -467,7 +467,7 @@
</varlistentry>
<varlistentry>
<term>
- <varname>net.sf.tapestry.asset.URL</varname>
+ <varname>org.apache.tapestry.asset.URL</varname>
</term>
<listitem>
<para>
1.26 +4 -3 jakarta-tapestry/doc/src/common/TapestryLinks.xml
Index: TapestryLinks.xml
===================================================================
RCS file: /home/cvs/jakarta-tapestry/doc/src/common/TapestryLinks.xml,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -r1.25 -r1.26
--- TapestryLinks.xml 6 Mar 2003 17:19:16 -0000 1.25
+++ TapestryLinks.xml 6 Mar 2003 19:19:33 -0000 1.26
@@ -97,6 +97,7 @@
<!ENTITY InspectorButton '<ulink url="&ReferenceRoot;/InspectorButton.html"><classname>InspectorButton</classname></ulink>'>
<!ENTITY Option '<ulink url="&ReferenceRoot;/Option.html"><classname>Option</classname></ulink>'>
<!ENTITY PageLink '<ulink url="&ReferenceRoot;/PageLink.html"><classname>PageLink</classname></ulink>'>
+<!ENTITY Palette '<ulink url="&ReferenceRoot;/contrib.Palette.html"><classname>Palette</classname></ulink>'>
<!ENTITY PropertySelection '<ulink url="&ReferenceRoot;/PropertySelection.html"><classname>PropertySelection</classname></ulink>'>
<!ENTITY Radio '<ulink url="&ReferenceRoot;/Radio.html"><classname>Radio</classname></ulink>'>
<!ENTITY RadioGroup '<ulink url="&ReferenceRoot;/RadioGroup.html"><classname>RadioGroup</classname></ulink>'>
@@ -122,6 +123,7 @@
<!ENTITY Eclipse '<ulink url="http://www.eclipse.org">Eclipse</ulink>'>
<!ENTITY Fop '<ulink url="http://xml.apache.org/fop">FOP</ulink>'>
<!ENTITY Log4J '<ulink url="http://jakarta.apache.org/log4j">Log4J</ulink>'>
+<!ENTITY Jakarta '<ulink url="http://jakarta.apache.org">Jakarta</ulink>'>
<!ENTITY JBoss '<ulink url="http://www.jboss.org">JBoss</ulink>'>
<!ENTITY Jetty '<ulink url="http://sf.net/projects/jetty">Jetty</ulink>'>
<!ENTITY JUnit '<ulink url="http://www.junit.org">JUnit</ulink>'>
@@ -129,13 +131,12 @@
<!ENTITY OGNL '<ulink url="http://www.ognl.org">OGNL</ulink>'>
<!ENTITY Saxon '<ulink url="http://sf.net/projects/saxon">Saxon</ulink>'>
<!ENTITY TapestryHomePage '<ulink url="http://jakarta.apache.org/proposals/tapestry">Tapestry Home Page</ulink>'>
-<!ENTITY TapestryProjectPage '<ulink url="http://sf.net/projects/tapestry">Tapestry Project Page</ulink>'>
<!-- Other useful stuff -->
<!ENTITY TapestryFrameworkJar "<filename>tapestry-<replaceable>x.x</replaceable>.jar</filename>">
<!ENTITY TapestryContribJar "<filename>tapestry-contrib-<replaceable>x.x</replaceable>.jar</filename>">
-
+<!ENTITY HowardLewisShipEmail '<ulink url="mailto:hlship@apache.org">Howard M. Lewis Ship</ulink>'>
1.83 +124 -57 jakarta-tapestry/Readme.html
Index: Readme.html
===================================================================
RCS file: /home/cvs/jakarta-tapestry/Readme.html,v
retrieving revision 1.82
retrieving revision 1.83
diff -u -r1.82 -r1.83
--- Readme.html 26 Jan 2003 02:59:20 -0000 1.82
+++ Readme.html 6 Mar 2003 19:19:33 -0000 1.83
@@ -43,67 +43,133 @@
<br><br>.....................................................<br><br>
<h2>Configuration</h2>
-<p>Tapestry ships with the the Tapestry Tutorial and the Virtual Library demo applications, which are very
-easy to configure and run. To run these Tapestry appliations please ensure:
+<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>To run the Tapestry Tutorial and the Virtual Library applications with the
+
+<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.4.
+ 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, you will need to download two libraries needed by the Workbench application and
+two libraries needed by the Virtual Library. 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><b>Download <a href="http://prdownloads.sourceforge.net/jboss/jboss-3.0.4.zip?download">JBoss 3.0.4</a></b>.<br>JBoss is an open-source application server, used to run the database and Enterprise JavaBeans in the Virtual Library.
+ <li>Download and install <a href="http://prdownloads.sourceforge.net/jboss/jboss-3.0.4.zip?download">JBoss 3.0.4</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.4 exactly, not a later release.
This only affects these turn-key
demos, not deployment of your own Tapestry applications.</span></p>
- <li><b>Create the file
- <code>config/build.properties</code>.<br></b>
- This file informs
- Tapestry where JBoss as been installed.
- The <code>config</code> directory contains a template file.
- Set
- <code>jboss.dir</code> to the JBoss installation
- directory, for example <i>C:/JBoss-3.0.4</i>.
- <b>Note:</b> Use only forward slashes in this file name.
- <li><b>Execute the command:
- <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 Tapestry Tutorial and
-the Virtual Library demonstration. (The
- <code>-emacs</code>option
+ <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>Congratulations, you can now run the
-<a href="http://localhost/tutorial">Tapestry Tutorial</a>
+
+ <blockquote>You can now run the
+<a href="http://localhost/workbench/app">Tapestry Workbench</a>
or the
<a href="http://localhost/vlib/app">Virtual Library</a> applications.</blockquote>
-<p>To run the Tapestry Tutorial application with the
-<a href="http://sourceforge.net/projects/jetty">Jetty</a> server included in this distribution (this does not involve
-JBoss):
+
+
+<h3>Configuring Jetty</h3>
+
+<p>To run the Tapestry Workbench application with
+Jetty servlet container:
<ul>
- <li><b>Execute the command:
- <code>ant run-tutorial</code></b><br>This will run the embedded
- Jetty server and the <a href="http://localhost:8080/tutorial">Tapestry Tutorial</a> application.</li>
+ <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>Download the external dependencies
+ <li>Execute the command:
+ <br>
+ <b>
+ <code>ant -emacs run-workbench</code></b><br>This will run the embedded
+ Jetty server.
+ <br></li>
</ul>
-<p>To deploy the Tapestry Tutorial application onto an existing
-<a href="http://jakarta.apache.org/tomcat">Tomcat</a> server:
+
+ <blockquote>You can now run the
+<a href="http://localhost:8080/workbench/app">Tapestry Workbench</a> application.
+</blockquote>
+
+ <h3>Configuring Tomcat</h3>
+
+<p>To deploy the Tapestry Workbench application onto an existing
+Tomcat:
+
+<p>To run the Tapestry Workbench application with
+Tomcat servlet container:
<ul>
- <li><b>Create the file
- <code>config/build.properties</code>.<br></b>This
- file informs Tapestry where Tomcat as been installed. The
- <code>config</code> directory contains a template file.
- Set
- <code>tomcat.dir</code> to the Tomcat installation
- directory, for example <i>C:/Program Files/Apache Group/Tomcat 4.1</i>.
- <b>Note:</b> Use only forward slashes in this file name.
- <li><b>Execute the command:
- <code>ant deploy-tomcat</code></b><br>This will deploy the tutorial application
- into the Tomcat server. If Tomcat is running you
- should be able to access the <a href="http://localhost:8080/tutorial">Tapestry Tutorial</a> application,
- otherwise start Tomcat to access the
- application.</li>
+ <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>Download the external dependencies
+ <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/app">Tapestry Workbench</a> application.
+</blockquote>
+
+
<h2>Documentation</h2>
<p>
@@ -113,7 +179,7 @@
<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>
+ <td><A href="web/doc/api/index.html">Tapestry API Documentation</A>
<br><br>
@@ -127,7 +193,7 @@
<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>
+ <td><A href="web/doc/ComponentReference/index.html">Tapestry Component Reference</A>
<br><br>
@@ -141,9 +207,9 @@
<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>
+ <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>
+ <A href="web/doc/Tutorial/Tutorial.pdf">[PDF]</A>
<br><br>
The best way to begin
@@ -161,9 +227,9 @@
<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>
+ <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>
+ <A href="web/doc/DevelopersGuide/DevelopersGuide.pdf">[PDF]</A>
<br><br>
Exhaustive
@@ -179,9 +245,9 @@
<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>
+ <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>
+ <A href="web/doc/TapestryUsersGuide/TapestryUsersGuide.pdf">[PDF]</A>
<br><br>
Complete reference to the Tapestry framework.</P>
@@ -195,9 +261,9 @@
<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>
+ <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>
+ <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.
@@ -209,11 +275,11 @@
<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>
+ <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
+ A <A href="web/index.html">local copy</A>
+ of the <A href="@HOME_PAGE_URL@">Tapestry Home Page</A> is available
well.
</td>
@@ -233,7 +299,8 @@
<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.
+<br>�
+2003 Apache Software Foundation.</p>
</body>
1.16 +74 -43 jakarta-tapestry/doc/src/ContributorsGuide/ContributorsGuide.xml
Index: ContributorsGuide.xml
===================================================================
RCS file: /home/cvs/jakarta-tapestry/doc/src/ContributorsGuide/ContributorsGuide.xml,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- ContributorsGuide.xml 19 Feb 2003 23:24:38 -0000 1.15
+++ ContributorsGuide.xml 6 Mar 2003 19:19:33 -0000 1.16
@@ -67,26 +67,19 @@
<chapter id="cvs">
<title>CVS Access</title>
-<para>
<warning>
<title>We've Moved to Jakarta</title>
<para>
Some of the details are in transition, with the move from SourceForge
-to Jakarta. The new server location is <literal>cvs.apache.org</literal>,
+to &Jakarta;. The new server location is <literal>cvs.apache.org</literal>,
the repository path is <literal>/home/cvs</literal> and
the module is <literal>jakarta-tapestry</literal>.
</para>
</warning>
-Tapestry is housed at the &TapestryProjectPage;. Read-only CVS access is available
-to anyone; to have read-write access you must be registered
-with SourceForge, and then contact the Tapestry administrator
-(<ulink url="mailto:hlship@apache.org">Howard Lewis Ship</ulink>) to be
-added to the list of Tapestry developers.
-</para>
<para>
Using Eclipse, obtaining the source code takes only a few steps. Tapestry
-compiles using some libraries from &JBoss; 3.0.4, which must be downloaded first.
+compiles using some libraries from &JBoss; 3.0.4 and &Jetty; 4.x which must be downloaded first.
</para>
<para>
@@ -139,7 +132,7 @@
<para>
You can access the Tapestry repository using command line CVS or other tools, as well. Details
-for using command line CVS are available at the &TapestryProjectPage;.
+for using command line CVS are available at the &Jakarta;.
</para>
@@ -164,7 +157,7 @@
You must create the file <filename>config/build.properties</filename>
(under the Tapestry root directory). This file defines a property,
<literal>jboss.dir</literal> that identifies the full pathname
-to the JBoss installation. A sample file is provided.
+to the JBoss installation and the &Jetty; installation. A sample file is provided.
<tip>
<para>
Be sure to use forward slashes for the path name, even
@@ -176,6 +169,12 @@
</tip>
</para>
+<para>
+Tapestry has some additional, external dependencies on libraries that (due to
+licensing conflicts) are not supplied in the distribution or stored in CVS.
+More details available shortly ....
+</para>
+
<section id="building.subprojects">
<title>Tapestry Subprojects</title>
@@ -219,31 +218,22 @@
<varlistentry>
- <term><filename>examples/Tutorial</filename></term>
+ <term><filename>examples/Workbench</filename></term>
<listitem>
<para>
- Builds <filename>tutorial.war</filename>.
+ Builds <filename>workbench.war</filename>.
</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term><filename>examples/wap</filename></term>
- <listitem>
- <para>
- Builds <filename>wap.war</filename>, a tiny
- demonstration of WAP support.
- </para>
- </listitem>
- </varlistentry>
<varlistentry>
<term><filename>examples/VlibBeans</filename></term>
<listitem>
<para>
- Builds <filename>VlibBeans.jar</filename>, the EJBs used
+ Builds <filename>vlibbeans.jar</filename>, the EJBs used
by the Virtual Library demonstration.
</para>
</listitem>
@@ -254,7 +244,7 @@
<term><filename>examples/Vlib</filename></term>
<listitem>
<para>
- Builds <filename>Vlib.war</filename>, the presentation
+ Builds <filename>vlib.war</filename>, the presentation
layer of the Virtual Library demonstration.
</para>
</listitem>
@@ -264,9 +254,9 @@
<term><filename>examples/VlibEAR</filename></term>
<listitem>
<para>
- Builds <filename>Vlib.ear</filename> from
- <filename>VlibBeans.jar</filename> and
- <filename>Vlib.war</filename>.
+ Builds <filename>vlib.ear</filename> from
+ <filename>vlibbeans.jar</filename> and
+ <filename>vlib.war</filename>.
</para>
</listitem>
</varlistentry>
@@ -285,6 +275,17 @@
<listitem>
<para>
Builds the Tapestry Developer's Guide documentation.
+ This guide is out of date, as is being replaced.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>doc/src/UsersGuide</filename></term>
+ <listitem>
+ <para>
+Builds the Tapestry Users' Guide (the replacement for the Developer's
+Guide). This document is still incomplete. See, you just can't win.
</para>
</listitem>
</varlistentry>
@@ -293,7 +294,7 @@
<term><filename>doc/src/ContributorsGuide</filename></term>
<listitem>
<para>
- Builds the this documentation.
+ Builds this very documentation.
</para>
</listitem>
</varlistentry>
@@ -376,6 +377,15 @@
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>clover</term>
+ <listitem>
+ <para>
+ Runs all &JUnit; tests and builds a code coverage report
+ (using the Clover tool).
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
@@ -398,12 +408,21 @@
<listitem>
<para>
-Download and unpack the &Saxon; distribution, release 6.5.2 or better.
+Download and unpack the &Saxon; distribution, release 6.5.2 exactly (later versions do not work).
</para>
</listitem>
<listitem>
<para>
+ Obtain the latest copies of the two DocBook distributions and place the files
+ in the <filename>ext-dist</filename> directory.
+ Details are in the file
+ <filename>doc/src/common/Readme.html</filename>.
+ </para>
+</listitem>
+
+<listitem>
+<para>
Copy <filename>saxon.jar</filename> into the
Ant <filename>lib</filename> directory.
</para>
@@ -483,8 +502,17 @@
<itemizedlist>
<listitem>
-<para>Extract the Clover distribution, <filename>support/clover.zip</filename>
-to a non-temporary directory.
+<para>
+Get a copy of the Clover distribution.
+<ulink url="http://www.thecortex.net/clover/">Cortex eBusiness</ulink> has donated a copy of Clover to
+support Tapestry. The distribution is
+available from
+&HowardLewisShipEmail;.
+</para>
+</listitem>
+
+<listitem>
+<para>Extract the Clover distribution to a non-temporary directory.
</para>
</listitem>
@@ -737,8 +765,8 @@
</para>
<para>
-The base package for the framework JAR (&TapestryFrameworkJar;) is <literal>net.sf.tapestry</literal>.
-The base package for the contrib JAR (&TapestryContribJar;) is <literal>net.sf.tapestry.contrib</literal>.
+The base package for the framework JAR (&TapestryFrameworkJar;) is <literal>org.apache.tapestry</literal>.
+The base package for the contrib JAR (&TapestryContribJar;) is <literal>org.apache.tapestry.contrib</literal>.
</para>
</section>
@@ -891,7 +919,7 @@
<para>
JUnit test source code is placed into the <filename class="directory">junit/src</filename> source tree.
-The package name for JUnit tests is <literal>net.sf.tapestry.junit</literal>.
+The package name for JUnit tests is <literal>org.apache.tapestry.junit</literal>.
</para>
<para>
@@ -910,7 +938,7 @@
</para>
<para>
-Create a test script in the <filename>net.sf.tapestry.junit.mock</filename> package. Add a method to
+Create a test script in the <filename>org.apache.tapestry.junit.mock</filename> package. Add a method to
the <classname>MockTestCase</classname> class.
</para>
@@ -941,9 +969,9 @@
<mock-test>
<context name="c6" root="context6"/>
- <servlet name="app" class="net.sf.tapestry.ApplicationServlet">
- <init-parameter name="net.sf.tapestry.engine-class"
- value="net.sf.tapestry.junit.mock.c6.C6Engine"/>
+ <servlet name="app" class="org.apache.tapestry.ApplicationServlet">
+ <init-parameter name="org.apache.tapestry.engine-class"
+ value="org.apache.tapestry.junit.mock.c6.C6Engine"/>
</servlet>
]]>
</programlisting>
@@ -1285,13 +1313,16 @@
</para>
<para>
-To use the script, change to the <filename>support</filename> directory and execute the command
-<command>python update-copyrights.py copyright.txt <replaceable>directory</replaceable></command>.
+To use the script, execute the command
+<command>python support/update-copyrights.py LICENSE.txt <replaceable>directory ...</replaceable></command>.
</para>
<para>
-The script is very fast, simply using <literal>..</literal> as the directory works in only a few seconds.
+You may specify any number of directories, though the script is fast enough that just using "." (for current directory)
+is easiest.
</para>
+
+
<warning>
<title>Cygwin Python</title>
1.132 +10 -2 jakarta-tapestry/web/new.html
Index: new.html
===================================================================
RCS file: /home/cvs/jakarta-tapestry/web/new.html,v
retrieving revision 1.131
retrieving revision 1.132
diff -u -r1.131 -r1.132
--- new.html 5 Mar 2003 23:11:54 -0000 1.131
+++ new.html 6 Mar 2003 19:19:34 -0000 1.132
@@ -14,7 +14,15 @@
<h3>Release 2.4-alpha-4</h3>
<ul>
-<li><b>All packages renamed from <code>net.sf.tapestry</code> to <code>org.apache.tapestry</code></b></li>
+<li><b>All packages have been renamed from <code>net.sf.tapestry</code> to <code>org.apache.tapestry</code></b>.</li>
+<li>Several non-ASL libraries (including Jetty) have been removed from both CVS and the distribution. To
+build Tapestry and run the demos is now more involved; it requires obtaining several external dependencies.
+The Tapestry distribution is much smaller, however. This was done for licensing reasons.
+Sorry.</li>
+<li>Expression bindings in HTML templates are now in the format
+<code><i>attribute</i>="ognl:<i>expression</i>"</code>.</li>
+<li>String bindings (to localized strings) in HTML templates are now in the format
+<code><i>attribute</i>="string:<i>key</i>"</code>.</li>
<li>Allow <set-property> element of specification to specify the expression as an attribute or
as wrapped character data.</li>
<li>The interfaces for <a href="doc/api/net/sf/tapestry/valid/IValidationDelegate.html">IValidationDelegate</a>,
1.18 +20 -12 jakarta-tapestry/doc/src/Tutorial/Tutorial.xml
Index: Tutorial.xml
===================================================================
RCS file: /home/cvs/jakarta-tapestry/doc/src/Tutorial/Tutorial.xml,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- Tutorial.xml 16 Jan 2003 01:16:51 -0000 1.17
+++ Tutorial.xml 6 Mar 2003 19:19:34 -0000 1.18
@@ -31,6 +31,14 @@
</bookinfo>
<chapter id="intro">
<title>Introduction</title>
+
+ <warning>
+ <para>
+ This Tutorial is extremely out of date. A new tutorial should be ready
+ before 2.4 reaches GA.
+ </para>
+ </warning>
+
<para>
Tapestry is a new application framework for developing web applications. It uses
a component object model to represent the pages of a web application. This is
@@ -192,9 +200,9 @@
<servlet>
<servlet-name>hello</servlet-name>
- <servlet-class>net.sf.tapestry.ApplicationServlet</servlet-class>
+ <servlet-class>org.apache.tapestry.ApplicationServlet</servlet-class>
<init-param>
- <param-name>net.sf.tapestry.application-specification</param-name>
+ <param-name>org.apache.tapestry.application-specification</param-name>
<param-value>/tutorial/hello/HelloWorld.application</param-value>
</init-param>
<load-on-startup>0</load-on-startup>
@@ -238,7 +246,7 @@
"http://tapestry.sf.net/dtd/Tapestry_1_3.dtd">
<application
name="Hello World Tutorial"
- engine-class="net.sf.tapestry.engine.&SimpleEngine;">
+ engine-class="org.apache.tapestry.engine.&SimpleEngine;">
<page name="Home"
specification-path="/tutorial/hello/Home.page"/>
@@ -272,7 +280,7 @@
"-//Howard Lewis Ship//Tapestry Specification 1.3//EN"
"http://tapestry.sf.net/dtd/Tapestry_1_3.dtd">
-<page-specification class="net.sf.tapestry.html.&BasePage;"/>
+<page-specification class="org.apache.tapestry.html.&BasePage;"/>
</programlisting>
</figure>
<para>
@@ -365,7 +373,7 @@
"-//Howard Lewis Ship//Tapestry Specification 1.3//EN"
"http://tapestry.sf.net/dtd/Tapestry_1_3.dtd">
-<application name="Simple Tutorial" engine-class="net.sf.tapestry.engine.&SimpleEngine;">
+<application name="Simple Tutorial" engine-class="org.apache.tapestry.engine.&SimpleEngine;">
<page name="Home" specification-path="/tutorial/simple/Home.page"/>
</application>
</programlisting>
@@ -506,7 +514,7 @@
package tutorial.simple;
import java.util.Date;
-import net.sf.tapestry.html.BasePage;
+import org.apache.tapestry.html.BasePage;
public class Home extends &BasePage;
{
@@ -647,9 +655,9 @@
"-//Howard Lewis Ship//Tapestry Specification 1.3//EN"
"http://tapestry.sf.net/dtd/Tapestry_1_3.dtd">
-<application name="Tapestry Hangman" engine-class="net.sf.tapestry.engine.&SimpleEngine;">
+<application name="Tapestry Hangman" engine-class="org.apache.tapestry.engine.&SimpleEngine;">
- <property name="net.sf.tapestry.visit-class">tutorial.hangman.Visit</property> <co id="hangman.app.visit"/>
+ <property name="org.apache.tapestry.visit-class">tutorial.hangman.Visit</property> <co id="hangman.app.visit"/>
<page name="Home" specification-path="/tutorial/hangman/Home.page"/>
@@ -1378,7 +1386,7 @@
"-//Howard Lewis Ship//Tapestry Specification 1.3//EN"
"http://tapestry.sf.net/dtd/Tapestry_1_3.dtd">
-<page-specification class="net.sf.tapestry.html.BasePage">
+<page-specification class="org.apache.tapestry.html.BasePage">
<component id="border" type="Border">
<static-binding name="title">Home</static-binding>
@@ -1559,7 +1567,7 @@
<para>
By default, the reset service (used by the reset button) is disabled.
To enable it, set the JVM system property
- <varname>net.sf.tapestry.enable-reset-service</varname> to true.
+ <varname>org.apache.tapestry.enable-reset-service</varname> to true.
The service is disabled since it is too tempting a target for a denial
of service attack.
</para>
@@ -1604,7 +1612,7 @@
<para>
The right side is a small second form, allowing new categories to be created.
This can be useful to make broad changes in logging levels. For instance, creating
-a category "net.sf.tapestry" would allow the logging level of all Tapestry classes to be
+a category "org.apache.tapestry" would allow the logging level of all Tapestry classes to be
set in a single place.
</para>
</section>