PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Overview
  • How to proceed?
  • Defining the languages supported by the help system
  • Translating the elements found in the help system
  • Displaying the help system in the selected language
  • Compiling and running the test of the help system in a specific language
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 a multilingual help system
Overview
The help editor of WINDEV gives you the ability to easily create a multilingual help system. All the elements found in the help system can:
  • be translated in the help editor directly.
  • be checked out for translation and checked in by WDMSG (optional tool used to check out and check in all the messages found in a WINDEV application).
As the help compiler does not allow you to create a multilingual help system, you will have to create a help file for each language supported by your help system.
How to proceed?

Defining the languages supported by the help system

By default, your help system and the project support the same languages.
To modify these languages (to add or remove languages for example):
  1. Display the description of the help system ("Help system .. Properties of help system", "Languages" tab).Display the description of the help system:
    • on the "Modification" pane, in the "Help system" group, click "Description".
    • display the "Languages" tab.
  2. Select the languages that will be supported by your help system. The "Synchronize with the project" button allows you to automatically take into account all the languages supported by the project.

Translating the elements found in the help system

If you do not use WDMSG to simplify the translation of the help elements, each element must be translated in its associated description window. The elements that must be translated are as follows:
  • Title of the help: this title is displayed in the title bar of the help file. To translate this title into the different languages, display the description of the help system ("Help system .. Properties of help system").Title of the help: this title is displayed in the title bar of the help file. To translate this title into the different languages, display the description of the help system: on the "Modification" pane, in the "Help system" group, click "Description".
  • Title of the help page: this title is the one used in the summary of the help file. To translate this title into the different languages, display the description of the help system ("Properties of the page" from the popup menu of the page or summary).
  • Index keywords: the keywords allow the users to easily find a help page. To translate the different keywords:
    1. Display the index in the editor ("Index" tab of the list of help pages).
    2. Display the properties of the keyword ("Keyword properties" from the popup menu) and enter the translation.
  • Header and content of the help page: to translate the header and the content of the help page, all you have to do is modify the display language of the help ("Display .. Language displayed"). The help page is displayed in the selected language.Header and content of the help page: to translate the header and the content of the help page, all you have to do is modify the display language of the help: in the "Modification" pane, in the "Translate" group, expand "Language displayed" and select the requested language. The help page is displayed in the selected language.

Displaying the help system in the selected language

By default, the help system is displayed in the editor in the main language of the project.
To display the entire help system in a specific language:
  1. Select "Display .. Language displayed".in the "Modification" pane, in the "Translate" group, expand "Language displayed".
  2. Select the requested language and validate.
  3. The entire help system is displayed in the editor in the selected language.

Compiling and running the test of the help system in a specific language

When compiling the help system, it will be created in the language displayed in the editor.
To avoid overwriting the help file created by each compilation, WINDEV proposes to manage the physical name of the help file by adding the identifier of the current language.
This option can be defined in the Compilation options. The identifier of the language used can correspond to:
  • the numeric identifier of the language used (identifier also used by Nation).
  • the text identifier of the language used (FR for French, ...).
// Start the help in a multilingual application
WHelp("MyHelp" + Nation() + ".chm")
Minimum required version
  • Version 9
Comments
Click [Add] to post a comment