[jira] [Commented] (WW-3652) Add example for "anchor" (aka "hash" or "fragment") to RedirectActionResult docs

["JB (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/WW-3652?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13053405#comment-13053405 ] 

JB commented on WW-3652:
------------------------

Began reading docs associated with issue; Updated source-code for creating patch.

> Add example for "anchor" (aka "hash" or "fragment") to RedirectActionResult docs
> --------------------------------------------------------------------------------
>
>                 Key: WW-3652
>                 URL: https://issues.apache.org/jira/browse/WW-3652
>             Project: Struts 2
>          Issue Type: Task
>          Components: Documentation
>    Affects Versions: 2.1.8.1, 2.2.1.1, 2.2.3
>            Reporter: Roland McIntosh
>            Priority: Trivial
>
> The documentation for the Redirect Action Result fails to mention that an "anchor" parameter is possible.  Here is the doc:
> http://struts.apache.org/2.2.3/docs/redirect-action-result.html
> Additionally, the is one more parameters technically supported by Redirect Action Result inherited from ServletRedirectResult: "parse" ( "location" is also inherited, but hidden by "actionName").
> The "Parameters" section might be amended with:
> * parse - boolean, true by default.  If set to false, the actionName param will not be parsed for Ognl expressions
> * anchor - optional.  Also known as "fragment" or colloquially as "hash."  You can specify an anchor for a result.
> An example of usage should be added to the wiki / javadocs for the anchor param, perhaps to the existing example "gatherReportInfo" action.
> Lastly, since "anchor" is also used to refer to the <a> tag, I recommend that the documentation also include the more common terms "fragment" and "hash" as given above.  This will enable folks searching for this functionality to find it quicker.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira