Author: craigmcc Date: Wed Jan 24 14:06:26 2007 New Revision: 499588 URL: http://svn.apache.org/viewvc?view=rev&rev=499588 Log: Update website pages that were not fully updated for the 1.0.4 release.
SHALE-398 Modified: shale/framework/trunk/shale-application/src/site/xdoc/index.xml shale/framework/trunk/src/site/xdoc/using.xml Modified: shale/framework/trunk/shale-application/src/site/xdoc/index.xml URL: http://svn.apache.org/viewvc/shale/framework/trunk/shale-application/src/site/xdoc/index.xml?view=diff&rev=499588&r1=499587&r2=499588 ============================================================================== --- shale/framework/trunk/shale-application/src/site/xdoc/index.xml (original) +++ shale/framework/trunk/shale-application/src/site/xdoc/index.xml Wed Jan 24 14:06:26 2007 @@ -33,7 +33,7 @@ associating a request scoped "backing bean" with each page to contain event handlers and/or submitted values. Indeed, Shale itself offers extended support for this paradigm by virtue of its - <a href="features-view-controller.html">View Controller</a> feature. + <a href="../shale-view/index.html">View Controller</a> feature. This is in contrast to the <em>action oriented</em> architecture typically found in web application frameworks like <a href="http://struts.apache.org/">Struts 1.x</a>.</p> @@ -74,10 +74,10 @@ <h4>(A) Standard Per-Request Processing</h4> - <p>As described in <a href="using.html#using-configuring">Configuring + <p>As described in <a href="../using.html#using-configuring">Configuring Your Application For Shale</a>, you are requested to configure a <em>Servlet Filter</em> - (<code>org.apache.shale.faces.ShaleApplicationFilter</code>) and + (<code>org.apache.shale.application.faces.ShaleApplicationFilter</code>) and map it to process incoming URLs (typically using the URL pattern <code>/*</code> to process all requests to this application). This filter receives control both <strong>before</strong> and @@ -126,7 +126,7 @@ <p>In addition to the standard request processing lifecycle described in the previous section, Shale offers an abstract base class - <a href="shale-core/apidocs/org/apache/shale/application/AbstractRegExpFilter.html"> + <a href="apidocs/org/apache/shale/application/AbstractRegExpFilter.html"> org.apache.shale.application.AbstractReqExpFilter</a> suitable for developing <code>preprocess</code> commands that perform request filtering based on matching incoming request values to @@ -136,15 +136,15 @@ <p>Three concrete implementations based on this abstract base class are also provided:</p> <ul> - <li><a href="shale-core/apidocs/org/apache/shale/application/ContextRelativePathFilter.html"> + <li><a href="apidocs/org/apache/shale/application/ContextRelativePathFilter.html"> ContextRelativePathFilter</a> - Filters requests by matching the context relative portion of the path (i.e. starting with the slash after the context path itself) against one or more regular expressions.</li> - <li><a href="shale-core/apidocs/org/apache/shale/application/RemoteAddrFilter.html"> + <li><a href="apidocs/org/apache/shale/application/RemoteAddrFilter.html"> RemoteAddrFilter</a> - Filters requests by matching the IP address of the remote client against one or more regular expressions.</li> - <li><a href="shale-core/apidocs/org/apache/shale/application/RemoteHostFilter.html"> + <li><a href="apidocs/org/apache/shale/application/RemoteHostFilter.html"> RemoteHostFilter</a> - Filters requests by matching the hostname of the remote client against one or more regular expressions.</li> </ul> Modified: shale/framework/trunk/src/site/xdoc/using.xml URL: http://svn.apache.org/viewvc/shale/framework/trunk/src/site/xdoc/using.xml?view=diff&rev=499588&r1=499587&r2=499588 ============================================================================== --- shale/framework/trunk/src/site/xdoc/using.xml (original) +++ shale/framework/trunk/src/site/xdoc/using.xml Wed Jan 24 14:06:26 2007 @@ -31,9 +31,9 @@ <p>This page documents the use of Shale in your web applicatons, including <a href="#using-dependencies">external dependencies</a> and detailed instructions on <a href="#using-configuring">configuring - your application</a>. A future milestone of Shale will - likely include a "shale-blank" example application with all of the - basics set up for you, ready to be customized for your own use.</p> + your application</a>. You might also consider starting from the + <em>shale-blank</em> example application that has many of the basics + set up for you, ready to be customized for your own use.</p> </subsection> @@ -54,60 +54,170 @@ </thead> <tbody> <tr> - <td><code>shale-core.jar</code></td> + <td><code>(All)</code></td> <td>JavaServer Faces Implementation</td> <td align="center">1.1</td> - <td align="center"><a href="#[1]">[1]</a></td> + <td align="center">API classes<a href="#[1]">[1]</a> must be on compile classpath. + API and implementation classes must be included in webapp or provided by the + servlet container.</td> </tr> <tr> - <td><code>shale-core.jar</code></td> + <td><code>(All)</code></td> + <td>JavaServer Pages API</td> + <td align="center">2.0</td> + <td align="center">API classes must be on compile classpath</td> + </tr> + <tr> + <td><code>(All)</code></td> + <td>Servlet API</td> + <td align="center">2.4</td> + <td align="center">API classes must be on compile classpath</td> + </tr> + <tr> + <td><code>shale-application.jar</code></td> <td><a href="http://jakarta.apache.org/commons/beanutils/">Commons BeanUtils</a></td> - <td align="center">1.7</td> + <td align="center">1.7.0</td> <td align="center">---</td> </tr> <tr> - <td><code>shale-core.jar</code></td> + <td><code>shale-application.jar</code></td> <td><a href="http://jakarta.apache.org/commons/chain/">Commons Chain</a></td> - <td align="center">1.0</td> + <td align="center">1.1</td> <td align="center">---</td> </tr> <tr> - <td><code>shale-core.jar</code></td> + <td><code>shale-application.jar</code></td> <td><a href="http://jakarta.apache.org/commons/digester/">Commons Digester</a></td> - <td align="center">1.7</td> + <td align="center">1.8</td> <td align="center">---</td> </tr> <tr> - <td><code>shale-core.jar</code></td> + <td><code>shale-application.jar</code></td> <td><a href="http://jakarta.apache.org/commons/logging/">Commons Logging</a></td> - <td align="center">1.0.4</td> + <td align="center">1.1</td> <td align="center">---</td> </tr> <tr> - <td><code>shale-core.jar</code></td> - <td><a href="http://jakarta.apache.org/commons/validator/">Commons Validator</a></td> - <td align="center">1.2.0</td> + <td><code>shale-application.jar</code></td> + <td><a href="http://shale.apache.org/">Shale Core</a></td> + <td align="center">(Same)</td> + <td align="center">---</td> + </tr> + <tr> + <td><code>shale-clay.jar</code></td> + <td><a href="http://jakarta.apache.org/commons/beanutils/">Commons BeanUtils</a></td> + <td align="center">1.7.0</td> <td align="center">---</td> </tr> <tr> <td><code>shale-clay.jar</code></td> - <td>(No additional external dependencies)</td> + <td><a href="http://jakarta.apache.org/commons/chain/">Commons Chain</a></td> + <td align="center">1.1</td> <td align="center">---</td> + </tr> + <tr> + <td><code>shale-clay.jar</code></td> + <td><a href="http://jakarta.apache.org/commons/digester/">Commons Digester</a></td> + <td align="center">1.8</td> <td align="center">---</td> </tr> <tr> - <td><code>shale-spring.jar</code></td> - <td><a href="http://springframework.org/">Spring Framework</a></td> - <td align="center">1.2.2</td> - <td align="center"><a href="#[2]">[2]</a></td> + <td><code>shale-clay.jar</code></td> + <td><a href="http://jakarta.apache.org/commons/logging/">Commons Logging</a></td> + <td align="center">1.1</td> + <td align="center">---</td> + </tr> + <tr> + <td><code>shale-clay.jar</code></td> + <td><a href="http://shale.apache.org/">Shale Core</a></td> + <td align="center">(Same)</td> + <td align="center">---</td> + </tr> + <tr> + <td><code>shale-core.jar</code></td> + <td><a href="http://jakarta.apache.org/commons/logging/">Commons Logging</a></td> + <td align="center">1.1</td> + <td align="center">---</td> + </tr> + <tr> + <td><code>shale-dialog.jar</code></td> + <td><a href="http://jakarta.apache.org/commons/logging/">Commons Logging</a></td> + <td align="center">1.1</td> + <td align="center">---</td> + </tr> + <tr> + <td><code>shale-dialog-basic.jar</code></td> + <td><a href="http://jakarta.apache.org/commons/beanutils/">Commons BeanUtils</a></td> + <td align="center">1.7.0</td> + <td align="center">---</td> + </tr> + <tr> + <td><code>shale-dialog-basic.jar</code></td> + <td><a href="http://jakarta.apache.org/commons/digester/">Commons Digester</a></td> + <td align="center">1.8</td> + <td align="center">---</td> + </tr> + <tr> + <td><code>shale-dialog-basic.jar</code></td> + <td><a href="http://jakarta.apache.org/commons/logging/">Commons Logging</a></td> + <td align="center">1.1</td> + <td align="center">---</td> + </tr> + <tr> + <td><code>shale-dialog-basic.jar</code></td> + <td><a href="http://shale.apache.org/">Shale Dialog</a></td> + <td align="center">(Same)</td> + <td align="center">---</td> + </tr> + <tr> + <td><code>shale-dialog-scxml.jar</code></td> + <td><a href="http://jakarta.apache.org/commons/beanutils/">Commons BeanUtils</a></td> + <td align="center">1.7.0</td> + <td align="center">---</td> + </tr> + <tr> + <td><code>shale-dialog-scxml.jar</code></td> + <td><a href="http://jakarta.apache.org/commons/digester/">Commons Digester</a></td> + <td align="center">1.8</td> + <td align="center">---</td> + </tr> + <tr> + <td><code>shale-dialog-scxml.jar</code></td> + <td><a href="http://jakarta.apache.org/commons/logging/">Commons Logging</a></td> + <td align="center">1.1</td> + <td align="center">---</td> + </tr> + <tr> + <td><code>shale-dialog-scxml.jar</code></td> + <td><a href="http://jakarta.apache.org/commons/scxml/">Commons SCXML</a></td> + <td align="center">0.6</td> + <td align="center">---</td> + </tr> + <tr> + <td><code>shale-dialog-scxml.jar</code></td> + <td><a href="http://shale.apache.org/">Shale Dialog</a></td> + <td align="center">(Same)</td> + <td align="center">---</td> </tr> <tr> - <td><code>shale-test.jar</code></td> - <td>(No additional external dependencies)</td> + <td><code>shale-remoting.jar</code></td> + <td><a href="http://jakarta.apache.org/commons/logging/">Commons Logging</a></td> + <td align="center">1.1</td> <td align="center">---</td> + </tr> + <tr> + <td><code>shale-spring.jar</code></td> + <td><a href="http://shale.apache.org/">Shale Core</a></td> + <td align="center">(Same)</td> <td align="center">---</td> </tr> <tr> + <td><code>shale-spring.jar</code></td> + <td><a href="http://springframework.org/">Spring Framework</a></td> + <td align="center">1.2.8</td> + <td align="center"><a href="#[2]">[2]</a></td> + </tr> + <tr> <td><code>shale-tiger.jar</code></td> <td>Java SE</td> <td>5 or later</td> @@ -115,12 +225,59 @@ (code name "Tiger") or later JDK.</td> </tr> <tr> + <td><code>shale-tiger.jar</code></td> + <td><a href="http://jakarta.apache.org/commons/beanutils/">Commons BeanUtils</a></td> + <td align="center">1.7.0</td> + <td align="center">---</td> + </tr> + <tr> + <td><code>shale-tiger.jar</code></td> + <td><a href="http://jakarta.apache.org/commons/digester/">Commons Digester</a></td> + <td align="center">1.8</td> + <td align="center">---</td> + </tr> + <tr> + <td><code>shale-tiger.jar</code></td> + <td><a href="http://jakarta.apache.org/commons/logging/">Commons Logging</a></td> + <td align="center">1.1</td> + <td align="center">---</td> + </tr> + <tr> + <td><code>shale-tiger.jar</code></td> + <td><a href="http://shale.apache.org/">Shale View Controller</a></td> + <td align="center">(Same)</td> + <td align="center">---</td> + </tr> + <tr> + <td><code>shale-tiles.jar</code></td> + <td><a href="http://shale.apache.org/">Shale Core</a></td> + <td align="center">(Same)</td> + <td align="center">---</td> + </tr> + <tr> <td><code>shale-tiles.jar</code></td> - <td><a href="http://cvs.apache.org/builds/struts/nightly/sandbox/tiles-core/"> - Standalone Tiles</a></td> + <td><a href="http://tiles.apache.org/">Standalone Tiles</a></td> <td align="center">Nightly</td> <td align="center"><a href="#[3]">[3]</a></td> </tr> + <tr> + <td><code>shale-validator.jar</code></td> + <td><a href="http://jakarta.apache.org/commons/validator/">Commons Validator</a></td> + <td align="center">1.3.1</td> + <td align="center">---</td> + </tr> + <tr> + <td><code>shale-view.jar</code></td> + <td><a href="http://jakarta.apache.org/commons/logging/">Commons Logging</a></td> + <td align="center">1.1</td> + <td align="center">---</td> + </tr> + <tr> + <td><code>shale-view.jar</code></td> + <td><a href="http://shale.apache.org/">Shale Core</a></td> + <td align="center">(Same)</td> + <td align="center">---</td> + </tr> </tbody> </table> @@ -141,8 +298,9 @@ <li><a name="[3]"></a>Standalone Tiles is a (work in progress) extraction of the Tiles Framework out of Struts, removing Struts dependencies, and doing some refactoring. To date there have been - no formal releases of this library; the link above points to the - nightly builds.</li> + no formal releases of this library. Shale framework releases are + packaged with a snapshot version of Standalone Tiles that works + with this version of Shale.</li> </ol> </subsection> @@ -161,11 +319,9 @@ JavaServer Faces, you must include such an implementation (plus all of its dependent JARs) in the <code>/WEB-INF/lib</code> directory.</p> - <p>All Shale based applications will require <code>shale-core.jar</code> + <p>Most Shale based applications will require <code>shale-core.jar</code> (and its dependencies, as described above). If you wish to utilize the - features provided in the optional Shale components - (<code>shale-clay.jar</code>, <code>shale-spring.jar</code>, - <code>shale-tiger.jar</code>, and/or <code>shale-tiles.jar</code>), + features provided in the optional Shale components, include those JARs (and ther external dependencies) as well.</p> <p>The <code>shale-test.jar</code> contains base classes for @@ -179,6 +335,25 @@ annotations facility) of Java SE 5 (code named "Tiger"). You must <strong>NOT</strong> include this library if you are running on a JDK 1.4 platform.</p> + + <blockquote> + <p><em>If you use <a href="http://maven.apache.org/">Maven 2</a> + as your build environment, the process of selecting the correct + JAR files and dependencies can be delegated to Maven. Each Shale + module has a group identifier of <code>org.apache.shale</code>, + and an artifact identifier of <code>shale-xxxxx</code> depending + on the base name of the JAR file. For example, to include the + Shale Core library (and all of its dependencies) in your web + application, add the following entry into the <code>dependencies</code> + section of your <code>pom.xml</code> file:</em></p> +<source> + <dependency> + <groupId>org.apache.shale</groupId> + <artifactId>shale-core</artifactId> + <version>1.0.4</version> + </dependency> +</source> + </blockquote> <h4>(B) Configure <code>/WEB-INF/web.xml</code> Resource</h4>