The Smart Client offers different possibilities how to access this Reference Manual. Depending on the chosen help format the access to help can be context sensitive, i.e. the chapter that describes your current working context will be shown when you call help.
Via Smart Client settings you can define what help format is used. Table 1 lists the available help file formats. For each format you can choose the source from where the help is loaded. If the source is not given for the selected help format the Smart Client will use a default source.
Help format |
Notes |
HTML |
Displays the help using the default web browser. The help is loaded from a configurable URL. By default HTML based help will point to a server hosted by Pöyry Infra GmbH. You can however configure the Smart Client to use another URL. Using HTML based help with the default URL guarantees that you have always the latest help. |
CHM |
Displays a compiled CHM help repository. The CHM file used can be configured, by default a CHM file that is installed along with the Smart Client is used. |
Table 1: types of help repositories that can be used as source for context sensitive help on the Smart Client
Smart Client Configuration Setting |
Notes |
CHM Help file full path |
The full path of the CHM file to load. If not given the Smart client will search for the CHM file in its installation directory. Examples: N:\redbex\RedbexReferenceManual.chm \\myserver\doc\RedbexReferenceManual.chm |
HTML help url |
URL where to find the HTML based Help. Can refer to HTML Help stored locally (or on your local network) as well as HTM based help hosted on a web Server in the Internet. If not given the default URL will point to Pöyry Infra GmbH's Web Server. |
Table 2: Configuration file settings for configuration of the context sensitive help on the Smart Client
