You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@struts.apache.org by ws...@apache.org on 2005/08/15 00:31:22 UTC
svn commit: r232658 - in /struts/site/trunk/xdocs: bylaws.xml
faqs/actionForm.xml faqs/apps.xml faqs/dispatchValidator.xml
userGuide/configuration.xml userGuide/release-notes-1.0-b1.xml volunteers.xml
Author: wsmoak
Date: Sun Aug 14 15:31:10 2005
New Revision: 232658
URL: http://svn.apache.org/viewcvs?rev=232658&view=rev
Log:
Updated docs to conform with Jakarta site2 format
- changed <section> to <subsection>
- changed <chapter> to <section>
- changed <pre><code> to <source>
- removed 'href' attributes from <section> and <subsection> tags
- changed anchors to match section names with underscores
Modified:
struts/site/trunk/xdocs/bylaws.xml
struts/site/trunk/xdocs/faqs/actionForm.xml
struts/site/trunk/xdocs/faqs/apps.xml
struts/site/trunk/xdocs/faqs/dispatchValidator.xml
struts/site/trunk/xdocs/userGuide/configuration.xml
struts/site/trunk/xdocs/userGuide/release-notes-1.0-b1.xml
struts/site/trunk/xdocs/volunteers.xml
Modified: struts/site/trunk/xdocs/bylaws.xml
URL: http://svn.apache.org/viewcvs/struts/site/trunk/xdocs/bylaws.xml?rev=232658&r1=232657&r2=232658&view=diff
==============================================================================
--- struts/site/trunk/xdocs/bylaws.xml (original)
+++ struts/site/trunk/xdocs/bylaws.xml Sun Aug 14 15:31:10 2005
@@ -7,9 +7,9 @@
<body>
-<chapter name="Apache Struts Project Bylaws">
+<section name="Apache Struts Project Bylaws">
- <section name="Charter">
+ <subsection name="Charter">
<p>
Struts is a Project of the <a href="http://apache.org/foundation">
@@ -20,9 +20,9 @@
and the direction of the ASF Board.
</p>
- </section>
+ </subsection>
- <section name="Roles & Responsibilities">
+ <subsection name="Roles and Responsibilities">
<p>
The roles and responsibilities that people can assume in the project
@@ -67,9 +67,9 @@
is responsible for the day-to-day management of the Project.
</p>
- </section>
+ </subsection>
- <section name="Management">
+ <subsection name="Management">
<p>
The Vice President is appointed by the ASF Board. The Vice
@@ -82,9 +82,9 @@
<a href="volunteers.html">Volunteers page</a>.
</p>
- </section>
+ </subsection>
- <section name="PMC Duties">
+ <subsection name="PMC Duties">
<p>
The PMC is responsible for the day-to-day
@@ -96,9 +96,9 @@
must be sanctioned by the Project Management Committee.
</p>
- </section>
+ </subsection>
- <section name="Subprojects">
+ <subsection name="Subprojects">
<p>
Subprojects are the Project's unit of release. Each subproject should
@@ -122,9 +122,9 @@
subproject requires approval by a 3/4 majority vote of the PMC.
</p>
- </section>
+ </subsection>
- <section name="Decision Making">
+ <subsection name="Decision Making">
<p>
All Volunteers are encouraged to participate in decisions, but the
@@ -132,9 +132,9 @@
The Project is a "<em>Minimum Threshold Meritocracy</em>".
</p>
- </section>
+ </subsection>
- <section name="Voting">
+ <subsection name="Voting">
<p>
Any subscriber to the list may vote on any issue or action item.
@@ -208,9 +208,9 @@
By convention, Committers should allow a vote to circulate for 72
hours before taking action.
</p>
- </section>
+ </subsection>
- <section name="Action Items">
+ <subsection name="Action Items">
<p>
All decisions revolve around "<em>Action
@@ -226,9 +226,9 @@
<li>Release Grade</li>
</ul>
- </section>
+ </subsection>
- <section name="Long Term Plans">
+ <subsection name="Long Term Plans">
<p>
Long term plans are simply announcements that group members are
@@ -238,9 +238,9 @@
are obligated to inform the group of their feelings.
</p>
- </section>
+ </subsection>
- <section name="Short Term Plan">
+ <subsection name="Short Term Plan">
<p>
Short term plans are announcements that a volunteer is working on a
@@ -249,18 +249,18 @@
changes.
</p>
- </section>
+ </subsection>
- <section name="Product Changes">
+ <subsection name="Product Changes">
<p>
All product changes to the repository are subject to
lazy consensus.
</p>
- </section>
+ </subsection>
- <section name="Showstoppers">
+ <subsection name="Showstoppers">
<p>
Showstoppers are issues that require a fix be in place before the
@@ -270,9 +270,9 @@
so by lazy consensus.
</p>
- </section>
+ </subsection>
- <section name="Release Plan">
+ <subsection name="Release Plan">
<p>
A release plan must be used to keep all volunteers aware of when a
@@ -284,9 +284,9 @@
in a release plan.
</p>
- </section>
+ </subsection>
- <section name="Release Grade">
+ <subsection name="Release Grade">
<p>
After a proposed release is built, it must be tested and classified before
@@ -298,14 +298,14 @@
be reused by another distribution.
</p>
- </section>
+ </subsection>
- <section>
+ <subsection>
<p class="right">
Next: <a href="releases.html">Release Guidelines</a>
</p>
- </section>
+ </subsection>
-</chapter>
+</section>
</body>
</document>
Modified: struts/site/trunk/xdocs/faqs/actionForm.xml
URL: http://svn.apache.org/viewcvs/struts/site/trunk/xdocs/faqs/actionForm.xml?rev=232658&r1=232657&r2=232658&view=diff
==============================================================================
--- struts/site/trunk/xdocs/faqs/actionForm.xml (original)
+++ struts/site/trunk/xdocs/faqs/actionForm.xml Sun Aug 14 15:31:10 2005
@@ -7,9 +7,9 @@
</properties>
<body>
-<chapter href="actionForm" name="How to Build an Action Form">
+<section name="How to Build an Action Form">
-<section href="login" name="Creating a Login Form">
+<subsection name="Creating a Login Form">
<p>
This is a simple example of a login form to illustrate how Struts
@@ -21,7 +21,7 @@
<hr/>
-<pre><code><![CDATA[
+<source><![CDATA[
<%@ page language="java" %>
<%@ taglib uri="/WEB-INF/struts-html.tld" prefix="html" %>
<%@ taglib uri="/WEB-INF/struts-bean.tld" prefix="bean" %>
@@ -72,7 +72,7 @@
</html:form>
</body>
</html:html>
-]]></code></pre>
+]]></source>
<hr/>
@@ -152,7 +152,7 @@
stored in the session context under the key <code>logonForm</code>.
The Struts developer provides the Java implementation of the
ActionForm bean, subclassing the Struts class <code>ActionForm</code>
- (see <a href="../userGuide/building_controller.html#action_form_classes">Building
+ (see <a href="../userGuide/building_controller.html#4_3_ActionForm_Classes">Building
Controller</a> components).
This bean is used to provide initial values for all of the input
fields that have names matching the property names of the bean.
@@ -165,7 +165,7 @@
The form bean can also be specified in the tag by providing
<code>name</code> and <code>type</code> attributes. But most often,
everything is specified in the
- <a href="../userGuide/building_controller.html#config">Struts Configuration
+ <a href="../userGuide/building_controller.html#4_8_Writing_Action_Mappings">Struts Configuration
File</a>.
</li>
@@ -204,7 +204,7 @@
<hr/>
-<pre><code><![CDATA[
+<source><![CDATA[
<%@page language="java">
<%@taglib
uri="/WEB-INF/struts-html.tld"
@@ -218,7 +218,7 @@
<html:submit />
</html:form>
-]]></code></pre>
+]]></source>
<hr/>
@@ -229,7 +229,7 @@
<hr/>
-<pre><code><![CDATA[
+<source><![CDATA[
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.struts.action.ActionForm;
@@ -258,19 +258,19 @@
}
}
-]]></code></pre>
+]]></source>
<hr/>
<p>
Look at the Javadocs for
- <code><a href="../api/org/apache/struts/upload/FormFile.html">
+ <code><a href="../struts-core/apidocs/org/apache/struts/upload/FormFile.html">
FormFile</a></code> to see the methods it exposes to manipulate files in
file uploading.
Also look at the Javadocs for
- <a href="../api/org/apache/struts/action/ActionServlet.html">
+ <a href="../struts-core/apidocs/org/apache/struts/action/ActionServlet.html">
ActionServlet</a> and
- <a href="../api/org/apache/struts/action/ActionMapping.html">
+ <a href="../struts-core/apidocs/org/apache/struts/action/ActionMapping.html">
ActionMapping</a> for the various parameters you can specify to change
how files are uploaded.
Basically in your <code>execute</code> method in your action class you
@@ -278,9 +278,9 @@
FormFile and do what you want with it.
</p>
-</section>
+</subsection>
- </chapter>
+ </section>
</body>
</document>
Modified: struts/site/trunk/xdocs/faqs/apps.xml
URL: http://svn.apache.org/viewcvs/struts/site/trunk/xdocs/faqs/apps.xml?rev=232658&r1=232657&r2=232658&view=diff
==============================================================================
--- struts/site/trunk/xdocs/faqs/apps.xml (original)
+++ struts/site/trunk/xdocs/faqs/apps.xml Sun Aug 14 15:31:10 2005
@@ -4,17 +4,17 @@
<title>Building Applications</title>
</properties>
<body>
-<chapter name="How to Build Applications" href="building_apps">
-<section href="intro" name="About This Document">
+<section name="How to Build Applications">
+<subsection name="About This Document">
<p>
This document outlines one possible sequence of development steps that can be followed to create a
Struts application. It is not intended as a complete description of each
referenced development activity. More detailed documentation is available
elsewhere and is referenced by "(more...)" links where possible.
</p>
-</section>
+</subsection>
-<section href="caveats" name="Caveats">
+<subsection name="Caveats">
<ol>
<li>Requirements development and design are outside of the scope of this document.</li>
<li>For help installing Struts, see the <a href="../userGuide/installation.html">Getting Started</a> chapter.</li>
@@ -25,9 +25,9 @@
other types of applications.</li>
<li>This material was written for Struts 1.1 (beta 2) and now 1.2.2</li>
</ol>
-</section>
+</subsection>
-<section href="overview" name="Overview">
+<subsection name="Overview">
<ol>
<li>Implement data entry forms as JSP files.</li>
<li>Implement one or more <code>ActionForm</code> descendents to buffer data
@@ -48,9 +48,9 @@
</ol>
</li>
</ol>
-</section>
+</subsection>
-<section href="details" name="Details">
+<subsection name="Details">
<ol>
<li>Implement data entry forms as JSP files.
<ol>
@@ -62,7 +62,7 @@
<a href="../userGuide/struts-bean.html">(more...)</a>
<ol>
<li>Create and maintain a properties file of the text elements
- to be displayed. <a href="../userGuide/preface.html#resources">(more...)
+ to be displayed. <a href="../userGuide/preface.html#0_6_Properties_Files_and_ResourceBundles">(more...)
</a></li>
</ol>
</li>
@@ -105,7 +105,7 @@
<li>Create <code>struts-config.xml</code> to
associate forms with actions. The file minimally needs:</li>
<li>Create or update <code>web.xml</code> to
- reference <code>ActionServlet</code>, taglibs used by Struts. <a href="../userGuide/configuration.html#dd_config"> (more...)</a></li>
+ reference <code>ActionServlet</code>, taglibs used by Struts. <a href="../userGuide/configuration.html#5_4_The_Web_Application_Deployment_Descriptor"> (more...)</a></li>
<li>Parallel Tasks
<ol>
<li>Building
@@ -137,7 +137,7 @@
</li>
</ol>
</li>
-</ol></section>
-</chapter>
+</ol></subsection>
+</section>
</body>
</document>
Modified: struts/site/trunk/xdocs/faqs/dispatchValidator.xml
URL: http://svn.apache.org/viewcvs/struts/site/trunk/xdocs/faqs/dispatchValidator.xml?rev=232658&r1=232657&r2=232658&view=diff
==============================================================================
--- struts/site/trunk/xdocs/faqs/dispatchValidator.xml (original)
+++ struts/site/trunk/xdocs/faqs/dispatchValidator.xml Sun Aug 14 15:31:10 2005
@@ -8,9 +8,9 @@
<body>
-<chapter href="dispatch-validator" name="Dispatching And Validating">
+<section name="Dispatching And Validating">
-<section name="Overview">
+<subsection name="Overview">
<p>
This is simple example to illustrate how to build a multi-page
@@ -20,9 +20,9 @@
form field validations.
</p>
-</section>
+</subsection>
-<section href="dispatch" name="Using the DispatchAction">
+<subsection name="Using the DispatchAction">
<p>
The example used is a simple two page wizard. The first page prompts
@@ -30,9 +30,9 @@
The application URL has the form
</p>
-<pre><code><![CDATA[
+<source><![CDATA[
http://localhost:8080/howto/name.do?submitName=enterName
-]]></code></pre>
+]]></source>
<p>
where the <code>submitName</code> parameter is used to specify the name
of the method in the action class that will be called to
@@ -40,7 +40,7 @@
<code>parameter</code> attribute specifies the name of the dispatch request parameter (i.e. <code>parameter="submitName"</code>).
</p>
-<pre><code><![CDATA[
+<source><![CDATA[
<action path="/name"
type="com.acme.AcmeAction"
name="acmeForm"
@@ -52,11 +52,11 @@
<forward name="address"
path="/pages/address.jsp"/>
</action>
-]]></code></pre>
+]]></source>
The method <code>enterName</code> simply forwards to the first page.
-<pre><code><![CDATA[
+<source><![CDATA[
public ActionForward enterName(ActionMapping mapping,
ActionForm form,
HttpServletRequest request,
@@ -66,7 +66,7 @@
return mapping.findForward("name");
}
-]]></code></pre>
+]]></source>
On the page <code>name.jsp</code> is a hidden field for the <code>submitName</code> parameter.
@@ -74,13 +74,13 @@
Javascript to set the <code>submitName</code> parameter
-<pre><code><![CDATA[
+<source><![CDATA[
<html:submit onclick="this.form.submitName.value='enterAddress'"/>
-]]></code></pre>
+]]></source>
The <code>enterAddress</code> method then forwards to the address page.
-<pre><code><![CDATA[
+<source><![CDATA[
public ActionForward enterAddress(ActionMapping mapping,
ActionForm form,
HttpServletRequest request,
@@ -89,24 +89,24 @@
return mapping.findForward("address");
}
-]]></code></pre>
+]]></source>
On the <code>adddress.jsp</code> page, we again dynamically set the <code>submitName</code>
parameter.
-<pre><code><![CDATA[
+<source><![CDATA[
<html:submit value="submit" onclick="this.form.submitName.value='submitAddress'"/>
-]]></code></pre>
+]]></source>
And the action path that is submitted is
-<pre><code><![CDATA[
+<source><![CDATA[
<html:form action="/address">
-]]></code></pre>
+]]></source>
The action mapping for <code>/address</code> is
-<pre><code><![CDATA[
+<source><![CDATA[
<action path="/address"
type="com.acme.AcmeAction"
name="acmeForm"
@@ -121,14 +121,14 @@
path="/pages/done.jsp"/>
</action>
-]]></code></pre>
+]]></source>
Note that two action mappings are required to handle the page flow (we'll discuss why
in the next section).
-</section>
+</subsection>
-<section href="validations" name="Validations">
+<subsection name="Validations">
Let's now add some validations to require input fields using the
Validator. In validation.xml, there's a <code>formset</code> definition
@@ -136,7 +136,7 @@
named <code>acmeForm</code>.
-<pre><code><![CDATA[
+<source><![CDATA[
<formset>
<form name="acmeForm">
<field property="firstName" page="1" depends="required">
@@ -147,7 +147,7 @@
</field>
</form>
</formset>
-]]></code></pre>
+]]></source>
We need to identify the page where the input field resides so that
we can control which validations are triggered for a given form
@@ -161,15 +161,15 @@
In <code>name.jsp</code>
-<pre><code><![CDATA[
+<source><![CDATA[
<html:hidden property="page" value="1"/>
-]]></code></pre>
+]]></source>
In <code>address.jsp</code>
-<pre><code><![CDATA[
+<source><![CDATA[
<html:hidden property="page" value="2"/>
-]]></code></pre>
+]]></source>
The Validator will use the value of the page property in determining which validations to run.
@@ -178,9 +178,9 @@
to in case validation fails. Therefore we need to define an action mapping for each page
that could be displayed after a validation fails.
-</section>
+</subsection>
-<section href="cancel" name="Cancel and Previous">
+<subsection name="Cancel and Previous">
The tricky part is how to setup Previous and Cancel buttons
for each of the pages. If the user clicks Previous then
@@ -191,17 +191,17 @@
to the number of the previous page, effectively circumventing
the validations associated with the current page.
-<pre><code><![CDATA[
+<source><![CDATA[
<html:submit value="previous"
onclick="this.form.submitName.value='previous'; this.form.page.value='1'"/>
-]]></code></pre>
+]]></source>
For cancel, there are two options. We could use the Struts
Cancel button or create an action specifically designed to process
a cancel request. The <code>cancel</code> action has no associated validations.
-<pre><code><![CDATA[
+<source><![CDATA[
<action path="/cancel"
type="com.acme.CancelAction">
@@ -209,19 +209,19 @@
path="/pages/cancel.jsp"/>
</action>
-]]></code></pre>
+]]></source>
And the Cancel button submits to the <code>/cancel</code> action path.
-<pre><code><![CDATA[
+<source><![CDATA[
<html:submit value="cancel" onclick="this.form.action='/acme/cancel.do'"/>
-]]></code></pre>
+]]></source>
The full example is <a href="dispatchValidator.zip"> here </a>.
-</section>
+</subsection>
- </chapter>
+ </section>
</body>
</document>
Modified: struts/site/trunk/xdocs/userGuide/configuration.xml
URL: http://svn.apache.org/viewcvs/struts/site/trunk/xdocs/userGuide/configuration.xml?rev=232658&r1=232657&r2=232658&view=diff
==============================================================================
--- struts/site/trunk/xdocs/userGuide/configuration.xml (original)
+++ struts/site/trunk/xdocs/userGuide/configuration.xml Sun Aug 14 15:31:10 2005
@@ -417,7 +417,7 @@
<p>
If you'd like to vary where the pages for each module are stored,
- see the <a href="5_2_1_Controller_Configuration">forwardPattern</a> setting for the
+ see the <a href="#5_2_1_Controller_Configuration">forwardPattern</a> setting for the
Controller.
</p>
Modified: struts/site/trunk/xdocs/userGuide/release-notes-1.0-b1.xml
URL: http://svn.apache.org/viewcvs/struts/site/trunk/xdocs/userGuide/release-notes-1.0-b1.xml?rev=232658&r1=232657&r2=232658&view=diff
==============================================================================
--- struts/site/trunk/xdocs/userGuide/release-notes-1.0-b1.xml (original)
+++ struts/site/trunk/xdocs/userGuide/release-notes-1.0-b1.xml Sun Aug 14 15:31:10 2005
@@ -251,9 +251,7 @@
instead.</li>
<li>In conjunction with the new configuration file format mentioned above,
the properties of <code>ActionMapping</code> have been substantially
- updated. See the
- <a href="../../api/org/apache/struts/action/ActionMapping.html">API
- Documentation</a> for more information</li>
+ updated. See the ActionMapping API Documentation for more information</li>
<li>The <code>Action</code> interface has been converted to a base class
instead, to reduce the impact of future enhancements. Anyone who has
extended the <code>ActionBase</code> convenience base class (which
Modified: struts/site/trunk/xdocs/volunteers.xml
URL: http://svn.apache.org/viewcvs/struts/site/trunk/xdocs/volunteers.xml?rev=232658&r1=232657&r2=232658&view=diff
==============================================================================
--- struts/site/trunk/xdocs/volunteers.xml (original)
+++ struts/site/trunk/xdocs/volunteers.xml Sun Aug 14 15:31:10 2005
@@ -5,8 +5,8 @@
</properties>
<body>
- <chapter name="Who We Are" href="whoWeAre">
- <section name="Community Support" href="support">
+ <section name="Who We Are">
+ <subsection name="Community Support">
<p>In July 2005, there were more than 2800 subscribers to
STRUTS-USER (including the digest version). In addition to the
@@ -15,9 +15,9 @@
<p>According to recently released
<a href="http://www.apache.org/~vgritsenko/stats/projects/struts">statistics</a>, Struts downloads range around 15,000 a month.</p>
- </section>
+ </subsection>
- <section name="Project Management Committee Members" href="pmc">
+ <subsection name="Project Management Committee Members">
<ul>
<li>
<strong>Craig R. McClanahan</strong>
@@ -75,9 +75,9 @@
<strong>Niall Pemberton</strong>
(niallp at apache.org)</li>
</ul>
- </section>
+ </subsection>
- <section name="Committers" href="committers">
+ <subsection name="Committers">
<ul>
<li>
@@ -97,9 +97,9 @@
(wsmoak at apache.org)</li>
</ul>
- </section>
+ </subsection>
- <section name="Emeritus Committers" href="committers.emeritus">
+ <subsection name="Emeritus Committers">
<ul>
<li>Luis Arias</li>
@@ -114,9 +114,9 @@
<li>Oleg Alexeev</li>
</ul>
- </section>
+ </subsection>
- <section name="More About Us" href="about">
+ <subsection name="More About Us">
<h4 id="craigmcc">Craig R. McClanahan -- PMC Member</h4>
<p>I've been involved with servlet and JSP technology since around 1998. It started out that I needed a way to build some web applications for several projects, and liked Java a lot better than the alternatives. I also liked the price tag of open source software, and started using Apache JServ -- later, getting involved in the project (like many people, I was whining about the twelve months it took to get from version 0.9 to version 1.0, and my son said "Dad, you know Java -- go help them finish it!" -- so I did :-).</p>
@@ -372,14 +372,14 @@
answering them, which I've been doing ever since. I accepted an
invitation to become a Struts Committer in June, 2005.</p>
- </section>
+ </subsection>
- <section>
+ <subsection>
<p class="right">Next:
<a href="announce.html">Announcements</a>
</p>
- </section>
- </chapter>
+ </subsection>
+ </section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
For additional commands, e-mail: dev-help@struts.apache.org