SiteMesh Plugin document improvements
-------------------------------------
Key: WW-3472
URL: https://issues.apache.org/jira/browse/WW-3472
Project: Struts 2
Issue Type: Task
Components: Documentation
Affects Versions: 2.2.1
Reporter: Roland McIntosh
Priority: Minor
Currently, the SiteMesh Plugin document contains much duplicated information
regarding web.xml configuration. Some of the information, like the section
entitled "Velocity," has errors in its example configuration (copy/paste errors
that incorrectly reference FreeMarker).
* The "Installation" section claims that "no other files need to be copied or
created" -- but my servlet container (Tomcat within Jboss 5.1) threw an error
if there was no decorators.xml file in the WEB-INF directory.
* The "Full Integration" section references WW-3296, but any relevant/useful
information should be extracted from that ticket and used in the document
directly.
Furthermore, the page neglects to give actual SiteMesh configuration examples.
The 2.0.14 docs had a limited example, but this can be improved by adding a
section on a simple decorators.xml file, a simple decorator, and a page to be
decorated. These should be FreeMarker or Velocity examples to highlight the
new functionality that Struts 2.2.1 affords.
In general the page could be more clear for newbies.
Current version:
http://struts.apache.org/2.x/docs/sitemesh-plugin.html
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
