svn commit: r699348 - in /tiles/framework/trunk/src/site/apt: config-reference.apt tutorial/configuration.apt

[ap...@apache.org]

Author: apetrelli
Date: Fri Sep 26 07:56:42 2008
New Revision: 699348

URL: http://svn.apache.org/viewvc?rev=699348&view=rev
Log:
TILES-296
Added docs for Java configuration.
Updated the reference doc for AbstractTilesContainerFactory.

Modified:
    tiles/framework/trunk/src/site/apt/config-reference.apt
    tiles/framework/trunk/src/site/apt/tutorial/configuration.apt

Modified: tiles/framework/trunk/src/site/apt/config-reference.apt
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/src/site/apt/config-reference.apt?rev=699348&r1=699347&r2=699348&view=diff
==============================================================================
--- tiles/framework/trunk/src/site/apt/config-reference.apt (original)
+++ tiles/framework/trunk/src/site/apt/config-reference.apt Fri Sep 26 07:56:42 2008
@@ -34,7 +34,7 @@
   [[1]] {{{config-reference.html#Main configuration}Main configuration}}.
 
 *---------------------------------------------+--------------------------------------+
-| {{{config-reference.html#org.apache.tiles.factory.TilesContainerFactory}<<<org.apache.tiles.factory.TilesContainerFactory>>>}}    | Class name of the container factory  |
+| {{{config-reference.html#org.apache.tiles.factory.AbstractTilesContainerFactory}<<<org.apache.tiles.factory.AbstractTilesContainerFactory>>>}}    | Class name of the container factory  |
 *---------------------------------------------+--------------------------------------+
 | {{{config-reference.html#org.apache.tiles.factory.TilesContainerFactory.MUTABLE}<<<org.apache.tiles.factory.TilesContainerFactory.MUTABLE>>>}} | Flag to use a mutable container |
 *---------------------------------------------+--------------------------------------+
@@ -89,17 +89,17 @@
 
 * {Main configuration}
 
-** {<<<org.apache.tiles.factory.TilesContainerFactory>>>}
+** {<<<org.apache.tiles.factory.AbstractTilesContainerFactory>>>}
 
   Specifies the container factory class name to use.
   
   * <<Specified in>>:
-  {{{framework/apidocs/org/apache/tiles/factory/TilesContainerFactory.html#CONTAINER_FACTORY_INIT_PARAM}<<<org.apache.tiles.factory.TilesContainerFactory>>>}}.
+  {{{framework/apidocs/org/apache/tiles/factory/AbstractTilesContainerFactory.html#CONTAINER_FACTORY_INIT_PARAM}<<<org.apache.tiles.factory.AbstractTilesContainerFactory>>>}}.
     
   * <<Default>>: <<<org.apache.tiles.factory.TilesContainerFactory>>>.
     
   * <<Usage>>: when specified, it must contain the name of a class that
-  extends the <<<TilesContainerFactory>>> class.
+  extends the <<<AbstractTilesContainerFactory>>> class.
 
 ** {<<<org.apache.tiles.factory.TilesContainerFactory.MUTABLE>>>}
 

Modified: tiles/framework/trunk/src/site/apt/tutorial/configuration.apt
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/src/site/apt/tutorial/configuration.apt?rev=699348&r1=699347&r2=699348&view=diff
==============================================================================
--- tiles/framework/trunk/src/site/apt/tutorial/configuration.apt (original)
+++ tiles/framework/trunk/src/site/apt/tutorial/configuration.apt Fri Sep 26 07:56:42 2008
@@ -115,6 +115,8 @@
 
 Configuring Tiles internals
 
+* Main configuration
+
   You can configure Tiles internal behaviour by specifying:
   
   * in a web application environment, by using context parameters or init
@@ -122,4 +124,34 @@
   
   * in a portlet environment, by using portlet init parameters.
   
-  For the details see {{{../config-reference.html}Tiles configuration reference}}.
\ No newline at end of file
+  For the details see {{{../config-reference.html}Tiles configuration reference}}.
+
+* Pure Java configuration
+  
+  In both environments, it is possible to use pure <<Java configuration>>,
+  without messing with the deployment descriptors.
+
+  All you have to do is create a class that extends
+  {{{../apidocs/org/apache/tiles/factory/AbstractTilesContainerFactory.html}AbstractTilesContainerFactory}}.
+  In particular you can use {{{../apidocs/org/apache/tiles/factory/BasicTilesContainerFactory.html}BasicTilesContainerFactory}}
+  as a basis for your extended configuration. <<<BasicTilesContainerFactory>>>
+  is the configuration that replicates the default configuration of Tiles,
+  i.e. the one that assumes when no additional parameter is provided.
+  The
+  {{{../apidocs/org/apache/tiles/factory/BasicTilesContainerFactory.html}Javadoc documentation of BasicTilesContainerFactory}}
+  documents all the methods that can be overridden to use your own
+  configuration.
+
+  To enable pure Java configuration, provide the
+  {{{../config-reference.html#org.apache.tiles.factory.AbstractTilesContainerFactory}<<<org.apache.tiles.factory.AbstractTilesContainerFactory>>>}}
+  parameter this way:
+
+--------------------------------
+<init-param>
+    <param-name>org.apache.tiles.factory.AbstractTilesContainerFactory</param-name>
+    <param-value>org.apache.tiles.test.factory.TestTilesContainerFactory</param-value>
+</init-param>
+--------------------------------
+
+  Where <<<TestTilesContainerFactory>>> is a class that extends
+  <<<AbstractTilesContainerFactory>>>.