You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@struts.apache.org by hu...@apache.org on 2005/11/08 04:37:29 UTC
svn commit: r331677 - in /struts/core/trunk/xdocs/userGuide:
building_controller.xml building_model.xml building_view.xml
configuration.xml index.xml installation.xml introduction.xml preface.xml
release-notes.xml
Author: husted
Date: Mon Nov 7 19:37:25 2005
New Revision: 331677
URL: http://svn.apache.org/viewcvs?rev=331677&view=rev
Log:
Complete first full-pass on Core for the 1.3.x series. Now onto Taglib!
Modified:
struts/core/trunk/xdocs/userGuide/building_controller.xml
struts/core/trunk/xdocs/userGuide/building_model.xml
struts/core/trunk/xdocs/userGuide/building_view.xml
struts/core/trunk/xdocs/userGuide/configuration.xml
struts/core/trunk/xdocs/userGuide/index.xml
struts/core/trunk/xdocs/userGuide/installation.xml
struts/core/trunk/xdocs/userGuide/introduction.xml
struts/core/trunk/xdocs/userGuide/preface.xml
struts/core/trunk/xdocs/userGuide/release-notes.xml
Modified: struts/core/trunk/xdocs/userGuide/building_controller.xml
URL: http://svn.apache.org/viewcvs/struts/core/trunk/xdocs/userGuide/building_controller.xml?rev=331677&r1=331676&r2=331677&view=diff
==============================================================================
--- struts/core/trunk/xdocs/userGuide/building_controller.xml (original)
+++ struts/core/trunk/xdocs/userGuide/building_controller.xml Mon Nov 7 19:37:25 2005
@@ -6,7 +6,7 @@
-->
<properties>
- <title>Struts Core User Guide - Building Controller Components</title>
+ <title>Struts Core Users Guide - Building Controller Components</title>
</properties>
<body>
Modified: struts/core/trunk/xdocs/userGuide/building_model.xml
URL: http://svn.apache.org/viewcvs/struts/core/trunk/xdocs/userGuide/building_model.xml?rev=331677&r1=331676&r2=331677&view=diff
==============================================================================
--- struts/core/trunk/xdocs/userGuide/building_model.xml (original)
+++ struts/core/trunk/xdocs/userGuide/building_model.xml Mon Nov 7 19:37:25 2005
@@ -7,7 +7,7 @@
<document url="building_model.html">
<properties>
- <title>Struts Core User's Guide - Building Model Components</title>
+ <title>Struts Core Users Guide - Building Model Components</title>
</properties>
<body>
Modified: struts/core/trunk/xdocs/userGuide/building_view.xml
URL: http://svn.apache.org/viewcvs/struts/core/trunk/xdocs/userGuide/building_view.xml?rev=331677&r1=331676&r2=331677&view=diff
==============================================================================
--- struts/core/trunk/xdocs/userGuide/building_view.xml (original)
+++ struts/core/trunk/xdocs/userGuide/building_view.xml Mon Nov 7 19:37:25 2005
@@ -6,7 +6,7 @@
-->
<properties>
- <title>Struts Core User's Guide - Building View Components</title>
+ <title>Struts Core Users Guide - Building View Components</title>
</properties>
<body>
Modified: struts/core/trunk/xdocs/userGuide/configuration.xml
URL: http://svn.apache.org/viewcvs/struts/core/trunk/xdocs/userGuide/configuration.xml?rev=331677&r1=331676&r2=331677&view=diff
==============================================================================
--- struts/core/trunk/xdocs/userGuide/configuration.xml (original)
+++ struts/core/trunk/xdocs/userGuide/configuration.xml Mon Nov 7 19:37:25 2005
@@ -2,7 +2,7 @@
<document url="configuration.html">
<properties>
- <title>The Struts User's Guide - Configuring Applications</title>
+ <title>Struts Core Users Guide - Configuring Applications</title>
</properties>
<body>
@@ -14,23 +14,23 @@
<p>
Before you can build an application, you need to lay a solid foundation.
There are several setup tasks you need to perform before deploying
- your Struts application.
- These include components in the Struts configuration file
+ your Struts Core application.
+ These include components in the Struts Core configuration file
and in the Web Application Deployment Descriptor.
</p>
</subsection>
<a name="struts-config"/>
- <subsection name="5.2 The Struts configuration file">
+ <subsection name="5.2 The Struts Core configuration file">
<p>
The <a href="building_controller.html#4_8_Writing_Action_Mappings">Writing Action
Mappings</a> section covered writing the <code><form-bean></code> and
- <code><action-mapping></code> portions of the Struts configuration file.
+ <code><action-mapping></code> portions of the Struts Core configuration file.
These elements usually play an important role in the development of a
- Struts application.
- The other elements in Struts configuration file tend to be static:
+ Struts Core application.
+ The other elements in Struts Core configuration file tend to be static:
you set them once and leave them alone.
</p>
@@ -67,8 +67,8 @@
moved to this section of <code>struts-config.xml</code> in order to allow
different modules in the same web application to be configured differently.
For full details on available parameters see the
- <a href="http://struts.apache.org/dtds/struts-config_1_2.dtd">
- struts-config_1_2.dtd</a> or the list below.
+ <a href="http://struts.apache.org/dtds/struts-config_1_3.dtd">
+ struts-config_1_3.dtd</a> or the list below.
</p>
@@ -82,11 +82,22 @@
</li>
<li>
+ <strong>catalog</strong> - Name of the catalog to use when processing requests
+ for this module.
+ [struts]
+ </li>
+
+ <li>
<strong>className</strong> - Classname of configuration bean.
[org.apache.struts.config.ControllerConfig] (optional)
</li>
<li>
+ <strong>command</strong> - Name of the command to execute to process a request.
+ [servlet-standard]
+ </li>
+
+ <li>
<strong>contentType</strong> - Default content type (and optional character
encoding) to be set on each response.
May be overridden by the Action, JSP, or other resource to which
@@ -153,7 +164,17 @@
respectively.
[250M] (optional)
</li>
-
+
+ <li>
+ <strong>memFileSize</strong> - The maximum size (in bytes) of a file whose contents will
+ be retained in memory after uploading. Files larger than
+ this threshold will be written to some alternative storage
+ medium, typically a hard disk. Can be expressed as a number
+ followed by a "K", "M", or "G", which are interpreted to
+ mean kilobytes, megabytes, or gigabytes, respectively.
+ ["256K"]
+ </li>
+
<li>
<strong>multipartClass</strong> - The fully qualified Java class name of the
multipart request handler class to be used with this module.
@@ -211,11 +232,9 @@
file uploads.
[{the directory provided by the servlet container}]
</li>
-
+
</ul>
-
-
<p>
This example uses the default values for several controller parameters.
If you only want default behavior you can omit the controller section
@@ -234,15 +253,13 @@
<subsection name="5.2.2 Message Resources Configuration">
<p>
- Struts has built in support for internationalization (I18N).
+ Struts Core has built in support for internationalization (I18N).
You can define one or more <code><message-resources></code> elements
for your webapp; modules can define their own resource bundles.
Different bundles can be used simultaneously in your application, the 'key'
attribute is used to specify the desired bundle.
</p>
-
-
<ul>
<li>
@@ -295,8 +312,8 @@
<subsection name="5.2.3 PlugIn Configuration">
<p>
- Struts PlugIns are configured using the <code><plug-in></code>
- element within the Struts configuration file.
+ Struts Core PlugIns are configured using the <code><plug-in></code>
+ element within the Struts Core configuration file.
This element has only one valid attribute, 'className', which is the fully
qualified name of the Java class which implements the
<code>org.apache.struts.action.PlugIn</code> interface.
@@ -326,7 +343,7 @@
<p>
Very little is required in order to start taking advantage of the Struts
- module feature.
+ Core module feature.
Just go through the following steps:
</p>
@@ -382,7 +399,7 @@
Since Struts 1.0, you listed your configuration file as an initialization
parameter to the action servlet in <code>web.xml</code>.
This is still done since Struts 1.1, but the parameter can be extended.
- In order to tell the Struts machinery about your different modules, you
+ In order to tell the Struts Core machinery about your different modules, you
specify multiple 'config' initialization parameters, with a slight twist.
You'll still use 'config' to tell the ActionServlet about your "default"
module, however, for each additional module, you will
@@ -418,7 +435,7 @@
<p>
(The <code>struts-default.xml</code> would be equivalent to what most folks call
<code>struts-config.xml</code>.
- I just like the symmetry of having all my Struts module configuration files being
+ I just like the symmetry of having all my Struts Core module configuration files being
named <code>struts-<em>module</em>.xml</code>)
</p>
@@ -438,7 +455,7 @@
There are three approaches for switching from one module to another.
You can use the built-in <code>org.apache.struts.actions.SwitchAction</code>,
you can use a <code><forward></code> (global or local) and specify the contextRelative attribute with a value of true,
- or you can specify the "module" parameter as part of any of the Struts hyperlink tags (Include, Img, Link, Rewrite, or Forward).
+ or you can specify the "module" parameter as part of any of the Struts JSP hyperlink tags (Include, Img, Link, Rewrite, or Forward).
</p>
<p>
@@ -544,7 +561,7 @@
<p>
The final step in setting up the application is to configure the
application deployment descriptor (stored in file
- <code>WEB-INF/web.xml</code>) to include all the Struts components that
+ <code>WEB-INF/web.xml</code>) to include all the Struts Core or Taglib components that
are required.
Using the deployment descriptor for the example application as a guide,
we see that the following entries need to be created or modified.
@@ -581,7 +598,7 @@
The initialization parameters supported by the action servlet are
described below.
(You can also find these details in the
- <a href="../struts-core/apidocs/org/apache/struts/action/ActionServlet.html">
+ <a href="../apidocs/org/apache/struts/action/ActionServlet.html">
Javadocs</a> for the ActionServlet class.)
Square brackets describe the default values that are assumed if you do
not provide a value for that initialization parameter.
@@ -590,6 +607,13 @@
<ul>
<li>
+ <strong>chainConfig</strong> - Comma-separated list of either
+ context-relative or classloader path(s) to load commons-chain catalog
+ definitions from. If none specified, the default catalog that is
+ provided with Struts Core will be used. (Since Struts Core 1.3)
+ </li>
+
+ <li>
<strong>config</strong> - Context-relative path to the XML resource
containing the configuration information for the default module.
This may also be a comma-delimited list of configuration files.
@@ -608,6 +632,13 @@
application modules. (Since Struts 1.1)
</li>
+ <li>
+ <strong>configFactory</strong> - The Java class name of the
+ ModuleConfigFactory used to create the implementation of the
+ ModuleConfig interface. (Since Struts Core 1.3)
+ [org.apache.struts.config.impl.DefaultModuleConfigFactory]
+ </li>
+
<li>
<strong>convertNull</strong> - Force simulation of the Struts 1.0
behavior when populating forms.
@@ -631,25 +662,11 @@
process the configuration file (strongly recommended)?
[true]
</li>
-
- <li>
- <strong>configFactory</strong> - The Java class name of the
- <code>ModuleConfigFactory</code> used to create the implementation of the
- <code>ModuleConfig</code> interface.
- [org.apache.struts.config.impl.DefaultModuleConfigFactory]
- </li>
- <li>
- <strong>chainConfig</strong> - Comma-separated list of either
- context-relative or classloader path(s) to load commons-chain catalog
- definitions from. If none specified, the default Struts catalog that is
- provided with Struts will be used. (Since Struts 1.3)
- </li>
-
</ul>
<p>
- <strong>WARNING</strong> - Struts will not
+ <strong>WARNING</strong> - Struts Core will not
operate correctly if you define more than one
<code><servlet></code> element for a controller
servlet, or a subclass of the standard controller servlet class.
@@ -664,11 +681,11 @@
<p>
<strong>Note:</strong> The material in this section is not specific to
- Struts.
+ Struts Core.
The configuration of servlet mappings is defined in the Java Servlet
Specification.
This section describes the most common means of configuring a Struts
- application.
+ Core application.
</p>
<p>
@@ -729,7 +746,7 @@
<source>http://www.mycompany.com/myapplication/logon.do</source>
<p>
- <strong>WARNING</strong> - Struts will not
+ <strong>WARNING</strong> - Struts Core will not
operate correctly if you define more than one
<code><servlet-mapping></code> element for the controller
servlet.
@@ -743,118 +760,13 @@
</subsection>
-<a name="dd_config_taglib"/>
-<subsection name="5.4.3 Configure the Struts Tag Libraries">
-
- <p>
- Next, you must add an entry defining the Struts tag libraries.
- </p>
-
- <p>
- The <a href="dev_bean.html">struts-bean</a> taglib contains tags useful in accessing beans and their
- properties, as well as defining new beans (based on these accesses)
- that are accessible to the remainder of the page via scripting
- variables and page scope attributes.
- Convenient mechanisms to create new beans based on the value of request
- cookies, headers, and parameters are also provided.
- </p>
-
- <p>
- The <a href="dev_html.html">struts-html</a> taglib contains tags used to create Struts input forms,
- as well as other tags generally useful in the creation of HTML-based
- user interfaces.
- </p>
-
- <p>
- The <a href="dev_logic.html">struts-logic</a> taglib contains tags that are useful in managing
- conditional generation of output text,
- looping over object collections for repetitive generation of output
- text, and application flow management.
- </p>
-
- <p>
- The <a href="dev_tiles.html">struts-tiles</a> taglib contains tags used for combining various view
- components, called "tiles", into a final composite view.
- </p>
-
- <p>
- The <a href="dev_nested.html">struts-nested</a> taglib is an extension of other struts taglibs that
- allows the use of nested beans.
- </p>
-
- <p>
- Below is how you would define all Struts taglibs for use within your
- application.
- In practice, you would only specify the taglibs that your application
- uses:
- </p>
-
-<source><![CDATA[
-<taglib>
- <taglib-uri>
- http://struts.apache.org/tags-bean
- </taglib-uri>
- <taglib-location>
- /WEB-INF/struts-bean.tld
- </taglib-location>
-</taglib>
-<taglib>
- <taglib-uri>
- http://struts.apache.org/tags-html
- </taglib-uri>
- <taglib-location>
- /WEB-INF/struts-html.tld
- </taglib-location>
-</taglib>
-<taglib>
- <taglib-uri>
- http://struts.apache.org/tags-logic
- </taglib-uri>
- <taglib-location>
- /WEB-INF/struts-logic.tld
- </taglib-location>
-</taglib>
-<taglib>
- <taglib-uri>
- http://struts.apache.org/tags-tiles
- </taglib-uri>
- <taglib-location>
- /WEB-INF/struts-tiles.tld
- </taglib-location>
-</taglib>
-<taglib>
- <taglib-uri>
- http://struts.apache.org/tags-nested
- </taglib-uri>
- <taglib-location>
- /WEB-INF/struts-nested.tld
- </taglib-location>
-</taglib>
-]]></source>
-
- <p>
- This tells the JSP system where to find the tag library descriptor
- for this library (in your application's <code>WEB-INF</code> directory, instead of
- out on the Internet somewhere).
- </p>
-
-</subsection>
-
<a name="dd_config_taglib_uri"/>
-<subsection name="5.4.3.1 Configure the Struts Tag Libraries (Servlet 2.3/2.4)">
-
- <p>
- <strong>Servlet 2.3/2.4 users only:</strong> The Servlet 2.3 and 2.4 specifications simplify
- the deployment and configuration of tag libraries.
- The instructions above will work on older containers as well as 2.3 and 2.4
- containers (Struts only requires a servlet 2.2 container);
- however, if you're using a 2.3/2.4 container such as Tomcat 4.x/5.x,
- you can take advantage of a simplified deployment.
- </p>
+<subsection name="5.4.3.1 Configure the Struts JSP Tag Libraries (Servlet 2.3/2.4)">
<p>
- All that's required to install the Struts tag libraries is to copy
- <code>struts.jar</code> into your <code>/WEB-INF/lib</code> directory and reference the tags in
+ The Servlet 2.3 and 2.4 specifications simplify the deployment and configuration of tag libraries.
+ All that's now required to install the Struts tag libraries is to copy
+ <code>struts-taglib.jar</code> into your <code>/WEB-INF/lib</code> directory and reference the tags in
your code like this:
</p>
@@ -872,6 +784,10 @@
You don't have to alter your <code>web.xml</code> file or copy tlds into any
application directories.
</p>
+
+ <p>
+ Of course, the configuration techniques use for older containers do still work.
+ </p>
</subsection>
@@ -879,10 +795,11 @@
<subsection name="5.5 Add Struts Components To Your Application">
<p>
- To use Struts, you must copy the .tld files that you require into
- your <code>WEB-INF</code> directory, and copy <code>struts.jar</code>
+ To use Struts Core, you must copy <code>struts.jar</code>
(and all of the <code>commons-*.jar</code> files) into your
- <code>WEB-INF/lib</code> directory.
+ <code>WEB-INF/lib</code> directory. To use Struts Taglib,
+ you must also copy the .tld files that you require into
+ your <code>WEB-INF</code> directory and the struts-taglib.jar.
</p>
<p>
@@ -925,25 +842,25 @@
in the web application's class loader, unless they are specifically
programmed to use the Thread context class loader.
- For example, Struts dynamically loads your action and form bean
+ For example, Struts Core dynamically loads your action and form bean
classes, and normally would not be able to find those classes.
- Struts has been programmed to deal with this in <em>most</em>
+ Struts Core has been programmed to deal with this in <em>most</em>
scenarios, but it has not been thoroughly audited to ensure that
it works in <em>all</em> scenarios. The Commons libraries that
- Struts uses have <strong>NOT</strong> been audited to catch all
+ Struts Core uses have <strong>NOT</strong> been audited to catch all
possible scenarios where this might become a problem.
</li>
<li>
When a class is loaded from a shared class loader, static variables
- used within that class become global as well. This can cause
+ used within that class become global as well. This can cause
inter-webapp conflicts when the underlying code assumes that the
statics are global only within a particular web applicaiton (which
would be true if the class was loaded from the webapp class loader).
- There are many cases where Struts, and the Commons libraries it
+ There are many cases where Struts Core, and the Commons libraries it
relies on, use static variables to maintain information that is
- presumed to be visible only within a single web applicaiton.
+ presumed to be visible only within a single web application.
Sharing these JAR files can cause unwanted interactions, and
probably cause incorrect behavior.
@@ -951,7 +868,7 @@
<li>
When JAR files are shared like this, it is not possible to update
the JAR file versions employed by a single web application without
- updating all of them. In addition, because updating a Struts version
+ updating all of them. In addition, because updating a Struts version
normally requires recompilation of the applications that use it,
you will have to recompile all of your applications as well, instead
of being able to manage them independently.
@@ -960,7 +877,7 @@
<p>
In spite of these difficulties, it is possible that sharing the
- Struts and Commons JAR files <em>might</em> appear to work for you.
+ Struts Core and Commons JAR files <em>might</em> appear to work for you.
However, this is <strong>NOT</strong> a supported configuration.
</p>
@@ -976,14 +893,14 @@
</subsection>
<a name="config_logging"/>
-<subsection name="5.6 Logging in Struts Based Applications">
+<subsection name="5.6 Logging in Struts Core BAsed Applications">
<p>
Since Struts 1.0, the logging functionality was fairly limited. You could
set a debugging detail level with a servlet initialization parameter, and
all log messages were written to wherever <code>ServletContext.log()</code>
output is sent by your servlet container. With Struts 1.1, however, all
- logging messages written by Struts itself, as well as the commons libraries
+ logging messages written by Struts Core itself, as well as the commons libraries
that it utilizes, flow through an abstract wrapper called
<a href="http://jakarta.apache.org/commons/logging">Commons Logging</a>,
which can be used as a wrapper around any logging implementation. The most
@@ -997,17 +914,17 @@
<p>
This section does not attempt to fully explain how Commons Logging is
configured and used. Instead, it focuses on pertinent details of using
- Commons Logging in a Struts based environment. For complete documentation
+ Commons Logging in a Struts Core based environment. For complete documentation
on using Commons Logging, consult the documentation for the logging system
you are using, plus the Commons Logging
- <a href="http://jakarta.apache.org/commons/logging/api/org/apache/commons/logging/package-summary.html#package_description">
+ <a href="http://jakarta.apache.org/commons/logging/commons-logging-1.0.3/docs/api/">
Javadocs</a>.
</p>
<p>
Commons Logging provides fine-grained control over the logging messages
- created by a <code>Log</code> instance. By convention, the <code>Log</code>
- instances for Struts (and the Commons packages in general) are named the
+ created by a <code>Log</code> instance. By convention, the <code>Log</code>
+ instances for Struts Core (and the Commons packages in general) are named the
fully qualified class name of the class whose messages are being logged.
Therefore, log messages created by the <code>RequestProcessor</code> class are, naturally
enough, directed to a logger named
@@ -1054,7 +971,7 @@
<p>
You can seamlessly integrate logging from your own components into the same
- logging implementation that Struts and the Commons libraries use, by
+ logging implementation that Struts Core and the Commons libraries use, by
following the instructions in
<a href="building_controller.html#4_11_Commons_Logging_Interface">
Section 4.11</a>. If you do
Modified: struts/core/trunk/xdocs/userGuide/index.xml
URL: http://svn.apache.org/viewcvs/struts/core/trunk/xdocs/userGuide/index.xml?rev=331677&r1=331676&r2=331677&view=diff
==============================================================================
--- struts/core/trunk/xdocs/userGuide/index.xml (original)
+++ struts/core/trunk/xdocs/userGuide/index.xml Mon Nov 7 19:37:25 2005
@@ -2,7 +2,7 @@
<document url="index.html">
<properties>
- <title>The Struts User's Guide - Table of Contents</title>
+ <title>The Struts Users Guide - Table of Contents</title>
</properties>
<body>
Modified: struts/core/trunk/xdocs/userGuide/installation.xml
URL: http://svn.apache.org/viewcvs/struts/core/trunk/xdocs/userGuide/installation.xml?rev=331677&r1=331676&r2=331677&view=diff
==============================================================================
--- struts/core/trunk/xdocs/userGuide/installation.xml (original)
+++ struts/core/trunk/xdocs/userGuide/installation.xml Mon Nov 7 19:37:25 2005
@@ -2,14 +2,14 @@
<document url="installation.html">
<properties>
- <title>The Struts Framework Project - Installation (1.1)</title>
+ <title>Apache Struts Core Users Guide - Installation (1.1)</title>
</properties>
<body>
<section name="6.2 Installation" href="installation">
<subsection name="Prerequisite Software" href="Prerequisites">
- <p>The Struts binary distribution needs three other software packages installed to
+ <p>The Struts Core binary distribution needs three other software packages installed to
operate. You may already have these installed on your system. To build Struts from
source you may need to acquire and install several others. The complete list is as
follows:</p>
@@ -20,12 +20,13 @@
your operating system platform.
A good starting point for locating Java Development Kit distributions is
<a href="http://java.sun.com/j2se">http://java.sun.com/j2se</a>.
- To build Struts, Java 1.4.2 (the latest production JDK) is suggested. </li>
+ To build Struts, Java 1.4.2 (the latest production JDK) is suggested and
+ required if you use our Maven build system. </li>
<li><strong>Servlet Container</strong> - You <strong>must</strong> download and install a
servlet container that is compatible with the Servlet API Specification,
- version 2.2 or later, and the JavaServer Pages (JSP) Specification,
- version 1.1 or later. One popular choice is to download Apache's
+ version 2.3 or later, and the JavaServer Pages (JSP) Specification,
+ version 1.2 or later. One popular choice is to download Apache's
<a href="http://jakarta.apache.org/tomcat/">Tomcat</a>, but any compliant
container should work well with Struts.</li>
@@ -43,100 +44,32 @@
<a href="#Building">building</a> and <a href="#Installing">installing</a>
Struts, below.</li>
- <li><strong>Ant Build System</strong> - If you are building Struts from the
- source distribution, you must download and install version 1.5.4 (or later)
- of the <a href="http://jakarta.apache.org/ant">Ant</a> build system.
- <ul>
- <li>Make sure that the "ant" and "ant.bat" scripts are executable, by
- adding the $ANT_HOME/bin directory to your PATH environment
- variable.</li>
- <li>
- Copy and review either the "build.properties.sample" or
- "build.properties.sample.lib" file as "build.properties".
- The latter is recommended if you are not active in Jakarta
- Commons development.
- </li>
- <li>
- <a href="http://maven.apache.org/">Maven</a> property files are also
- provided, but the Maven build is still experimental. New developers
- may find Maven easier to use, since it acquires the appropriate JARs
- automatically.
- </li>
- </ul>
- </li>
-
- <li><strong>Servlet API Classes</strong> - In order to compile Struts itself,
- or applications that use Struts, you will need a <code>servlet.jar</code>
- file containing the Servlet and JSP API classes. Most servlet containers
- include this JAR file. Otherwise, you can get the Servlet API classes
- distribution from
- <a href="http://jakarta.apache.org/builds/jakarta-servletapi">here</a>.
- </li>
-
- <li>
- <strong>Other Packages</strong> - Struts utilizes several
- packages from other open source projects, especially the <a href="http://jakarta.apache.org/commons/">Jakarta
- Commons Project</a>.
- These are the packages which must be available if you wish to
- build Struts from source:
- <ul>
- <li><a href="http://www.antlr.org/">ANTLR</a> (Version 2.7.2)</li>
- <li><a href="http://jakarta.apache.org/commons/beanutils/">Jakarta Commons Beanutils</a> (Version 1.7.0)</li>
- <li><a href="http://jakarta.apache.org/commons/digester/">Jakarta Commons Digester</a> (Version 1.6)</li>
- <li><a href="http://jakarta.apache.org/commons/fileupload/">Jakarta Commons FileUpload</a> (Version 1.0)</li>
- <li><a href="http://jakarta.apache.org/commons/logging/">Jakarta Commons Logging</a> (Version 2.0)</li>
- <li><a href="http://jakarta.apache.org/commons/logging/">Jakarta Commons Logging</a> (Version 1.0.4)</li>
- <li><a href="http://jakarta.apache.org/commons/validator/">Jakarta Commons Validator</a> (Version 1.1.3) </li>
- <li><a href="http://jakarta.apache.org/oro/">Jakarta ORO</a> (Version 2.0.7)</li>
- </ul>
- ANTLR is a <a href="http://antlr.org/license.html">public domain library</a>;
- all other libraries are distributed under the
- <a href="http://www.apache.org/licenses/">Apache Software License</a>.
- For your convenience, the requisite JARs are provided as a single
- download under the <code>lib</code> sub-directory with each release
- distribution.
- Please note that the minimum requirements may change between releases,
- and some JARs may need to be updated to use the latest Nightly Build.
- </li>
-
- <li><strong>Xalan XSLT Processor</strong> - If you are building Struts from
- the source distribution, you will need a version of Xalan to perform
- XSLT transformations. If you are using the JAXP/1.1 XML parser, you
- should use the version of <code>xalan.jar</code> shipped with it.
- Otherwise, download and install version 1.2 of Xalan from
- <a href="http://xml.apache.org/xalan">here</a>.
- </li>
-
- <li><strong>Unit tests</strong> - To verify your build against the JUnit and
- Cactus unit tests, three other packages must be available:
- <ul>
- <li><a href="http://jakarta.apache.org/cactus">Jakarta Cactus</a> (Version 1.4.1)</li>
- <li><a href="http://jakarta.apache.org/commons/lang/">Jakarta Commons Lang</a> (Version 2.0)</li>
- <li><a href="http://www.junit.org">JUnit</a> (Version 3.8.1)</li>
- </ul>
+ <li><strong>Maven Build System</strong> - If you are building Struts Core from the
+ source distribution, you must download and install the
+ <a href="http://maven.apache.org/maven-1.x/">Apache Maven 1.1</a> build system.
</li>
</ul>
</subsection>
- <subsection name="Install A Struts Binary Distribution" href="Installing">
+ <subsection name="Install A Struts Core Library Distribution" href="Installing">
- <p>First, download a binary distribution of Struts by following the
- instructions <a href="../acquiring.html">here</a>. Then, make sure
+ <p>First, download a binary distribution of Struts Core Library by following the
+ instructions <a href=".http://struts.apache.org/acquiring.html">here</a>. Then, make sure
you have downloaded and installed the
<a href="#Prerequisites">prerequisite</a> software packages described
above.</p>
- <p>Unpack the Struts binary distribution into a convenient directory.
+ <p>Unpack the Struts Core Library distribution into a convenient directory.
(If you <a href="#Building">build Struts from the source distribution</a>,
the result of the build will already be an unpacked binary distribution
for you). The distribution consists of the following contents:</p>
<ul>
- <li><strong>lib/*.jar</strong> - The struts.jar contains the Java classes
- distributed by the Struts project. The other JAR files contain packages
- from other projects that are imported by Struts. When you launch
+ <li><strong>lib/*.jar</strong> - The struts-*.jars contains Java classes
+ distributed by Apache Struts. The other JAR files contain packages
+ from other projects that are imported by Struts subprojects. When you launch
a Struts-based application, these JARs need to be available to your
application, usually by copying them to the application's
<code>WEB-INF/lib</code> directory. <br />
@@ -148,52 +81,31 @@
your application classes are stored in the shared repository.</li>
<li><strong>lib/*.tld</strong> - These are the "tag library
descriptor" files that describe the custom tags in the various Struts
- tag libraries. The tld file for any Struts taglibs that you use should
+ JSP tag libraries. The tld file for any Struts taglibs that you use should
be copied into the <code>WEB-INF</code> directory of your web
- application. (Applications under Servlet 2.3 containers can omit this
+ application. (You can omit this
step if the <a href="configuration.html#dd_config_taglib_23">standard uri</a>
is referenced.)</li>
<li><strong>webapps/struts-blank.war</strong> - This is a simple "web
application archive" file containing a basic starting point for
building your own Struts-based applications.</li>
- <li><strong>webapps/struts-documentation.war</strong> - This is a
- "web application archive" file containing all of the Struts
- documentation found on the
- <a href="http://struts.apache.org/">Struts web site</a>
- (including these pages). You can install this web application
- on any servlet container compatible with Servlet API 2.2 or later.</li>
- <li><strong>webapps/struts-examples.war</strong> - This "modular"
- applications combines several usefule demonstrations:
- <ul><li>Exercise-Taglib - This application module contains test pages for
- the various custom tags distributed with Struts. It is primarily of use to
- developers who are enhancing the Struts custom tag libraries, but may also
- be useful as simple examples of the usage of various Struts tags.</li>
- <li><strong>Upload</strong> - This application module
- is a quick example of uploading files using the Struts framework.
- </li>
- <li><strong>Validator</strong> - This application module
- is an example of using the validator framework, using both the
- server-side and optional client-side validation.
- </li></ul></li>
<li><strong>webapps/struts-mailreader.war</strong> - This is an example
web application that uses a large percentage of Struts features.
You can install this web application on any servlet container
- compatible with the Servlet 2.2 (or later) and JSP 1.1 (or later)
- specifications. If an XML parser is not made available to web
+ compatible with the Servlet 2.2 (or later) and JSP 1.2 (or later)
+ specifications. If an XML parser is not made available to web
applications by your container, you will need to add one to the
WEB-INF/lib directory of this web application.</li>
- <li><strong>webapps/tiles-documentation.war</strong> - This web
- application documents how to use tiles, and was developed using tiles.</li>
</ul>
- <p>To use Struts in your own application, you will need to follow
+ <p>To use Struts Core Library in your own application, you will need to follow
these steps:</p>
<ul>
<li>Copy the <code>lib/*.jar</code> files from the Struts
- distribution into the <code>WEB-INF/lib</code> directory of your
+ Core Library distribution into the <code>WEB-INF/lib</code> directory of your
web application.</li>
<li>Copy the <code>lib/*.tld</code> files for any Struts taglibs you use
- from the Struts distribution into the <code>WEB-INF</code> directory
+ from the Library distribution into the <code>WEB-INF</code> directory
of your web application.</li>
<li>Modify the <code>WEB-INF/web.xml</code> file for your web application
to include a <code><servlet></code> element to define the
@@ -201,35 +113,12 @@
to establish which request URIs are mapped to this servlet. Use the
<code>WEB-INF/web.xml</code> file from the Struts example application
for a detailed example of the required syntax.</li>
- <li>Modify the <code>WEB-INF/web.xml</code> file of your web application
- to include the following tag library declarations (Servlet 2.3 can omit
- this step if the <a href="configuration.html#dd_config_taglib_23">standard uri</a>
- is referenced):</li>
- </ul>
-
-<pre><taglib>
- <taglib-uri>/WEB-INF/struts-bean.tld</taglib-uri>
- <taglib-location>/WEB-INF/struts-bean.tld</taglib-location>
-</taglib>
-
-<taglib>
- <taglib-uri>/WEB-INF/struts-html.tld</taglib-uri>
- <taglib-location>/WEB-INF/struts-html.tld</taglib-location>
-</taglib>
-
-<taglib>
- <taglib-uri>/WEB-INF/struts-logic.tld</taglib-uri>
- <taglib-location>/WEB-INF/struts-logic.tld</taglib-location>
-</taglib>
-</pre>
-
- <ul>
<li>Create a file <code>WEB-INF/struts-config.xml</code> that defines the
action mappings and other characteristics of your specific application.
You can use the <code>struts-config.xml</code> file from the Struts
- example application for a detailed example of the required syntax.</li>
- <li>At the top of each JSP page that will use the Struts custom tags,
- add line(s) declaring the Struts custom tag libraries used on
+ Blank application for examples of the required syntax.</li>
+ <li>At the top of each JSP page that will use the Struts JST tags,
+ add line(s) declaring the Struts JSP tag libraries used on
this particular page, like this:</li>
</ul>
@@ -243,7 +132,7 @@
to include the JAR files (copied earlier) on the
CLASSPATH that is submitted to the compiler.</li>
</ul>
-</subsection> <subsection name="Installing Struts With Your Servlet Container" href="Containers">
+</subsection> <subsection name="Installing Struts Core With Your Servlet Container" href="Containers">
<p>For most containers, you need only to: </p>
<ul>
@@ -252,13 +141,13 @@
<li>In some cases, you may need to restart your container if it is running.</li>
</ul>
-<h4>Running Struts Applications Under A Security Manager</h4>
+<h4>Running Struts Core Applications Under A Security Manager</h4>
<p>Many application servers execute web applications under the control of a
Java security manager, with restricted permissions on what classes in the web
application can do. If you utilize form beans with mapped properties, you may
encounter security exceptions unless you add the following permission to the
-set of permissions granted to your Struts application's codebase:</p>
+set of permissions granted to your Struts Core application's codebase:</p>
<pre>
permission java.lang.RuntimePermission "accessDeclaredMembers";
</pre>
@@ -266,14 +155,14 @@
<p>Consult the documentation on your application server for more information
about how to configure additional security manager permissions.</p>
-<h4>Installing Struts on Various Containers</h4>
+<h4>Installing Struts Core on Various Containers</h4>
<ul>
<li>Bluestone Universal Business Server 7.2 - <a href="installation-ubs72.html">Additional
steps required.</a></li>
<li>Borland Application Server 4.5 -No additional
steps required.</li>
<li>iPlanet Application Server - Service Pack 2 is recommended. Note that the database
- object in the Struts-Example application is not compatible with this container.</li>
+ object in the Struts MailReader application is not compatible with this container.</li>
<li>iPlanet Web Server - <a href="installation-ip.html">Additional steps required.</a></li>
<li>iPortal Application Server - <a href="installation-ipas.html">Additional steps required.</a></li>
<li>Jetty - <a href="installation-jetty.html">Additional steps required.</a></li>
@@ -297,84 +186,26 @@
<li>WebSphere - <a href="installation-was352-x.html">Steps for the Example Application.</a></li></ul>
</subsection>
-<subsection name="Building Struts From Source" href="Building">
+<subsection name="Building Struts Core From Source" href="Building">
- <p>First, download a source distribution of Struts by following the
- instructions <a href="../acquiring.html">here</a>. Then, make sure
- you have downloaded and installed <strong>all</strong> of the
- <a href="#Prerequisites">prerequisite</a> software packages described
- above.</p>
-
- <p>To build Struts, you will need to customize the build process to the
- details of your development environment as follows:</p>
- <ul>
- <li>The Struts source distribution uses a file named
- <code>build.properties</code> (in the top-level directory of the
- distribution) to identify the location of external components
- that Struts depends on.</li>
- <li>There is no <code>build.properties</code> file included with the
- source distribution. However, there is an example file named
- <code>build.properties.example</code> that you can copy to
- <code>build.properties</code> and then customize.</li>
- <li>The properties you must configure in <code>build.properties</code> are:
- <ul>
- <li><strong>catalina.home</strong> - Pathname to the directory of your
- binary distribution of Tomcat 4.0 (required only if you wish to
- use the <code>deploy.catalina</code> target).</li>
- <li><strong>commons-beanutils.jar</strong> - Pathname of the BeanUtils
- package JAR file from the Jakarta Commons project.</li>
- <li><strong>commons-collections.jar</strong> - Pathname of the
- Collections package JAR file from the Jakarta Commons project.</li>
- <li><strong>commons-digester.jar</strong> - Pathname of the
- Digester package JAR file from the Jakarta Commons project.</li>
- <li><strong>commons-fileupload.jar</strong> - Pathname of the
- Fileupload package JAR file from the Jakarta Commons project.</li>
- <li><strong>commons-lang.jar</strong> - Pathname of the
- Lang package JAR file from the Jakarta Commons project.</li>
- <li><strong>commons-logging.jar</strong> - Pathname of the
- Logging package JAR file from the Jakarta Commons project.</li>
- <li><strong>commons-validator.jar</strong> - Pathname of the
- Validator package JAR file from the Jakarta Commons project.</li>
- <li><strong>servletapi.home</strong> - Pathname to the directory of
- your binary distribution of the Servlet API classes.</li>
- <li><strong>tomcat.home</strong> - Pathname to the directory of your
- binary distribution of Tomcat 3.2 (required only if you wish to
- use the <code>deploy.tomcat</code> target).</li>
- <li><strong>xerces.home</strong> - Pathname to the directory of your
- binary distribution of the Xerces parser, version 1.2 or 1.3
- (required only if you wish to use the <code>deploy.catalina</code>
- target).</li>
- </ul></li>
-
-
- <li>If you are a Struts developer with write access to the CVS repository,
- be sure that you do <strong>NOT</strong> check in a copy of the
- <code>build.properties</code> file, since it will be different for
- each individual developer.</li>
- </ul>
-
- <p>To build a "distribution" version of Struts, first change your current
- directory to the directory in which you have unpacked the Struts
- source distribution, and (if necessary) create or customize the
- <code>build.properties</code> file as described above. Then, type:</p>
-<pre>
- ant dist
-</pre>
-
- <p>This command will create a binary distribution of Struts, in a
- directory named <code>dist</code> (relative to where you
- are compiling from). This directory contains an exact replica of the
- files included in a binary distribution of Struts, as described
- in the <a href="#Installing">preceding section</a>.</p>
-
- <p>IMPORTANT NOTE: The <code>struts.jar</code>, as well as the JAR files
- from the Jakarta Commons project, must be in your classpath when
- compiling Struts. The <code>build.xml</code> provided does this
- automatically. If you use your development machine to test Struts
- application locally, be sure that the <code>struts.jar</code> is
- <strong>NOT</strong> on your classpath when your container is running.
+ <p>
+ First, download a source distribution of a Struts subproject by following the
+ instructions <a href="http://struts.apache.org/acquiring.html">here</a>. Then, make sure
+ you have downloaded and installed <a href="http://maven.apache.org/maven-1.x/">Apache Maven 1.1</a>
</p>
+
+ <p>
+ Change to the subproject you would like to build, and invoke
+ </p>
+
+ <source>maven build</source>
+
+ <p>
+ Go to the \build directory and run the command
+ </p>
+ <source>$maven build-all</source>
+
</subsection>
<subsection>
Modified: struts/core/trunk/xdocs/userGuide/introduction.xml
URL: http://svn.apache.org/viewcvs/struts/core/trunk/xdocs/userGuide/introduction.xml?rev=331677&r1=331676&r2=331677&view=diff
==============================================================================
--- struts/core/trunk/xdocs/userGuide/introduction.xml (original)
+++ struts/core/trunk/xdocs/userGuide/introduction.xml Mon Nov 7 19:37:25 2005
@@ -2,7 +2,7 @@
<document url="introduction.html">
<properties>
- <title>The Struts User's Guide - Introduction</title>
+ <title>The Struts Users Guide - Introduction</title>
</properties>
<body>
Modified: struts/core/trunk/xdocs/userGuide/preface.xml
URL: http://svn.apache.org/viewcvs/struts/core/trunk/xdocs/userGuide/preface.xml?rev=331677&r1=331676&r2=331677&view=diff
==============================================================================
--- struts/core/trunk/xdocs/userGuide/preface.xml (original)
+++ struts/core/trunk/xdocs/userGuide/preface.xml Mon Nov 7 19:37:25 2005
@@ -2,7 +2,7 @@
<document url="preface.html">
<properties>
- <title>The Struts Core User's Guide - Preface: Core Technologies</title>
+ <title>The Struts Core Users Guide - Preface: Core Technologies</title>
</properties>
<body>
Modified: struts/core/trunk/xdocs/userGuide/release-notes.xml
URL: http://svn.apache.org/viewcvs/struts/core/trunk/xdocs/userGuide/release-notes.xml?rev=331677&r1=331676&r2=331677&view=diff
==============================================================================
--- struts/core/trunk/xdocs/userGuide/release-notes.xml (original)
+++ struts/core/trunk/xdocs/userGuide/release-notes.xml Mon Nov 7 19:37:25 2005
@@ -1,7 +1,7 @@
<?xml version="1.0"?>
<document url="release-notes.html">
<properties>
- <title>Struts Release Notes (since 1.2.7)</title>
+ <title>Apach Struts Core User Guide - Release Notes (since 1.2.7)</title>
</properties>
<body>
<section name="6.1 Release Notes - Version 1.3.0-dev">
@@ -51,25 +51,25 @@
to join us.
</p>
- <h3>Struts Classic</h3>
+ <h3>Struts Core Library</h3>
<p>
Since Struts 1.2.7, we have subdivided Struts into several subprojects,
each with its own release cycle.
- The codebases that were part of Struts 1.2.7 will inherit version 1.3.0,
- but, hereafter, subproject revisions will increment independently of each other.
+ The set of seven subprojects derived from Struts 1.2 is sometimes referred to as "Struts Classic".
+ The Struts Classic subprojects are Applications, Core, EL, Extras, Site, Taglibs, and Tiles.
+ These subprojects will all inherit version 1.3.0, but, thereafter,
+ subproject revisions will increment independently of each other.
</p>
<p>
- Since many teams will use more than one Struts subproject,
- we are bundling several of the subprojects in a single distribution
- called "Struts Classic".
- The seven subprojects included in the Struts Classic 1.3.0 distribution
- are: Applications, Core, EL, Plugins, Site, Taglibs, and Tiles.
+ Since many teams will use Struts Core with one or more Struts subprojects,
+ we are bundling the jars for subprojects that utilize Struts Core into a single distribution
+ called "Struts Core Library".
</p>
<p>
- The Struts website and Struts Classic distribution are being built with Maven.
+ The Struts subprojects, including the website, are being built with Maven.
But, of course, you can continue to build your own projects any way you like!)
</p>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
For additional commands, e-mail: dev-help@struts.apache.org