Home | Sign in | English EN
  • Overview
  • How to?
  • Defining the default page
  • Defining the compilation options:
  • Compiling a help file
  • Test of the help system
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WindowsLinuxPHPWEBDEV - Browser code
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Stored procedures
Compiling the help system and running its test
To create a help file based on the information entered in the help editor, the help must be compiled. A specific compiler is used for each help format (.chm or .hlp). These compilers are supplied with WINDEV.
The compilation is used to create the final help file from all the available elements: images, keywords, help pages, ...
A compilation must be performed:
  • to create the help file.
  • whenever the help system is modified (modification made to a page, to a keyword, ...).
Once the compilation is over, the test of the help file can be run.
Caution: Before compiling the help, make sure that the compilers supplied with WINDEV are referenced in the options of the help editor.
How to?

Defining the default page

Before compiling the help system, you must define the default page. This page will be the first help page displayed when the help is started.
To define the default help page of the help system:
  1. Display the characteristics of the help system: on the "Modification" pane, in the "Help system" group, click "Description".
  2. In the "General" tab, select the default page.

Defining the compilation options:

The help is compiled in CHM format by default.
To choose the format of the help system, you must define the compilation options:
  1. On the "Modification" pane, in the "General" group, click "Options".
  2. Select the type of help to generate: chm or hlp and indicate the generation options. For more details, see Compilation options.

Compiling a help file

To compile a help file:
  1. On the "Modification" tab, in the "General" group, click "Compile". The compilation starts.
  2. Once the compilation is over:
    • If no error was found by the compiler, the help file is automatically started.
    • If an error was detected by the compiler, the status report of the compilation is displayed. This status report lists:
      • the warnings: these warnings concern the links not found in the help file for example.
      • the operations performed by the compiler, as well as the errors and the problems that occurred. The "Print" button is used to print the status report.
To run the test of the help system, click "Show the help".

Test of the help system

The test of the help system can be run via one of the following methods:
  • when compiling the help (see previous paragraph).
  • on the "Modification" tab, in the "General" group, click "Test". This option is used to start the last help file that was created. If modifications have been made after the last compilation, these modifications are ignored.
Minimum version required
  • Version 9
Click [Add] to post a comment