Home › Forums › Developers › General developer's discussion ›

1.7 Alpha Suggestion for improved help page + query

Submitted by Guest on Tue, 30/07/2013 - 07:39
in

The screen shot below shows my adjusted help page.

Suggestion: we amend the distributed help.properties to include the entries shown. (I specifically added the F1 for help page for the CSH to allow for the second entry.)

Question: should I document how to do the 'local procedures' entry so that it links to a text or pdf file on the server itself?  As you can see from my help.properties extract below, I just put it in the Tomcat root.

Regards, Tim G

 #
# Default help links.
#
help.topic.0.title = Help Topics
help.topic.0.url = http://www.openvpms.org/documentation/csh/1.7/topics

# the following blank entry just spaces things down
help.topic.1.title =
help.topic.1.url =

help.topic.2.title = You can press F1 for help on any screen
help.topic.2.url = http://www.openvpms.org/documentation/csh/1.7/introduction/press-f1-help

help.topic.3.title = An Introduction to OpenVPMS
help.topic.3.url = http://www.openvpms.org/documentation/csh/1.7/introduction

help.topic.4.title = OpenVPMS Concepts and Glossary
help.topic.4.url = http://www.openvpms.org/documentation/csh/1.7/concepts

help.topic.5.title = Local procedures
help.topic.5.url = http://localhost:8080/localProcs.pdf

help.topic.6.title = User's Forum
help.topic.6.url = http://www.openvpms.org/category/forums/users/general



# There is no upper limit of default help links, although from a usability perspective they should not exceed
# 10 topics. ie up to help.topic.9.title and help.topic.9.url
# Note that you can't omit an entry - ie if topic.3 is missing then 4,5,6 etc will not be shown

‹ 1.7 Alpha Order of prompts for Fill-in fields 1.7 Alpha help.properties relative links ›

Comment viewing options

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

Re: 1.7 Alpha Suggestion for improved help page + query

Submitted by tanderson on Thu, 01/08/2013 - 14:37.

I've implemented some of your suggestions. I've left the F1 link out for now.

The Local Procedures I think is a site specific implementation details. I've made this easier to do by moving help.properties so that it can be edited from <TOMCAT_HOME>/openvpms/WEB-INF/classes/localisation/help.properties

 #
# Default help links.
#
help.topic.0.title = Help Topics
help.topic.0.url = http://www.openvpms.org/documentation/csh/1.7/topics

help.topic.1.title = An Introduction to OpenVPMS
help.topic.1.url = http://www.openvpms.org/documentation/csh/1.7/introduction

help.topic.2.title = OpenVPMS Concepts and Glossary
help.topic.2.url = http://www.openvpms.org/documentation/csh/1.7/concepts

help.topic.3.title = User's Forum
help.topic.3.url = http://www.openvpms.org/category/forums/users/general

Re: 1.7 Alpha Suggestion for improved help page + query

Submitted by tgething (not verified) on Thu, 01/08/2013 - 16:50.

Thanks Tim. I agree with the 'hold the F1 line' at least until we get agreement on the CSH invocation mechanism.

The Local procedures bit - agree leave it out but I will document what can be done in the appropriate CSh section. [At least I now know that you have to use a full URL.]

Regards, Tim G

Syndicate content