Author: apetrelli
Date: Fri May 18 01:53:52 2007
New Revision: 539325
URL: http://svn.apache.org/viewvc?view=rev&rev=539325
Log:
TILESSHARED-10
Finished configuration reference.
Modified:
tiles/site/src/site/apt/config-reference.apt
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=539325&r1=539324&r2=539325
==============================================================================
--- tiles/site/src/site/apt/config-reference.apt (original)
+++ tiles/site/src/site/apt/config-reference.apt Fri May 18 01:53:52 2007
@@ -48,27 +48,27 @@
[[2]] {{{config-reference.html#BasicTilesContainer
configuration}<<<BasicTilesContainer>>> configuration}}.
*---------------------------------------------+--------------------------------------+
-| <<<org.apache.tiles.impl.BasicTilesContainer.DEFINITIONS_CONFIG>>> | List
of paths that contain Tiles definitions |
+|
{{{config-reference.html#org.apache.tiles.impl.BasicTilesContainer.DEFINITIONS_CONFIG}<<<org.apache.tiles.impl.BasicTilesContainer.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 |
+|
{{{config-reference.html#org.apache.tiles.context.ChainedTilesContextFactory.FACTORY_CLASS_NAMES}<<<org.apache.tiles.context.ChainedTilesContextFactory.FACTORY_CLASS_NAMES>>>}}
| List of elementary factory class names |
*---------------------------------------------+--------------------------------------+
[[4]] {{{config-reference.html#DigesterDefinitionsReader
configuration}<<<DigesterDefinitionsReader>>> configuration}}.
*---------------------------------------------+--------------------------------------+
-|
<<<org.apache.tiles.definition.digester.DigesterDefinitionsReader.PARSER_VALIDATE>>>
| Flag to deactivate XML parser validation |
+|
{{{config-reference.html#org.apache.tiles.definition.digester.DigesterDefinitionsReader.PARSER_VALIDATE}<<<org.apache.tiles.definition.digester.DigesterDefinitionsReader.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 |
+|
{{{config-reference.html#org.apache.tiles.definition.DefinitionsReader}<<<org.apache.tiles.definition.DefinitionsReader>>>}}
| Definitions reader class name |
*---------------------------------------------+--------------------------------------+
-| <<<org.apache.tiles.locale.LocaleResolver>>> | Locale resolver class name
|
+|
{{{config-reference.html#org.apache.tiles.locale.LocaleResolver}<<<org.apache.tiles.locale.LocaleResolver>>>}}
| Locale resolver class name |
*---------------------------------------------+--------------------------------------+
* Extended configuration
@@ -76,11 +76,11 @@
[[1]] {{{config-reference.html#KeyedDefinitionsFactoryTilesContainerFactory
configuration}<<<KeyedDefinitionsFactoryTilesContainerFactory>>>
configuration}}.
*---------------------------------------------+--------------------------------------+
-|
<<<org.apache.tiles.impl.KeyedDefinitionsFactoryTilesContainer.KeyExtractor>>>
| Key extractor class name |
+|
{{{config-reference.html#org.apache.tiles.impl.KeyedDefinitionsFactoryTilesContainer.KeyExtractor}<<<org.apache.tiles.impl.KeyedDefinitionsFactoryTilesContainer.KeyExtractor>>>}}
| Key extractor class name |
*---------------------------------------------+--------------------------------------+
-|
<<<org.apache.tiles.factory.KeyedDefinitionsFactoryTilesContainerFactory.KEYS>>>
| List of keys to be used |
+|
{{{config-reference.html#org.apache.tiles.factory.KeyedDefinitionsFactoryTilesContainerFactory.KEYS}<<<org.apache.tiles.factory.KeyedDefinitionsFactoryTilesContainerFactory.KEYS>>>}}
| List of keys to be used |
*---------------------------------------------+--------------------------------------+
-| <<<[EMAIL PROTECTED]>>> | List of paths containing definitions for the given
<<<key>>> |
+| [EMAIL PROTECTED]<<<[EMAIL PROTECTED]>>>}} | List of paths containing
definitions for the given <<<key>>> |
*---------------------------------------------+--------------------------------------+
Standard configuration parameters
@@ -149,22 +149,120 @@
* {<<<BasicTilesContainer>>> configuration}
- TBD
+** {<<<org.apache.tiles.impl.BasicTilesContainer.DEFINITIONS_CONFIG>>>}
+
+ Specifies the list of files that contain the definitions.
+
+ * <<Specified in>>:
+
{{{framework/apidocs/org/apache/tiles/impl/BasicTilesContainer.html#DEFINITIONS_CONFIG}<<<org.apache.tiles.impl.BasicTilesContainer>>>}}.
+
+ * <<Default>>: <<</WEB-INF/tiles.xml>>>.
+
+ * <<Usage>>: when specified, it must contain a comma-separated list of paths
+ of files that contain Tiles definitions.
* {<<<ChainedTilesContextFactory>>> configuration}
- TBD
+**
{<<<org.apache.tiles.context.ChainedTilesContextFactory.FACTORY_CLASS_NAMES>>>}
+
+ Specifies the list of elementary Tiles context factory class names.
+
+ * <<Specified in>>:
+
{{{framework/apidocs/org/apache/tiles/context/ChainedTilesContextFactory.html#FACTORY_CLASS_NAMES}<<<org.apache.tiles.context.ChainedTilesContextFactory>>>}}.
+
+ * <<Default>>:
<<<org.apache.tiles.servlet.context.ServletTilesContextFactory,
+ org.apache.tiles.portlet.context.PortletTilesContextFactory,
+ org.apache.tiles.jsp.context.JspTilesContextFactory>>>
+
+ * <<Usage>>: when specified, it must contain a comma-separated list of class
+ names implementing
+
{{{framework/apidocs/org/apache/tiles/context/TilesContextFactory.html}<<<TilesContextFactory>>>}}.
* {<<<DigesterDefinitionsReader>>> configuration}
- TBD
+**
{<<<org.apache.tiles.definition.digester.DigesterDefinitionsReader.PARSER_VALIDATE>>>}
+
+ Specifies if the digester should validate input XML files.
+
+ * <<Specified in>>:
+
{{{framework/apidocs/org/apache/tiles/definition/digester/DigesterDefinitionsReader.html#PARSER_VALIDATE_PARAMETER_NAME}<<<org.apache.tiles.definition.digester.DigesterDefinitionsReader>>>}}.
+
+ * <<Default>>: <<<true>>>
+
+ * <<Usage>>: when specified, it must be <<<true>>> if you want to enable
+ validation, <<<false>>> otherwise..
* {<<<UrlDefinitionsFactory>>> configuration}
- TBD
+** {<<<org.apache.tiles.definition.DefinitionsReader>>>}
+
+ Specifies the implementation of
+
{{{framework/apidocs/org/apache/tiles/definition/DefinitionsReader.html}<<<DefinitionsReader>>>}}
+ to use.
+
+ * <<Specified in>>:
+
{{{framework/apidocs/constant-values.html#org.apache.tiles.definition.DefinitionsFactory.READER_IMPL_PROPERTY}<<<org.apache.tiles.definition.DefinitionsFactory>>>}}.
+
+ * <<Default>>:
<<<org.apache.tiles.definition.digester.DigesterDefinitionsReader>>>
+
+ * <<Usage>>: when specified, it must contain the name of a class implementing
+
{{{framework/apidocs/org/apache/tiles/definition/DefinitionsReader.html}<<<DefinitionsReader>>>}}.
+
+** {<<<org.apache.tiles.locale.LocaleResolver>>>}
+
+ Specifies the implementation of
+
{{{framework/apidocs/org/apache/tiles/locale/LocaleResolver.html}<<<LocaleResolver>>>}}
+ to use.
+
+ * <<Specified in>>:
+
{{{framework/apidocs/constant-values.html#org.apache.tiles.definition.DefinitionsFactory.LOCALE_RESOLVER_IMPL_PROPERTY}<<<org.apache.tiles.definition.DefinitionsFactory>>>}}.
+
+ * <<Default>>: <<<org.apache.tiles.locale.impl.DefaultLocaleResolver>>>
+
+ * <<Usage>>: when specified, it must contain the name of a class implementing
+
{{{framework/apidocs/org/apache/tiles/locale/LocaleResolver.html}<<<LocaleResolver>>>}}.
Extended configuration parameters
* {<<<KeyedDefinitionsFactoryTilesContainerFactory>>> configuration}
- TBD
+**
{<<<org.apache.tiles.impl.KeyedDefinitionsFactoryTilesContainer.KeyExtractor>>>}
+
+ Specifies the implementation of
+
{{{framework/apidocs/org/apache/tiles/impl/KeyedDefinitionsFactoryTilesContainer.KeyExtractor.html}<<<KeyExtractor>>>}}
+ to use.
+
+ * <<Specified in>>:
+
{{{framework/apidocs/org/apache/tiles/factory/KeyedDefinitionsFactoryTilesContainerFactory.html#KEY_EXTRACTOR_CLASS_INIT_PARAM}<<<org.apache.tiles.factory.KeyedDefinitionsFactoryTilesContainerFactory>>>}}.
+
+ * <<Default>>:
<<<org.apache.tiles.impl.KeyedDefinitionsFactoryTilesContainer.DefaultKeyExtractor>>>
+
+ * <<Usage>>: when specified, it must contain the name of a class implementing
+
{{{framework/apidocs/org/apache/tiles/impl/KeyedDefinitionsFactoryTilesContainer.KeyExtractor.html}<<<KeyExtractor>>>}}.
+
+**
{<<<org.apache.tiles.factory.KeyedDefinitionsFactoryTilesContainerFactory.KEYS>>>}
+
+ Specifies the list of keys to be used to assign a key to each Definitions
+ Factory.
+
+ * <<Specified in>>:
+
{{{framework/apidocs/org/apache/tiles/factory/KeyedDefinitionsFactoryTilesContainerFactory.html#CONTAINER_KEYS_INIT_PARAM}<<<org.apache.tiles.factory.KeyedDefinitionsFactoryTilesContainerFactory>>>}}.
+
+ * <<Default>>: None, it must be specified explicitly.
+
+ * <<Usage>>: when specified, it must contain a comma-separated list of keys
+ to be used to assign a key to each definitions factory.
+
+** {<<<[EMAIL PROTECTED]>>>}
+
+ Specifies the list of files that contain the definitions for the
corresponding
+ <<<$\{key\}>>>.
+
+ * <<Specified in>>:
+
{{{framework/apidocs/org/apache/tiles/impl/KeyedDefinitionsFactoryTilesContainer.html#DEFINITIONS_CONFIG_PREFIX}<<<org.apache.tiles.impl.KeyedDefinitionsFactoryTilesContainer>>>}}.
+
+ * <<Default>>: <<</WEB-INF/tiles.xml>>>.
+
+ * <<Usage>>: when specified, it must contain a comma-separated list of paths
+ of files that contain Tiles definitions to assign to the needed
+ <<<$\{key\}>>>.
