Struts 2
  1. Struts 2
  2. WW-3472

SiteMesh Plugin document improvements

    Details

    • Type: Task Task
    • Status: Open
    • Priority: Minor Minor
    • Resolution: Unresolved
    • Affects Version/s: 2.2.1
    • Fix Version/s: 2.3.x
    • Component/s: Documentation
    • Labels:
      None

      Description

      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 "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 sitemesh.xml, a simple decorators.xml file (in the case when a ConfigDecoratorMapper is defined), 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

        Activity

        Roland McIntosh created issue -
        Hide
        Roland McIntosh added a comment -

        Remove erroneous and extraneous info regarding decorators.xml not being found – I didn't realize that I had added a sitemesh.xml file and defined a ConfigDecoratorMapper which referenced it, therefore the error that appeared when it was missing is expected.

        Show
        Roland McIntosh added a comment - Remove erroneous and extraneous info regarding decorators.xml not being found – I didn't realize that I had added a sitemesh.xml file and defined a ConfigDecoratorMapper which referenced it, therefore the error that appeared when it was missing is expected.
        Roland McIntosh made changes -
        Field Original Value New Value
        Description 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
        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 "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 sitemesh.xml, a simple decorators.xml file (in the case when a ConfigDecoratorMapper is defined), 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
        Lukasz Lenart made changes -
        Fix Version/s 2.3.x [ 12319176 ]
        Hide
        Lukasz Lenart added a comment -

        Roland McIntosh maybe you could update that page? Looks like you have more wide knowledge than I in that area

        Show
        Lukasz Lenart added a comment - Roland McIntosh maybe you could update that page? Looks like you have more wide knowledge than I in that area
        Lukasz Lenart made changes -
        Fix Version/s 2.3.x [ 12328667 ]
        Fix Version/s 2.3.18 [ 12319176 ]

          People

          • Assignee:
            Unassigned
            Reporter:
            Roland McIntosh
          • Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

            • Created:
              Updated:

              Development