Keyword Index


In addition to the table of contents, you can also create a keyword index. An index is a list of keywords or phrases that link to a page. Think of this as similar to a book index. This can help readers find the information they are looking for.


You can include the page in the keyword index and specify an index name when adding new pages. The index will list the keywords in alphabetical order (ABC). You can also hide the entire keyword index tab.


Benefits of creating a keyword index:


  • Ease of use and navigation through the help center for users

  • Save user's time and effort in finding the correct information


In this article, you will learn how to:


Enable the Keyword Index


By default, the keyword index is turned off. To enable the keyword index,


  • Go to Settings in the navbar.




  • Click “Table of Content.”




  • Scroll down to the Keyword index option and select Yes.




  • Click Save.


NOTE! Your user role will determine whether or not you have access to the Settings section.


How to View the Keyword Index


  • In the left sidebar, click “Index.”




This will display the index of keywords. To view a page, click on a keyword, and that page will open.


How to Add a Page to the Keyword Index


  • Navigate to the page in the TOC that you wish to add to the keyword index. 




  • Click “Edit Page.”




  • Click on the Settings icon.


Open Settings


  • In the screen overlay, switch to the Advanced tab.

  • Select the checkbox in front of “Show page in index.”

  • Type in a keyword or phrase in the input field.

  • Use a comma to indent and group. For example, “Passwords, How to reset” would group under “Passwords.”


You can also enter multiple keyword entries. Each row you add will be a new entry in the index. For example, the two rows “Passwords, How to reset” and "My Account, Manage password" would create two separate keyword entries linking to the same page.


  • Click on the Save button.


Edit details


NOTE! Make sure to enable the Keyword Index feature.


How to Hide a Page from the Keyword Index


  • Go to the page settings.

  • Switch to the Advanced tab in the screen overlay.

  • Uncheck the “Show page in index” option.

  • Save the settings. 


Uncheck the box


The page will no longer appear under those keywords in the index.


How to Rename a Keyword


  • Go to the page settings.

  • Switch to the Advanced tab in the screen overlay.

  • Replace the keywords.

  • Click Save.


Replace current keywords with new ones


How to Filter

The filter will search the index by keyword. It will explore the entire index and only show the results that match.


Type the keyword


To filter the index, type your search term in the input field.

  • The index will immediately search and display the results.
  • Delete the search term out of the box to revert to the standard view.


That is all about the keyword index.



Was this information helpful?
© 2005 - 2023 ProProfs
add chat to your website