Author: apetrelli
Date: Tue Apr 24 08:45:46 2007
New Revision: 531987
URL: http://svn.apache.org/viewvc?view=rev&rev=531987
Log:
TILESSHARED-10
Added more configuration references.
Modified:
tiles/site/src/site/apt/config-reference.apt
tiles/site/src/site/site.xml
Modified: tiles/site/src/site/apt/config-reference.apt
URL:
http://svn.apache.org/viewvc/tiles/site/src/site/apt/config-reference.apt?view=diff&rev=531987&r1=531986&r2=531987
==============================================================================
--- tiles/site/src/site/apt/config-reference.apt (original)
+++ tiles/site/src/site/apt/config-reference.apt Tue Apr 24 08:45:46 2007
@@ -25,26 +25,158 @@
In this page you can find a fast reference on configuring the various parts
of
Tiles. These configuration parameters can be used as context parameters of a
- web applicatio, or as init parameters of servlets, filters or portlets.
+ web application, or as init parameters of servlets, filters or portlets.
Summary
- [[1]] Main configuration.
+* Standard configuration
- [[2]] <<<BasicTilesContainer>>> configuration.
+ [[1]] {{{config-reference.html#Main configuration}Main configuration}}.
+
+*---------------------------------------------+--------------------------------------+
+|
{{{config-reference.html#org.apache.tiles.CONTAINER_FACTORY}<<<org.apache.tiles.CONTAINER_FACTORY>>>}}
| Class name of the container factory |
+*---------------------------------------------+--------------------------------------+
+|
{{{config-reference.html#org.apache.tiles.CONTAINER_FACTORY.mutable}<<<org.apache.tiles.CONTAINER_FACTORY.mutable>>>}}
| Flag to use a mutable container |
+*---------------------------------------------+--------------------------------------+
+|
{{{config-reference.html#org.apache.tiles.CONTEXT_FACTORY}<<<org.apache.tiles.CONTEXT_FACTORY>>>}}
| Tiles context factory class name |
+*---------------------------------------------+--------------------------------------+
+|
{{{config-reference.html#org.apache.tiles.DEFINITIONS_FACTORY}<<<org.apache.tiles.DEFINITIONS_FACTORY>>>}}
| Definitions factory class name |
+*---------------------------------------------+--------------------------------------+
+|
{{{config-reference.html#org.apache.tiles.PREPARER_FACTORY}<<<org.apache.tiles.PREPARER_FACTORY>>>}}
| View preparer factory class name |
+*---------------------------------------------+--------------------------------------+
+
+ [[2]] {{{config-reference.html#BasicTilesContainer
configuration}<<<BasicTilesContainer>>> configuration}}.
+
+*---------------------------------------------+--------------------------------------+
+| <<<org.apache.tiles.DEFINITIONS_CONFIG>>> | List of paths that contain
Tiles definitions |
+*---------------------------------------------+--------------------------------------+
+
+ [[3]] {{{config-reference.html#ChainedTilesContextFactory
configuration}<<<ChainedTilesContextFactory>>> configuration}}.
+
+*---------------------------------------------+--------------------------------------+
+| <<<org.apache.tiles.context.ChainTilesContextFactory.FACTORY_CLASS_NAMES>>>
| List of elementary factory class names |
+*---------------------------------------------+--------------------------------------+
+
+ [[4]] {{{config-reference.html#DigesterDefinitionsReader
configuration}<<<DigesterDefinitionsReader>>> configuration}}.
+
+*---------------------------------------------+--------------------------------------+
+| <<<definitions-parser-validate>>> | Flag to deactivate XML parser
validation |
+*---------------------------------------------+--------------------------------------+
+
+ [[5]] {{{config-reference.html#UrlDefinitionsFactory
configuration}<<<UrlDefinitionsFactory>>> configuration}}.
+
+*---------------------------------------------+--------------------------------------+
+| <<<org.apache.tiles.definition.DefinitionsReader>>> | Definitions reader
class name |
+*---------------------------------------------+--------------------------------------+
+| <<<org.apache.tiles.locale.LocaleResolver>>> | Locale resolver class name
|
+*---------------------------------------------+--------------------------------------+
+
+* Extended configuration
+
+ [[1]] {{{config-reference.html#KeyedDefinitionsFactoryTilesContainerFactory
configuration}<<<KeyedDefinitionsFactoryTilesContainerFactory>>>
configuration}}.
+
+*---------------------------------------------+--------------------------------------+
+| <<<org.apache.tiles.CONTAINER.keyExtractor>>> | Key extractor class name
|
+*---------------------------------------------+--------------------------------------+
+| <<<org.apache.tiles.CONTAINER.keys>>> | List of keys to be used
|
+*---------------------------------------------+--------------------------------------+
+| <<<[EMAIL PROTECTED]>>> | List of paths containing definitions for the given
<<<key>>> |
+*---------------------------------------------+--------------------------------------+
+
+Standard configuration parameters
+
+* {Main configuration}
+
+** {<<<org.apache.tiles.CONTAINER_FACTORY>>>}
+
+ Specifies the container factory class name to use.
+
+ * <<Specified in>>:
+
{{{apidocs/org/apache/tiles/factory/TilesContainerFactory.html#CONTAINER_FACTORY_INIT_PARAM}<<<org.apache.tiles.factory.TilesContainerFactory>>>}}.
+
+ * <<Default>>: <<<org.apache.tiles.factory.TilesContainerFactory>>>.
+
+ * <<Usage>>: when specified, it must contain the name of a class that
+ extends the <<<TilesContainerFactory>>> class.
+
+** {<<<org.apache.tiles.CONTAINER_FACTORY.mutable>>>}
+
+ Flag to use a mutable container.
- [[3]] <<<UrlDefinitionsFactory>>> configuration.
+ * <<Specified in>>:
+
{{{apidocs/org/apache/tiles/factory/TilesContainerFactory.html#CONTAINER_FACTORY_MUTABLE_INIT_PARAM}<<<org.apache.tiles.factory.TilesContainerFactory>>>}}.
+
+ * <<Default>>: <<<false>>> (the container is not mutable).
+
+ * <<Usage>>: when specified and when its value is <<<true>>>, the container
to
+ be created will be <mutable>, i.e. definitions can be created at runtime.
-Configuration parameters
+** {<<<org.apache.tiles.CONTEXT_FACTORY>>>}
-* Main configuration
+ Specifies the context factory class name to use.
+
+ * <<Specified in>>:
+
{{{apidocs/org/apache/tiles/factory/TilesContainerFactory.html#CONTEXT_FACTORY_INIT_PARAM}<<<org.apache.tiles.factory.TilesContainerFactory>>>}}.
+
+ * <<Default>>: <<<org.apache.tiles.context.ChainedTilesContextFactory>>>.
+
+ * <<Usage>>: when specified, it must contain the name of a class that
+ implements the <<<TilesContextFactory>>> interface.
+
+** {<<<org.apache.tiles.DEFINITIONS_FACTORY>>>}
+
+ Specifies the context factory class name to use.
+
+ * <<Specified in>>:
+
{{{apidocs/org/apache/tiles/factory/TilesContainerFactory.html#DEFINITIONS_FACTORY_INIT_PARAM}<<<org.apache.tiles.factory.TilesContainerFactory>>>}}.
+
+ * <<Default>>: <<<org.apache.tiles.definition.UrlDefinitionsFactory>>>.
+
+ * <<Usage>>: when specified, it must contain the name of a class that
+ implements the <<<DefinitionsFactory>>> interface.
+
+** {<<<org.apache.tiles.DEFINITIONS_FACTORY>>>}
+
+ Specifies the definitions factory class name to use.
+
+ * <<Specified in>>:
+
{{{apidocs/org/apache/tiles/factory/TilesContainerFactory.html#DEFINITIONS_FACTORY_INIT_PARAM}<<<org.apache.tiles.factory.TilesContainerFactory>>>}}.
+
+ * <<Default>>: <<<org.apache.tiles.definition.UrlDefinitionsFactory>>>.
+
+ * <<Usage>>: when specified, it must contain the name of a class that
+ implements the <<<DefinitionsFactory>>> interface.
+
+** {<<<org.apache.tiles.PREPARER_FACTORY>>>}
+
+ Specifies the view preparer factory class name to use.
+
+ * <<Specified in>>:
+
{{{apidocs/org/apache/tiles/factory/TilesContainerFactory.html#PREPARER_FACTORY_INIT_PARAM}<<<org.apache.tiles.factory.TilesContainerFactory>>>}}.
+
+ * <<Default>>: <<<org.apache.tiles.preparer.BasicPreparerFactory>>>.
+
+ * <<Usage>>: when specified, it must contain the name of a class that
+ implements the <<<PreparerFactory>>> interface.
+
+* {<<<BasicTilesContainer>>> configuration}
TBD
-* <<<BasicTilesContainer>>> configuration
+* {<<<ChainedTilesContextFactory>>> configuration}
TBD
+
+* {<<<DigesterDefinitionsReader>>> configuration}
-* <<<UrlDefinitionsFactory>>> configuration
+ TBD
+
+* {<<<UrlDefinitionsFactory>>> configuration}
- TBD
\ No newline at end of file
+ TBD
+
+Extended configuration parameters
+
+* {<<<KeyedDefinitionsFactoryTilesContainerFactory>>> configuration}
+
+ TBD
Modified: tiles/site/src/site/site.xml
URL:
http://svn.apache.org/viewvc/tiles/site/src/site/site.xml?view=diff&rev=531987&r1=531986&r2=531987
==============================================================================
--- tiles/site/src/site/site.xml (original)
+++ tiles/site/src/site/site.xml Tue Apr 24 08:45:46 2007
@@ -131,7 +131,7 @@
name="Migration from Struts Tiles"
href="/migration/index.html"/>
<item
- name="Configuration"
+ name="Configuration reference"
href="/config-reference.html"/>
<item
name="Javadoc"
