Author: apetrelli
Date: Thu May 17 08:43:58 2007
New Revision: 538978
URL: http://svn.apache.org/viewvc?view=rev&rev=538978
Log:
TILESSHARED-10
Tutorial almost finished. Only the configuration reference needs to be updated.
Removed:
tiles/site/src/site/apt/tutorial/extension/basic_tiles_container.apt
Modified:
tiles/site/src/site/apt/config-reference.apt
tiles/site/src/site/apt/tutorial/advanced/runtime.apt
tiles/site/src/site/apt/tutorial/extension/index.apt
tiles/site/src/site/apt/tutorial/extension/points.apt
tiles/site/src/site/apt/tutorial/extension/url_definitions_factory.apt
tiles/site/src/site/apt/tutorial/index.apt
tiles/site/src/site/apt/tutorial/integration/frameworks.apt
tiles/site/src/site/apt/tutorial/integration/index.apt
tiles/site/src/site/apt/tutorial/integration/view.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=538978&r1=538977&r2=538978
==============================================================================
--- tiles/site/src/site/apt/config-reference.apt (original)
+++ tiles/site/src/site/apt/config-reference.apt Thu May 17 08:43:58 2007
@@ -34,21 +34,21 @@
[[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.factory.TilesContainerFactory}<<<org.apache.tiles.factory.TilesContainerFactory>>>}}
| 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.factory.TilesContainerFactory.MUTABLE}<<<org.apache.tiles.factory.TilesContainerFactory.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.context.TilesContextFactory}<<<org.apache.tiles.context.TilesContextFactory>>>}}
| 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.definition.DefinitionsFactory}<<<org.apache.tiles.definition.DefinitionsFactory>>>}}
| Definitions factory class name |
*---------------------------------------------+--------------------------------------+
-|
{{{config-reference.html#org.apache.tiles.PREPARER_FACTORY}<<<org.apache.tiles.PREPARER_FACTORY>>>}}
| View preparer factory class name |
+|
{{{config-reference.html#org.apache.tiles.preparer.PreparerFactory}<<<org.apache.tiles.preparer.PreparerFactory>>>}}
| 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 |
+| <<<org.apache.tiles.impl.BasicTilesContainer.DEFINITIONS_CONFIG>>> | List
of paths that contain Tiles definitions |
*---------------------------------------------+--------------------------------------+
[[3]] {{{config-reference.html#ChainedTilesContextFactory
configuration}<<<ChainedTilesContextFactory>>> configuration}}.
@@ -60,7 +60,7 @@
[[4]] {{{config-reference.html#DigesterDefinitionsReader
configuration}<<<DigesterDefinitionsReader>>> configuration}}.
*---------------------------------------------+--------------------------------------+
-| <<<definitions-parser-validate>>> | Flag to deactivate XML parser
validation |
+|
<<<org.apache.tiles.definition.digester.DigesterDefinitionsReader.PARSER_VALIDATE>>>
| Flag to deactivate XML parser validation |
*---------------------------------------------+--------------------------------------+
[[5]] {{{config-reference.html#UrlDefinitionsFactory
configuration}<<<UrlDefinitionsFactory>>> configuration}}.
@@ -76,9 +76,9 @@
[[1]] {{{config-reference.html#KeyedDefinitionsFactoryTilesContainerFactory
configuration}<<<KeyedDefinitionsFactoryTilesContainerFactory>>>
configuration}}.
*---------------------------------------------+--------------------------------------+
-| <<<org.apache.tiles.CONTAINER.keyExtractor>>> | Key extractor class name
|
+|
<<<org.apache.tiles.impl.KeyedDefinitionsFactoryTilesContainer.KeyExtractor>>>
| Key extractor class name |
*---------------------------------------------+--------------------------------------+
-| <<<org.apache.tiles.CONTAINER.keys>>> | List of keys to be used
|
+|
<<<org.apache.tiles.factory.KeyedDefinitionsFactoryTilesContainerFactory.KEYS>>>
| List of keys to be used |
*---------------------------------------------+--------------------------------------+
| <<<[EMAIL PROTECTED]>>> | List of paths containing definitions for the given
<<<key>>> |
*---------------------------------------------+--------------------------------------+
@@ -87,7 +87,7 @@
* {Main configuration}
-** {<<<org.apache.tiles.CONTAINER_FACTORY>>>}
+** {<<<org.apache.tiles.factory.TilesContainerFactory>>>}
Specifies the container factory class name to use.
@@ -99,7 +99,7 @@
* <<Usage>>: when specified, it must contain the name of a class that
extends the <<<TilesContainerFactory>>> class.
-** {<<<org.apache.tiles.CONTAINER_FACTORY.mutable>>>}
+** {<<<org.apache.tiles.factory.TilesContainerFactory.MUTABLE>>>}
Flag to use a mutable container.
@@ -111,7 +111,7 @@
* <<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.
-** {<<<org.apache.tiles.CONTEXT_FACTORY>>>}
+** {<<<org.apache.tiles.context.TilesContextFactory>>>}
Specifies the context factory class name to use.
@@ -123,7 +123,7 @@
* <<Usage>>: when specified, it must contain the name of a class that
implements the <<<TilesContextFactory>>> interface.
-** {<<<org.apache.tiles.DEFINITIONS_FACTORY>>>}
+** {<<<org.apache.tiles.definition.DefinitionsFactory>>>}
Specifies the context factory class name to use.
@@ -135,19 +135,7 @@
* <<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>>:
-
{{{framework/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>>>}
+** {<<<org.apache.tiles.preparer.PreparerFactory>>>}
Specifies the view preparer factory class name to use.
Modified: tiles/site/src/site/apt/tutorial/advanced/runtime.apt
URL:
http://svn.apache.org/viewvc/tiles/site/src/site/apt/tutorial/advanced/runtime.apt?view=diff&rev=538978&r1=538977&r2=538978
==============================================================================
--- tiles/site/src/site/apt/tutorial/advanced/runtime.apt (original)
+++ tiles/site/src/site/apt/tutorial/advanced/runtime.apt Thu May 17 08:43:58
2007
@@ -73,7 +73,7 @@
To create definitions at runtime, first of all you need to configure your
Tiles-based application to use a
-
{{{../../config-reference.html#org.apache.tiles.CONTAINER_FACTORY.mutable}mutable
container}}.
+
{{{../../config-reference.html#org.apache.tiles.factory.TilesContainerFactory.MUTABLE}mutable
container}}.
In your JSP page, now you can create definitions. This definition will be
available during the request, and then it will expire.
@@ -140,7 +140,7 @@
To create definitions at runtime, first of all you need to configure your
Tiles-based application to use a
-
{{{../../config-reference.html#org.apache.tiles.CONTAINER_FACTORY.mutable}mutable
container}}.
+
{{{../../config-reference.html#org.apache.tiles.factory.TilesContainerFactory.MUTABLE}mutable
container}}.
This is a snippet to show how to create a definition.
Modified: tiles/site/src/site/apt/tutorial/extension/index.apt
URL:
http://svn.apache.org/viewvc/tiles/site/src/site/apt/tutorial/extension/index.apt?view=diff&rev=538978&r1=538977&r2=538978
==============================================================================
--- tiles/site/src/site/apt/tutorial/extension/index.apt (original)
+++ tiles/site/src/site/apt/tutorial/extension/index.apt Thu May 17 08:43:58
2007
@@ -21,6 +21,12 @@
Extending Tiles
-----------
-Introduction
+Extending Tiles
- This is the introduction
+ Tiles is not a static framework: it can be customized and extended for your
+ needs, to provide custom behaviour to different aspects of the application.
+
+ [[1]] {{{points.html}Extension Points}}.
+
+ [[2]] {{{url_definitions_factory.html}Customizing
<<<UrlDefinitionsFactory>>>}}.
+
\ No newline at end of file
Modified: tiles/site/src/site/apt/tutorial/extension/points.apt
URL:
http://svn.apache.org/viewvc/tiles/site/src/site/apt/tutorial/extension/points.apt?view=diff&rev=538978&r1=538977&r2=538978
==============================================================================
--- tiles/site/src/site/apt/tutorial/extension/points.apt (original)
+++ tiles/site/src/site/apt/tutorial/extension/points.apt Thu May 17 08:43:58
2007
@@ -21,6 +21,73 @@
Tiles Extension Points
-----------
-Introduction
+Tiles Extension Points
- This is the introduction
+ Tiles can be extended in different aspects, depending on the task of each
+ aspect.
+
+* Tiles Container
+
+ The Tiles container is the object responsible of loading and rendering all
+ Tiles artifacts. It is not created directly, but through a
+
{{{../../framework/apidocs/org/apache/tiles/factory/TilesContainerFactory.html}<<<TilesContainerFactory>>>}}.
+ The default implementation is
+
{{{../../framework/apidocs/org/apache/tiles/impl/BasicTilesContainer.html}<<<BasicTilesContainer>>>}}.
+
+ It is unlikely that you need to customize your Tiles container (and container
+ factory) and we suggest to use the default container factory.
+
+ As an exception, you can use
+ {{{../../config-reference.html#KeyedDefinitionsFactoryTilesContainerFactory
configuration}KeyedDefinitionsFactoryTilesContainerFactory}}
+ that allows to create multiple definitions factory for different "keys".
+
+* Tiles Context Factory
+
+ The
+
{{{../../framework/apidocs/org/apache/tiles/context/TilesRequestContext.html}<<<TilesRequestContext>>>}}
+ and
+
{{{../../framework/apidocs/org/apache/tiles/context/TilesApplicationContext.html}<<<TilesApplicationContext>>>}}
+ interfaces are used to abstract the Tiles context from the particular
+ technology. The
+
{{{../../config-reference.html#org.apache.tiles.context.TilesContextFactory}<<<TilesContextFactory>>>}}
+ interface is used to create instances of the 2 classes above.
+
+ The default implementation,
+ {{{../../config-reference.html#ChainedTilesContextFactory
configuration}<<<ChainedTilesContextFactory>>>}}
+ links together different implementation. The default configuration links
+ together the implementation for Servlet, Portlet and JSP technologies. If you
+ need to support a new technology, we suggest to configure
+ {{{../../config-reference.html#ChainedTilesContextFactory
configuration}<<<ChainedTilesContextFactory>>>}}
+ and create a new instance of
+
{{{../../framework/apidocs/org/apache/tiles/context/TilesContextFactory.html}<<<TilesContextFactory>>>}}.
+
+* Tiles Definitions Factory
+
+ The
+
{{{../../config-reference.html#org.apache.tiles.definition.DefinitionsFactory}<<<DefinitionsFactory>>>}}
+ interfaces is used to create and retrieve definitions. The returned
definition
+ will be used to be rendered by the Tiles container.
+
+ The default implementation,
{{{url_definitions_factory.html}<<<UrlDefinitionsFactory>>>}}
+ can be configured, or can be used as a basis for an extended factory.
+
+ You can provide your implementation of <<<UrlDefinitionsFactory>>> if you
need
+ to return definitions in a non standard way (for example, getting a
definition
+ depending on a value of a bean in request scope).
+
+* Preparer Factory
+
+ The
+
{{{../../config-reference.html#org.apache.tiles.preparer.PreparerFactory}<<<PreparerFactory>>>}}
+ is responsible of creating instances of
+
{{{../../framework/apidocs/org/apache/tiles/preparer/ViewPreparer.html}<<<ViewPreparer>>>}}.
+
+ The default implementation,
+
{{{../../framework/apidocs/org/apache/tiles/preparer/BasicPreparerFactory.html}<<<BasicPreparerFactory>>>}}
+ takes the preparer name as a class name, instantiates an object per each
+ class name and returns it.
+
+ You can change this behaviour by implementing
+
{{{../../config-reference.html#org.apache.tiles.preparer.PreparerFactory}<<<PreparerFactory>>>}}.
+ For example, the Struts 1 plugin contains an implementation that takes an URL
+ or an action mapping as a preparer name, and creates an instance accordingly.
\ No newline at end of file
Modified: tiles/site/src/site/apt/tutorial/extension/url_definitions_factory.apt
URL:
http://svn.apache.org/viewvc/tiles/site/src/site/apt/tutorial/extension/url_definitions_factory.apt?view=diff&rev=538978&r1=538977&r2=538978
==============================================================================
--- tiles/site/src/site/apt/tutorial/extension/url_definitions_factory.apt
(original)
+++ tiles/site/src/site/apt/tutorial/extension/url_definitions_factory.apt Thu
May 17 08:43:58 2007
@@ -21,6 +21,35 @@
Customizing UrlDefinitionsFactory
-----------
-Introduction
+Customizing UrlDefinitionsFactory
- This is the introduction
+ The
+ {{{../../config-reference.html#UrlDefinitionsFactory
configuration}<<<UrlDefinitionsFactory>>>}}
+ is the default implementation of
+
{{{../../framework/apidocs/org/apache/tiles/definition/DefinitionsFactory.html}<<<DefinitionsFactory>>>}}.
+
+* Definitions reader
+
+ The
+
{{{../../config-reference.html#org.apache.tiles.definition.DefinitionsReader}<<<DefinitionsReader>>>}}
+ interfaces reads a source (usually an URL) to return a map of raw (i.e. with
+ their inheritance <<not resolved>>) definitions. The default implementation,
+
{{{../../framework/apidocs/org/apache/tiles/definition/digester/DigesterDefinitionsReader.html}<<<DigesterDefinitionsReader>>>}}
+ reads from usual Tiles XML definition files using Jakarta Commons Digester.
+
+ If you need to read definitions from other kind of sources, this is the item
+ to configure.
+
+* Locale resolver
+
+ The
+
{{{../../config-reference.html#org.apache.tiles.locale.LocaleResolver}<<<LocaleResolver>>>}}
+ interface resolves the current locale requested by the user. The default
+ implementation,
+
{{{../../framework/apidocs/org/apache/tiles/locale/impl/DefaultLocaleResolver.html}<<<DefaultLocaleResolver>>>}}
+ takes the current locale from a session-scoped Locale object under the
+ <<<org.apache.tiles.LOCALE>>> key. If it is not found, the default locale of
+ the request will be taken.
+
+ If you want to read the current locale in other ways, this is the item to
+ configure.
\ No newline at end of file
Modified: tiles/site/src/site/apt/tutorial/index.apt
URL:
http://svn.apache.org/viewvc/tiles/site/src/site/apt/tutorial/index.apt?view=diff&rev=538978&r1=538977&r2=538978
==============================================================================
--- tiles/site/src/site/apt/tutorial/index.apt (original)
+++ tiles/site/src/site/apt/tutorial/index.apt Thu May 17 08:43:58 2007
@@ -67,7 +67,5 @@
[[1]] {{{extension/points.html}Tiles Extension Points}}
- [[2]] {{{extension/basic_tiles_container.html}Customizing
<<<BasicTilesContainer>>>}}
-
[[2]] {{{extension/url_definitions_factory.html}Customizing
<<<UrlDefinitionsFactory>>>}}
Modified: tiles/site/src/site/apt/tutorial/integration/frameworks.apt
URL:
http://svn.apache.org/viewvc/tiles/site/src/site/apt/tutorial/integration/frameworks.apt?view=diff&rev=538978&r1=538977&r2=538978
==============================================================================
--- tiles/site/src/site/apt/tutorial/integration/frameworks.apt (original)
+++ tiles/site/src/site/apt/tutorial/integration/frameworks.apt Thu May 17
08:43:58 2007
@@ -21,6 +21,19 @@
Integration with other Frameworks
-----------
-Introduction
+Integration with other web Frameworks
- This is the introduction
+ Tiles can be integrated with other web frameworks. Usually this kind of
+ integration is made through extensions/plugins to Tiles.
+
+ * {{{http://struts.apache.org/1.x/index.html}Struts 1}}: Currently under
+ development. A Struts 1 plugin is available in the SVN trunk, that presumably
+ will be released along with Struts 1.4.
+
+ * {{{http://struts.apache.org/2.x/index.html}Struts 2}}: A Struts 1 plugin is
+ provided, though it needs to be updated to the latest released version of
+ Tiles.
+
+ * {{{http://shale.apache.org/shale-tiles/index.html}Shale}}: An integration
+ layer is provided, but it needs to be updated to the latest released version
+ of Tiles.
Modified: tiles/site/src/site/apt/tutorial/integration/index.apt
URL:
http://svn.apache.org/viewvc/tiles/site/src/site/apt/tutorial/integration/index.apt?view=diff&rev=538978&r1=538977&r2=538978
==============================================================================
--- tiles/site/src/site/apt/tutorial/integration/index.apt (original)
+++ tiles/site/src/site/apt/tutorial/integration/index.apt Thu May 17 08:43:58
2007
@@ -21,6 +21,12 @@
Tiles Integrations
-----------
-Introduction
+Tiles integrations
+
+ Tiles can be integrated with various frameworks and view technologies, to
+ include Tiles elements into their specific features.
+
+ * {{{frameworks.html}Integration in web frameworks}}.
+
+ * {{{view.html}Integration in view technologies}}.
- This is the introduction
Modified: tiles/site/src/site/apt/tutorial/integration/view.apt
URL:
http://svn.apache.org/viewvc/tiles/site/src/site/apt/tutorial/integration/view.apt?view=diff&rev=538978&r1=538977&r2=538978
==============================================================================
--- tiles/site/src/site/apt/tutorial/integration/view.apt (original)
+++ tiles/site/src/site/apt/tutorial/integration/view.apt Thu May 17 08:43:58
2007
@@ -21,6 +21,8 @@
Integration with other View Technologies
-----------
-Introduction
+Integration with other View Technologies
- This is the introduction
+ Currently Tiles 2 is only integrated with JavaServer Pages. Hopefully it will
+ soon support {{{http://freemarker.sourceforge.net/}FreeMarker}} and
+ {{{http://velocity.apache.org/}Velocity}}.
Modified: tiles/site/src/site/site.xml
URL:
http://svn.apache.org/viewvc/tiles/site/src/site/site.xml?view=diff&rev=538978&r1=538977&r2=538978
==============================================================================
--- tiles/site/src/site/site.xml (original)
+++ tiles/site/src/site/site.xml Thu May 17 08:43:58 2007
@@ -130,9 +130,6 @@
name="Extension Points"
href="/tutorial/extension/points.html"/>
<item
- name="BasicTilesContainer"
-
href="/tutorial/extension/basic_tiles_container.html"/>
- <item
name="UrlDefinitionsFactory"
href="/tutorial/extension/url_definitions_factory.html"/>
</item>
