In-Application Help Setup

Download the Documentation ZIP below to your machine. The Documentation ZIP is updated for each release.

 

 Not available for download from the Documentation ZIP

 

Option 1 - Documentation Server

You can unzip the documentation under <calypso home>/client/static/docs/.

 

Once the Data Server is started, you can browse the documentation using the URL http://localhost:8100/docs/AllDocuments.htm.

You can modify the Data Server host and port as needed.

 

To link the documentation to the Calypso Navigator, set the environment property HELP_LOCATION in your Environment accordingly.

Example:

HELP_LOCATION = http\://localhost\:8100/docs/

Note that it ends with a "/" sign.

 

Option 2 - Shared Drive

You can unzip the documentation to a shared location.

Example:

C:/calypso/localdocs

 

You can browse the documentation using the URL <location>/AllDocuments.htm.

Example:

file:///C:/calypso/localdocs/AllDocuments.htm

 

To link the documentation to the Calypso Navigator, set the environment property HELP_LOCATION in your Environment accordingly.

Example:

HELP_LOCATION = file\:///C\:/calypso/localdocs/

Note that it ends with a "/" sign.

 

Accessing the Documentation from the Calypso Navigator

Once you have set environment property HELP_LOCATION according to Option 1 or Option 2, you can choose Help > Search Documentation to bring up the home page of the Documentation Portal.

 

Otherwise, most windows have a Help button or a Help menu that you can use to access the corresponding documentation.