tiles-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From apetre...@apache.org
Subject svn commit: r531510 - in /tiles/site/src/site: apt/config-reference.apt apt/tutorial/configuration.apt site.xml
Date Mon, 23 Apr 2007 15:50:48 GMT
Author: apetrelli
Date: Mon Apr 23 08:50:47 2007
New Revision: 531510

URL: http://svn.apache.org/viewvc?view=rev&rev=531510
Log:
TILESSHARED-10
Updated the configuration page.
Added the configuration reference page.

Added:
    tiles/site/src/site/apt/config-reference.apt   (with props)
Modified:
    tiles/site/src/site/apt/tutorial/configuration.apt
    tiles/site/src/site/site.xml

Added: tiles/site/src/site/apt/config-reference.apt
URL: http://svn.apache.org/viewvc/tiles/site/src/site/apt/config-reference.apt?view=auto&rev=531510
==============================================================================
--- tiles/site/src/site/apt/config-reference.apt (added)
+++ tiles/site/src/site/apt/config-reference.apt Mon Apr 23 08:50:47 2007
@@ -0,0 +1,50 @@
+~~ $Id$
+~~
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements.  See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership.  The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License.  You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied.  See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+~~
+         -----------
+         Tiles Configuration reference
+         -----------
+
+Configuration reference
+
+  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.
+
+Summary
+
+  [[1]] Main configuration.
+
+  [[2]] <<<BasicTilesContainer>>> configuration.
+  
+  [[3]] <<<UrlDefinitionsFactory>>> configuration.
+
+Configuration parameters
+
+* Main configuration
+
+  TBD
+  
+* <<<BasicTilesContainer>>> configuration
+
+  TBD
+
+* <<<UrlDefinitionsFactory>>> configuration
+
+  TBD
\ No newline at end of file

Propchange: tiles/site/src/site/apt/config-reference.apt
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: tiles/site/src/site/apt/config-reference.apt
------------------------------------------------------------------------------
    svn:keywords = Date Author Id Revision HeadURL

Modified: tiles/site/src/site/apt/tutorial/configuration.apt
URL: http://svn.apache.org/viewvc/tiles/site/src/site/apt/tutorial/configuration.apt?view=diff&rev=531510&r1=531509&r2=531510
==============================================================================
--- tiles/site/src/site/apt/tutorial/configuration.apt (original)
+++ tiles/site/src/site/apt/tutorial/configuration.apt Mon Apr 23 08:50:47 2007
@@ -21,7 +21,74 @@
          Tiles Configuration
          -----------
 
-Introduction
+Configuring Tiles
 
-  This is an introduction
-  
\ No newline at end of file
+  Your application needs to be configured to work with Tiles. There are various
+  options, depending on your needs, your application type, etc.
+  
+Starting Tiles in a web application
+
+  Tiles has always been a web application package, usually used in conjunction
+  with Struts. Tiles 2 evolved to the point of being technology-independent, but
+  its use in a Servlet-based web application will be the most frequent use case.
+  
+* Starting Tiles engine
+
+  To start Tiles in a web application you can:
+  
+  * Load the Tiles servlet at startup. You can do it by specifying it in your
+  <<<web.xml>>> file:
+
+--------------------------
+<servlet>
+    <servlet-name>tiles</servlet-name>
+    <servlet-class>org.apache.tiles.servlet.TilesServlet</servlet-class>
+    <init-param>
+        <param-name>org.apache.tiles.DEFINITIONS_CONFIG</param-name>
+        <param-value>/WEB-INF/tiles-defs.xml,/org/apache/tiles/classpath-defs.xml</param-value>
+    </init-param>
+    <load-on-startup>2</load-on-startup>
+</servlet>
+--------------------------
+
+  As you can see, the init parameter <<<org.apache.tiles.DEFINITIONS_CONFIG>>>
+  specifies the path of the {{{basic/index.html}Tiles configuration files}}.
+  You can specify it also as a context parameters.
+  
+  * Load the Tiles listener. Specify it in your <<<web.xml>>> file:
+
+-------------------------------
+<listener>
+    <listener-class>org.apache.tiles.listener.TilesListener</listener-class>
+</listener>
+-------------------------------
+  
+  You can specify the Tiles configuration files using a context parameter.
+  
+  * Load the Tiles filter.
+  
+------------------------------
+<filter>
+    <filter-name>Tiles Filter</filter-name>
+    <filter-class>org.apache.tiles.filter.TilesFilter</filter-class>
+    <init-param>
+        <param-name>org.apache.tiles.DEFINITIONS_CONFIG</param-name>
+        <param-value>/WEB-INF/tiles-defs.xml,/org/apache/tiles/classpath-defs.xml</param-value>
+    </init-param>
+</filter>
+--------------------------------
+
+Starting Tiles in a portlet application 
+
+  TBD
+
+Configuring Tiles internals
+
+  You can configure Tiles internal behaviour by specifying:
+  
+  * in a web application environment, by using context parameters or init
+  parameters of TilesServlet or TilesFilter;
+  
+  * 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

Modified: tiles/site/src/site/site.xml
URL: http://svn.apache.org/viewvc/tiles/site/src/site/site.xml?view=diff&rev=531510&r1=531509&r2=531510
==============================================================================
--- tiles/site/src/site/site.xml (original)
+++ tiles/site/src/site/site.xml Mon Apr 23 08:50:47 2007
@@ -131,6 +131,9 @@
                     name="Migration from Struts Tiles"
                     href="/migration/index.html"/>
             <item
+                    name="Configuration"
+                    href="/config-reference.html"/>
+            <item
                     name="Javadoc"
                     href="/framework/apidocs/index.html"/>
             <item



Mime
View raw message