martinc 01/10/06 21:48:08
Modified: doc index.xml
doc/userGuide building_controller.xml building_model.xml
building_view.xml introduction.xml
src/share/org/apache/struts/action ActionServlet.java
Log:
Documentation updates:
- Bugzilla items 3670 through 3680
- Updated JavaDoc also for Bugzilla 3678
- Document 'validating' init-param in User Guide
- Fixed a typo on the home page
PR: 3670 through 3680
Submitted by: David M. Karr
Revision Changes Path
1.9 +1 -1 jakarta-struts/doc/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-struts/doc/index.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- index.xml 2001/09/18 01:39:51 1.8
+++ index.xml 2001/10/07 04:48:08 1.9
@@ -76,7 +76,7 @@
morning. Use at your own risk!</p>
<ul>
- <li>Nightly builds - download the source directly via
+ <li>Nightly builds - Download the source directly via
<a href="http://jakarta.apache.org/getinvolved/cvsindex.html";>
Anonymous CVS</a>.</li>
<li>Nightly builds - Download the binary distributions from
1.5 +17 -8 jakarta-struts/doc/userGuide/building_controller.xml
Index: building_controller.xml
===================================================================
RCS file: /home/cvs/jakarta-struts/doc/userGuide/building_controller.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- building_controller.xml 2001/10/05 11:19:29 1.4
+++ building_controller.xml 2001/10/07 04:48:08 1.5
@@ -197,8 +197,8 @@
</p>
<p>
- Inside of the <struts-config> element, there two important elements
that use
- to describe your actions:
+ Inside of the <struts-config> element, there are two important
+ elements that are used to describe your actions:
<blockquote>
<b><form-beans></b><br />
@@ -217,7 +217,7 @@
<blockquote>
<b><action-mappings></b><br />
This section contains your action definitions. You use an
<action> element
- for each of your actions you would like to define. Each action element
has requires
+ for each of your actions you would like to define. Each action element
requires
the following attributes to be defined:
<ul>
@@ -273,7 +273,7 @@
name for the form bean.
</p>
<p>
- The "<code>global-forwards</code>" section is used to create logical name
mappings between commonly used
+ The "<code>global-forwards</code>" section is used to create logical name
mappings for commonly used
jsp pages. Each of these forwards is available through a call to your
action mapping instance,
i.e. <code>actionMappingInstace.findForward("logicalName")</code>.
</p>
@@ -287,7 +287,7 @@
and saving a bean of the specified class if needed.
</p>
<p>
- An optional but very useful section is the local "local
<code>forwards</code>". In the example
+ Optional but very useful are the local "<code>forward</code>" elements. In
the example
application, many actions include a local "success" and/or "failure"
forward as
part of an Action mapping.
</p>
@@ -415,7 +415,8 @@
instead of the servlet log. [0]</li>
<li><strong>factory</strong> - The Java class name of the
<code>MessageResourcesFactory</code> used to create the application
- <code>MessageResources</code> object.</li>
+ <code>MessageResources</code> object.
+ [org.apache.struts.util.PropertyMessageResourcesFactory]</li>
<li><strong>formBean</strong> - The Java class name of the ActionFormBean
implementation to use [org.apache.struts.action.ActionFormBean].</li>
<li><strong>forward</strong> - The Java class name of the ActionForward
@@ -435,7 +436,7 @@
user session, identify and store an appropriate
<code>java.util.Locale</code> object (under the standard key
identified by <code>Action.LOCALE_KEY</code>) in the user's session
- if there is not a Locale object there already.</li>
+ if there is not a Locale object there already. [true]</li>
<li><strong>mapping</strong> - The Java class name of the ActionMapping
implementation to use [org.apache.struts.action.ActionMapping].
Two convenient classes you may wish to use are:
@@ -453,7 +454,7 @@
by a "K" "M", or "G", which are interpreted to mean kilobytes,
megabytes, or gigabytes, respectively. [250M]</li>
<li><strong>multipartClass</strong> - The fully qualified name of the
- MultiplartRequestHandler implementation class to be used for
processing
+ MultipartRequestHandler implementation class to be used for processing
file uploads. [org.apache.struts.upload.DiskMultipartRequestHandler]
</li>
<li><strong>nocache</strong> - If set to <code>true</code>, add HTTP
headers
@@ -468,11 +469,19 @@
application as a servlet context attribute]</li>
<li><strong>validate</strong> - Are we using the new configuration file
format? [true]</li>
+ <li><strong>validating</strong> - Should we use a validating XML parse to
+ process the configuration file (strongly recommended)? [true]</li>
</ul>
</section>
<section name="4.5.2 Configure the Action Servlet Mapping"
href="dd_config_mapping">
+ <p>
+ <strong>Note:</strong> The material in this section is not specific to
+ Struts. The configuration of servlet mappings is defined in the Java
+ Servlet Specification. This section describes the most common means
+ of configuring a Struts application.
+ </p>
<p>
There are two common approaches to defining the URLs that will
be processed by the controller servlet -- prefix matching and extension
1.2 +1 -1 jakarta-struts/doc/userGuide/building_model.xml
Index: building_model.xml
===================================================================
RCS file: /home/cvs/jakarta-struts/doc/userGuide/building_model.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- building_model.xml 2001/03/18 17:48:59 1.1
+++ building_model.xml 2001/10/07 04:48:08 1.2
@@ -148,7 +148,7 @@
properties for all of the fields, no matter which page the field is actually
displayed on. Likewise, the various pages of the same form should all be
submitted to the same Action Class. If you follow these suggestions, the
- page designers can rearrange the fields among the various pages, pftem
without
+ page designers can rearrange the fields among the various pages, often
without
requiring changes to the processing logic.
</p>
</section>
1.4 +4 -3 jakarta-struts/doc/userGuide/building_view.xml
Index: building_view.xml
===================================================================
RCS file: /home/cvs/jakarta-struts/doc/userGuide/building_view.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- building_view.xml 2001/08/07 17:34:48 1.3
+++ building_view.xml 2001/10/07 04:48:08 1.4
@@ -107,7 +107,7 @@
</ul>
<p>
- When you configue the controller servlet in the web application
+ When you configure the controller servlet in the web application
deployment descriptor, one of the things you will need to define in
an initialization parameter is the base name of the resource bundle
for the application. In the case described above, it would be
@@ -378,8 +378,9 @@
<li><a href="../struts-html.html#password">password</a> input
fields</li>
<li><a href="../struts-html.html#radio">radio</a> buttons</li>
<li><a href="../struts-html.html#reset">reset</a> buttons</li>
- <li><a href="../struts-html.html#select">select</a> lists with
embedded</li>
- <li><a href="../struts-html.html#option">options</a></li>
+ <li><a href="../struts-html.html#select">select</a> lists with embedded
option or options items</li>
+ <li><a href="../struts-html.html#option">option</a></li>
+ <li><a href="../struts-html.html#options">options</a></li>
<li><a href="../struts-html.html#submit">submit</a> buttons</li>
<li><a href="../struts-html.html#text">text</a> input fields</li>
<li><a href="../struts-html.html#textarea">textareas</a></li>
1.4 +1 -1 jakarta-struts/doc/userGuide/introduction.xml
Index: introduction.xml
===================================================================
RCS file: /home/cvs/jakarta-struts/doc/userGuide/introduction.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- introduction.xml 2001/07/20 06:22:11 1.3
+++ introduction.xml 2001/10/07 04:48:08 1.4
@@ -122,7 +122,7 @@
<p>
The form bean can be used by a JSP to collect data from the user ... by
an
- action object to validate the user entered ... and then by the JSP again
to
+ action object to validate the user-entered data ... and then by the JSP
again to
re-populate the form fields. In the case of validation errors, Struts has
a
shared mechanism for raising and displaying error messages.
</p>
1.76 +7 -6
jakarta-struts/src/share/org/apache/struts/action/ActionServlet.java
Index: ActionServlet.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/src/share/org/apache/struts/action/ActionServlet.java,v
retrieving revision 1.75
retrieving revision 1.76
diff -u -r1.75 -r1.76
--- ActionServlet.java 2001/10/04 02:54:04 1.75
+++ ActionServlet.java 2001/10/07 04:48:08 1.76
@@ -1,7 +1,7 @@
/*
- * $Header:
/home/cvs/jakarta-struts/src/share/org/apache/struts/action/ActionServlet.java,v 1.75
2001/10/04 02:54:04 craigmcc Exp $
- * $Revision: 1.75 $
- * $Date: 2001/10/04 02:54:04 $
+ * $Header:
/home/cvs/jakarta-struts/src/share/org/apache/struts/action/ActionServlet.java,v 1.76
2001/10/07 04:48:08 martinc Exp $
+ * $Revision: 1.76 $
+ * $Date: 2001/10/07 04:48:08 $
*
* ====================================================================
*
@@ -172,7 +172,8 @@
* instead of the servlet log. [0]</li>
* <li><strong>factory</strong> - The Java class name of the
* <code>MessageResourcesFactory</code> used to create the application
- * <code>MessageResources</code> object.</li>
+ * <code>MessageResources</code> object.
+ * [org.apache.struts.util.PropertyMessageResourcesFactory]</li>
* <li><strong>formBean</strong> - The Java class name of the ActionFormBean
* implementation to use [org.apache.struts.action.ActionFormBean].
* <li><strong>forward</strong> - The Java class name of the ActionForward
@@ -192,7 +193,7 @@
* user session, identify and store an appropriate
* <code>java.util.Locale</code> object (under the standard key
* identified by <code>Action.LOCALE_KEY</code>) in the user's session
- * if there is not a Locale object there already.</li>
+ * if there is not a Locale object there already. [true]</li>
* <li><strong>mapping</strong> - The Java class name of the ActionMapping
* implementation to use [org.apache.struts.action.ActionMapping].
* Two convenient classes you may wish to use are:
@@ -229,7 +230,7 @@
* </ul>
*
* @author Craig R. McClanahan
- * @version $Revision: 1.75 $ $Date: 2001/10/04 02:54:04 $
+ * @version $Revision: 1.76 $ $Date: 2001/10/07 04:48:08 $
*/
public class ActionServlet
