Author: rahul
Date: Sat Dec 30 19:41:28 2006
New Revision: 491378
URL: http://svn.apache.org/viewvc?view=rev&rev=491378
Log:
Remove site FIXME, add content for the shale-tiles homepage (from its
package.html).
SHALE-380
Modified:
shale/framework/trunk/shale-tiles/src/site/xdoc/index.xml
Modified: shale/framework/trunk/shale-tiles/src/site/xdoc/index.xml
URL:
http://svn.apache.org/viewvc/shale/framework/trunk/shale-tiles/src/site/xdoc/index.xml?view=diff&rev=491378&r1=491377&r2=491378
==============================================================================
--- shale/framework/trunk/shale-tiles/src/site/xdoc/index.xml (original)
+++ shale/framework/trunk/shale-tiles/src/site/xdoc/index.xml Sat Dec 30
19:41:28 2006
@@ -25,7 +25,46 @@
<section name="Shale Tiles Integration">
<a name="tiles"/>
- <p>FIXME - Describe Tiles 2 integration feature.</p>
+ <p>This package contains an optional integration layer for working
+ with standalone Tiles. It has <strong>NO</strong> dependencies
+ on the remainder of Shale, so the JAR file containing it
+ (<code>shale-tiles.jar</code>) may be used to integrate Tiles
+ with any implementation of JavaServer Faces.</p>
+
+ <p><strong>Note:</strong><i> Shale's Tiles integration works only
+ with standalone Tiles, which currently resides in the Struts
+ sandbox (and is soon to be a Top Level Project at Apache).
+ Shale's Tiles integration does not work with Struts Tiles.
+ </i></p>
+
+ <subsection name="Services Provided">
+
+ <p>Using Shale's Tiles integration is easy: you just include
+ <code>shale-tiles.jar</code> in <code>WEB-INF/lib</code>. For
+ your efforts, for every view ID that you specify for JSF
+ navigation, Shale:
+ <ol>
+ <li>Strips off the view ID's suffix (eg: "/tiles/test.jsp"
+ becomes "/tiles/test")</li>
+ <li>Searches for a tile with the resulting name, with or
+ without the leading slash (eg: "/tiles/test" or
+ "tiles/test")</li>
+ <li>Loads the tile if found; otherwise, delegates to the
+ default JSF navigation handler</li>
+ </ol>
+ </p>
+
+ <p>With Shale's Tiles integration, you can use a tile or a single
+ JSP page to represent a JSF view and your view IDs for
+ navigation are the same for both. For example, you could have a
+ JSP page <code>/login.jsp</code>, that you specify as a view ID
+ for navigation. Later on, you can replace that JSP page with a
+ tile simply by specifying a tile named <code>login</code> in
+ your Tiles definition file. Shale will strip off the
+ <code>.jsp</code> suffix and load the tile instead of the JSP
+ page.</p>
+
+ </subsection>
<subsection name="Resources">
<ul>
