This is an automated email from the ASF dual-hosted git repository.
git-site-role pushed a commit to branch asf-staging
in repository https://gitbox.apache.org/repos/asf/struts-site.git
The following commit(s) were added to refs/heads/asf-staging by this push:
new e1718d71e Updates stage by Jenkins
e1718d71e is described below
commit e1718d71e91bf7b2aeeff988401f23207dca70be
Author: jenkins <bui...@apache.org>
AuthorDate: Sat Feb 3 16:42:27 2024 +0000
Updates stage by Jenkins
---
content/plugins/tiles/index.html | 157 +++++++++++++++++++++------------------
1 file changed, 83 insertions(+), 74 deletions(-)
diff --git a/content/plugins/tiles/index.html b/content/plugins/tiles/index.html
index c7fe6cd11..83f1258db 100644
--- a/content/plugins/tiles/index.html
+++ b/content/plugins/tiles/index.html
@@ -155,6 +155,7 @@
<ul id="markdown-toc">
<li><a href="#features" id="markdown-toc-features">Features</a></li>
<li><a href="#usage" id="markdown-toc-usage">Usage</a> <ul>
+ <li><a href="#accessing-struts-attributes"
id="markdown-toc-accessing-struts-attributes">Accessing Struts
attributes</a></li>
<li><a href="#i18n" id="markdown-toc-i18n">I18N</a></li>
</ul>
</li>
@@ -180,90 +181,98 @@ look and feel. It can be used for both page decorating
and componentization.</p>
<p>The following steps must be taken in order to enable tiles support within
your Struts2 application:</p>
<ol>
- <li>Include the struts-tiles-plugin as a dependency in your web application.
If you are using maven2, the dependency
- configuration will be similar to:
- ```xml</li>
-</ol>
-<dependency>
- <groupId>org.apache.struts</groupId>
- <artifactId>struts2-tiles-plugin</artifactId>
- <version>${version.tiles}</version>
- </dependency>
-<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>
-2. Register the Tiles listener. This listener will typically either be the
standard tiles listener `org.apache.tiles.listener.TilesListener`
- or the Struts2 replacement `org.apache.struts2.tiles.TilesListener`. The
latter provides tighter integration with
- Struts features such as freemarker integration.
- ```xml
- <listener>
-
<listener-class>org.apache.struts2.tiles.StrutsTilesListener</listener-class>
- </listener>
-</code></pre></div></div>
+ <li>
+ <p>Include the struts-tiles-plugin as a dependency in your web
application. If you are using maven2, the dependency
+configuration will be similar to:</p>
+
+ <div class="language-xml highlighter-rouge"><div class="highlight"><pre
class="highlight"><code><span class="nt"><dependency></span>
+ <span class="nt"><groupId></span>org.apache.struts<span
class="nt"></groupId></span>
+ <span class="nt"><artifactId></span>struts2-tiles-plugin<span
class="nt"></artifactId></span>
+ <span class="nt"><version></span>${version.tiles}<span
class="nt"></version></span>
+<span class="nt"></dependency></span>
+</code></pre></div> </div>
+ </li>
+ <li>
+ <p>Register the Tiles listener. This listener will typically either be the
standard tiles listener <code class="language-plaintext
highlighter-rouge">org.apache.tiles.listener.TilesListener</code>
+or the Struts2 replacement <code class="language-plaintext
highlighter-rouge">org.apache.struts2.tiles.TilesListener</code>. The latter
provides tighter integration with
+Struts features such as freemarker integration.</p>
+
+ <div class="language-xml highlighter-rouge"><div class="highlight"><pre
class="highlight"><code><span class="nt"><listener></span>
+ <span
class="nt"><listener-class></span>org.apache.struts2.tiles.StrutsTilesListener<span
class="nt"></listener-class></span>
+<span class="nt"></listener></span>
+</code></pre></div> </div>
+ </li>
+ <li>
+ <p>All package definitions, which require tiles support, must either
extend the <code class="language-plaintext
highlighter-rouge">tiles-default</code> package or must register
+the <strong>Tiles Result</strong> type definition.</p>
-<ol>
- <li>All package definitions, which require tiles support, must either extend
the <code class="language-plaintext highlighter-rouge">tiles-default</code>
package or must register
- the <strong>Tiles Result</strong> type definition.
- ```xml</li>
-</ol>
-<result-types>
- <result-type name="tiles"
class="org.apache.struts2.views.tiles.TilesResult" />
- </result-types>
-<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>
-4. Configure your actions to utilize a tiles definition:
- ```xml
- <action name="sample"
class="org.apache.struts2.tiles.example.SampleAction" >
- <result name="success" type="tiles">tilesWorks</result>
- </action>
-</code></pre></div></div>
+ <div class="language-xml highlighter-rouge"><div class="highlight"><pre
class="highlight"><code><span class="nt"><result-types></span>
+ <span class="nt"><result-type</span> <span class="na">name=</span><span
class="s">"tiles"</span> <span class="na">class=</span><span
class="s">"org.apache.struts2.views.tiles.TilesResult"</span><span
class="nt">/></span>
+<span class="nt"></result-types></span>
+</code></pre></div> </div>
+ </li>
+ <li>
+ <p>Configure your actions to utilize a tiles definition:</p>
-<ol>
- <li>Instead of xml configuration you can use annotations
- <div class="language-java highlighter-rouge"><div class="highlight"><pre
class="highlight"><code> <span class="nd">@Result</span><span
class="o">(</span><span class="n">name</span> <span class="o">=</span> <span
class="s">"success"</span><span class="o">,</span> <span
class="n">type</span><span class="o">=</span><span
class="s">"tiles"</span><span class="o">)</span>
- <span class="nd">@TilesDefinition</span><span class="o">(</span><span
class="n">extend</span> <span class="o">=</span> <span
class="s">"fooLayout"</span><span class="o">,</span> <span
class="n">putAttributes</span> <span class="o">=</span> <span class="o">{</span>
- <span class="nd">@TilesPutAttribute</span><span class="o">(</span><span
class="n">name</span> <span class="o">=</span> <span
class="s">"header"</span><span class="o">,</span> <span class="n">value</span>
<span class="o">=</span> <span
class="s">"/WEB-INF/tiles/header.jsp"</span><span class="o">),</span>
- <span class="nd">@TilesPutAttribute</span><span class="o">(</span><span
class="n">name</span> <span class="o">=</span> <span
class="s">"body"</span><span class="o">,</span> <span class="n">value</span>
<span class="o">=</span> <span class="s">"/WEB-INF/tiles/body.ftl"</span><span
class="o">)</span>
- <span class="o">})</span>
- <span class="kd">public</span> <span class="kd">class</span> <span
class="nc">FooAction</span> <span class="kd">extends</span> <span
class="nc">ActionSupport</span> <span class="o">{</span>
+ <div class="language-xml highlighter-rouge"><div class="highlight"><pre
class="highlight"><code><span class="nt"><action</span> <span
class="na">name=</span><span class="s">"sample"</span> <span
class="na">class=</span><span
class="s">"org.apache.struts2.tiles.example.SampleAction"</span> <span
class="nt">></span>
+ <span class="nt"><result</span> <span class="na">name=</span><span
class="s">"success"</span> <span class="na">type=</span><span
class="s">"tiles"</span><span class="nt">></span>tilesWorks<span
class="nt"></result></span>
+<span class="nt"></action></span>
+</code></pre></div> </div>
+ </li>
+ <li>
+ <p>Instead of xml configuration you can use annotations</p>
+
+ <div class="language-java highlighter-rouge"><div class="highlight"><pre
class="highlight"><code><span class="nd">@Result</span><span
class="o">(</span><span class="n">name</span> <span class="o">=</span> <span
class="s">"success"</span><span class="o">,</span> <span
class="n">type</span><span class="o">=</span><span
class="s">"tiles"</span><span class="o">)</span>
+<span class="nd">@TilesDefinition</span><span class="o">(</span><span
class="n">extend</span> <span class="o">=</span> <span
class="s">"fooLayout"</span><span class="o">,</span> <span
class="n">putAttributes</span> <span class="o">=</span> <span class="o">{</span>
+ <span class="nd">@TilesPutAttribute</span><span class="o">(</span><span
class="n">name</span> <span class="o">=</span> <span
class="s">"header"</span><span class="o">,</span> <span class="n">value</span>
<span class="o">=</span> <span
class="s">"/WEB-INF/tiles/header.jsp"</span><span class="o">),</span>
+ <span class="nd">@TilesPutAttribute</span><span class="o">(</span><span
class="n">name</span> <span class="o">=</span> <span
class="s">"body"</span><span class="o">,</span> <span class="n">value</span>
<span class="o">=</span> <span class="s">"/WEB-INF/tiles/body.ftl"</span><span
class="o">)</span>
+<span class="o">})</span>
+<span class="kd">public</span> <span class="kd">class</span> <span
class="nc">FooAction</span> <span class="kd">extends</span> <span
class="nc">ActionSupport</span> <span class="o">{</span>
+</code></pre></div> </div>
+ </li>
+ <li>
+ <p>You have to define Tiles Definitions in a <code
class="language-plaintext highlighter-rouge">tiles.xml</code> file. That can be
placed in <code class="language-plaintext highlighter-rouge">resources</code>
or in <code class="language-plaintext highlighter-rouge">WEB-INF</code>.</p>
+
+ <div class="language-xml highlighter-rouge"><div class="highlight"><pre
class="highlight"><code><span class="cp"><!DOCTYPE tiles-definitions PUBLIC
+ "-//Apache Software Foundation//DTD Tiles Configuration 3.0//EN"
+ "http://tiles.apache.org/dtds/tiles-config_3_0.dtd"></span>
+<span class="nt"><tiles-definitions></span>
+
+ <span class="nt"><definition</span> <span class="na">name=</span><span
class="s">"fooLayout"</span> <span class="na">template=</span><span
class="s">"/WEB-INF/tiles/layout.jsp"</span><span class="nt">></span>
+ <span class="nt"><put-attribute</span> <span
class="na">name=</span><span class="s">"title"</span> <span
class="na">value=</span><span class="s">"Tiles Sample"</span><span
class="nt">/></span>
+ <span class="nt"><put-attribute</span> <span
class="na">name=</span><span class="s">"header"</span> <span
class="na">value=</span><span class="s">".header"</span><span
class="nt">/></span>
+ <span class="nt"><put-attribute</span> <span
class="na">name=</span><span class="s">"body"</span> <span
class="na">value=</span><span class="s">".bodyp"</span><span
class="nt">/></span>
+ <span class="nt"></definition></span>
+
+ <span class="nt"><definition</span> <span class="na">name=</span><span
class="s">"tilesWorks"</span> <span class="na">extends=</span><span
class="s">"fooLayout"</span><span class="nt">></span>
+ <span class="nt"><put-attribute</span> <span
class="na">name=</span><span class="s">"header"</span> <span
class="na">value=</span><span class="s">"/WEB-INF/tiles/header.jsp"</span><span
class="nt">/></span>
+ <span class="nt"><put-attribute</span> <span
class="na">name=</span><span class="s">"body"</span> <span
class="na">value=</span><span class="s">"/WEB-INF/tiles/body.jsp"</span><span
class="nt">/></span>
+ <span class="nt"></definition></span>
+
+<span class="nt"></tiles-definitions></span>
</code></pre></div> </div>
</li>
- <li>You have to define Tiles Definitions in a <code
class="language-plaintext highlighter-rouge">tiles.xml</code> file. That can be
placed in <code class="language-plaintext highlighter-rouge">resources</code>
or in <code class="language-plaintext highlighter-rouge">WEB-INF</code>.
- ```xml
- <!DOCTYPE tiles-definitions PUBLIC
- “-//Apache Software Foundation//DTD Tiles Configuration 3.0//EN”
- “http://tiles.apache.org/dtds/tiles-config_3_0.dtd”></li>
</ol>
-<tiles-definitions>
-
- <definition name="fooLayout" template="/WEB-INF/tiles/layout.jsp">
- <put-attribute name="title" value="Tiles Sample" />
- <put-attribute name="header" value=".header" />
- <put-attribute name="body" value=".bodyp" />
- </definition>
-
- <definition name="tilesWorks" extends="fooLayout">
- <put-attribute name="header" value="/WEB-INF/tiles/header.jsp" />
- <put-attribute name="body" value="/WEB-INF/tiles/body.jsp" />
- </definition>
-
- </tiles-definitions>
-<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>
-As from Struts 2.3.28, the plugin automatically loads all Tiles definitions
matching the following pattern `tiles*.xml` -
-you don't have to specify them via
`org.apache.tiles.definition.DefinitionsFactory.DEFINITIONS_CONFIG` in
`web.xml`,
+
+<p>As from Struts 2.3.28, the plugin automatically loads all Tiles definitions
matching the following pattern <code class="language-plaintext
highlighter-rouge">tiles*.xml</code> -
+you don’t have to specify them via <code class="language-plaintext
highlighter-rouge">org.apache.tiles.definition.DefinitionsFactory.DEFINITIONS_CONFIG</code>
in <code class="language-plaintext highlighter-rouge">web.xml</code>,
but you can use this option if your application is going to work in restricted
servlet environment e.g., Google AppEngine.
-In such case, definitions will be read from the provided init-param.
+In such case, definitions will be read from the provided init-param.</p>
-> Note: When using a Tomcat WAR versoning mechanism which uses `##` you
must specify all the tiles definition directly
-> using the `init-param`, in other case it won't be loaded. It's due to
limitation of `URL` class.
+<blockquote>
+ <p>Note: When using a Tomcat WAR versoning mechanism which uses <code
class="language-plaintext highlighter-rouge">##</code> you must specify all the
tiles definition directly
+using the <code class="language-plaintext
highlighter-rouge">init-param</code>, in other case it won’t be loaded. It’s
due to limitation of <code class="language-plaintext
highlighter-rouge">URL</code> class.</p>
+</blockquote>
-### Accessing Struts attributes
+<h3 id="accessing-struts-attributes">Accessing Struts attributes</h3>
-As from Struts version 2.5.3 it's possible accessing defined values on a
`ValueStack` using `S2` prefix when defining
-an expression in tiles definition, e.g.:
+<p>As from Struts version 2.5.3 it’s possible accessing defined values on a
<code class="language-plaintext highlighter-rouge">ValueStack</code> using
<code class="language-plaintext highlighter-rouge">S2</code> prefix when
defining
+an expression in tiles definition, e.g.:</p>
-```xml
-<definition name="home" extends="logged-in">
- <put-attribute name="title" expression="S2:actionProperty"/>
- <put-attribute name="body" value="/WEB-INF/tiles/home.jsp"/>
-</definition>
+<div class="language-xml highlighter-rouge"><div class="highlight"><pre
class="highlight"><code><span class="nt"><definition</span> <span
class="na">name=</span><span class="s">"home"</span> <span
class="na">extends=</span><span class="s">"logged-in"</span><span
class="nt">></span>
+ <span class="nt"><put-attribute</span> <span class="na">name=</span><span
class="s">"title"</span> <span class="na">expression=</span><span
class="s">"S2:actionProperty"</span><span class="nt">/></span>
+ <span class="nt"><put-attribute</span> <span class="na">name=</span><span
class="s">"body"</span> <span class="na">value=</span><span
class="s">"/WEB-INF/tiles/home.jsp"</span><span class="nt">/></span>
+<span class="nt"></definition></span>
</code></pre></div></div>
<p>In such case Tiles will delegate evaluation of the expression to Struts and
<code class="language-plaintext highlighter-rouge">ValueStack</code> will be
examined.</p>
