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.

settings_kb

Click “Table of Content.”

tabel_of_content

Scroll down to the Keyword index option and select Yes.

enable_keyword_index

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.”

open_keyword_index_tab

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.

select_the_page

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.