PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

  • Overview
  • How to proceed?
  • 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/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Creating the help pages
Overview
A help system includes several pages. The pages are the main elements of a help system. When the user consults the help, he reads the content of a help page.
Several types of help pages can be implemented in a help file, let's see the most common ones:
  • the context-sensitive help pages: the content of the help page gives information about the use of a specific window. In most cases, this type of help page is started from the help icon ("?" button) found 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.
The help pages are linked between themselves by links. The links allow the users to move within the help system.
Note: To automatically generate the help pages corresponding to the project elements (windows and reports), select "Help system .. Generate the help pages .. Generate help pages for the project".Note: To automatically generate the help pages corresponding to the project elements (windows and reports), on the "Modification" pane, in the "Help system" group, click "Generate help pages for the project".
How to proceed?

Creating a blank help page

To create a blank help page:
  • 1st method:
    • Select a page in the summary.
    • Select "Help system .. New blank page" ( ).On the "Modification" pane, 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" from the popup menu of the summary. A new blank page is automatically created and it can be modified.
  • 3rd method:
    • Select "Help system .. New page" ( ).On the "Modification" pane, 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" from the popup 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 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:
  • select "Help system .. New page" ( ). In the wizard, select "Import an existing document".on the "Modification" pane, in the "Table of contents" group, expand "New" and select "New page". In the wizard, select "Import an existing document".
  • select "New .. New page" from the popup 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 "Delete the page" from the popup menu of the summary (or press the [Del] key).Select "Delete the page" from the popup menu of the summary (or press the [Del] 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 required version
  • Version 9
Comments
Click [Add] to post a comment