PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

  • Overview
  • How to proceed?
  • Creating a help system associated with your application
  • Displaying the properties of the help system
Products
WINDEVWEBDEV - Server codeWEBDEV - Browser codeWINDEV MobileReports and Queries
Platforms
WindowsLinuxWindows MobileUniversal Windows 10 AppAndroidAndroid Widget iPhone/iPadApple Watch
Languages
JavaPHPAjaxUser code (UMC)External language
Databases
HFSQLHFSQL Client/ServerStored proceduresOLE DBODBCNative Accesses
Creating the help system in WINDEV
Overview
The main steps for creating a help file (HLP or CHM) are as follows:
How to proceed?

Creating a help system associated with your application

To create a help system associated with your application:
  1. Open your project in WINDEV.
  2. Select "File .. New .. Architecture .. Help". The wizard for creating the help is automatically started.Click among the quick access buttons.
    • In the wheel that is displayed, hover "Architecture" and click "Help".In the window that is displayed, click "Architecture" then "Help".
    • The wizard for creating the help is automatically started.
  3. Go to the next wizard step and specify:
    • the name of the help system,
    • a short description of this help system.
  4. Go to the next wizard step.
  5. Enter the information that will be displayed in the "About" box (caption, copyright, ...). Go to the next wizard step.
  6. Select the application windows for which a help page must be generated.
    The "Automatically generate the help button in each window" option is used to automatically create a help button in each selected window. This button will automatically open the corresponding help page. Go to the next wizard step.
  7. Select the application reports for which a help page must be generated. Go to the next wizard step.
  8. Validate. All the specified help pages are created and displayed in the help editor. Each page can now be modified, deleted, ... in the help editor.
  9. Save the help: a WDH file is created in your project.
List of help pages.
This list corresponds to the table of contents of the generated help file
Image of the window or report associated with the help page.
This image is displayed in a header area.
This image corresponds to the window or to the report associated with the help page in edit. This image can be moved to the body area of the help page for example.
Title of the help page.
This title is displayed in a header area. This area can have a specific background color.
Body of the help page.
Contains the text, the images, the links, ... of the help.
Tabs used to go from the summary to the index.
Note: Once your help system is created, use one of the following methods to open this help system in the help editor:
  • select "File .. Open" and select the corresponding help file (WDH file).on the "Home" pane, in the "General" group, expand "Open", select "Open" and the corresponding help file (WDH file).
  • select the "Helps" folder in the "Project explorer" pane and double-click the name of the help system.

Displaying the properties of the help system

The properties of the help system are used to define:
  • the logical name of the help system,
  • the default page displayed by the help,
  • the languages supported by the help system,
  • ...
To display the properties of the help system, select "Help system .. Properties of the help system".To display the properties of the help system, on the "Modification" pane, in the "Help system" group, click "Description".
See Properties of the help system for more details.
Minimum required version
  • Version 9
Comments
Click [Add] to post a comment