You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@struts.apache.org by hu...@apache.org on 2006/07/12 23:24:57 UTC
svn commit: r421417 - in /struts/struts1/trunk/tiles: pom.xml
src/site/site.xml src/site/xdoc/examples.xml src/site/xdoc/userGuide.xml
Author: husted
Date: Wed Jul 12 14:24:57 2006
New Revision: 421417
URL: http://svn.apache.org/viewvc?rev=421417&view=rev
Log:
STR-2910 Update Tiles documentation
Modified:
struts/struts1/trunk/tiles/pom.xml
struts/struts1/trunk/tiles/src/site/site.xml
struts/struts1/trunk/tiles/src/site/xdoc/examples.xml
struts/struts1/trunk/tiles/src/site/xdoc/userGuide.xml
Modified: struts/struts1/trunk/tiles/pom.xml
URL: http://svn.apache.org/viewvc/struts/struts1/trunk/tiles/pom.xml?rev=421417&r1=421416&r2=421417&view=diff
==============================================================================
--- struts/struts1/trunk/tiles/pom.xml (original)
+++ struts/struts1/trunk/tiles/pom.xml Wed Jul 12 14:24:57 2006
@@ -34,12 +34,12 @@
<artifactId>struts-tiles</artifactId>
<packaging>jar</packaging>
<name>Struts Tiles</name>
- <url>http://struts.apache.org/1.x/struts-tiles/</url>
-
+ <url>http://struts.apache.org</url>
+
<distributionManagement>
<site>
<id>apache-site</id>
- <url>scp://people.apache.org/www/struts.apache.org/1.x/struts-tiles/</url>
+ <url>scp://people.apache.org/www/struts.apache.org/1.x/struts-tiles</url>
</site>
</distributionManagement>
Modified: struts/struts1/trunk/tiles/src/site/site.xml
URL: http://svn.apache.org/viewvc/struts/struts1/trunk/tiles/src/site/site.xml?rev=421417&r1=421416&r2=421417&view=diff
==============================================================================
--- struts/struts1/trunk/tiles/src/site/site.xml (original)
+++ struts/struts1/trunk/tiles/src/site/site.xml Wed Jul 12 14:24:57 2006
@@ -3,14 +3,19 @@
<bannerLeft>
<name>Apache Software Foundation</name>
<src>http://www.apache.org/images/asf-logo.gif</src>
- <href>http://www.apache.org/</href>
+ <href>http://www.apache.org</href>
</bannerLeft>
<bannerRight>
<name>Apache Struts</name>
<src>http://struts.apache.org/images/struts.gif</src>
- <href>http://struts.apache.org/index.html</href>
+ <href>http://struts.apache.org</href>
</bannerRight>
<body>
+ <links>
+ <item name="Apache" href="http://www.apache.org" />
+ <item name="Struts 1" href="http://struts.apache.org/1.x" />
+ <item name="Struts 2" href="http://struts.apache.org/2.0" />
+ </links>
<menu name="Struts Tiles">
<item href="index.html" name="Tiles Home"/>
<item href="installation.html" name="Installation"/>
@@ -50,7 +55,7 @@
href="apidocs/index.html"/>
<item
name="Apache Struts Home"
- href="http://struts.apache.org/index.html"/>
+ href="http://struts.apache.org/"/>
</menu>
${reports}
</body>
Modified: struts/struts1/trunk/tiles/src/site/xdoc/examples.xml
URL: http://svn.apache.org/viewvc/struts/struts1/trunk/tiles/src/site/xdoc/examples.xml?rev=421417&r1=421416&r2=421417&view=diff
==============================================================================
--- struts/struts1/trunk/tiles/src/site/xdoc/examples.xml (original)
+++ struts/struts1/trunk/tiles/src/site/xdoc/examples.xml Wed Jul 12 14:24:57 2006
@@ -246,7 +246,11 @@
...
]]></source>
</subsection>
+
+</section>
+<!--
+
<subsection name="Using Inheritance: Overloading parameters">
</subsection>
@@ -255,7 +259,6 @@
<subsection name="List Usage">
</subsection>
-</section>
<section name="JSP Usage">
<subsection name="Defining Tiles In A JSP Page">
@@ -280,6 +283,8 @@
</subsection>
</section>
+
+-->
</body>
</document>
Modified: struts/struts1/trunk/tiles/src/site/xdoc/userGuide.xml
URL: http://svn.apache.org/viewvc/struts/struts1/trunk/tiles/src/site/xdoc/userGuide.xml?rev=421417&r1=421416&r2=421417&view=diff
==============================================================================
--- struts/struts1/trunk/tiles/src/site/xdoc/userGuide.xml (original)
+++ struts/struts1/trunk/tiles/src/site/xdoc/userGuide.xml Wed Jul 12 14:24:57 2006
@@ -23,98 +23,15 @@
<body>
-<section name="1. Tiles Configuration">
+<section name="Struts Tiles User Guide">
- <subsection name="1.1 Web Application Configuration">
- <p>There are several ways to configure your web application to use Tiles. The
- method you choose depends on whether you are using Tiles with another
- framework, like Struts, and which version of the Servlet specification
- you are targeting.</p>
-
- <p>If you are using Tiles with Struts you do not need to specify the
- Tiles configuration files in the web application deployment descriptor.
- Instead you reference the Tiles configuration file(s) in your Struts
- configuration using a Plugin. The configuration should look like this:
- </p>
-
- <source><![CDATA[
- <plug-in className="org.apache.struts.tiles.TilesPlugin">
- <set-property
- property="definitions-config"
- value="/WEB-INF/tiles-defs.xml"/>
- </plug-in>
- ]]></source>
-
- <p>If you are using Struts 1.2.x you will need to also make sure you are
- using the <code>org.apache.struts.tiles.TilesRequestProcessor</code>
- or a <code>RequestProcessor</code> class that extends it.</p>
- <source><![CDATA[
- <controller
- processorClass="org.apache.struts.tiles.TilesRequestProcessor"/>
- ]]></source>
-
- <p>If you are using Struts 1.3.x, the default
- <code>ComposableRequestProcessor</code> can be configured to recognize
- Tiles definitions. A chain-config file is included in struts-tiles.jar.
- To use it, add the following <code>init-param</code> to the Action
- Servlet definition in web.xml.</p>
- <source><![CDATA[
- <init-param>
- <param-name>chainConfig</param-name>
- <param-value>org/apache/struts/tiles/chain-config.xml</param-value>
- </init-param>
- ]]></source>
-
- <p>If you are not using Struts most of the configuration will be found in
- the web application deployment descriptor as follows:</p>
-
- <source><![CDATA[
- <servlet>
- <servlet-name>Tiles Servlet</servlet-name>
- <servlet-class>org.apache.struts.tiles.servlets.TilesServlet</servlet-class>
- <init-param>
- <param-name>definitions-config</param-name>
- <param-value>/WEB-INF/tiles-defs.xml</param-value>
- </init-param>
- <load-on-startup>1</load-on-startup>
- </servlet>
- ]]></source>
-
- <p>Tiles will work with applications based on the Servlet 2.2 specification.
- If your application is Servlet 2.2-based you will need to include the TLD
- files under your WEB-INF directory and include the following taglib
- declaration in the deployment descriptor:
-
- <source><![CDATA[
-<taglib>
- <taglib-uri>/WEB-INF/tiles.tld</taglib-uri>
- <taglib-location>/WEB-INF/tiles.tld</taglib-location>
-</taglib>
- ]]></source>
-
- You will also need to reference the taglib from each JSP page in the
- following manner:
-
- <source><![CDATA[
- <%@ taglib uri="/WEB-INF/tiles.tld" prefix="tiles" %>
- ]]></source>
-
- </p>
-
- <p>If your application is targeting the Servlet 2.3/2.4 specification you
- do not need to declare the tag libraries in the deployment descriptor.
- They are declared in the Tiles jar file that should be deployed with your
- web application. In Servlet 2.3/2.4 containers you would reference the
- taglib in JSP pages like this:
+ <p>
+ One Tiles is installed and the XML Definitions are being loaded,
+ the better part of using Tiles is managing the XML Definitions.
+ </p>
+
- <source><![CDATA[
- <%@ taglib uri="http://struts.apache.org/tags-tiles" prefix="tiles" %>
- ]]></source>
-
- </p>
- </subsection>
-
- <subsection name="1.2 XML Definitions Configuration">
+ <subsection name="XML Definitions Configuration">
<p>This section provides an overview of the Tiles XML configuration mechanism.
</p>
@@ -158,7 +75,7 @@
</subsection>
- <subsection name="1.2.1 Definitions">
+ <subsection name="Definitions">
<p>A definition can define a template or a "tile." If it is defining
a template its path will point to a JSP page that contains the layout
of the template. The definition's attributes will point to various
@@ -221,7 +138,7 @@
</ul>
</subsection>
- <subsection name="1.2.2 Put">
+ <subsection name="Put">
<p>The "put" element describes an attribute of a definition. Definition
attributes have a name and a value. The value can be specified as an
xml attribute, or in the body of the <code><put></code>tag.</p>
@@ -267,7 +184,7 @@
</subsection>
- <subsection name="1.2.3 PutList">
+ <subsection name="PutList">
<p>The PutList tag is similar to the Put tag except that it allows you
to specify a list of attributes for a Tiles Definition. It specifies
an attribute that is a Java List containing any kind of values. In
@@ -283,7 +200,7 @@
</ul>
</subsection>
- <subsection name="1.2.4 Add">
+ <subsection name="Add">
<p>The <strong>add</strong> element describes an element of a list. It
is similar to the <strong>put</strong> element except that it is only
used in lists. It supports the following attributes.</p>
@@ -319,7 +236,7 @@
</subsection>
- <subsection name="1.2.5 Bean">
+ <subsection name="Bean">
<p>The <strong>bean</strong> element describes an element of a list. It
causes a bean of the specified java classtype to be created. This
bean is initialized with appropriate nested
@@ -331,7 +248,7 @@
</ul>
</subsection>
- <subsection name="1.2.6 Set-Property">
+ <subsection name="Set-Property">
<p>The <strong>set-property</strong> element specifies the method name
and initial value of a bean property. When the object representing
the surrounding element is instantiated, the accessor for the
@@ -349,7 +266,7 @@
</subsection>
- <subsection name="1.2.7 Item">
+ <subsection name="Item">
<p>The <strong>item</strong> element describes an element of a list.
It causes a bean of the specified classtype to be created and added
to the list. Each bean can contain different properties: value, link,
@@ -381,38 +298,40 @@
</ul>
</subsection>
- <subsection name="1.2.8 Description">
+ <subsection name="Description">
<p>The <strong>description</strong> element contains descriptive
(paragraph length) text about the surrounding element, suitable for
use in GUI tools.</p>
</subsection>
- <subsection name="1.2.9 Display-Name">
+ <subsection name="Display-Name">
<p>The <strong>display-name</strong> element contains a short (one line)
description of the surrounding element, suitable for use in GUI
tools.</p>
</subsection>
- <subsection name="1.2.10 Icon">
+ <subsection name="Icon">
<p>The <strong>icon</strong> element contains a small-icon and
large-icon element which specify the location, relative to the
Tiles configuration file, for small and large images used to
represent the surrounding element in GUI tools.</p>
</subsection>
- <subsection name="1.2.11 Large-Icon">
+ <subsection name="Large-Icon">
<p>The <strong>large-icon</strong> element specifies the location,
relative to the Struts configuration file, of a resource containing
a large (32x32 pixel) icon image.</p>
</subsection>
- <subsection name="1.2.12 Small-Icon">
+ <subsection name="Small-Icon">
<p>The <strong>large-icon</strong> element specifies the location,
relative to the Struts configuration file, of a resource containing
a large (16x16 pixel) icon image.</p>
</subsection>
</section>
+<!--
+
<section name="2. Using Tiles">
<subsection name="2.1 Inserting Tiles Into A JSP Page">
</subsection>
@@ -424,48 +343,95 @@
</subsection>
</section>
-<section name="3. Other Resources">
+-->
+
+<section name="Other Resources">
<p>
-<a href="http://www.oracle.com/technology/oramag/oracle/04-may/o34dev_struts.html">
-<strong>Reuse Tiles and Simplify UI</strong></a>
-by James Holmes. Howto article in Oracle Magazine.
+Tiles has been covered by many books and articles.
</p>
-<p>
+<subsection name="Sample Book Chapters">
+
+<ul>
+<li>
<a href="http://www.manning.com/getpage.html?project=husted&filename=chapters.html">
<strong>Developing applications with Tiles</strong></a> by Cedric Dumoulin and
Ted Husted. Sample chapter from
<a href="http://www.amazon.com/exec/obidos/ISBN=1930110502/hitchhikeguidetoA/">
Struts in Action</a>; available as a free download (PDF).
-</p>
+</li>
-<p>
+<li>
<a href="http://www.oreilly.com/catalog/jakarta/chapter/">
<strong>Using Tiles</strong></a> Sample beta chapter from
<a href="http://www.amazon.com/exec/obidos/ISBN=0596003285/hitchhikeguidetoA/">
Programming Jakarta Struts</a>; available as a free download (PDF).
-</p>
+</li>
+</ul>
-<p>
+</subsection>
+
+<subsection name="Articles">
+
+<ul>
+<li>
+<a href="http://www.developer.com/java/ent/article.php/3569446">
+<strong>Open Source-Based Portal-Lite</strong></a>
+by Scott Nelson. Using Tiles to prototype a portal site.
+</li>
+
+<li>
+<a href="http://www-128.ibm.com/developerworks/websphere/library/techarticles/0505_kodali/0505_kodali.html">
+<strong>Improve performance by caching Struts and Tiles applications</strong></a>
+by Nirmala Kodali. Implementing caching under WebSphere.
+</li>
+
+<li>
+<a href="http://www.laliluna.de/first-steps-struts-tiles-tutorial.html">
+<strong>Introduction to Struts and Tiles with a working example</strong></a>
+by Sascha Wolski.
+</li>
+
+<li>
+<a href="http://www.javaworld.com/javaworld/jw-10-2004/jw-1025-xkins.html">
+<strong> Skin Web applications using Xkins</strong></a>
+by Guillermo Meyer. Use skinning with Struts and Tiles.
+</li>
+
+<li>
+<a href="http://www.oracle.com/technology/oramag/oracle/04-may/o34dev_struts.html">
+<strong>Reuse Tiles and Simplify UI</strong></a>
+by James Holmes. Howto article in Oracle Magazine.
+</li>
+
+<li>
<a href="http://www-106.ibm.com/developerworks/java/library/j-strutstiles.html?loc=j">
<strong>Struts and Tiles aid component-based development</strong></a> by Wellie Chao.
-</p>
+</li>
-<p>
+<li>
<a href="http://www.javaworld.com/javaworld/jw-01-2002/jw-0104-tilestrut.html">
<strong>UI design with Tiles and Struts</strong></a> by Prakash Malani.
-</p>
+</li>
-<p>
+<li>
<a href="http://www.theserverside.com/resources/article.jsp?l=Tiles101">
<strong>Tiles 101/201</strong></a> by Patrick Peak.
-</p>
+</li>
-<p>
+<li>
<a href="http://www.lifl.fr/~dumoulin/tiles/tilesAdvancedFeatures.pdf">
<strong>Tiles Advanced Features</strong></a> by Cedric Dumoulin.
+</li>
+</ul>
+
+<p>
+For a comprehensive listing of Struts resources, visit
+<a href="http://www.StrutsCentral.net/">Struts Central.</a>
</p>
+
+</subsection>
</section>