Context sensitive help
Description
Environment
None
Activity
Show:
Tim Anderson April 30, 2013 at 7:54 PM
Changes applied to:
vpms, revisions: 4957-4963, 4987
The help.properties file contains:
a help.url property which denotes the prefix for all topic URLs
a list of help topics and their corresponding URL suffixes. To get the link for a help topic, the suffix is appended to the help.url property.
If help is available for a topic, the web page will be opened in a new window or tab (depending on browser preferences).
If no help is available, a dialog will be displayed inviting the user to create some.
For 1.7 the help.properties file looks like:
Fixed
Details
Details
Assignee
Tim Anderson
Tim AndersonReporter
Tim Anderson
Tim AndersonTime tracking
16h logged
Components
Fix versions
Affects versions
Priority
MajorWho's Looking?
Open Who's Looking?
Created April 7, 2013 at 9:37 PM
Updated February 26, 2014 at 3:00 PM
Resolved April 30, 2013 at 7:54 PM
Who's Looking?
Add support to launch context sensitive help:
in each workspace
in each dialog
Help will be provided by external HTML pages. When accessing help for a particular topic, OpenVPMS will check that help for the topic is available. If so, it will launch a new browser window for the topic. If not, it will pop up a message dialog stating that no help exists.
Each workspace and dialog will be assigned a help topic identifier. This will be used to look up a URL or URL fragment in a help.properties file.
This help.properties file can be localised by providing a language specific version e.g. help_fr.properties.
Where a URL fragment is specified, this will be appended to a help.url property.
E.g. given the following:
help.url = http://www.openvpms.org/documentation/1.7/
workspace/customer/charges = customer/charges
The workspace/customer/charges topic identifier will resolve to the URL:
http://www.openvpms.org/documentation/1.7/customer/charges
Context sensitive help will be launched by a keyboard shortcut (e.g. F1).