[ISIS-1307] Integrating User Help Documentation - ASF JIRA

Agile Board

Attach files

Attach Screenshot

Add vote

Voters

Watch issue

Watchers

Create sub-task

Link

Clone

Update Comment Author

Replace String in Comment

Update Comment Visibility

Delete Comments

XML

Word

Printable

JSON

Details

Type: Improvement
Status: Open
Priority: Minor
Resolution: Unresolved
Affects Version/s: None
Fix Version/s: None
Component/s: Isis Viewer Wicket
Labels:
None

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.