You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@struts.apache.org by ma...@apache.org on 2001/11/04 08:42:21 UTC
cvs commit: jakarta-struts/src/share/org/apache/struts/taglib/logic package.html
martinc 01/11/03 23:42:21
Modified: doc/userGuide taglib_struts-html-ref.xml
legacy/api-1.0/org/apache/struts/action ActionMapping.html
legacy/api-1.0/org/apache/struts/taglib/html
package-summary.html
legacy/api-1.0/org/apache/struts/taglib/logic
package-summary.html
src/share/org/apache/struts/action ActionMapping.java
src/share/org/apache/struts/taglib/html package.html
src/share/org/apache/struts/taglib/logic package.html
Log:
Fixed miscellaneous documentation errors.
PR: 4618, 4619, 4620, 4621, 4623, 4624
Submitted by: David M. Karr, Martin Cooper
Revision Changes Path
1.3 +1 -1 jakarta-struts/doc/userGuide/taglib_struts-html-ref.xml
Index: taglib_struts-html-ref.xml
===================================================================
RCS file: /home/cvs/jakarta-struts/doc/userGuide/taglib_struts-html-ref.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- taglib_struts-html-ref.xml 2001/10/20 05:02:42 1.2
+++ taglib_struts-html-ref.xml 2001/11/04 07:42:21 1.3
@@ -1,5 +1,5 @@
<?xml version="1.0"?>
-<document url="./struts-form.xml">
+<document url="./struts-html.xml">
<properties>
<author>Mike Schachter</author>
1.2 +2 -2 jakarta-struts/legacy/api-1.0/org/apache/struts/action/ActionMapping.html
Index: ActionMapping.html
===================================================================
RCS file: /home/cvs/jakarta-struts/legacy/api-1.0/org/apache/struts/action/ActionMapping.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ActionMapping.html 2001/09/17 20:03:01 1.1
+++ ActionMapping.html 2001/11/04 07:42:21 1.2
@@ -141,7 +141,7 @@
selected by this <code>ActionMapping</code>.
<li><strong>path</strong> - Request URI path used to select this mapping.
If extension mapping is used for the controller servlet, the extension
- will be stripped before comparisions against this value are made.
+ will be stripped before comparisons against this value are made.
<li><strong>prefix</strong> - Prefix used to match request parameter
names to form bean property names, if any. Replaces the old
<code>formPrefix</code> property.
@@ -167,7 +167,7 @@
</ul>
<P>
<DL>
-<DT><B>Version: </B><DD>$Revision: 1.1 $ $Date: 2001/09/17 20:03:01 $</DD>
+<DT><B>Version: </B><DD>$Revision: 1.2 $ $Date: 2001/11/04 07:42:21 $</DD>
<DT><B>Author: </B><DD>Craig R. McClanahan</DD>
<DT><B>See Also: </B><DD><A HREF="../../../../serialized-form.html#org.apache.struts.action.ActionMapping">Serialized Form</A></DL>
<HR>
1.2 +4 -4 jakarta-struts/legacy/api-1.0/org/apache/struts/taglib/html/package-summary.html
Index: package-summary.html
===================================================================
RCS file: /home/cvs/jakarta-struts/legacy/api-1.0/org/apache/struts/taglib/html/package-summary.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- package-summary.html 2001/09/17 20:09:53 1.1
+++ package-summary.html 2001/11/04 07:42:21 1.2
@@ -266,7 +266,7 @@
</pre>
</pre>
-<p>Given this configuration, the HTML form tag for <code>input.jsp</code> will default
+<p>Given this configuration, the HTML form tag for <code>logon.jsp</code> will default
to using "<code>logonForm</code>" as its name property and
"<code>org.apache.struts.example.LogonForm</code>" as the attribute's type. This way you
can manage the namespace for your framework components from the configuration file.</p>
@@ -503,7 +503,7 @@
<p>Most often, error messages are displayed in a particular way. To make it easy
to format your messages, you can also specific an <code>errors.header</code>
and <code>errors.footer</code> string in your message resource. Typically, you
- might want to render the messages in a different color, or set them up them
+ might want to render the messages in a different color, or set them up
to appear in an unordered list. Using the <code>errors.header</code> and <code>errors.footer</code>
strings keeps the setup codes out of your JSP until a message actually prints.</p>
<pre>
@@ -561,7 +561,7 @@
holding the value using the <code>paramName</code> attribute, and a particular
property using <code>paramProperty</code>. </p>
<p>So, a tag like</p>
-<pre> <html:link paramID="target"
+<pre> <html:link paramId="target"
paramName="linkParams" <br> paramProperty="target"
paramScope="request"<br> >detail.html</html:link></pre>
<p>would correspond to something like</p>
@@ -574,7 +574,7 @@
named bean identifies a value that can be converted to a String.
<p>To pass multiple dynamic parameters, you can store them in a <code><a href="http://java.sun.com/j2se/1.3/docs/api/java/util/Map.html">java.util.Map</a></code>,
and use the name of the map for the <code>paramName</code>. The map must then
- contain one or more <code>paramIDs</code> and their corresponding values. As
+ contain one or more <code>paramIds</code> and their corresponding values. As
the Map is processed, the keys are assumed to be the names of query parameters
to be appended. The value associated with each key must be either a String or
a String array representing the parameter value(s). If a String array is specified,
1.2 +29 -29 jakarta-struts/legacy/api-1.0/org/apache/struts/taglib/logic/package-summary.html
Index: package-summary.html
===================================================================
RCS file: /home/cvs/jakarta-struts/legacy/api-1.0/org/apache/struts/taglib/logic/package-summary.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- package-summary.html 2001/09/17 20:10:52 1.1
+++ package-summary.html 2001/11/04 07:42:21 1.2
@@ -177,8 +177,8 @@
<a name="doc.Functionality"></a>
<h3>Logic Tag Functionality<a name="doc.Functionality"></a></h3>
<p> The functionality of the logic tags can be divided into four groups:</p>
-<p><b>Value Comparisions -</b> The purpose of these tags is to print out the body
- of the tag if the comparision evaluates to <i>true. </i></p>
+<p><b>Value Comparisons -</b> The purpose of these tags is to print out the body
+ of the tag if the comparison evaluates to <i>true. </i></p>
<ul>
<li><b><a href="../../../../../../struts-logic.html#equal">equal,</a> <a href="../../../../../../struts-logic.html#notEqual">notEqual</a></b>
</li>
@@ -205,26 +205,26 @@
<p>Each of the four groups of logic tags have a common set of attributes associated
with them. :</p>
<blockquote>
- <p><b>Value Comparisions</b> (equal, notEqual, greaterEqual, lessEqual, greaterThan,
+ <p><b>Value Comparisons</b> (equal, notEqual, greaterEqual, lessEqual, greaterThan,
lessThan, present, notPresent)</p>
- <p>Each of the value comparision tags takes a <i>value</i> and compares it to
- the value of a comparision attribute. If the value given can be successfully
- converted to a <i>float</i> or <i>double</i>, then a number comparision is
- performed on the value given and the value of the comparision attribute. Otherwise
- a String comparision is performed. You have to specify one of the comparision
+ <p>Each of the value comparison tags takes a <i>value</i> and compares it to
+ the value of a comparison attribute. If the value given can be successfully
+ converted to a <i>float</i> or <i>double</i>, then a number comparison is
+ performed on the value given and the value of the comparison attribute. Otherwise
+ a String comparison is performed. You have to specify one of the comparison
attributes: <i>cookie</i>, <i>header</i>, <i>parameter</i>, <i>property</i>
- or <i>name. </i>For each of the examples, the tag "<i>someComparisionTag"</i>can
- be replaced by any of the value comparision tags.</p>
+ or <i>name. </i>For each of the examples, the tag "<i>someComparisonTag"</i>can
+ be replaced by any of the value comparison tags.</p>
<ul>
<li>value - the value to which this tag is going to compare, used in conjunction
- with one of the comparision attributes: <i>cookie</i>, <i>header</i>, <i>parameter</i>,
+ with one of the comparison attributes: <i>cookie</i>, <i>header</i>, <i>parameter</i>,
<i>and property</i> and/or <i>name. </i></li>
<li>cookie - the name of the cookie to compare to <i>value</i>
<ul>
<li>example:
- <pre><logic:<i>someComparisionTag</i> value="someUserName" cookie="userName">
+ <pre><logic:<i>someComparisonTag</i> value="someUserName" cookie="userName">
User Logged In
-</logic:<i>someComparisionTag</i>>
+</logic:<i>someComparisonTag</i>>
</pre>
</li>
</ul>
@@ -232,9 +232,9 @@
<li>header - the name of the HTTP header to compare to <i>value</i>
<ul>
<li>example:
- <pre><logic:<i>someComparisionTag</i> value="en_US" header="Accept-Language">
+ <pre><logic:<i>someComparisonTag</i> value="en_US" header="Accept-Language">
Welcome English-speaking User*
-</logic:<i>someComparisionTag</i>>
+</logic:<i>someComparisonTag</i>>
</pre>
</li>
<li>
@@ -253,9 +253,9 @@
pageContext.setAttribute("testString", testString, PageContext.PAGE_SCOPE);
%>
<jsp:useBean id="testString" scope="page" type="java.lang.String" />
-<logic:<i>someComparisionTag</i> name="testString" value="pantalones">
+<logic:<i>someComparisonTag</i> name="testString" value="pantalones">
Usted tiene pantalones!
-</logic:<i>someComparision</i>>
+</logic:<i>someComparison</i>>
</pre>
</li>
</ul>
@@ -263,9 +263,9 @@
<li>parameter - the name of the request parameter to compare to <i>value</i>
<ul>
<li>example:
- <pre><logic:<i>someComparisionTag</i> value="" parameter="username">
+ <pre><logic:<i>someComparisonTag</i> value="" parameter="username">
Error: a username must be specified
-</logic:<i>someComparisionTag</i>>
+</logic:<i>someComparisonTag</i>>
</pre>
</li>
</ul>
@@ -282,8 +282,8 @@
scope" </li>
</ul>
<p><b>Substring Matching</b> (match, notMatch)</p>
- <p>The substring matching tags take all the same arguments as the value comparision
- tags. You compare the String specified by <i>value</i> to any of the comparision
+ <p>The substring matching tags take all the same arguments as the value comparison
+ tags. You compare the String specified by <i>value</i> to any of the comparison
values you give it, specified by <i>cookie</i>, <i>header</i>, <i>parameter</i>,
<i>property</i> or <i>name.</i> Note that in the examples, <i>matchTag</i>
corresponds either the <i>match </i>or <i>notMatch</i> tag. Matching tags
@@ -292,16 +292,16 @@
<li>location - has two possible values, "start" and "end".
If "start", the substring is attempted to be matched at the beginning
of the String, if "end", then the substring is attempted to be
- matched to the end of the String
+ matched to the end of the String.
<ul>
<li>example:
- <pre><logic:<i>matchTag</i> parameter="action" value="processLogin">
+ <pre><logic:<i>matchTag</i> parameter="action" value="processLogin" location="start">
Processing Login....
</logic:<i>matchTag</i>>
-Basically, in this short example, a request parameter "action"
-was compared to see if it was equal to the String value "processLogin".
-In this case, <i>matchTag</i> would have to be <logic:match>.
+In this example, a request parameter "action" was compared to see if
+its value started with the String "processLogin". In this case,
+<i>matchTag</i> would have to be <logic:match>.
</pre>
</li>
</ul>
@@ -329,7 +329,7 @@
<li>name - The logical name of the ActionForward to use</li>
</ul>
<p><b>Collection Utilities</b> (iterate)</p>
- <p>The <i>iterate</i> tag is responsible for executing it's body content once
+ <p>The <i>iterate</i> tag is responsible for executing its body content once
for every element inside of the specified Collection. There is one required
attribute:</p>
<ul>
@@ -426,7 +426,7 @@
</blockquote>
<h3>Logic Examples</h3>
<blockquote>
- <p><b>Value Comparisions</b></p>
+ <p><b>Value Comparisons</b></p>
<blockquote>
<p><u></u><u></u><u>Logic Equivalence Tags (equal, notEqual, greaterEqual,
lessEqual, lessThan, greaterThan)</u></p>
@@ -485,7 +485,7 @@
is higher or lower than 7, and prints out a hint. As said before, this
is a horribly designed small application, with no validity checks on the
number input, but shows the basic usage of the logic equal tags</p>
- <p>For String comparisions, the equal tags use the java.lang.String.compareTo()
+ <p>For String comparisons, the equal tags use the java.lang.String.compareTo()
method. See the javadocs on the compareTo() method for more information,
located <a href="http://www.javasoft.com/products/jdk/1.2/docs/api/java/lang/String.html#compareTo(java.lang.Object)">here</a>.</p>
</blockquote>
1.20 +5 -5 jakarta-struts/src/share/org/apache/struts/action/ActionMapping.java
Index: ActionMapping.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/action/ActionMapping.java,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -r1.19 -r1.20
--- ActionMapping.java 2001/10/04 03:02:27 1.19
+++ ActionMapping.java 2001/11/04 07:42:21 1.20
@@ -1,7 +1,7 @@
/*
- * $Header: /home/cvs/jakarta-struts/src/share/org/apache/struts/action/ActionMapping.java,v 1.19 2001/10/04 03:02:27 craigmcc Exp $
- * $Revision: 1.19 $
- * $Date: 2001/10/04 03:02:27 $
+ * $Header: /home/cvs/jakarta-struts/src/share/org/apache/struts/action/ActionMapping.java,v 1.20 2001/11/04 07:42:21 martinc Exp $
+ * $Revision: 1.20 $
+ * $Date: 2001/11/04 07:42:21 $
*
* ====================================================================
*
@@ -106,7 +106,7 @@
* selected by this <code>ActionMapping</code>.</li>
* <li><strong>path</strong> - Request URI path used to select this mapping.
* If extension mapping is used for the controller servlet, the extension
- * will be stripped before comparisions against this value are made.</li>
+ * will be stripped before comparisons against this value are made.</li>
* <li><strong>prefix</strong> - Prefix used to match request parameter
* names to form bean property names, if any.</li>
* <li><strong>scope</strong> - Identifier of the scope ("request" or
@@ -130,7 +130,7 @@
* </ul>
*
* @author Craig R. McClanahan
- * @version $Revision: 1.19 $ $Date: 2001/10/04 03:02:27 $
+ * @version $Revision: 1.20 $ $Date: 2001/11/04 07:42:21 $
*/
public class ActionMapping implements Serializable {
1.10 +4 -4 jakarta-struts/src/share/org/apache/struts/taglib/html/package.html
Index: package.html
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/taglib/html/package.html,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- package.html 2001/10/16 15:35:27 1.9
+++ package.html 2001/11/04 07:42:21 1.10
@@ -84,7 +84,7 @@
</pre>
</pre>
-<p>Given this configuration, the HTML form tag for <code>input.jsp</code> will default
+<p>Given this configuration, the HTML form tag for <code>logon.jsp</code> will default
to using "<code>logonForm</code>" as its name property and
"<code>org.apache.struts.example.LogonForm</code>" as the attribute's type. This way you
can manage the namespace for your framework components from the configuration file.</p>
@@ -478,7 +478,7 @@
<p>Most often, error messages are displayed in a particular way. To make it easy
to format your messages, you can also specific an <code>errors.header</code>
and <code>errors.footer</code> string in your message resource. Typically, you
- might want to render the messages in a different color, or set them up them
+ might want to render the messages in a different color, or set them up
to appear in an unordered list. Using the <code>errors.header</code> and <code>errors.footer</code>
strings keeps the setup codes out of your JSP until a message actually prints.</p>
<pre>
@@ -536,7 +536,7 @@
holding the value using the <code>paramName</code> attribute, and a particular
property using <code>paramProperty</code>. </p>
<p>So, a tag like</p>
-<pre> <html:link paramID="target"
+<pre> <html:link paramId="target"
paramName="linkParams" <br> paramProperty="target"
paramScope="request"<br> >detail.html</html:link></pre>
<p>would correspond to something like</p>
@@ -549,7 +549,7 @@
named bean identifies a value that can be converted to a String.
<p>To pass multiple dynamic parameters, you can store them in a <code><a href="http://java.sun.com/j2se/1.3/docs/api/java/util/Map.html">java.util.Map</a></code>,
and use the name of the map for the <code>paramName</code>. The map must then
- contain one or more <code>paramIDs</code> and their corresponding values. As
+ contain one or more <code>paramIds</code> and their corresponding values. As
the Map is processed, the keys are assumed to be the names of query parameters
to be appended. The value associated with each key must be either a String or
a String array representing the parameter value(s). If a String array is specified,
1.10 +28 -28 jakarta-struts/src/share/org/apache/struts/taglib/logic/package.html
Index: package.html
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/taglib/logic/package.html,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- package.html 2001/05/29 18:06:02 1.9
+++ package.html 2001/11/04 07:42:21 1.10
@@ -31,8 +31,8 @@
<a name="doc.Functionality"></a>
<h3>Logic Tag Functionality<a name="doc.Functionality"></a></h3>
<p> The functionality of the logic tags can be divided into four groups:</p>
-<p><b>Value Comparisions -</b> The purpose of these tags is to print out the body
- of the tag if the comparision evaluates to <i>true. </i></p>
+<p><b>Value Comparisons -</b> The purpose of these tags is to print out the body
+ of the tag if the comparison evaluates to <i>true. </i></p>
<ul>
<li><b><a href="../../../../../../struts-logic.html#equal">equal,</a> <a href="../../../../../../struts-logic.html#notEqual">notEqual</a></b>
</li>
@@ -59,26 +59,26 @@
<p>Each of the four groups of logic tags have a common set of attributes associated
with them. :</p>
<blockquote>
- <p><b>Value Comparisions</b> (equal, notEqual, greaterEqual, lessEqual, greaterThan,
+ <p><b>Value Comparisons</b> (equal, notEqual, greaterEqual, lessEqual, greaterThan,
lessThan, present, notPresent)</p>
- <p>Each of the value comparision tags takes a <i>value</i> and compares it to
- the value of a comparision attribute. If the value given can be successfully
- converted to a <i>float</i> or <i>double</i>, then a number comparision is
- performed on the value given and the value of the comparision attribute. Otherwise
- a String comparision is performed. You have to specify one of the comparision
+ <p>Each of the value comparison tags takes a <i>value</i> and compares it to
+ the value of a comparison attribute. If the value given can be successfully
+ converted to a <i>float</i> or <i>double</i>, then a number comparison is
+ performed on the value given and the value of the comparison attribute. Otherwise
+ a String comparison is performed. You have to specify one of the comparison
attributes: <i>cookie</i>, <i>header</i>, <i>parameter</i>, <i>property</i>
- or <i>name. </i>For each of the examples, the tag "<i>someComparisionTag"</i>can
- be replaced by any of the value comparision tags.</p>
+ or <i>name. </i>For each of the examples, the tag "<i>someComparisonTag"</i>can
+ be replaced by any of the value comparison tags.</p>
<ul>
<li>value - the value to which this tag is going to compare, used in conjunction
- with one of the comparision attributes: <i>cookie</i>, <i>header</i>, <i>parameter</i>,
+ with one of the comparison attributes: <i>cookie</i>, <i>header</i>, <i>parameter</i>,
<i>and property</i> and/or <i>name. </i></li>
<li>cookie - the name of the cookie to compare to <i>value</i>
<ul>
<li>example:
- <pre><logic:<i>someComparisionTag</i> value="someUserName" cookie="userName">
+ <pre><logic:<i>someComparisonTag</i> value="someUserName" cookie="userName">
User Logged In
-</logic:<i>someComparisionTag</i>>
+</logic:<i>someComparisonTag</i>>
</pre>
</li>
</ul>
@@ -86,9 +86,9 @@
<li>header - the name of the HTTP header to compare to <i>value</i>
<ul>
<li>example:
- <pre><logic:<i>someComparisionTag</i> value="en_US" header="Accept-Language">
+ <pre><logic:<i>someComparisonTag</i> value="en_US" header="Accept-Language">
Welcome English-speaking User*
-</logic:<i>someComparisionTag</i>>
+</logic:<i>someComparisonTag</i>>
</pre>
</li>
<li>
@@ -107,9 +107,9 @@
pageContext.setAttribute("testString", testString, PageContext.PAGE_SCOPE);
%>
<jsp:useBean id="testString" scope="page" type="java.lang.String" />
-<logic:<i>someComparisionTag</i> name="testString" value="pantalones">
+<logic:<i>someComparisonTag</i> name="testString" value="pantalones">
Usted tiene pantalones!
-</logic:<i>someComparision</i>>
+</logic:<i>someComparison</i>>
</pre>
</li>
</ul>
@@ -117,9 +117,9 @@
<li>parameter - the name of the request parameter to compare to <i>value</i>
<ul>
<li>example:
- <pre><logic:<i>someComparisionTag</i> value="" parameter="username">
+ <pre><logic:<i>someComparisonTag</i> value="" parameter="username">
Error: a username must be specified
-</logic:<i>someComparisionTag</i>>
+</logic:<i>someComparisonTag</i>>
</pre>
</li>
</ul>
@@ -136,8 +136,8 @@
scope" </li>
</ul>
<p><b>Substring Matching</b> (match, notMatch)</p>
- <p>The substring matching tags take all the same arguments as the value comparision
- tags. You compare the String specified by <i>value</i> to any of the comparision
+ <p>The substring matching tags take all the same arguments as the value comparison
+ tags. You compare the String specified by <i>value</i> to any of the comparison
values you give it, specified by <i>cookie</i>, <i>header</i>, <i>parameter</i>,
<i>property</i> or <i>name.</i> Note that in the examples, <i>matchTag</i>
corresponds either the <i>match </i>or <i>notMatch</i> tag. Matching tags
@@ -149,13 +149,13 @@
matched to the end of the String
<ul>
<li>example:
- <pre><logic:<i>matchTag</i> parameter="action" value="processLogin">
+ <pre><logic:<i>matchTag</i> parameter="action" value="processLogin" location="start">
Processing Login....
</logic:<i>matchTag</i>>
-Basically, in this short example, a request parameter "action"
-was compared to see if it was equal to the String value "processLogin".
-In this case, <i>matchTag</i> would have to be <logic:match>.
+In this example, a request parameter "action" was compared to see if
+its value started with the String "processLogin". In this case,
+<i>matchTag</i> would have to be <logic:match>.
</pre>
</li>
</ul>
@@ -183,7 +183,7 @@
<li>name - The logical name of the ActionForward to use</li>
</ul>
<p><b>Collection Utilities</b> (iterate)</p>
- <p>The <i>iterate</i> tag is responsible for executing it's body content once
+ <p>The <i>iterate</i> tag is responsible for executing its body content once
for every element inside of the specified Collection. There is one required
attribute:</p>
<ul>
@@ -280,7 +280,7 @@
</blockquote>
<h3>Logic Examples</h3>
<blockquote>
- <p><b>Value Comparisions</b></p>
+ <p><b>Value Comparisons</b></p>
<blockquote>
<p><u></u><u></u><u>Logic Equivalence Tags (equal, notEqual, greaterEqual,
lessEqual, lessThan, greaterThan)</u></p>
@@ -339,7 +339,7 @@
is higher or lower than 7, and prints out a hint. As said before, this
is a horribly designed small application, with no validity checks on the
number input, but shows the basic usage of the logic equal tags</p>
- <p>For String comparisions, the equal tags use the java.lang.String.compareTo()
+ <p>For String comparisons, the equal tags use the java.lang.String.compareTo()
method. See the javadocs on the compareTo() method for more information,
located <a href="http://www.javasoft.com/products/jdk/1.2/docs/api/java/lang/String.html#compareTo(java.lang.Object)">here</a>.</p>
</blockquote>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>