WProofreader is multilingual proofreading solution that is designed to be integrated into web apps. It enables spelling, grammar, and style check while users type or work with text in WProofreader dialog. With auto-search feature enabled, it detects editable fields in focus, be it HTML editable controls or WYSIWYG editors, and enables spelling and grammar checking there. View the full list of supported integrations for details. 

WProofreader is the Web Content Accessibility Guidelines (WCAG) and Section 508 compliant, thus its actions are available using a keyboard. For more information, refer to WProofreader v2.2.x Keyboard Navigation guide.

This version of the guide describes WProofreader user interface starting from version 2.3.


1. Text Input Field

Since WProofreader is integrated in one of supported rich text editors or HTML editable elements, most part of interaction with it takes place in the input field. The input field is an editable node where users enter text. 

Once you have enabled WProofreader, misspelled words, grammar or style problems are underlined with a red or green line respectively. The number of issues found is displayed in the lower-right part of the text input field as a badge. 

Users have several options to address the problem: 

  • Hover on a marked word or phrase and replace it with a suggested one from the list of available corrections.
  • Hover the badge with a number of issues found to switch to the Proofread in dialog mode. 

While the text is being checked, the badge circles showing that checking is in progress. This process continues as users keep on typing.

2. Suggestions Balloon

As you type your text in a web app where WProofreader is integrated, it tries to discover spelling, grammar and style problems and suggest options to correct them. The total number of discovered issues will be shown in the orange badge in the lower-right part of the editor screen. 

WProofreader suggestions balloon is displayed when a user hovers on a marked misspelled word or phrase with a style or grammar problem. 

In case of a spelling error, user can perform the following actions: 

  • correct a mistake with a suggestion available on the list, 
  • ignore a mistake for a particular word throughout the text, 
  • add a word to the personal dictionary so that it is no longer highlighted as an incorrect word and offered in the correction list for relevant words.

Only one word is highlighted in case of a spelling error. A whole phrase can be highlighted if the grammar issues were discovered. For grammar problems, a single word can be underlined.

The suggestions balloon for a grammar or style problem differs from the one for spelling errors. It also provides a problem description – a rule which explains why the phrase is highlighted as a grammar or a style problem.

Common actions that are available in the default suggestions balloon are listed in the table below.

Action NameDescription
Problem descriptionA rule which explains why a phrase is considered a grammar or style problem.
Suggestions listSelect a word from the list of available suggestions in pop-up balloon with suggestions.
Ignore all

Ignore a spelling, grammar or style problem for a certain word or phrase in the active text fragment.

The word you have ignored is not considered a misspelling or a grammar error for the current browser session only.

Add word

Add a word to a personal user dictionary so that they are no longer considered as a misspelled ones and will be available in the correction list for relevant words.

The Add word action is available for the words which are not recognized by spell check engine.

3. Proofreading in a Dialog

In addition to spelling and grammar check during typing process, users can proofread all the text at once in a separate dialog. To access the proofreading in dialog mode hover on the badge, then click Proofread in Dialog icon.

4. Settings 

You can modify WProofreader settings such as spelling ignore options, languages, and manage personal dictionaries in Settings dialog. There are several ways to access it: 

  • from the badge in the lower-right part of the editor screen by clicking the Settingsicon;
  • in WProofreader dialog, switching to Settings mode and clickingicon in its upper-left corner.

4.1. Options

Options tab is used for specifying most common cases to ignore spelling checks: 

  • words with all letters capitalized (for example, “WSC”), 
  • domain names (for example, “support@webspellchecker.net”),
  • words with mixed case (for example, “WebSpellChecker”), 
  • words with numbers (for example, “2nd”).

Select the desired types of spelling errors to be ignored by WProofreader in this dialog.

Options are applied automatically and will be valid for the current session only. After reloading the page, the settings are reset unless they are predefined by default by the administrator.  

4.2. Languages

Out-of-the-box WProofreader provides spell check for 17 languages and grammar check for 15 out of 17 default languages. This list can be extended with the additional languages if required. 

The Languages tab of the Settings dialog contains the list of available languages for spelling and grammar checking and is used for setting the default checking language. Here you can select one of the language locales for grammar and spelling check.

4.3. Dictionary

Dictionaries tab of the Settings dialog is used to manage personal user dictionaries. Here you can create personal user dictionaries by adding your domain-specific terms, names and other words to it. These words can be: 

  • complex words, 
  • acronyms, 
  • proper names. 

Personal User Dictionaries

Personal user dictionaries allow each of your app’s users to create their own vocabulary to be used across multiple sites that use WProofreader. These can be rare or field-specific words may be not recognized by our proofreading engine and reported as a mistake. All the words added to a personal dictionary will not be considered as misspelling, and they will also be available on the suggestions list.

By default, all the words added to the personal user dictionary are stored in the browser local storage on the user side. When a user creates a new dictionary, all the new words and the words from the browser local storage are added to this dictionary and stored on the system server. It allows the user to access the contents of his or her personal dictionary from different browsers, machines or devices when working with WProofreader. Thus, users are not limited by a particular browser as in case with the words stored in the browser local storage.

Users can manage the dictionaries contents using the Dictionaries tab of the Settings dialog.

Create a personal dictionary

To create a new dictionary, navigate to the Dictionaries tab, type a new dictionary name and click Create

All the new words and the words from the browser local storage will be added to this dictionary and stored on the server. It allows the user to access the contents of his or her personal dictionary from different browsers, machines or devices when working with WProofreader. Thus, users are not limited by a particular browser as in case with the words stored in the browser local storage.

Connect the existing dictionary

To connect an already existing dictionary containing a list of previously added words, type the dictionary name and click Connect.  

Once the dictionary is connected, the words will be added to the dictionary on the server. If the dictionary is not connected, all newly added words are saved to a local storage.

Rename a dictionary

To rename a dictionary: 

  1. Navigate to Settings dialog and select Dictionaries tab.
  2. Press the Tab continuously to select the Renameicon near the selected dictionary name. Type the desired new name and press Enter or press Tab to select the Rename button and press Enter
    The dictionary will be renamed.

Add words to the dictionary

There are several ways to add words to the dictionary depending on the current WProofreader working mode: 

  • Using Add word action in a suggestions balloon,
  • In Proofread in dialog mode, click Add wordin the Problems-suggestions area.

  • In Dictionaries tab, type the desired word and click Add word or press Enter or Space to confirm the action.

Remove words from the dictionary

You can remove specific words from the connected dictionary. To do so: 

  1. Navigate to Settings dialog and select Dictionaries tab.
  2. In the words list area, navigate to the desired word and click the Delete wordicon.

This action cannot be undone. 

Also you can remove the whole dictionary which is no longer required. To do so, type the name of the existing dictionary and connect it, and in the Dictionaries tab, click the recycle bin icon.

All words from the selected dictionary will be removed, and you cannot restore them later.

For details on working with user dictionaries, refer to User Dictionary FAQ section.

4.4. About

About tab of WProofreader Settings dialog shows information on WProofreader version as well as copyright info. You can find it useful when providing the information about your system to our support team.


Can be also useful: 

  • No labels