ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / Editors / Help editor
  • Overview
  • How to?
  • Creating a blank help page
  • Creating a help page from an existing document
  • Deleting a help page
  • Modifying the help pages
  • Sections of a help page
  • In a help page, you can:
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Overview
A help system includes several pages. Pages are the main elements of a help system. When users open the help, they are taken to a help page.
Several types of help pages can be implemented in a help file, let's see the most common ones:
  • context-sensitive help pages: the content of the help page gives information about the use of a specific window. Generally, this type of help page is opened via the help icon ("?") in the window.
  • "How to" help pages: these help pages describe step by step the different actions required to perform an operation.
  • "Conceptual" help pages: these help pages present a concept or an idea and define the terms used.
There are links between the different pages. These links allow users to navigate the help system.
Remark: To automatically generate help pages corresponding to the different elements of the project (windows and reports), on the "Modification" tab, in the "Help system" group, click "Generate help pages of the project".
How to?

Creating a blank help page

To create a blank help page:
  • 1st method:
    • Select a page in the summary.
    • On the "Modification" tab, in the "Table of contents" group, expand "New" and select "New blank page".
    • A new blank page is automatically created and it can be modified.
  • 2nd method: Select "New .. New blank page" in the context menu of the summary. A new blank page is automatically created and it can be modified.
  • 3rd method:
    • On the "Modification" tab, in the "Table of contents" group, expand "New" and select "New page".
    • In the wizard, select "Create a blank page".
    • Specify the characteristics of the page and validate.
  • 4th method: Select "New .. New page" in the context menu of the summary. In the wizard, select "Create a blank page". Specify the characteristics of the page and validate.

Creating a help page from an existing document

A wizard allows you to create a help page from on an existing document. In this wizard, select:
  • the name and path of the TXT, HTM or RTF file to import.
  • the name of the help page to create.
Caution: If the imported document contains several pages, all the pages will be imported into a single help page.
To start the import wizard, use one of the following methods:
  • on the "Modification" tab, in the "Table of contents" group, expand "New" and select "New page". In the wizard, select "Import an existing document".
  • select "New .. New page" in the context menu of the summary. In the wizard, select "Import an existing document".

Deleting a help page

To delete a help page:
  1. Select the help page in the summary.
  2. Select "Deletes the page" in the context menu of the summary (or press the Delete key).
Modifying the help pages

Sections of a help page

A help page includes several sections:
All these sections can be modified.

In a help page, you can:

Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 05/23/2023

Send a report | Local help