Page level help

One of OPV's problems is the lack of a cohesive set of documentation.  One way to solve this would be to provide a page level help facility.

By this I mean a facility that on all screens, if you pressed say F5, then the code would look in the messages.properties file for a URL in the slot named say helppages.link.  If this entry was not present then nothing would happen.  If it was present then the code would invoke the specified URL with %p=xxxxx appended where xxxx was a unique identifier for the current window.

This would allow one to build per-screen help text.

I would hope that the work to provide the F5 support is relatively small.  The big job is writing the actual help text for each screen.  However, the above design allows for a) things to be phased in over a period (if the linked URL had no help text for screen xxxxx, then it just says 'Sorry help not yet available for this screen"; b) help text generation needs only HTML skills; c) installation specific tailoring of the help text.

I have started on a an OpenVPMS Operations manual for the Hong Kong practice, but it struck me that a  per-screen help system would be more accessible to the users.

Regards, Tim

Comment viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.

Re: Page level help

I've started a new project for this at http://www.openvpms.org/project/context-sensitive-help

Syndicate content