cedric 2002/11/05 06:17:16
Modified: src/share/org/apache/struts/tiles package.html
Log:
Update documentation
Revision Changes Path
1.3 +43 -56 jakarta-struts/src/share/org/apache/struts/tiles/package.html
Index: package.html
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/tiles/package.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- package.html 12 Sep 2002 08:38:26 -0000 1.2
+++ package.html 5 Nov 2002 14:17:16 -0000 1.3
@@ -146,8 +146,7 @@
value="/WEB-INF/tiles-defs.xml,
/WEB-INF/tiles-tests-defs.xml,/WEB-INF/tiles-tutorial-defs.xml,
/WEB-INF/tiles-examples-defs.xml" />
- <set-property property="definitions-debug" value="1" />
- <set-property property="definitions-parser-details" value="0" />
+ <set-property property="moduleAware" value="true" />
<set-property property="definitions-parser-validate" value="true" />
</plug-in>
</pre>
@@ -156,40 +155,47 @@
<li>Specify configuration file names. There can be several comma separated file
names (default: ?? )</li>
</ul>
</li>
- <li>definitions-debug: (optional)
-<ul>
-<li>Specify Tiles debug level<ul>
-<li>0 : no debug information</li>
-<li>1 : debug information</li>
-<li>2 : more debug information</li>
-</ul>
-</li>
-</ul>
-</li>
- <li>definitions-parser-details: (optional)
+ <li>definitions-parser-validate: (optional)
<ul>
-<li>Specify Digester debug level. This value is passed to Digester<ul>
-<li>0 : no debug information (default)</li>
-<li>1 : debug information</li>
-<li>2 : more debug information</li>
+ <li>Specify if XML parser should validate the Tiles configuration
+ file
+ <ul>
+ <li>true : validate. DTD should be specified in file header
(default)</li>
+<li>false : no validation </li>
+
</ul>
</li>
</ul>
</li>
- <li>definitions-parser-validate: (optional)
+
+ <li>moduleAware: (optional)
<ul>
- <li>Specify if XML parser should validate the Tiles configuration
- file
+ <li>Specify if the Tiles definition factory is module aware. If true
(default),
+ there will be one factory for each Struts module.
+ If false, there will be one common factory for all module. In
this later case,
+ it is still needed to declare one plugin per module. The
factory will be
+ initialized with parameters found in the first initialized
plugin (generally the
+ one associated with the default module).
<ul>
<li>true : validate. DTD should be specified in file header
(default)</li>
-<li>false : no validation </li>
+<li>false : no validation
+ </li>
+
+
+
</ul>
</li>
</ul>
</li>
</ul>
- <p>The TilesPlugin class creates one single definition factory shared
- by all Struts modules, even if the plugin is declared several times.
+ <p>The TilesPlugin class creates one defintion factory for each struts
module.
+ </p>
+ <p>
+ If the flag moduleAware is false, only one shared factory is created
for all module.
+ In this later case, the factory is initialized with parameters found
in the first plugin.
+ The plugins should be declared in all modules, and the moduleAware
flag should be
+ the same for the entire application.</p>
+ <p>
Paths found in Tiles definitions are relative to the main context.</p>
<p>You don't need to specify a TilesRequestProcessor, this is automatically
done by the plug-in. If, however, you want to specify your own
RequestProcessor,
@@ -208,28 +214,8 @@
separated file names
-->
<init-param>
- <param-name>definitions-config</param-name>
- <param-value>/WEB-INF/tiles-defs.xml</param-value>
- </init-param>
- <!-- Tiles Servlet parameter
- Specify Tiles debug level.
- O : no debug information
- 1 : debug information
- 2 : more debug information
- -->
- <init-param>
- <param-name>definitions-debug</param-name>
- <param-value>1</param-value>
- </init-param>
- <!-- Tiles Servlet parameter
- Specify Digester debug level. This value is passed to Digester
- O : no debug information
- 1 : debug information
- 2 : more debug information
- -->
- <init-param>
- <param-name>definitions-parser-details</param-name>
- <param-value>0</param-value>
+ <param-name>definitions-config</param-name>
+ <param-value>/WEB-INF/tiles-defs.xml</param-value>
</init-param>
<!-- Tiles Servlet parameter
Specify if XML parser should validate the Tiles configuration file(s).
@@ -254,17 +240,9 @@
<init-param>
- <param-name>definitions-config</param-name>
- <param-value>/WEB-INF/tiles-defs.xml</param-value>
- </init-param>
- <init-param>
- <param-name>definitions-debug</param-name>
- <param-value>1</param-value>
- </init-param>
- <init-param>
- <param-name>definitions-parser-details</param-name>
- <param-value>0</param-value>
- </init-param>
+ <param-name>definitions-config</param-name>
+ <param-value>/WEB-INF/tiles-defs.xml</param-value>
+ </init-param>
<init-param>
<param-name>definitions-parser-validate</param-name>
<param-value>true</param-value>
@@ -315,6 +293,15 @@
</tiles-definition>
</pre>
+</div>
+<div class="subsection1">
+<h3>Debugging</h3>
+<p>To debug a page made of Tiles, you can use following advices:</p>
+<ul>
+ <li>Check each Tiles separatly. Try to access nested Tiles directly to test
+ if thes work properly.</li>
+ <li>Enable Tiles logging. See the commons-logging package help.</li>
+</ul>
</div>
</div>
</div>
--
To unsubscribe, e-mail: <mailto:struts-dev-unsubscribe@;jakarta.apache.org>
For additional commands, e-mail: <mailto:struts-dev-help@;jakarta.apache.org>
