[CAUSEWAY-1307] [Wish] Integrating User Help Documentation

• Type: Wish
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Component/s: Viewer Wicket
• Assignee: Unassigned
• Reporter: Steve Cameron
• Created: 12/Feb/16 04:07
• Updated: 29/Apr/22 16:41

Description

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.

Issue Links

• contains: CAUSEWAY-2000 [Duplicate] Display an optional help page in a sidebar, eg on the right.
• duplicates: CAUSEWAY-510 [DUPLICATE] Help page overlay (a la ? in gmail)
• is duplicated by: CAUSEWAY-891 [Duplicate] Dynamic and optional description for actions, as way to provide additional guidance in the action prompt.