Share:
ClickHelp Documentation

Check Spelling: Built-in, Browser, Grammarly

In this topic, we'll look at three different approaches to spell checking in ClickHelp:


Built-in ClickHelp Spell Checking

ClickHelp topic editor has a built-in spell checker. It is fairly similar to the "Spelling & Grammar" tool in Microsoft Word. It looks all the words up in a dictionary, marking words that are not in the dictionary, and suggests a replacement for them.

Note
ClickHelp picks dictionaries based on the project's Language setting. To learn more about adjusting the language for your project, refer to this topic: Adjusting Language for ProjectIf there is no needed language in our dictionary database, ClickHelp will use English by default.   

To check the spelling in your topic, first, start editing the topic in the Design view. Then click on the "Check Spelling" button — it is located under the "Spell Checker" section of the Home tab of the ribbon:

When you do that, you will see the Check Spelling dialog — but only if you have incorrectly spelled words or are missing from the dictionary.

You will see the topic's content in the upper part, with one of the words having a red wavy underline. It means that there is no such word in the dictionary and the spell checker considers this word to have incorrect spelling. The replacement suggestions are given below.

There are several buttons to the right:

  • Ignore once - ignore the underlined word once for the current spell-checking session. When you close and open this dialog again, the word will be underlined again.
  • Ignore all - ignore all of the occurrences of the underlined word in the entire topic.
  • Add to dictionary - add the word to the dictionary and always consider it correct.
  • Change - change the underlined word to the selected suggestion.
  • Change all - change all occurrences of the underlined word to the selected suggestion.

There's also the "Options" button that allows you to set up ignoring certain words like emails or uppercase words.

When the spell checking is completed — all of the words have been changed with the suggestions, ignored, or added to the dictionary — you will see the corresponding notification.

Note
If you need to use a language that is not present in our dictionary database, please contact us at support@clickhelp.com — we'll consider adding it.   

Browser Native Spell Checking

All of the major browsers, like Chrome, Edge, or Firefox, have their own spell-checking feature.

By default, it is disabled in the Topic Editor, along with the browser context menu that is, among other things, used to perform spell-check related operations. To enable the context menu and the browser built-in spell-checking feature, you need to tick the "Check as you type" option. It's located under the "Spell Checker" section of the Home tab of the ribbon:

Third-party Extensions/Services (Grammarly)

There are plenty of third-party browser extensions and services that allow you to check the spelling and grammar. The most popular one is Grammarly. It features a browser extension that allows you to check grammar and spelling in ClickHelp "on the go":

Note
Grammarly works in place of the browser's spell-checking feature, effectively disabling it. But it does not interfere with the ClickHelp Spell Checking.  

It also provides some advanced functionality like formatting recommendations and tone adjustment along with a more detailed analysis of the text you write:

You do not need to do any extra steps in ClickHelp to enable Grammarly - install and enable the browser extension.

Note
Grammarly works regardless of the "Check as you type" feature being enabled or disabled.