You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@struts.apache.org by rl...@apache.org on 2004/02/01 19:50:23 UTC
cvs commit: jakarta-struts/contrib/struts-el/doc/userGuide struts-bean-el.xml struts-html-el.xml struts-logic-el.xml struts-tiles-el.xml
rleland 2004/02/01 10:50:23
Modified: contrib/struts-el/doc/userGuide struts-bean-el.xml
struts-html-el.xml struts-logic-el.xml
struts-tiles-el.xml
Log:
Doc Changes, 3 types:
1) Change application to module where needed.
3) Format XML so it syncs up easier.
2) Sync up the el documentation with the struts docs,
This includes changing references to Action.CONSTANT to Global.CONSTANT.
I did not add references to missing attributes with struts has but the el documentation
does not. Also EL has attributes that I believe have been removed from struts.
<ad>
For the best comparison/editing tool go to
http://www.scootersoftware.com
and download BeyondCompare
</ad>
Revision Changes Path
1.8 +23 -20 jakarta-struts/contrib/struts-el/doc/userGuide/struts-bean-el.xml
Index: struts-bean-el.xml
===================================================================
RCS file: /home/cvs/jakarta-struts/contrib/struts-el/doc/userGuide/struts-bean-el.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- struts-bean-el.xml 16 Jan 2004 04:10:58 -0000 1.7
+++ struts-bean-el.xml 1 Feb 2004 18:50:23 -0000 1.8
@@ -52,13 +52,13 @@
<teiclass>org.apache.struts.taglib.bean.IncludeTei</teiclass>
<bodycontent>empty</bodycontent>
<info>
-
- <p>Perform an internal dispatch to the specified application component (or
- external URL) and make the response data from that request available as a
- scoped variable of type <code>String</code>. This tag has a function
- similar to that of the standard <code><jsp:include></code> tag,
- except that the response data is stored in a page scope attribute instead
- of being written to the output stream. If the current request is part of a
+ <p>Perform an internal dispatch to the specified application component
+ (or external URL)
+ and make the response data from that request available as a scoped variable of
+ type <code>String</code>. This tag has a function similar to that of
+ the standard <code><jsp:include></code> tag, except that the
+ response data is stored in a page scope attribute instead of being
+ written to the output stream. If the current request is part of a
session, the generated request for the include will also include the
session identifier (and thus be part of the same session).</p>
@@ -68,12 +68,12 @@
<ul>
<li><em>forward</em> - Use the value of this attribute as the name
of a global <code>ActionForward</code> to be looked up, and
- use the application-relative or context-relative URI found there.</li>
+ use the module-relative or context-relative URI found there.</li>
<li><em>href</em> - Use the value of this attribute unchanged (since
this might link to a resource external to the application, the
session identifier is <strong>not</strong> included.</li>
<li><em>page</em> - Use the value of this attribute as an
- application-relative URI to the desired resource.</li>
+ module-relative URI to the desired resource.</li>
</ul>
</info>
@@ -123,9 +123,9 @@
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<info>
- <p>Specifies the name of the associated page scope attribute that will be
- made available with the value of the specified web application
- resource.</p>
+ <p>Specifies the name of the scripting variable (and associated page
+ scope attribute) that will be made available with the value of the
+ specified web application resource.</p>
</info>
</attribute>
@@ -134,7 +134,7 @@
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
- <p>Application-relative name (starting with a '/') of the web application
+ <p>Module-relative name (starting with a '/') of the web application
resource to be dispatched, and whose response data is to be made
available as a bean.</p>
</info>
@@ -148,7 +148,7 @@
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
- <p>Application-relative URI (starting with a '/') of the web application
+ <p>Module-relative URI (starting with a '/') of the web application
resource to be included.</p>
</info>
</attribute>
@@ -166,6 +166,7 @@
</tag>
+
<tag>
<name>message</name>
@@ -248,7 +249,7 @@
<code>MessageResources</code> object containing our messages
is stored.</p>
</info>
- <default>Action.MESSAGES_KEY</default>
+ <default>Globals.MESSAGES_KEY</default>
</attribute>
<attribute>
@@ -271,7 +272,7 @@
<p>The name of the session scope bean under which our currently
selected <code>Locale</code> object is stored.</p>
</info>
- <default>Action.LOCALE_KEY</default>
+ <default>Globals.LOCALE_KEY</default>
</attribute>
<attribute>
@@ -355,6 +356,7 @@
</tag>
+
<tag>
<name>resource</name>
@@ -378,9 +380,9 @@
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<info>
- <p>Specifies the name of the associated page scope attribute that will be
- made available with the value of the specified web application
- resource.</p>
+ <p>Specifies the name of the scripting variable (and associated page
+ scope attribute) that will be made available with the value of the
+ specified web application resource.</p>
</info>
</attribute>
@@ -401,12 +403,13 @@
<required>true</required>
<rtexprvalue>true</rtexprvalue>
<info>
- <p>Application-relative name (starting with a '/') of the web application
+ <p>Module-relative name (starting with a '/') of the web application
resource to be loaded and made available.</p>
</info>
</attribute>
</tag>
+
<tag>
1.28 +82 -91 jakarta-struts/contrib/struts-el/doc/userGuide/struts-html-el.xml
Index: struts-html-el.xml
===================================================================
RCS file: /home/cvs/jakarta-struts/contrib/struts-el/doc/userGuide/struts-html-el.xml,v
retrieving revision 1.27
retrieving revision 1.28
diff -u -r1.27 -r1.28
--- struts-html-el.xml 24 Jan 2004 18:46:53 -0000 1.27
+++ struts-html-el.xml 1 Feb 2004 18:50:23 -0000 1.28
@@ -134,12 +134,11 @@
<name>indexed</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
- <info>
- Valid only inside of <code>logic-el:iterate</code> or
- <code>c:forEach</code> tags. If <code>true</code> then name of
- the html tag will be rendered as "propertyName[34]". Number in
- brackets will be generated for every iteration and taken from
- ancestor iteration tag.
+ <info>
+ Valid only inside of <code>logic-el:iterate</code> or <code>c:forEach</code> tags.
+ If <code>true</code> then name of the html tag will be rendered as
+ "id[34].propertyName". Number in brackets will be generated
+ for every iteration and taken from ancestor iteration tag.
</info>
</attribute>
@@ -699,11 +698,10 @@
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
- Valid only inside of <code>logic-el:iterate</code> or
- <code>c:forEach</code> tags. If <code>true</code> then name of
- the html tag will be rendered as "id[34].propertyName". Number
- in brackets will be generated for every iteration and taken
- from ancestor iteration tag.
+ Valid only inside of <code>logic-el:iterate</code> or <code>c:forEach</code> tags.
+ If <code>true</code> then name of the html tag will be rendered as
+ "id[34].propertyName". Number in brackets will be generated
+ for every iteration and taken from ancestor iteration tag.
</info>
</attribute>
@@ -991,7 +989,7 @@
<info>
Name of the request scope bean under which our error messages
have been stored. If not present, the name specified by the
- <code>Action.ERROR_KEY</code> constant string will be used.
+ <code>Globals.ERROR_KEY</code> constant string will be used.
</info>
</attribute>
@@ -1090,11 +1088,10 @@
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
- Valid only inside of <code>logic-el:iterate</code> or
- <code>c:forEach</code> tags. If <code>true</code> then name of
- the html tag will be rendered as "id[34].propertyName". Number
- in brackets will be generated for every iteration and taken
- from ancestor iteration tag.
+ Valid only inside of <code>logic-el:iterate</code> or <code>c:forEach</code> tags.
+ If <code>true</code> then name of the html tag will be rendered as
+ "id[34].propertyName". Number in brackets will be generated
+ for every iteration and taken from ancestor iteration tag.
</info>
</attribute>
@@ -1504,7 +1501,8 @@
for use in framed presentations.
</info>
</attribute>
- </tag>
+
+ </tag>
<tag>
@@ -1526,12 +1524,12 @@
<ul>
<li><em>forward</em> - Use the value of this attribute as the
name of a global <code>ActionForward</code> to be looked
- up, and use the application-relative or context-relative
+ up, and use the module-relative or context-relative
URI found there.</li>
<li><em>href</em> - Use the value of this attribute unchanged.
</li>
<li><em>page</em> - Use the value of this attribute as a
- application-relative URI, and generate a server-relative
+ module-relative URI, and generate a server-relative
URI by including the context path and application
prefix.</li>
<li><em>action</em> - Use the value of this attribute as the
@@ -1600,7 +1598,7 @@
end of the URL that is created by any of the above mechanisms,
by using the <code>anchor</code> attribute.</p>
- </info>
+ </info>
<attribute>
<name>action</name>
@@ -1619,7 +1617,7 @@
</info>
</attribute>
- <attribute>
+ <attribute>
<name>anchor</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
@@ -1966,11 +1964,10 @@
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
- Valid only inside of <code>logic-el:iterate</code> or
- <code>c:forEach</code> tags. If <code>true</code> then name of
- the html tag will be rendered as "id[34].propertyName". Number
- in brackets will be generated for every iteration and taken
- from ancestor iteration tag.
+ Valid only inside of <code>logic-el:iterate</code> or <code>c:forEach</code> tags.
+ If <code>true</code> then name of the html tag will be rendered as
+ "id[34].propertyName". Number in brackets will be generated
+ for every iteration and taken from ancestor iteration tag.
</info>
</attribute>
@@ -2250,7 +2247,7 @@
<p>Set to <code>true</code> in order to render
<code>xml:lang</code> and <code>xmlns</code> attributes
on the generated <code>html</code> element. This also
- causes all other html tags to render as XHTML (the
+ causes all other html tags to render as XHTML 1.0 (the
<html:xhtml/> tag has a similar purpose).
</p>
</info>
@@ -2359,11 +2356,11 @@
<name>indexed</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
- <info>
- Valid only inside of logic:iterate tag. If <code>true</code>
- then name of the html tag will be rendered as
- "propertyName[34]". Number in brackets will be generated for
- every iteration and taken from ancestor logic:iterate tag.
+ <info>
+ Valid only inside of <code>logic-el:iterate</code> or <code>c:forEach</code> tags.
+ If <code>true</code> then name of the html tag will be rendered as
+ "id[34].propertyName". Number in brackets will be generated
+ for every iteration and taken from ancestor iteration tag.
</info>
</attribute>
@@ -2645,21 +2642,22 @@
<p>Renders an HTML <code><img></code> element with
the image at the specified URL. Like the link tag, URL
rewriting will be applied automatically to the value
- specified in <code>src</code> or <code>page</code>,
- to maintain session state
+ specified in <code>src</code>, <code>page</code>, or
+ <code>action</code> to maintain session state
in the absence of cookies. This will allow dynamic
generation of an image where the content displayed for this
image will be taken from the attributes of this tag.</p>
<p>The base URL for this image is calculated directly based on
- the value specified in <code>src</code> or <code>page</code>,
+ the value specified in <code>src</code>, <code>page</code>, or
+ <code>action</code> or <code>page</code>,
or indirectly by looking up a message resource string based on
the <code>srcKey</code> or <code>pageKey</code> attributes.
You <strong>must</strong> specify exactly one of these
attributes.</p>
- <p>Normally, the <code>src</code> or <code>page</code> that
- you specify will be left
+ <p>Normally, the <code>src</code>, <code>page</code>, or
+ <code>action</code> that you specify will be left
unchanged (other than URL rewriting if necessary). However,
there are two ways you can append one or more dynamically
defined query parameters to the <code>src</code> URL --
@@ -2805,16 +2803,16 @@
</info>
</attribute>
- <attribute>
- <name>contextRelative</name>
- <required>false</required>
- <rtexprvalue>true</rtexprvalue>
- <info>
- <p>If set to "true", this "anchors" the image src at the
- application context rather than the module context when the
- 'page' attribute is used to specify an image path.</p>
- </info>
- </attribute>
+ <attribute>
+ <name>contextRelative</name>
+ <required>false</required>
+ <rtexprvalue>true</rtexprvalue>
+ <info>
+ <p>If set to "true", this "anchors" the image src at the
+ application context rather than the module context when the
+ 'page' attribute is used to specify an image path.</p>
+ </info>
+ </attribute>
<attribute>
<name>height</name>
@@ -3385,17 +3383,17 @@
<ul>
<li><em>forward</em> - Use the value of this attribute as the
name of a global <code>ActionForward</code> to be looked
- up, and use the application-relative or context-relative
+ up, and use the module-relative or context-relative
URI found there.</li>
<li><em>action</em> - Use the value of this attribute as the
name of a <code>Action</code> to be looked
- up, and use the application-relative or context-relative
+ up, and use the module-relative or context-relative
URI found there.</li>
<li><em>href</em> - Use the value of this attribute unchanged.
</li>
<li><em>page</em> - Use the value of this attribute as a
- application-relative URI, and generate a server-relative
- URI by including the context path and application
+ module-relative URI, and generate a server-relative
+ URI by including the context path and module
prefix.</li>
</ul>
@@ -3470,7 +3468,7 @@
<p>The keyboard character used to move focus immediately
to this element.</p>
</info>
- </attribute>
+ </attribute>
<attribute>
<name>action</name>
@@ -3537,13 +3535,11 @@
<name>indexed</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
- <info>
- Valid only inside of <code>logic-el:iterate</code> or
- <code>c:forEach</code> tags. If <code>true</code> then indexed
- parameter with name from indexId attribute will be added to the
- query string. Indexed parameter looks like "index[32]". Number
- in brackets will be generated for every iteration and taken
- from ancestor iteration tag.
+ <info>
+ Valid only inside of <code>logic-el:iterate</code> or <code>c:forEach</code> tags.
+ If <code>true</code> then name of the html tag will be rendered as
+ "id[34].propertyName". Number in brackets will be generated
+ for every iteration and taken from ancestor iteration tag.
</info>
</attribute>
@@ -3951,7 +3947,7 @@
<info>
Name of the bean in any scope under which our messages
have been stored. If not present, the name specified by the
- <code>Action.ERROR_KEY</code> constant string will be used.
+ <code>Globals.ERROR_KEY</code> constant string will be used.
</info>
</attribute>
@@ -4759,11 +4755,10 @@
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
- Valid only inside of <code>logic-el:iterate</code> or
- <code>c:forEach</code> tags. If <code>true</code> then name of
- the html tag will be rendered as "id[34].propertyName". Number
- in brackets will be generated for every iteration and taken
- from ancestor iteration tag.
+ Valid only inside of <code>logic-el:iterate</code> or <code>c:forEach</code> tags.
+ If <code>true</code> then name of the html tag will be rendered as
+ "id[34].propertyName". Number in brackets will be generated
+ for every iteration and taken from ancestor iteration tag.
</info>
</attribute>
@@ -5101,12 +5096,11 @@
<name>indexed</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
- <info>
- Valid only inside of <code>logic-el:iterate</code> or
- <code>c:forEach</code> tags. If <code>true</code> then name of
- the html tag will be rendered as "id[34].propertyName". Number
- in brackets will be generated for every iteration and taken
- from ancestor iteration tag.
+ <info>
+ Valid only inside of <code>logic-el:iterate</code> or <code>c:forEach</code> tags.
+ If <code>true</code> then name of the html tag will be rendered as
+ "id[34].propertyName". Number in brackets will be generated
+ for every iteration and taken from ancestor iteration tag.
</info>
</attribute>
@@ -5891,11 +5885,10 @@
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
- Valid only inside of <code>logic-el:iterate</code> or
- <code>c:forEach</code> tags. If <code>true</code> then name of
- the html tag will be rendered as "id[34].propertyName". Number
- in brackets will be generated for every iteration and taken
- from ancestor iteration tag.
+ Valid only inside of <code>logic-el:iterate</code> or <code>c:forEach</code> tags.
+ If <code>true</code> then name of the html tag will be rendered as
+ "id[34].propertyName". Number in brackets will be generated
+ for every iteration and taken from ancestor iteration tag.
</info>
</attribute>
@@ -6200,11 +6193,10 @@
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
- Valid only inside of <code>logic-el:iterate</code> or
- <code>c:forEach</code> tags. If <code>true</code> then name of
- the html tag will be rendered as "propertyName[34]". Number in
- brackets will be generated for every iteration and taken from
- ancestor iteration tag.
+ Valid only inside of <code>logic-el:iterate</code> or <code>c:forEach</code> tags.
+ If <code>true</code> then name of the html tag will be rendered as
+ "id[34].propertyName". Number in brackets will be generated
+ for every iteration and taken from ancestor iteration tag.
</info>
</attribute>
@@ -6472,12 +6464,11 @@
<name>indexed</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
- <info>
- Valid only inside of <code>logic-el:iterate</code> or
- <code>c:forEach</code> tags. If <code>true</code> then name of
- the html tag will be rendered as "id[34].propertyName". Number
- in brackets will be generated for every iteration and taken
- from ancestor iteration tag.
+ <info>
+ Valid only inside of <code>logic-el:iterate</code> or <code>c:forEach</code> tags.
+ If <code>true</code> then name of the html tag will be rendered as
+ "id[34].propertyName". Number in brackets will be generated
+ for every iteration and taken from ancestor iteration tag.
</info>
</attribute>
@@ -6796,11 +6787,11 @@
<name>indexed</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
- <info>
- Valid only inside of logic:iterate tag.
+ <info>
+ Valid only inside of <code>logic-el:iterate</code> or <code>c:forEach</code> tags.
If <code>true</code> then name of the html tag will be rendered as
"id[34].propertyName". Number in brackets will be generated
- for every iteration and taken from ancestor logic:iterate tag.
+ for every iteration and taken from ancestor iteration tag.
</info>
</attribute>
1.9 +2 -2 jakarta-struts/contrib/struts-el/doc/userGuide/struts-logic-el.xml
Index: struts-logic-el.xml
===================================================================
RCS file: /home/cvs/jakarta-struts/contrib/struts-el/doc/userGuide/struts-logic-el.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- struts-logic-el.xml 18 Jan 2004 07:11:27 -0000 1.8
+++ struts-logic-el.xml 1 Feb 2004 18:50:23 -0000 1.9
@@ -872,12 +872,12 @@
<ul>
<li><em>forward</em> - Use the value of this attribute as the
name of a global <code>ActionForward</code> to be looked
- up, and use the application-relative or context-relative
+ up, and use the module-relative or context-relative
URI found there.</li>
<li><em>href</em> - Use the value of this attribute unchanged.
</li>
<li><em>page</em> - Use the value of this attribute as an
- application-relative URI, and generate a server-relative
+ module-relative URI, and generate a server-relative
URI by including the context path.</li>
</ul>
1.4 +12 -12 jakarta-struts/contrib/struts-el/doc/userGuide/struts-tiles-el.xml
Index: struts-tiles-el.xml
===================================================================
RCS file: /home/cvs/jakarta-struts/contrib/struts-el/doc/userGuide/struts-tiles-el.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- struts-tiles-el.xml 16 Jan 2004 04:10:58 -0000 1.3
+++ struts-tiles-el.xml 1 Feb 2004 18:50:23 -0000 1.4
@@ -39,10 +39,10 @@
<p>Insert a tiles/component/template with the possibility to pass parameters
(called attribute).
A tile can be seen as a procedure that can take parameters or attributes.
- <code><template:insert></code> allows to define these attributes and pass them to the inserted jsp page,
+ <code><tiles:insert></code> allows to define these attributes and pass them to the inserted jsp page,
called template.
- Attributes are defined using nested tag <code><template:put></code> or
- <code><template:putList></code>.
+ Attributes are defined using nested tag <code><tiles:put></code> or
+ <code><tiles:putList></code>.
</p>
<p>
You must specify one of this tag attribute :
@@ -65,13 +65,13 @@
</p>
<p><strong>Example : </strong></p>
<pre><code>
- <template:insert page="/basic/myLayout.jsp" flush="true">
- <template:put name="title" value="My first page" />
- <template:put name="header" value="/common/header.jsp" />
- <template:put name="footer" value="/common/footer.jsp" />
- <template:put name="menu" value="/basic/menu.jsp" />
- <template:put name="body" value="/basic/helloBody.jsp" />
- </template:insert></code></pre>
+ <tiles:insert page="/basic/myLayout.jsp" flush="true">
+ <tiles:put name="title" value="My first page" />
+ <tiles:put name="header" value="/common/header.jsp" />
+ <tiles:put name="footer" value="/common/footer.jsp" />
+ <tiles:put name="menu" value="/basic/menu.jsp" />
+ <tiles:put name="body" value="/basic/helloBody.jsp" />
+ </tiles:insert></code></pre>
</info>
<tagclass>org.apache.strutsel.taglib.tiles.ELInsertTag</tagclass>
<bodycontent>JSP</bodycontent>
@@ -113,7 +113,7 @@
<info>
Name of the definition to insert. Definition are defined in a centralized file.
For now, only definition from factory can be inserted with this attribute.
- To insert a definition defined with tag <template:definition>, use beanName="".
+ To insert a definition defined with tag <tiles:definition>, use beanName="".
</info>
</attribute>
@@ -388,7 +388,7 @@
<li>String : Content is printed directly.</li>
<li>page | template : Content is included from specified URL. Name is used as an URL.</li>
<li>definition : Value is the name of a definition defined in factory (xml file). Definition will be searched
- in the inserted tile, in a <code><template:insert attribute="attributeName"></code> tag, where 'attributeName'
+ in the inserted tile, in a <code><tiles:insert attribute="attributeName"></code> tag, where 'attributeName'
is the name used for this tag.</li>
</ul>
If 'type' attribute is not specified, content is 'untyped', unless it comes from a typed bean.
---------------------------------------------------------------------
To unsubscribe, e-mail: struts-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: struts-dev-help@jakarta.apache.org