struts-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Michael Cox (JIRA)" <j...@apache.org>
Subject [jira] Created: (STR-3194) Need more thorough documentation of struts-config.xml
Date Fri, 04 Dec 2009 15:59:13 GMT
Need more thorough documentation of struts-config.xml
-----------------------------------------------------

                 Key: STR-3194
                 URL: https://issues.apache.org/struts/browse/STR-3194
             Project: Struts 1
          Issue Type: Improvement
          Components: Documentation
    Affects Versions: 1.3.10
         Environment: N/A
            Reporter: Michael Cox
            Priority: Minor


Being new to Struts, I've searched all over the documentation here:

http://struts.apache.org/1.x/index.html

But it's nearly impossible to get just a basic understanding of the struts-config.xml file
and its inner workings.  As one example, the "input" attribute of the "action" element is
included in several examples but is not actually documented anywhere.  Other websites say
that the "input" attribute describes where to forward if there is a validation error.  Since
it is extremely unintuitive that a validation error page is specified by an attribute called
"input" (rather than, say, "errorpage"), and since the official documentation should be reasonably
thorough when covering the basics of Struts, we really need to have a better description of
the Struts configuration XML file.  The documentation should contain a thorough explanation
of every element and attribute, as well as how the values can map to other elements.  (i.e.
how an action can be specified in the "path" attribute of a "forward" element by using "actionName.do",
how a "forward" attribute of an "action" element can point to a tiles definition in tiles-defs.xml,
etc.  This wiring of values is very confusing to beginners -- especially since the names that
were chosen are often misleading -- and seems to be poorly documented in the official pages.)

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message