Global variables

In your templates you can use global variables listed below and defined by chm2web:

#ROOT#

Link to the root folder of your help system with "/" at the end.

#START.FILE.NAME#

The name of the main page of your help system. This variable usually contains "index.html".

#CONTENTS.FILE.NAME#

The name of the file that contains the table of contents of your online help system. This file should be opened in the frame named "toc". In current version of chm2web, this variable always contains "helpcontents.html".

#INDEX.FILE.NAME#

The name of the file that contains help index of your web online help system. This file should be opened in the frame named "toc". In current version of chm2web, this variable always contains "helpindex.html".

#SEARCH.FILE.NAME#

The name of the file that contains full text search of your web online help system. This file should be opened in the frame named "toc". In current version of chm2web, this variable always contains "helpsearch.html".

#PAGE.HEADER.NAME#

The name of the header file created with PAGE.HEADER.BODY template. In current version of chm2web, this variable always contains "helpheader.html".

#HEADER.CONTENTS.NAME#

The name of the header file created with HEADER.BODY template contains the help system header with the active "Table Of Contents" button. In the current chm2web version, this variable always contains "helpheaderc.html".

#HEADER.INDEX.NAME#

The name of the header file created with HEADER.BODY template contains the help system header with the active "Help Index" button. In current version of chm2web, this variable always contains "helpheaderi.html".

#HEADER.SEARCH.NAME#

The name of the header file created with HEADER.BODY template contains the help system header with the active "Search" button. In current version of chm2web, this variable always contains "helpheaders.html".

Please note: to set an empty value you should use "!null!value" keyword, for example: "INDEX.TREE = !null!value".