Help / Editors / Help editor
  • 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
It is necessary to compile the help to create a file based on the information entered in the help editor. A specific compiler is used for each help format (HTML, HTML Help or PDF). These compilers are provided with WINDEV, WEBDEV and WINDEV Mobile.
Compilation is the process that creates the final help file using all the available elements: images, keywords, help pages, etc.
The compilation must be performed:
  • to create the help file (CHM, PDF or HTML pages).
  • each time the help system is modified (modification of a page, keyword, etc.).
Once the compilation is completed, the help file can be tested.
Caution: Before compiling the help, make sure that the compilers provided with WINDEV, WEBDEV and WINDEV Mobile 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 page of the help system:
  1. Go to the characteristics of the help system: on the "Modification" tab, in the "Help system" group, click "Description".
  2. In the "General" tab, select the default page.

Defining the compilation options

By default, the help is compiled in the format chosen when the help system was created.
To choose the format of the help system, you must define the compilation options:
  1. On the "Modification" tab, in the "General" group, click "Options".
  2. Select the type of help to generate and specify the generation options if necessary.
    For more details, see Compilation options.
WEBDEV - Server codeWINDEV Mobile For WEBDEV sites or WINDEV Mobile applications, it is recommended to use a PDF help file.

Compiling a help file

To compile a help file:
  1. On the "Modification" tab, in the "General" group, click "Compile".
    Compilation starts.
  2. Once the compilation is completed:
    • If the compiler did not find any errors, the help file opens automatically.
    • If the compiler detects errors, the status report of the compilation is displayed. This status report shows:
      • the warnings: these warnings indicate non-existing links in the help file, for example.
      • the operations performed by the compiler, as well as the errors and problems encountered. The "Print" button is used to print the status report.
To test the help system, click "Test".

Test of the help system

The help system can be tested 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 opens the last created help file. If changes have been made since the last compilation, they are not taken into account.
Minimum version required
  • Version 9
This page is also available for…
Click [Add] to post a comment

Last update: 05/23/2023

Send a report | Local help