[jira] [Updated] (ISIS-1307) Integrating User Help Documentation

["Daniel Keir Haywood (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/ISIS-1307?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Daniel Keir Haywood updated ISIS-1307:
--------------------------------------
      Component/s:     (was: Isis Core)
                   Isis Viewer Wicket
    Fix Version/s:     (was: 2.1.4)

> Integrating User Help Documentation
> -----------------------------------
>
>                 Key: ISIS-1307
>                 URL: https://issues.apache.org/jira/browse/ISIS-1307
>             Project: Isis
>          Issue Type: Improvement
>          Components: Isis Viewer Wicket
>            Reporter: Steve Cameron
>            Priority: Minor
>
> At the moment there is the @PropertyLayout#describedAs() attribute for providing help 'hints' to users. I am wondering if there could be added a more detailed help information being provide to a user pressing F1 key?
> More specifically to design a mechanism for help documentation to be navigated to (into) from the Isis Wicket viewer interface in a context sensitive way.
> Broadening this further still, maybe there is a good way to keep user documentation embedded within the Java domain object class files and to generate formatted user help documents in a similar way that Javadoc is generated? 
> I've done a little research on this approach but cannot find an example of where this has been done, but to my mind it seems natural as a Naked Objects way to do it. 



--
This message was sent by Atlassian Jira
(v8.3.4#803005)