User Tools

Site Tools


Sidebar

csh:loadcsh

loadCSH()

Function that loads the current project's context sensitive help settings into the global variables CSH, MapNumbers and TopicIds. This function is called by getNextMapNumber(), .CSH() and topicCSH() when the project's CSH is not yet loaded. If you use the functions of the library, there is no need to manually call this function in your script.

Note: If you make bulk changes to the CSH in the project (by manipulating the .ali file, you will need to release the CSH information. To reload the information, first unload the information with the function unloadCSH() and reload by calling loadCSH().

Usage

loadCSH();

Parameters

This function has no parameters.

Return values

This function has no return values.

Structure of Global Variables

The global variables CSH, MapNumbers and TopicIds are initialized by this function.

CSH

The global variable CSH is false when the CSH is not yet initialized. Otherwise the global variable is an array with the following structure:

- Numeric array key
|- CSHTopicidKey
|- CSHMapnumberKey
|- CSHTopicKey

Each key in the array is an embedded array. You use global variables to get the desired key:

  • Use the global variable CSHTopicidKey for the TopicId.
  • Use the global variable CSHMapnumberKey for the map number.
  • Use the global variable CSHTopicKey for the topic path (relative from project root).

The keys CSHTopicidKey and CSHMapnumberKey always have a value. When no topic is linked to these CSH keys, the array key CSHTopicKey is false.

MapNumbers

The global variable MapNumbers is false when the CSH is not yet initialized. Otherwise the global variable is a single level array with all the map numbers used in the project.

TopicIds

The global variable TopicIds is false when the CSH is not yet initialized. Otherwise the global variable is a single level array with all the TopicId's used in the project.

csh/loadcsh.txt · Last modified: 2017/05/20 14:06 (external edit)