ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / Editors / Help editor
  • Overview
  • How to?
  • Creating an index keyword (without associating it with a page)
  • Creating an index keyword and associating it to a page
  • Associating an existing index keyword with a page
  • Deleting an index keyword
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
Index keywords allow users to easily find a help page. Each help page can be associated with one or more keywords and each keyword can be associated with one or more pages.
Caution: index keywords are ignored in PDF help files.
How to?

Creating an index keyword (without associating it with a page)

To create an index keyword:
  1. Open the list of index keywords in the help editor ("Index" tab ).
  2. In the list of keywords, select "New keyword" in the context menu. The "New index entry" words appear in edit.
  3. Enter the keyword and validate.
Remarks: To set a keyword as "sub-keyword", simply drag it and drop it onto the main keyword.

Creating an index keyword and associating it to a page

You can create an index keyword and associate it directly to a page, from the page properties.
  1. Open the page properties ("Page properties" in the context menu of the page).
  2. Go to the "Index" tab.
  3. Click "Add". The index keyword management window opens.
This window allows you to:
  • create the help system keywords and sub-keywords.
  • associate existing keywords and sub-keywords to the current page.
To create a keyword or sub-keyword:
  1. Enter the keyword or sub-keyword.
  2. You can:
    • Click "Create key": the keyword will be created and added to the list of keywords in alphabetical order.
    • Select the main keyword in the list and click "Sub-key": the keyword will be added as a sub-entry of the selected keyword.
To associate a keyword or sub-keyword to the current page: Select the keyword or sub-keyword in the "Available keywords for this help system" list and click the ">" button.
  1. The keyword or a sub-keyword appears in the list of keywords associated with the page.
    • Validate the window.
Remark: The index keywords can also be automatically generated from the content of the page. For more details, see Automatic index generation.

Associating an existing index keyword with a page

To associate an index keyword with a page:
1st solution:
  1. Open the help page in the help editor.
  2. Open the page properties ("Page properties" in the context menu of the page).
  3. In the "Index" tab, click the "Add" button. Select the desired keyword in "Available keywords for this help system" and click "->".
2nd solution:
  1. Open the list of index keywords in the help editor ("Index" tab ).
  2. Select the desired index entry.
  3. Right-click the keyword and select "Keyword properties". For more details, see Keyword properties.
  4. In the "Association" tab, click the "Add" button and select the desired help page.

Deleting an index keyword

To delete an index keyword:
  1. Open the list of index keywords in the help editor ("Index" tab ).
  2. Select the desired index entry.
  3. Select "Delete keyword" in the context menu. All the pages associated with this keyword will no longer be associated with this keyword.
Minimum version required
  • Version 9
Comments
Click [Add] to post a comment

Last update: 05/24/2023

Send a report | Local help