The RoboHelp ExtendScript Library sets several global variables. Most of these variables are used by library functions. Modifying these variables may stop the library functions from working correctly.
Global variable | Description |
---|---|
aliasfileextension | The extension of the alias file. |
CSH | Array that holds the CSH information. Map#, TopicId and topic are grouped. This variable is initialized by the function loadCSH(). When not initialized, the value is false . See the function loadCSH() for more information. |
CSHHighestNumberTaken | Boolean that indicates whether the highest possible map# has been taken. Used by the function getNextMapNumber(). |
CSHMapnumberKey | The array key of the array CSH that holds the Map#. |
CSHNoMoreMapNumbers | Boolean that indicates whether there are Map# left for CSH. Used by the function getNextMapNumber(). |
CSHTopicidKey | The array key of the array CSH that holds the TopicId. |
CSHTopicKey | The array key of the array CSH that hold the relative path to the topic. |
currentProject | Holds the current project as a resource. When there is no current project, the value is null. This variable is initialized by the function loadcurrentproject(). |
FMContainer | The file that holds information about the linked FrameMaker files in the current project. |
libInit | Boolean that indicates whether the library was loaded. This variable is set to true when all dependent scrips are loaded. Removed in version 20121218, please see rhInit . |
libVersion | Integer with the version number or the library. |
LinkedFMDocs | Variable that holds the topics the relative paths to the topics that are part of a linked FrameMaker file. This variable is initialized by the function loadLinkedFiles(). When not initialized, the value is false . |
LinkedWordDocs | Variable that holds the topics the relative paths to the topics that are part of a linked Word file. This variable is initialized by the function loadLinkedFiles(). When not initialized, the value is false . |
logfile | File resource with the log file to be used by the function log(). When not initialized, the value if false . |
mapfileextension | Array with extensions of map files. |
MapNumbers | Array that holds all the Map# in the project. This variable is initialized by the function loadCSH(). When not initialized, the value is false . |
rhInit | Boolean that indicates whether RoboHelp is started and whether RoboHelp specific features are enabled. |
TopicIds | Array that holds all the TopicId's in the project. This variable is initialized by the function loadCSH(). When not initialized, the value is false . |
v7Location | The full path to 7-Zip. You set this variable when you install the library. If not set on install, the value is null. |
WordContainer | The file that holds the Word files linked to the current project. |
xpjextension | The extension of the XPJ file. |