husted 01/09/17 18:39:51
Modified: doc todo-1.1.xml project.xml installation.xml index.xml
Log:
Minor tweaks to home page; refactor installation pages to put binary instructions
first; update TODO list to reflect current task status.
Revision Changes Path
1.6 +100 -119 jakarta-struts/doc/todo-1.1.xml
Index: todo-1.1.xml
===================================================================
RCS file: /home/cvs/jakarta-struts/doc/todo-1.1.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- todo-1.1.xml 2001/07/26 04:05:35 1.5
+++ todo-1.1.xml 2001/09/18 01:39:51 1.6
@@ -13,25 +13,48 @@
<p>Application frameworks, like the applications we build with them,
never seem to be completed. The following major areas of improvement
- are being considered for implementation in version <strong>1.1</strong>
- of Struts, with work to begin as soon as version 1.0 is released.</p>
+ are being considered for implementation in a future version
+ of Struts. </p>
+ <p>Which features are implemented first depends greatly on
+ individual developers becoming involved in the process. Many key
+ features in Struts grew out of code first distributed on the mailing
+ list. If there is a feature here that you need, or already have, please
+ start a thread and show us the code!</p>
+
+ <p align="center"><a href="userGuide/kickstart.html#release"><b>So, when is the
next release coming out?</b></a></p>
+
<p>An external development that is likely to affect the development of
Struts 1.1 will be the emerging Standard Tag Library, being produced under
- the Java Community Process (see JSR #52 for more information), at
- <a href="http://java.sun.com/jcp";>http://java.sun.com/jcp</a>. The existing
- Struts tags will certainly be used as input to the standardization process,
+ the <a href="http://www.jcp.org/jsr/detail/52.jsp";>Java Community Process</a>.
+ A very early release is now available at
+ <a href="http://jakarta.apache.org/taglibs/doc/jsptl-doc/intro.html";>Jakarta
+ Taglibs</a>.</p>
+
+ <p>The existing Struts tags were used as input to the standardization process,
but in the case where standard tags with similar functionality are adopted,
we should migrate Struts tags to maintain maximum compatibility with the
new standard library.</p>
+ </section>
+
+ <section name="Pending Tasks" href="pending">
+
+ <ul>
+ <li><a href="proposal-workflow.html">Workflow</a></li>
+ <li><a href="http://husted.com/about/struts/struts-security.htm";>Role Based
Actions</a></li>
+ <li><a href="http://husted.com/about/struts/logic-niallp.htm";>If/Else/Switch
tags</a></li>
+ <li><a href="http://husted.com/about/struts/codemaker.htm";>Code generator</a></li>
+ </ul>
+
+ <p>See also the Tiles, Validator, and Service Manager packages in the contrib
folder.</p>
+
<p>The TODO list tasks are divided into functional areas that correspond
to the major components of the Struts Framework. References in square
brackets are the Java package containing the corresponding source code.</p>
</section>
-
<task-list name="Struts Documentation" href="Docs">
<info>
@@ -39,6 +62,32 @@
which do not have direct relationships with code bases.</p>
</info>
+ <task name="TODO stylesheet">
+ <info>
+ Revise TODO stylesheet to add Status and Source elements, and to support
mailto
+ links for volunteers in Assigned element. All elements should support
hypertext
+ links.
+ </info>
+ </task>
+
+ <task name="Taglib stylesheet">
+ <info>
+ Add support for "since" element for tracking changes to tags between versions.
+ </info>
+ </task>
+
+ <task name="Contribution Reviews">
+ <info>
+ Area to post articles about contributions from Struts developers.
+ </info>
+ </task>
+
+ <task name="Expanded FAQ">
+ <info>
+ Area to post a "choice" FAQ of truly common questions.
+ </info>
+ </task>
+
</task-list>
@@ -55,7 +104,7 @@
easy to install.</p>
</info>
<assigned>
- <a href="mailto:[EMAIL PROTECTED]";>Ted Husted</a>
+ <a href="mailto:[EMAIL PROTECTED]";>Ted Husted</a>
</assigned>
</task>
@@ -66,7 +115,7 @@
example application.</p>
</info>
<assigned>
- <a href="mailto:[EMAIL PROTECTED]";>Ted Husted</a>
+ <a href="mailto:[EMAIL PROTECTED]";>Ted Husted</a>
</assigned>
</task>
@@ -106,6 +155,7 @@
would be provided by a set of standard <code>Actions</code>, and
will offer an alternative mechanism (not a replacement of Actions)
to organizing your business logic.</p>
+ <p><a href="proposal-workflow.html"><b>A Workflow Proposal is
pending.</b></a></p>
</info>
<assigned>
<a href="mailto:[EMAIL PROTECTED]";>Craig Tataryn</a>,
@@ -113,18 +163,6 @@
</assigned>
</task>
- <task name="Standard Validations">
- <info>
- <p>Add the ability to configure standard validations on particular
- properties to be enforced by the controller servlet automatically.
- Where feasible, client-side JavaScript validations may also be
- generated based on the same configuration rules.</p>
- </info>
- <assigned>
- <a href="mailto:[EMAIL PROTECTED]";>Dave Winterfeldt</a>
- </assigned>
- </task>
-
<task name="PropertyEditor Support">
<info>
<p>Add support for JavaBeans that include a <code>PropertyEditor</code>
@@ -143,9 +181,11 @@
work items on this list (such as workflow processing and standard
validations), so work on this should be coordinated with those
changes.</p>
+ <p>
[STRUTS-DEV, Robert Leland, 10/10/2000]
[STRUTS-DEV, David Geary, 12/20/2000]
[STRUTS-USER, Ted Husted, 12/23/2000]
+ </p>
</info>
</task>
@@ -165,8 +205,10 @@
<p>Improve the current Struts support for generating no-cache headers
to provide finer-grained, configurable control on a per-page basis.
</p>
+ <p>
[STRUTS-DEV, Hou Yunfeng, 10/07/2000]
[STRUTS-DEV, Matthias Kerkhoff, 11/18/2000]
+ </p>
</info>
</task>
@@ -175,7 +217,12 @@
<p>Add the ability to require the current user to be in a particular
security role before they can execute a particular action.
</p>
+ <p>
+ <a href="http://husted.com/about/struts/struts-security.htm";><b>A proposed
extension is available.</b></a>
+ </p>
+ <p>
[STRUTS-DEV, James W., 01/23/2001]
+ </p>
</info>
<assigned>
<a href="mailto:[EMAIL PROTECTED]";>Nic Hobbs</a>
@@ -184,29 +231,6 @@
</task-list>
-
- <task-list name="XML Digester [org.apache.struts.digester]" href="Digester">
-
- <info>
- <p>The Digester package supports scripted firing of "rules" based on
- matching a particular pattern of nested XML tags. Among the predefined
- rules that can be utilized are rules to create new objects, set bean
- properties from the contents of attributes, or call arbitrary methods
- with arguments based on the XML content being parsed. A common
- use for this technology (illustrated in the Struts ActionServlet), is
- parsing configuration files and building corresponding object trees.</p>
- </info>
-
- <task name="Developer Documentation">
- <info>
- <p>Create more detailed documentation of how the Digester package
- can be utilized by application developers.</p>
- </info>
- </task>
-
- </task-list>
-
-
<task-list name="Bean Tag Library [org.apache.struts.taglib.bean]"
href="BEAN">
@@ -240,7 +264,7 @@
</assigned>
</task>
- <task name="JDBC RowSet Support">
+ <task name="XML DOM / JDBC RowSet Support">
<info>
<p>Update all of the relevant tags to get and set attributes from a
JDBC RowSet (or ResultSet) object, as well as from XML DOM objects and
@@ -258,10 +282,12 @@
<p>Add the ability to use formatting patterns (suitably localized) for
presenting numbers, dates, times, timestamps, and so on via formatted
patterns.</p>
+ <p>
[STRUTS-DEV, Oleg Alexeev, 10/27/2000]
[STRUTS-USER, Ned Seagoon, 12/11/2000]
[STRUTS-DEV, Ned Seagoon, 12/13/2000]
[STRUTS-USER, Ned Seagoon, 01/04/2001]
+ </p>
</info>
<assigned>
<a href="mailto:[EMAIL PROTECTED]";>Dave Bettin</a>
@@ -280,27 +306,13 @@
support for internationalized and localized applications.</p>
</info>
- <task name="Client Side Validation">
- <info>
- <p>Add the ability to automatically generate optional JavaScript code
- to perform client-side validations for things like required fields,
- numeric fields, dates/times/timestamps, and so on. The required
- validation should mesh with validation enhancements provided in the
- controller servlet itself.</p>
- [STRUTS-DEV, David Winterfeldt, 07/27/2000]
- </info>
- <assigned>
- <a href="mailto:[EMAIL PROTECTED]";>Ted Husted</a>,
- <a href="mailto:[EMAIL PROTECTED]";>Dave Winterfeldt</a>,
- <a href="mailto:[EMAIL PROTECTED]";>Spencer Smith</a>
- </assigned>
- </task>
-
<task name="Radio Button Groups">
<info>
<p>Add a new tag that supports generation of groups of radio buttons.
</p>
+ <p>
[STRUTS-DEV, Wellington Silva, 08/28/2000]
+ </p>
</info>
</task>
@@ -308,21 +320,12 @@
<info>
<p>Improve the mechanism by which you define values and corresponding
labels for <code><html:options></code>.</p>
+ <p>
[STRUTS-DEV, David Winterfeldt, 07/27/2000]
[STRUTS-DEV, David Winterfeldt, 08/02/2000]
[STRUTS-DEV, Andy Boyko, 11/15/2000]
[STRUTS-DEV, Andy Boyko, 12/07/2000]
- </info>
- </task>
-
- <task name="Improve Error Reporting">
- <info>
- <p>Improve the ability of the <code><html:errors></code> tag
- to present error messages, especially property-specific messages.
</p>
- [STRUTS-DEV, Oleg Alexeev, 10/23/2000]
- [STRUTS-DEV, Oleg Alexeev, 11/15/2000]
- [STRUTS-DEV, Oleg Alexeev, 01/01/2001]
</info>
</task>
@@ -331,7 +334,9 @@
<p>Support additional HTML 4.0.1 attributes (such as "disabled",
"readonly", "wrap" on textarea)
where appropriate.</p>
+ <p>
[STRUTS-USER, , 08/23/2000]
+ </p>
</info>
</task>
@@ -343,8 +348,10 @@
A significant use case is master-detail relationships (say, a
customer and their current orders) where you allow editing of any
and all fields.</p>
+ <p>
[STRUTS-USER, Lars, 12/06/2000]
[STRUTS-USER, Chandan Kulkarni, 12/26/2000]
+ </p>
</info>
</task>
@@ -360,27 +367,6 @@
</task-list>
-
- <task-list name="JDBC Tag Library [org.apache.struts.taglib.jdbc]"
- href="JDBC">
-
- <info>
- <p>This tag library will provide mechanisms to acquire information from
- a database that is useful in the presentation logic of an application
- (such as populating the values shown in an HTML <code>select</code>
- element). They will interact with a data source object created and
- initialized by the controller servlet.</p>
- </info>
-
- <task name="Create Tag Library">
- <info>
- <p>Create the initial tag library and documentation.</p>
- </info>
- </task>
-
- </task-list>
-
-
<task-list name="Logic Tag Library [org.apache.struts.taglib.logic]"
href="Logic">
@@ -389,27 +375,29 @@
nested body content based on a variety of logical conditions.</p>
</info>
- <task name="'Else' and 'Else If' Capability">
+ <task name="'Else' and 'Else If' Capability and Other Conditional Structures">
<info>
<p>Add "else" and "else if" constructs to the existing conditional
tags, in some reasonable format.</p>
- [STRUTS-DEV, Eduardo Pelegri-Llopart, 06/14/2000]
- [STRUTS-DEV, Frank Nestel, 06/26/2000]
- </info>
- </task>
-
- <task name="Other Conditional Structures">
- <info>
<p>Add conditional tags that emulate the "case" or "switch"
capability of many programming languages.</p>
+ <p>NOTE: Pending the outcome of the JSPTL, this functionality will
+ <b>not</b> be added to the Struts-Logic tags. However, a
+ <a href="http://husted.com/about/struts/logic-niallp.htm";><b>contributor
+ taglib</b></a> is available.</p>
</info>
+ <assigned>
+ <a href="mailto:[EMAIL PROTECTED]";>Niall Pemberton</a>
+ </assigned>
</task>
<task name="Iterating Parallel Collections">
<info>
<p>Enhance <code><logic:iterate></code>, or provide a new
tag, to iterate over multiple collections in parallel.</p>
+ <p>
[STRUTS-DEV, Jeff R., 08/03/2000]
+ </p>
</info>
</task>
@@ -473,10 +461,15 @@
<p>Create a tool that takes an XML-based description of the
properties of the form bean, and automatically generates
the corresponding Java class.</p>
+ <p><a href="http://husted.com/about/struts/codemaker.htm";><b>A
+ contributor extension is now available.</b></a></p>
+ <p>
[STRUTS-DEV, Mark Wutka, 06/01/2000 and 06/16/2000]
+ </p>
</info>
<assigned>
<a href="mailto:[EMAIL PROTECTED]";>Martin Cooper</a>
+ <a href="[EMAIL PROTECTED]">Ravindran Ramaiah</a>
</assigned>
</task>
@@ -495,16 +488,9 @@
<p>Implementation of <code>MessageResources</code> and
<code>MessageResourcesFactory</code> that loads message keys
and strings from one or more XML resources or files.</p>
+ <p>
[STRUTS-DEV, Scott Sayles, 01/07/2000]
- </info>
- </task>
-
- <task name="GenericDataSource Improvements">
- <info>
- <p>Improve the connection pool implementation by including checking
- for dead connections before a connection is returned. (The means
- used for checking needs to be configurable somehow).</p>
- [STRUTS-USER, David Winterfeldt, 01/04/2001]
+ </p>
</info>
</task>
@@ -515,13 +501,13 @@
values that implement <code>Collection</code>, <code>List</code>, or
<code>Set</code>, treating them in a manner similar to the way that
indexed or array-valued properties are handled.</p>
+ <p>
[Bugzilla #640]
+ </p>
</info>
</task>
-
</task-list>
-
<task-list name="Unit Test Suites" href="Unit Tests">
<info>
@@ -547,12 +533,6 @@
</info>
</task>
- <task name="Digester">
- <info>
- <p>Unit tests for the <code>org.apache.struts.digester</code> package.</p>
- </info>
- </task>
-
<task name="Taglib.Bean">
<info>
<p>Unit tests for the <code>org.apache.struts.taglib.bean</code>
package.</p>
@@ -616,7 +596,7 @@
[STRUTS-DEV, Phil Grimm, 11/22/2000]
</info>
<assigned>
- <a href="mailto:[EMAIL PROTECTED]";>Ted Husted</a>
+ <a href="mailto:[EMAIL PROTECTED]";>Ted Husted</a>
</assigned>
</task>
@@ -638,10 +618,11 @@
<task name="Proposal">
<info>
- <p>Detailed proposal with implementation plan. [STRUTS-USER, Ned Seagoon,
12/22/2000]</p>
+ <p>Detailed proposal with implementation plan.</p>
+ <p> [STRUTS-USER, Ned Seagoon, 12/22/2000]</p>
</info>
<assigned>
- <a href="mailto:[EMAIL PROTECTED]";>Ted Husted</a>
+ <a href="mailto:[EMAIL PROTECTED]";>Ted Husted</a>
</assigned>
</task>
1.11 +5 -0 jakarta-struts/doc/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-struts/doc/project.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- project.xml 2001/09/17 19:55:29 1.10
+++ project.xml 2001/09/18 01:39:51 1.11
@@ -13,6 +13,11 @@
<item name="Who We Are" href="userGuide/volunteers.html"/>
</menu>
+ <menu name="Downloads">
+ <item name="Binaries"
href="http://jakarta.apache.org/site/binindex.html"/>
+ <item name="Source Code"
href="http://jakarta.apache.org/site/sourceindex.html"/>
+ </menu>
+
<menu name="Getting Started">
<item name="Installation" href="installation-1.0.html"/>
<item name="Release Notes" href="release-notes-1.0.html"/>
1.12 +106 -98 jakarta-struts/doc/installation.xml
Index: installation.xml
===================================================================
RCS file: /home/cvs/jakarta-struts/doc/installation.xml,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- installation.xml 2001/09/17 19:55:29 1.11
+++ installation.xml 2001/09/18 01:39:51 1.12
@@ -12,22 +12,37 @@
<section name="Prerequisite Software" href="Prerequisites">
- <p>In order to build a Struts source distribution, or install and use a
- Struts binary distribution, you will need to acquire and install several
- other software packages, as follows:</p>
+ <p>The Struts 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>
<ul>
- <li><strong>Java Development Kit</strong> - You must download and install
+ <li><strong>Java Development Kit</strong> - You <b>must</b> download and install
a Java2 (version 1.2 or later) Java Development Kit implementation for
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>.</li>
- <li><strong>Servlet Container</strong> - You must download and install a
+
+ <li><strong>Servlet Container</strong> - You <b>must</b> 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
<a href="http://jakarta.apache.org/tomcat";>Tomcat</a> (version 3.1
or later required, version 3.2 or later recommended).</li>
+
+ <li><strong>XML Parser</strong> - Struts <b>requires</b> the presence of an XML
+ parser that is compatible with the Java API for XML Parsing (JAXP)
+ specification, 1.1 or later. You can download and install the JAXP
+ <a href="http://java.sun.com/xml";>reference implementation</a>,
+ which is required for building the Struts source distribution. In
+ Struts-based web applications, you may replace the reference
+ implementation classes with any other JAXP compliant parser, such as
+ <a href="http://xml.apache.org/xerces-j";>Xerces</a>. See detailed
+ instructions related to the parser in the instructions for
+ <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.3 or later
of the <a href="http://jakarta.apache.org/ant";>Ant</a> build system.
@@ -41,6 +56,7 @@
adding the $ANT_HOME/bin directory to your PATH environment
variable.</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
@@ -48,35 +64,27 @@
distribution from
<a href="http://jakarta.apache.org/builds/jakarta-servletapi";>here</a>.
</li>
+
+ <li><strong>JDBC 2.0 Optional Package Classes</strong> - Struts supports
+ an optional implementation of <code>javax.sql.DataSource</code>, so it
+ requires the API classes to be compiled. They can be downloaded from
+ <a
href="http://java.sun.com/products/jdbc/download.html";>http://java.sun.com/products/jdbc/download.html</a>.</li>
+
<li><strong>Jakarta Commons Packages</strong> - Struts utilizes several
packages from the <a href="http://jakarta.apache.org/commons/";>Jakarta
- Commons Project</a>. If you are utilizing a binary distriubtion of
+ Commons Project</a>. If you are utilizing a binary distribution of
Struts, the corresponding JAR files are included in the <code>lib</code>
- directory. However, if you wish to build Struts from source, you will
+ directory. However, if you wish to build Struts from source, you will
need to download and install the following packages:
<ul>
<li><em>Beanutils</em> (Version 1.0 or later)</li>
<li><em>Collections</em> (Version 1.0 or later)</li>
<li><em>Digester</em> (Version 1.0 or later)</li>
</ul></li>
- <li><strong>JDBC 2.0 Optional Package Classes</strong> - Struts supports
- an optional implementation of <code>javax.sql.DataSource</code>, so it
- requires the API classes to be compiled. They can be downloaded from
- <a
href="http://java.sun.com/products/jdbc/download.html";>http://java.sun.com/products/jdbc/download.html</a>.</li>
- <li><strong>XML Parser</strong> - Struts requires the presence of an XML
- parser that is compatible with the Java API for XML Parsing (JAXP)
- specification, 1.1 or later. You can download and install the JAXP
- <a href="http://java.sun.com/xml";>reference implementation</a>,
- which is required for building the Struts source distribution. In
- Struts-based web applications, you may replace the reference
- implementation classes with any other JAXP compliant parser, such as
- <a href="http://xml.apache.org/xerces-j";>Xerces</a>. See detailed
- instructions related to the parser in the instructions for
- <a href="#Building">building</a> and <a href="#Installing">installing</a>
- Struts, below.</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
+ 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>
@@ -84,89 +92,18 @@
</section>
- <section name="Building Struts From Source" href="Building">
-
- <p>First, download a source distribution of Struts by following the
- instructions <a href="index.html#Acquiring">here</a>. Then, make sure
- you have downloaded and installed all 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>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 following section.</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>stuts.jar</code> is
- <strong>NOT</strong> on your classpath when your container is running.
- </p>
-
-
- </section>
-
<section name="Install A Struts Binary Distribution" href="Installing">
<p>First, download a binary distribution of Struts by following the
instructions <a href="index.html#Acquiring">here</a>. Then, make sure
- you have downloaded and installed all of the
+ 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.
- (If you build Struts from the source distribution, the result of the
- build will already be an unpacked binary distribution for you). The
- distribution consists of the following contents:</p>
+ (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/commons-*.jar</strong> - These JAR files contain packages
@@ -321,5 +258,76 @@
<li>WebSphere - <a href="installation-was352.html">Additional steps
required.</a></li>
<li>WebSphere - <a href="installation-was352-x.html">Steps for the Example
Application.</a></li></ul>
</section>
+
+<section name="Building Struts From Source" href="Building">
+
+ <p>First, download a source distribution of Struts by following the
+ instructions <a href="index.html#Acquiring">here</a>. Then, make sure
+ you have downloaded and installed <b>all</b> 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>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>stuts.jar</code> is
+ <strong>NOT</strong> on your classpath when your container is running.
+ </p>
+
+ </section>
+
</body>
</document>
1.8 +36 -30 jakarta-struts/doc/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-struts/doc/index.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- index.xml 2001/06/24 04:55:08 1.7
+++ index.xml 2001/09/18 01:39:51 1.8
@@ -42,66 +42,72 @@
</section>
-
<section name="Acquiring Struts" href="Acquiring">
- <p>The final release of <strong>Struts 1.0</strong> has been created and
- made available at
- <a href="http://jakarta.apache.org/builds/jakarta-struts/release/v1.0";>
- http://jakarta.apache.org/builds/jakarta-struts/release/v1.0</a>. The
- source code for this version of Struts can also be downloaded at
- <a href="http://jakarta.apache.org/builds/jakarta-struts/release/v1.0/src";>
- http://jakarta.apache.org/builds/jakarta-struts/release/v1.0/src</a>.</p>
+ <p>The production release of <strong>Struts 1.0</strong> is available in
+ in convenient binary distribution and also with complete source code.</p>
+ <ul>
+ <li><a href="http://jakarta.apache.org/builds/jakarta-struts/release/v1.0";>
+ <b>Struts 1.0 Binary Distribution</b></a></li>
+ <li><a href="http://jakarta.apache.org/builds/jakarta-struts/release/v1.0/src";>
+ <b>Struts 1.0 Source Code Distribution</b></a></li>
+ </ul>
+
<p>Check the <a href="release-notes-1.0.html">Release Notes</a>
- for a summary of what new features have been added, and other significant
- changes, since the Struts 1.0-beta-3 release.</p>
+ for a summary of what new features have been added and other
+ changes since the Struts 1.0-beta-3 release.</p>
+
+ <p><b>In addition to a Struts distribution,</b> you will need to ensure that
+ you have downloaded and installed all of the
+ <a href="installation.html#Prerequisites">prerequisite</a> software
+ applications. Then, follow the appropriate instructions to
+ <a href="installation.html#Installing">install and use a Struts binary
+ distribution</a> in your web application or for
+ <a href="installation.html#Building">building Struts from the source
+ distribution</a>.</p>
+
+ </section>
- <hr width="75%"/>
+ <section name="Nightly Builds" href="Builds">
- <p>You can acquire interim binary and source distributions of Struts from the
- following locations:</p>
+ <p>For developers who are helping to develop Struts, or who just want
+ "the latest bits", the latest development version is made available each
+ morning. Use at your own risk!</p>
<ul>
- <li>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>Download nightly binary distributions from
+ <li>Nightly builds - Download the binary distributions from
<a href="http://jakarta.apache.org/builds/jakarta-struts/nightly";>
here</a>.</li>
- <li>Download nightly source distributions from
+ <li>Nightly builds - Download the source distributions from
<a href="http://jakarta.apache.org/builds/jakarta-struts/nightly/src";>
here</a>.</li>
</ul>
+ <p>Be sure to check the <a href="release-notes.html">Release Notes</a> for the
nightly
+ builds so you know what you are getting!</p>
+
<p>Access to the CVS source repository for Struts is available through both
<a href="http://jakarta.apache.org/cvsweb/index.cgi/jakarta-struts/";>web
browser</a> and
<a href="http://jakarta.apache.org/getinvolved/cvsindex.html";>CVS client</a>
interfaces.</p>
- <p>In addition to the Struts distribution, you will need to ensure that
- you have downloaded and installed all of the
- <a href="installation.html#Prerequisites">prerequisite</a> software
- applications. Then, follow the appropriate instructions to
- <a href="installation.html#Building">build Struts from the source
- distribution</a>, or <a href="installation.html#Installing">install and
- use a Struts binary distribution</a> in your web application.</p>
-
</section>
-
<section name="Reporting Bugs and Feature Requests" href="Bugs">
- <p>Tracking of bug reports and new feature requests for Struts is hosted at
- <a
href="http://nagoya.apache.org/bugzilla/";>http://nagoya.apache.org/bugzilla/</a>.
+ <p>Tracking of bug reports and enhancement requests for Struts is handled through
+ the <a href="http://jakarta.apache.org/site/bugs.html";>Apache Bug Database</a>.
Please select <strong>Struts</strong> from the product list, along with the
details of which component of Struts you feel this report relates to,
- and details of your operating environment. You will automatically be
- notified by Email as the status of your bug report changes.</p>
+ and details of your operating environment. You will automatically be
+ notified by email as the status of your bug or enhancement report changes.</p>
</section>
-
<section name="Getting Involved" href="Involved">
