Configure a grammar and spell checker profile

Adobe RoboHelp includes a grammar and spell-checking assistant, which makes your text error-free, and easy to understand. The grammar checker tool scans your topic or all topics in a project and offers suggestions for spelling and grammatical errors. The tool makes your project free of all language-related errors, punctuation errors, and other grammatical mistakes. The result is a project with high-quality content.

How it works

The grammar checker assistant stops at every instance of a misspelled word and possible grammatical disagreements. Based on the suggestions, you can either accept or reject them.

The tool scans the following and flags the errors:

  • Current File - Allows grammar and spell check on the file currently in focus.
  • All Topics - Allows grammar and spell check in all the files of the currently opened project.
  • All Project Files - Allows grammar and spell check in all the files of the currently opened projects, which include topics, TOC, Index, and Glossary.

Note: The grammar and spell checker assistant cannot check errors in a Markdown file.

Add a grammar and spell checker profile

As a pre-requisite, you must add a profile in RoboHelp. RoboHelp provides the following spell checker providers:

  • Sapling AI
  • Microsoft Spelling Checker API
  • Custom API

To add a profile, follow the steps below:

  1. On the toolbar, select Edit > Grammar and Spell Checker Profiles

  2. On the Grammar and Spell Checker Profiles dialog, select + near Profiles, and create a profile. 

    Create a grammar checker profile
    Create a grammar checker profile

  3. Name your profile and select the spell checker API from the drop-down menu.

    Select the grammar checker profile
    Select the grammar checker profile

  4. Select the required provider.

Sapling AI 

Create a profile 

Sapling is a grammar and spell checker service that you can integrate into RoboHelp and correct typos and rephrase the content. 

To integrate Sapling, follow the steps below: 

  1. Select Sapling.ai from the Grammar and Spell Checker Provider API drop-down menu.

    Select Sapling
    Select Sapling

  2. Enter the API key that Sapling provides. To get the API key, sign in to Sapling and create an account. Create an account in Sapling. After you create the account, you get an API key.

    You may also create a trial account, which is valid for 30 days.

    Copy the API key from the API section.

    Sapling API
    Sapling API

  3. Enter the API endpoint as https://api.sapling.ai/api/v1/edits

  4. If you have the endpoint header key and value, you can enter them as well. 

  5. To ensure that the information you’ve entered is valid and complete, select Validate. If there are any errors, re-check the information.

  6. Click Save.

Set Application Preferences

After you’ve created a Sapling profile, set the profile in the Application Preferences dialog.

From the drop-down menu, select the Sapling profile that you’ve created.

Select the grammar checker profile
Select the grammar checker profile

Microsoft Spelling Checker API

Create a profile

The Microsoft Grammar and Spelling Checker enables you to perform contextual grammar and spell checking on text.

To integrate Microsoft Grammar Checker, follow the steps below: 

  1. Select Microsoft Spelling Checker API from the Grammar and Spell Checker Provider API drop-down menu.

  2. Enter the API key and the endpoint of the Bing service. To get the API key, see the following resources:

Set Application preferences

After you’ve created a Microsoft profile, set the profile in the Application Preferences dialog.

From the drop-down menu, select the Microsoft service profile that you’ve created.

 Adobe

Получете помощ по-бързо и по-лесно

Нов потребител?