Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

Being an administrator, you can customize WProofreader default settings such as user interface and application behavior , for exampledescribed in this guide. 

This guide covers the following topics

  • Number of spelling suggestions, 
  • WProofreader dialog user interface elements and orange badge, 
  • Settings dialog;
  • Default language settings;
  • Dictionaries features such as predefined dictionaries available for all system users and Dictionaries tab;
  • About tab of WProofreader Settings dialog by removing WProofreader brand name;
  • autoSearch settings.

WProofreader Initialization Options

There are several  options letting you initialize WProofreader functionality in your web app, namely using: 

  • autoSearch (config and inline data attributes);
  • init() method;
  • init () and CONFIG without autoSearch.

For details, refer to Get Started with WProofreader Server (autoSearch) guide and Get Started with WProofreader Cloud autoSearch.

After you have initialized WProofreader, you can customize the above-mentioned settings using WProofreader API. You can also configure  some parameters using WProofreader API for grammar, spelling check, and WProofreader dialog user interface.

autoSearch description and advantages

The autoSearch feature enables detecting new editable fields on the page and proofreading the text they contain automatically on hover selection. If you choose this option, WProofreader is enabled in the selected WYSIWYG editor or HTML editable control, and no additional actions are required. 

Initialization using inline attributes is suitable if you want to have a single script with basic options definitions. 

Please note that with this type of initialization array or number API parameters are not supported. Thus, you cannot modify such parameters as actionItems, suggestionsCount, and moreSuggestionsCount described further in this section.

autoSearch is useful when your web page which has multiple controls, you add one script which is enabled in the areas in focus automatically compared with creating an init() for each control. From the performance point of view, autoSearch also has a better performance as the grammar and spelling and style are checked only in active area compared with checking in all controls like in init()

Another advantage of autoSearch for dynamic page where some fields can be hidden or added at a certain point, autoSearch is enabled automatically and releases the memory automatically as well helping to avoid possible  memory leaks. 

init() method description and advantages

The init() method is a reasonable choice when you clearly know in which control you want to initialize in WProofreader. More than that you are aware of your page controls, and additional controls do not appear dynamically. 

Consider the following situation when your web application page has several text areas where you want to initialize WProofreader. As soon as the user loads the page, WProofreader is enabled automatically, and it’s not required to select the area to enable grammar and spelling check in it compared with autoSearch method. 

With dynamic web page load using init() method, administrator needs to be monitor when it’s necessary to start WProofreader and. From the performance point of view, grammar and spelling and style are checked in all controls like in init() which implies performance increase.

Server and Cloud Version of WProofreader

In general, WProofreader provides the same functionality for both Cloud and Server versions. The difference is mainly about the location of requests processing: it can be either on WebSpellChecker Cloud hosted on Amazon Web Services (AWS) in data centers in the USA or on your server or using other Cloud services providers. 

With Cloud version, to validate the access to our server, you need to use a special activation key in service ID parameter. The path to WProofreader Cloud will be obtained from the path to to wscbundle.js file.

For the Server version,  you need to instruct WProofreader to be aware where the requests will be processed by specifying the following parameters:

  • serviceProtocol
  • serviceHost
  • servicePath
  • servicePort

Example for setting up the Server version of WProofreader: 

Code Block
languagejs
themeEmacs
<script>
    window.WEBSPELLCHECKER_CONFIG = {
        autoSearch: true,
        enableGrammar: true,
        serviceProtocol: 'https',
        serviceHost: 'your_host_name',
        servicePort: '2880',
        servicePath: '/'
  };
</script>

For more details, refer to Get Started with WProofreader Server AutoSearch.

Table of Contents
maxLevel3
stylenone

1. Introduction

1.1. Server and Cloud version

In general, WProofreader provides the same functionality for both Cloud and Server versions. The difference is mainly about the location of requests processing: it can be either on WebSpellChecker Cloud hosted on Amazon Web Services (AWS) in data centers in the USA or on your servers such as physical servers, VMs or instances. 

With Cloud version, to access the services, you need to use a special activation key in serviceId parameter. The path to WebSpellChecker Cloud will be obtained from the path to the wscbundle.js file.

For the Server version, you need to instruct WProofreader where the requests will be processed by specifying the following parameters:

  • serviceProtocol
  • serviceHost
  • servicePath
  • servicePort

Example of setting up the Server version of WProofreader with the autoSearch option turned on: 

Code Block
languagejs
themeEmacs
<script>
    window.WEBSPELLCHECKER_CONFIG = {
        autoSearch: true,
        serviceProtocol: 'https',
        serviceHost: 'your_host_name',
        servicePort: '443',
        servicePath: 'wscservice/api'
  };
</script>
Code Block
languagejs
themeEmacs
<script type="text/javascript" src="http(s)://your_host_name/wscservice/wscbundle/wscbundle.js"></script>

For more details, refer to Get Started with WProofreader Server AutoSearch.

Example for setting up the Cloud version of WProofreader with the autoSearch option turned on: 

Code Block
languagejs
themeEmacs
<script>
    window.WEBSPELLCHECKER_CONFIG = {
	autoSearch: true,
    serviceId: '1:your-service-ID'
   };
</script>
Code Block
languagejs
themeEmacs
<script type="text/javascript" src="https://svc.webspellchecker.net/spellcheck31/wscbundle/wscbundle.js"></script>

For more details, refer to Get Started with WProofreader Cloud AutoSearch

1.2. AutoSearch options

Once you have enabled autoSearch by adding autoSearch: true, in configuration, you can specify where the spelling and grammar check should be enabled on your webpage.

By default, WProofreader with autoSearch function turned on will be enabled only in the area in focus. For the areas which are not focused, WProofreader will not be enabled by default until user places a cursor there and starts typing. For details, refer to the following AutoSearch Creation options

  • disableAutoSearchIn lets you disable the autoSearch mechanism by class, id, data attribute name, and HTML elements. Please note that if enableAutoserchIn option is specified, this option will be ignored. 
  • enableAutoSearchIn lets you enable the autoSearch mechanism only for elements with provided class, id, data attribute name or HTML elements type.
Warning

Only one option can be used at the same time. The enableAutoSearch option has higher priority compared with disableAutoSearchIn. If you try using both of them, it can lead to unpredictable behavior and conflicts.

Code Block
languagejs
themeEmacs
<script>
    window.WEBSPELLCHECKER_CONFIG = {
        autoSearch: true,
        disableAutoSearchIn: ['.class', '#id', '[data-attribute]', 'textarea'], 
        enableAutoSearchIn: ['.class', '#id', '[data-attribute]', 'textarea'],
		... 
    }
</script>

1.2.1 Enable proofreading in inputs

By default, WProofreader is disabled in HTML <input> editable elements due to possible compatibility issues. However, you can change this behavior by using the enableAutoSearchIn option:

Code Block
languagejs
themeEmacs
enableAutoSearchIn:['input'],

1.3. AutoStartup 

The autoStartup parameter is set to true by default, meaning that WProofreader starts in the enabled state and starts processing available text for grammar, spelling, and style errors. If, for some reason, you do not want WProofreader to start checking text at once and allow your users to choose when to start, you have an option to start WProofreader in the disabled state. To do so, set the autoStartup value as false, as shown below: 

Code Block
languagejs
themeEmacs
autoStartup: false,
Note

When WProofreader starts in a disabled state, the badge is grayed out. To activate it, users need to go to the badge and click the turn on icon.

1.4. Deactivating grammar checking

Grammar checking is enabled by default in WProofreader. If you want to deactivate grammar checking, specify the enableGrammar parameter and set it to false as shown below: 

Code Block
languagejs
themeEmacs
enableGrammar: false,
Note

After you have deactivated grammar checking, it becomes disabled for all languages. Only spell check will be performed then.

2. Customizing user interface

With WProofreader API you can customize:

  • Change the default style theme;
  • Suggestions balloon view and commands available;
  • Badge view and commands available; 
  • Settings dialog view and additional preferences; 
  • Actions for Proofread in dialog mode.
Tip

Here you can find the full list of API options and methods available for WProofreader.

2.1. Change the default style theme

You have an option to change the default style theme using theme option. At the moment, the following themes are available: default, gray, dark, custom.  The gray theme perfectly matches the color palette of modern rich text editors.

Besides, you can adjust CSS styles to make them look native inside your web app. To do this, simply use the custom theme option and write your CSS styles. Find out more in our how-to guide: How to customize the look and feel of WProofreader?

Code Block
languagejs
themeEmacs
theme: 'gray',

2.2. Suggestions pop-up view and commands

You can customize WProofreader options available in the suggestions pop-up. For example:

  • Limit the number of suggestions shown to users; 
  • Prevent users from adding words to the user custom dictionary;
  • Add more commands to the list of action items, for example, the possibility to switch to the Settings dialog. 
Note

The latter is possible only in case of disabled badge. All the action items from the badge are moved to the suggestions pop-up then. For details, see Changing the Badge View and Options section. 

Anchor
changingNumberofSuggestions
changingNumberofSuggestions
2.2.1. Changing the number of spelling suggestions 

By default, WProofreader offers 3 suggestions in its suggestions pop-up. An admin can customize this number using an API option and provide both bigger and smaller number of suggestions. 

For Cloud version, up to 8 suggestions are available. For the Server version, this number can be increased. You can use the suggestionsCount parameter to increase or decrease the number of spelling suggestions shown to your end users.

Note

Displaying a significant number of suggestions may decrease the speed of the service. 

To display only 2 suggestions:

Code Block
languagejs
themeEmacs
suggestionsCount:2,

2.2.2. Changing action items order and availability

Use the actionItems parameter to add or hide the menu items in the suggestion pop-up and modify the order of these items. To do so, change the 'addWord', 'ignoreAll', 'ignore', 'settings', 'toggle', 'proofreadDialog' array values accordingly. 

For example, if you want to prevent your users from adding words to their user custom dictionary, remove the 'addWord' value from the array of parameter values:Example for setting up the Cloud version of WProofreader: 

Code Block
languagejs
themeEmacs
<script>
    window.WEBSPELLCHECKER_CONFIG = {
	autoSearch:true,
    serviceId: '1:j47ai-r4SLN1-dG5xP1-UuonU-WqXUZ3-0bzqZ1-QI8OP1-bQZcb1-KQuPE3-nWbcY3-aA4Zk4-wT9'
   };
</script>

For more details, refer to Get Started with WProofreader Cloud AutoSearch

actionItems: ['ignoreAll', 'ignore', 'settings', 'toggle', 'proofreadDialog'],
Note

Removing the addWord from the array of parameter values removes the Add word command for both suggestion balloon and for proofreading in dialog mode.

To hide Settings dialog for your users, remove the 'settings' from the array of parameter values: Example of specifying a path to wscbundle.js:  

Code Block
languagejs
themeEmacs
<script type="text/javascript" src="[path_to_config]/wscbundle_config.js">
</script>
Note

The serviceId parameter value in code sample above is an example.

AutoSearch Options

Once you have enabled autoSearch by adding autoSearch: true, in configuration, you can specify where the spelling and grammar check should be enabled on your webpage. By default, WProofreader with autoSearch function turned on will be enabled only in the area in focus. For the areas which are not focus, WProofreader will not be not enabled by default until user places a cursor there and starts typing. For details, refer to the following AutoSearchCreation options

  • disableAutoSearchIn lets you disable the autoSearch mechanism by class, id, data attribute name and HTML elements. Please note that if enableAutoserchIn option is specified, this option will be ignored. 
  • enableAutoSearchIn lets you enable the autoSearch mechanism only for elements with provided class, id, data attribute name or HTML elements type.
Note

WProofreader will be enabled on all types of editable controls on the page if they are in focus. The only exception is <input> control which is disabled by default as not supported by default.

The CONFIG can be added in a script or loaded from the file as mentioned in Get Started with WProofreader Cloud Auto-search  and Get Started with WProofreader Server Auto-search guides as well as added into inline data attributes.

Code Block
languagejs
themeEmacs
<script>
    window.WEBSPELLCHECKER_CONFIG = {
        autoSearch: true,
        disableAutoSearchIn: ['.class', '#id', '[data-attribute]', 'textarea'], 
        enableAutoSearchIn: ['.class', '#id', '[data-attribute]', 'textarea'],
... 
    }
</script>

AutoStartup 

The autoStartup parameter is set to true by default for autoSearch initialization and init() method meaning that WProofreader starts in enabled state and starts processing available text for grammar, spelling, and style errors. 

actionItems: ['addWord', 'ignoreAll', 'toggle', 'proofreadDialog'],

2.2.3. Enabling or disabling the more suggestions sub-menu item

By default, the moreSuggestionsCount parameter is set to 0, meaning that additional suggestions, if there are any more than specified in the suggestionsCount parameter are not shown. To display 3 suggestions on the suggestions balloon view and show 5 more suggestions in the More Suggestions section:

Code Block
languagejs
themeEmacs
suggestionsCount:3,
moreSuggestionsCount:5,

Anchor
wproofreaderBadge
wproofreaderBadge
2.3. WProofreader badge

The badge in the lower-right part of the editable area shows the status of the checking process (namely, the number of errors, the process itself – spinner, all checked) and allows to access more options: 

  • Turn on/off the proofreading;
  • Switch to the ‘Proofread in dialog’ mode;
  • Switch to the Settings dialog to manage spell checking options, language, and user custom dictionary;
  • Promptly select a language for check.
  • Enable the global state of the badge.
  • Sets the relative position of the badge in pixels.

2.3.1. Badge view and options

You can change the following badge options:

  • Turn off badge pulsation,
  • Completely remove a badge,
  • Remove some actions from the badge, for example, Settings Image Added, Disable/enable WProofreader Image Added, or Proofread in dialog Image Added.

2.3.2. Turning off badge pulsation
Status
colourRed
titleINACTIVE | 5.24.0

When WProofreader starts, the badge starts pulsing three times to get the user’s attention to the discovered issues. If it turns out to be distracting for the users, you can disable pulsation by setting the disableBadgePulsation parameter as true as shown in the sample below:

Code Block
languagejs
themeEmacs
disableBadgePulsing:true,

2.3.3. Removing a badge

If the enableBadgeButton parameter is set false,  part of action items, specifically Settings, Disable/Enable and Proofread in dialog from the badge area will be moved to the suggestions pop-upIf for some reason, you do not want WProofreader to start checking text at once and allow your users to choose on when to start , you have an option to start WProofreader in the disabled state. To do so, set the autoStartup value as false, as shown below

Code Block
languagejs
themeEmacs
autoStartupenableBadgeButton: false,
Note

When WProofreader starts in disabled state, and the badge is grayed out. To activate it, users need to go to badge and click the turn on icon.

1.4 Deactivating Grammar Checking

Users will not have an indication of the total number of errors detected in the control. The spinner that shows the grammar and spelling checking process is also disabled.

2.3.4. Removing actions from badge

To remove some actions from the badge, for example, SettingsImage Added , Disable/enable WProofreader Image Added, or Proofread in dialog Image Added, use the actionItems parameter. An example below shows how you can allow the users to access proofreading in dialog only from the badgeGrammar checking is enabled by default in WProofreader. If you want to deactivate grammar checking, specify the enableGrammar parameter and set it to ‘false’ as shown below

Code Block
languagejs
themeEmacs
enableGrammaractionItems: false,
Note

After you have deactivated grammar checking, it becomes disabled for all languages. Only spell check will be performed then.

Customizing WProofreader User Interface

With WProofreader API you can customize:

  • Suggestions balloon;
  • Application  Settings and commands available in suggestions  balloon and the orange badge area;
  • Actions for spelling and grammar checking for proofreading in dialog mode;
  • Actions for spellcheck available in as you type mode such as Add word and Ignore all;
  • Displaying or hiding grammar tips for grammar errors; 
  • Branding and copyright information displayed on the About tab.
Tip

Here you can find the full list of API options and methods available for WProofreader.

Suggestions Balloon

You can customize WProofreader options available in suggestions balloon, for example:

  • Limit the number of suggestions shown to users; 
  • Prevent users from adding words to personal user dictionary;
  • Add more commands to the list of action items, for example, possibility to switch to the Settings dialog. 
Note

The latter is possible only in case of disabled orange badge. All the action items from the badge are moved to the suggestions balloon then. For details, see Changing the Badge View and Options section. 

2.1.1. Changing Action Items Order and Availability

Use the actionItems parameter to add or hide  the menu items in the suggestions balloon and modify the order of these items. To do so, change the  'addWord', 'ignoreAll', 'settings', 'toggle', 'proofreadDialog' array values accordingly. 

[ 'proofreadDialog'],

2.3.5. Enabling language selector in badge

There is an option available that allows adding a language selector that will be present on the badge. This helps a user switch quickly among languages without going to the settings.

Code Block
languagejs
themeEmacs
enableLanguagesInBadgeButton: true,

2.3.6. Enable the global state of the badge
Status
colourGreen
titleNEW | 5.24.0

There is an option available that allows enabling one global badge on the page that aggregates all the suggestions on the page instead of having separate badges for each field.  By default, it’s disabled.

Code Block
languagejs
themeEmacs
globalBadge: true,

2.3.7. Moving global badge 
Status
colourGreen
titleNEW | 5.26.0

If global badge is enabled it will be placed in the bottom right corner of the page and its position can be regulated using the following options: badgeOffsetX, badgeOffsetY, badgeZIndex.For example, if you want to prevent your users from adding words to their personal user dictionary, remove the  'addWord' value from the array of parameter values:

Code Block
languagejs
themeEmacs
actionItems: ['ignoreAll', 'settings', 'toggle', 'proofreadDialog'],
Note

Removing the addWord from the array of parameter values removes the Add word command for both suggestion balloon and for proofreading in a dialog mode.

To hide Settings dialog for your users, remove the 'settings' from the array of parameter values: 

Code Block
languagejs
themeEmacs
actionItems: ['addWord', 'ignoreAll', 'toggle', 'proofreadDialog'],

2.1.2 Changing the Number of Spelling Suggestions 

By default, WProofreader offers 3 suggestions in its suggestions balloon. As an admin can customize this number using an API option and provide both bigger and smaller number of suggestions. 

For Cloud version, up to 8 suggestions are available. For the Server version, this number can be increased. You can use the  suggestionsCount parameter to increase or decrease the number of spelling suggestions shown to your end users.

Note

Displaying a significant number of suggestions may decrease the speed of the service. 

To display only 2 suggestions:

Code Block
languagejs
themeEmacs
suggestionsCount:2,

2.1.3 Enabling or Disabling the More Suggestions Sub-menu Item

By default,  the moreSuggestionsCount parameter is set to 0 meaning that additional suggestions if there are any more than specified in the SuggestionsCount parameter are not shown. To display 3 suggestions on the suggestions balloon view and show 5 more suggestions in the More Suggestions section:

Code Block
languagejs
themeEmacs
suggestionsCount:3,
moreSuggestionsCount:5,

2.2 Settings Dialog Tabs

With WProofreader API you can customize the user interface of the Settings dialog, namely, change the order of the tabs in user interface or hide some elements or disabling or enabling some
badgeOffsetX = 20, badgeOffsetY = 20, badgeZIndex = 1000

2.4. Settings dialog

The Settings dialog contains the following sections: Options, Languages, Dictionaries, General and About. 

NameActions availableDescription
Ignore options

Predefine some or all available options for application users.

Specifying the most common cases to ignore spelling checks: 

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

Hide the section from your users so that they use only predefined options and set predefined language for all of them.

Selecting the default language for grammar and spelling checking.
DictionariesHide the section from your users so that they use only predefined options and set up a predefined user dictionary for all of them.

Adding and deleting words to/from personal user dictionaries. Connecting and disconnecting selected dictionaries.

GeneralPredefine some or all available features for application users.

Enabling or disabling the following suggestions:

  • spelling suggestions
  • grammar suggestions
  • style guide suggestions
  • correct spelling automatically
  • autocomplete suggestions
AboutHide the branding information if you have a fully-fledged version of WebSpellChecker.

Displaying information on WProofreader copyright info and version number.

Depending on your web app usage preferences or requirements, you may want to customize the Settings dialog, for example:

  • Hide one of the sections;
  • Disable commands for users so that they have the admin-defined settings and presets only.

Depending on your web app usage preferences or requirementsWith the settingsSections parameter, you can customize change the Settings dialog tabs availability and modify its user interface elements.With the settingsSections parameter you can change the Settings dialog tabs visibility and order, i.e hide one of the sections, change the order of the mostly used tabs first or remove some sections from the user interface if, for example, you don’t want your users to have access to them and have access to admin-predefined settings only. Example below places Options tab after Languages and Dictionaries tabs: sections visibility. Example below places Options, Languages and Dictionaries tabs and hides General tab: 

Code Block
languagejs
themeEmacs
settingsSections: ['languages', 'dictionaries', 'options'],

2.4.1. Ignore options  

Settings on the Options section let you define the following spelling exceptions:

  • All caps words like 'EXAMPL'.
  • Domain names like 'http://example.com'.
  • Words with mixed case like 'eXaMpL'.
  • Words with numbers like 'exampl7'. 

You can change the default behavior using the following parameters:

Code Block
languagejs
themeEmacs
settingsSectionsignoreAllCapsWords: true,
ignoreDomainNames: ['languages', 'dictionaries', 'options'],
Note

You can remove the About tab of WProofreader dialog only if you have purchased a Custom Server or Cloud version of WProofreader package.

Tab nameAvailable actions
OptionsPredefine some or all available options for application users.
LanguagesHide the tab from your users so that they use only predefined options and set predefined language for all of them.
DictionariesHide the tab from your users so that they use only predefined options and set predefined user dictionary for all of them.
AboutHide the branding information if you have a fully-fledged version of WebSpellChecker.
true,
ignoreWordsWithMixedCases: true,
ignoreWordsWithNumbers: true,

To disable ignoring, set the value of the desired option as false.

2.4.2. Language

The Language section of the Settings dialog contains the list of available languages for spelling and grammar checking and enables users to set the default checking language.

To set the predefined language for all application users, use the lang parameter and specify the desired language short code as shown in the Default Language for all Users section.

To hide the Language section from your users so that they cannot modify the selected language, use the settingsSections parameter as shown below:

Code Block
languagejs
themeEmacs
settingsSections: ['options', 'dictionaries', 'about'],

2.4.3. Dictionaries

Customizing Dictionaries user interface

These are some options for altering Dictionaries user interface elements and features:

  1. Hiding Dictionary view at all.
  2. Hiding or removing the Preferences section on the Dictionary view to prevent users from adding/changing/removing the dictionary.
  3. Setting up a predefined dictionary for all users.
Hiding preferences section on the Dictionary tab

The Preferences section of the Dictionaries tab contains action items and buttons for managing user dictionaries, specifically: create a new dictionary, connect/disconnect existing dictionary, rename and delete a dictionary.

You may need to hide or remove the Preferences section when users have a general user dictionary and you do not want your users to make any changes to it except adding or removing words. 

 To disable the dictionary preferences UI for your users, specify the disableDictionariesPreferences option as true

2.2.1. Options Tab 

Settings on the Options tab let you define the following spelling exceptions: 

  • All caps words like 'EXAMPL'.
  • Domain names like 'http://example.com'.
  • Words with mixed case like 'eXaMpL'.
  • Words with numbers like 'exampl7'. 

Use the parameters values in sample below to enable or select these elements of the Options tab:

Code Block
languagejs
themeEmacs
ignoreAllCapsWords: true,
ignoreDomainNames: true,
ignoreWordsWithMixedCases: true,
ignoreWordsWithNumbers: true,

To deselect some of the elements, set the value of the desired element as false.

2.2.2. Languages Tab

You can set predefined language for all application users in the Languages tab and hide it from your users so that they cannot modify the selected language using the settingsSections parameter as shown below:

Code Block
languagejs
themeEmacs
settingsSectionsdisableDictionariesPreferences: ['options', 'dictionaries', 'about'],

2.2.3. Dictionaries Tab

Customizing Dictionaries tab User Interface

These are some options for altering Dictionaries tab user interface elements and features:

  1. Hiding Dictionary tab at all.
  2. Hiding or removing preferences section on the Dictionary tab to prevent users from adding/changing/removing the dictionary. Usually it is done when users have a company-wide predefined dictionary. For details, refer to setting up WProofreader Dictionaries tab section. 
  3. Setting a predefined dictionary for all users.

Hiding or Removing Preferences Section on the Dictionary Tab

To disable the dictionary preferences UI for your users, specify the disableDictionariesPreferences option as true:

Code Block
languagejs
themeEmacs
disableDictionariesPreferences: true,

Removing Dictionaries Tab

true,
Removing Dictionaries tab

You may want to remove the Dictionaries tab from user interface in the following cases: 

  • Users can only add new words using the Add word command from the suggestion balloon or when proofreading in a dialog mode. The dictionary itself cannot be deleted or modified.
  • There is no predefined dictionary and you want to prevent storing the dictionaries on a server. Instead all the words are saved in users browsers local storage.  
Tip

Instead of completely removing the Dictionaries tab, consider disabling only the user interface elements responsible for creating, deleting, renaming, and connecting a dictionary as in the examples above and when allowing your users to see and manage words added to the dictionary.

Note

If the users have not saved the words added to the dictionary on the server and use local storage instead, these words become inaccessible when switching to a different browser or a computer.

Use the sample You can disable the Dictionaries area user interface for end-users so that they can use a predefined company-wide user dictionary only using the sample script below:

Code Block
languagejs
themeEmacs
settingsSections: ['languages', 'options'],
Info

For details refer to Configuring Server Personal Dictionaries  and Configuring Cloud Personal User Dictionaries, Personal User Dictionary Interface in WProofreader sections andFAQ section.

2.2.4. About Tab

To remove the branding of WProofreader, namely the title on the UI of the product and About tab with copyrights and logo, set the removeBranding parameter value true as shown in the code sample below: 

Code Block
languagejs
themeEmacs
removeBranding:true,
Note

You can remove the About tab of WProofreader dialog and branding information if you have purchased a Custom or a Server version of WProofreader package. 

2.4 Proofreading in a Dialog

Actions available for configuring WProofreader dialog mode are the same as for the suggestions balloon, namely: 

  • Hiding or turning off descriptions of discovered grammar problems;
  • Changing the number of suggestions;
  • Hiding some commands, for example, Add to dictionary or Ignore All commands;
  • Preventing users from switching to the Settings dialog mode.

You can turn off descriptions for discovered grammar issues both in suggestions balloon and WProofreader dialog. To do so, set the value disableProblemDescription as true.

Code Block
languagejs
themeEmacs
disableProblemDescription:true,

FAQ section.

Note

If users try to use a different browser, they won't be able to access the dictionary. If there is no Dictionary tab in the Settings dialog, they cannot remove some words they might have added by mistake.

2.4.4. General section
Status
colourYellow
titleUpd | 5.29.1

Starting WebSpellChecker version 5.29.1.0, your end-users will be able to hide spelling (red underlines), grammar (blue underlines) or style guide (yellow underlines) suggestions using the toggle switch on the WProofreader interface. Previously it was available for Correct spelling automatically and Autocomplete suggestions.

2.4.5. About tab

Note

You can remove the About tab of WProofreader dialog and branding information if you have purchased a Custom or a Server version of WProofreader package. 

To remove the branding of WProofreader, namely the title on the UI of the product and About tab with copyrights and logo, set the removeBranding parameter value true as shown in the code sample below: To hide the Add to dictionary command, specify the actionItems parameter values as shown in the sample below:  

Code Block
languagejs
themeEmacs
actionItems: ['ignoreAll', 'settings', 'toggle', 'proofreadDialog'],
removeBranding:true,

2.5. Actions for proofreading in a dialog

Actions available for configuring WProofreader dialog mode are the same as for the suggestions balloon, namely: 

  • Hiding or turning off descriptions of discovered grammar problems;
  • Changing the number of suggestions;
  • Hiding some actions, for example, Add to dictionary or Ignore All;
  • Preventing users from switching to the Settings dialog mode.

You can turn off descriptions for discovered grammar issues both in suggestions balloon and WProofreader dialog. To do so, set the value disableProblemDescription as true.To disable switching from Settings to WProofreader dialog and vice versa, exclude the settings value from the array of parameter values:

Code Block
languagejs
themeEmacs
actionItems: ['ignoreAll', 'toggle', 'proofreadDialog'],

2.5 Badge View and Options

You can change the following orange badge options:

  • Turn off badge pulsation,
  • Completely remove a badge,
  • Remove some actions from the badge, for example, Settings Image Removed, Disable/enable WProofreader Image Removed, or Proofread in dialog Image Removed.

If the enableBadgeButton parameter is set false,  part of action items specifically Settings, Disable/Enable and Proofread in dialog from the badge area  will be moved to the suggestions ballon: 

Code Block
languagejs
themeEmacs
enableBadgeButton:false,

When WProofreader starts, the badge start pulsing three times to get the user’s attention to the discovered issues. If it turns out to be distracting for the users, you can disable pulsation  setting the disableBadgePulsation parameter as true as shown in the sample below:

Code Block
languagejs
themeEmacs
disableBadgePulsation:true,

3. Languages and Dictionaries Settings

3.1.  Default Language Options

The default language setting for WProofreader users is American English. But being the administrator, you can change this default language for all users. 

Besides the default languages list, you can have  more dictionaries to extend the linguistics coverage. Here are available options: 

disableProblemDescription:true,

To hide the Add to dictionary command, specify the actionItems parameter values as shown in the sample below:  

Code Block
languagejs
themeEmacs
actionItems: ['ignoreAll', 'settings', 'toggle', 'proofreadDialog'],

To hide or remove the Settings icon so that the users cannot navigate and change WProofreader settings, exclude the settings value from the array of parameter values:

Code Block
languagejs
themeEmacs
actionItems: ['ignoreAll', 'toggle', 'proofreadDialog'],

3. Languages and dictionaries settings

Anchor
defaultLanguageOptions
defaultLanguageOptions
3.1. Default language options

The default language setting for WProofreader users is American English (en_US). But being the administrator, you can change this default language for all users. 

Besides the default languages list, you can have  more dictionaries to extend the linguistics coverage. Here are available options: 

  • Auto Detect language. This is a feature that auto-detects the input language and does the check using the proper language. Its support covers around 80 languages. This feature is available in all paid plans except the Basic one. To enable it by default for all users, set 'auto' as a default language (see details below).
  • Additional languages list including 150Additional languages list including 100+ languages available with WebSpellChecker paid version. No additional configuration is required.
  • Specialized languages such as legal and medical are not included into a default bundle and can be configured on demand for your daily used professional terms.

For details, contact WebSpellChecker support team

3.2. Default

Language

language for all

Users

users

You can specify the default language for all WProofreader users using the lang option.   For example, if you  you set the lang: 'de_DE', German locale is specified for all users. 

Code Block
languagejs
themeEmacs
lang: 'de_DE',

To enable the language locale, be sure to use the proper language code. For details, refer to the supported language short codes list.

Note

Users can modify the default language locale using the Languages tab of the Settings dialog but the locale they have selected will be used until they reload the browser. After reloading the browser a language specified by the administrator is used again. 

3.3

User Interface Localization Language

. User interface localization language

You can change WProofreader interface localization to match the locale preferences. The default interface localization language is American English.  All the available short codes for localization are available in the description of localization parameter in API options.

localization to match the locale preferences. For example, to set German language as the localization option in  in WProofreader, use the localization parameter as in sample below

Code Block
languagejs
themeEmacs
localization: 'de',

3.4

Predefined Dictionary for All Users 

. Predefined user dictionary 

To activate one dictionary common for all application users, specify the userDictionaryName  parameter by providing the dictionary name. After that, all words added by users via the Add word command are added to this particular dictionary.  

Code Block
languagejs
themeEmacs
userDictionaryName=:'user_dictionary_name',
Info

If you have authentication enabled in your web app, you can predefine certain dictionaries for specific users using this approach.

Note

Users can add words to a dictionary for spelling suggestions only. Grammar suggestions cannot be added to the dictionary. 

3.5. Extending the

List

list of

Dictionaries

dictionaries

If you want to use some dictionaries different from the default ones, refer to the list of additional language dictionaries available on our web site and contact our sales team for purchasing details. 

3.

7

6. Custom

Dictionaries

dictionaries

Custom dictionaries allow to create creating company-wide dictionaries and extend extending the vocabulary of the standard dictionary with words specific to industry or domain. To  To configure a global custom dictionary in WProofreader, use the customDictionaryIds parameter and add a string with required dictionaries IDs which should be separated by commas:

Code Block
languagejs
themeEmacs
customDictionaryIds: '100694, 100695',

In the example above,   ID is the unique dictionary ID will be assigned to your custom dictionary. For details on setting global custom dictionaries for Server version, refer to Configuring Server Global Custom Dictionaries section, namely: 

For details on setting custom dictionaries for Cloud version, refer to Configuring Cloud Custom Dictionaries guide.

4. Miscellaneous

Options 

options 

4.1. Minimal

Word Length

word length

By default, WProofreader enables spell check starting with 3 and more letters per word. You can customize this option using the minWordLength API parameter parameter

Code Block
languagejs
themeEmacs
minWordLength: 2,

After you have used this option, the words which have two (2) and more letters in them will be spell checked. 

4.2

Excluding Some Elements of Web Page Markup From Spelling and Grammar Checking

. Excluding elements from checking

There are a list of options such as ignoreElementsignoreClasses and ignoreAttributes that help to manage where the text checking should not be done. 

Use the ignoreElements parameter to instruct WProofreader not to check the  the HTML elements in the text such as, typeface types, links, tables and others. By default, links or text within the <a> tag are ignored as well as <style> and <script> tags.  

You can additionally choose to ignore spelling and grammar checking  in certain web page markup elements, for example, headings tags and others.and grammar checking  in certain web page markup elements by classes or attributes.

In example below, text inside table elements, elements containing specified class or attribure will be skipped during checking:

Code Block
languagejs
themeEmacs
ignoreElements: 'table',
ignoreClasses: ['ignore-checking'],
ignoreAttributes: ['data-wsc-ignore-checking']

4.3. Disabling

Proofreading

proofreading in As You Type

Mode

mode

Proofreading during typing is enabled by default for users of the web applications where WProofreader is integratedtyping in the so called ‘as you type mode’ is enabled by default. You can disable this mode using the proofreadAsYouType parameter so that thus proofreading becomes possible only in dialog mode. To do so, change  the value of proofreadAsYouType parameter to false: 

Code Block
languagejs
themeEmacs
proofreadAsYouType: false,

After disabling proofreading in proofread as you type mode, application users can access proofreading by initiating WProofreader dialog mode from the orange badge. 

4.4 Enabling WProofreader on Touch Devices 

To enable WProofreader on touch devices such as smartphones or tablets, specify the enableOnTouchDevices value as true: 

Code Block
languagejs
themeEmacs
enableOnTouchDevices: true,

badge by clicking Proofread in dialog Image Addedicon.