1. Overview

Global custom dictionary is a special mechanism that allows creating company-wide dictionaries that are intended to extend the vocabulary of the standard dictionary with custom words specific to your industry, domain, etc. All the words added to a custom dictionary will be available for all users of a web application within a company.

Custom dictionaries for Cloud customers are saved and stored on the WebSpellChecker Cloud servers. Such dictionaries can be created and modified only by a person who is authorized to access the account panel on the webspellchecker.com website.


2. Availability

Custom dictionaries are available for all customers who have either trial or paid subscription to WebSpellChecker Cloud Services.

Good to know:

  • You can manage custom dictionaries in WebSpellChecker Cloud version using a customer account panel at webspellchecker.com website. It allows an administrator of a subscription to create, edit, enable/disable, and delete custom dictionary(ies) via simple user interface.
  • Custom dictionaries are language-dependent.
  • It is possible to create up to N of languages multiplied by 5 custom dictionaries per subscription. For example, if you have a standard subscription with 17 languages enabled, you can create 85 dictionaries (17 languages * 5) in total.
  • The size of a single custom dictionary is limited two (2) million symbols including spaces and commas.
  • Any updates to the dictionary are applied within 5-10 minutes.

3. Getting started with custom dictionaries

To get started with the custom dictionary functionality:

  • Locate the Dictionaries section on the main page of your account and add a new dictionary. As soon as new dictionary is added, it will be displayed on the list of your custom dictionaries.

4. Create custom dictionary

4.1. Navigate to the Dictionaries tab.

4.2. Under your subscription section, click Add New Dictionary button to create a new dictionary.

4.3. Fill in all the necessary fields to create a new custom dictionary and click Create.

  • Type a dictionary name (the dictionary name should be unique and use only Latin characters or/and digits);
  • Add or copy/paste the words separated by space or comma that you want to appear in the dictionary.

Each unit in a dictionary is a separate word which can contain language-specific letters and digits. Don't use any specific symbols (e.g. math symbols) in the dictionary as it will fail to compile and won't work eventually.

  • Select a language to apply a new custom dictionary for. The words from this custom dictionary will be used to extend the default wordlist of a chosen language dictionary.


4.4. Apply the changes made to the service configuration on your web page or a web app.

  • Once the dictionary is created, a unique dictionary ID will be assigned to your custom dictionary as shown below. 

  • Depending on the product and where it is integrated, pass an appropriate custom dictionary parameter (e.g. customDictionaryIds) with a required dictionary ID (DicId) as a value on your web app. You have already obtained this value on the previous step.

Product integration

Custom dictionary parameter

SCAYT plugin for CKEditor 4

config.scayt_customDictionaryIds = 'DicId'

WSC plugin for CKEditor 4

config.wsc_customDictionaryIds: 'DicId'

WProofreader (integration with HTML editable controls, WYSIWYG editors)

customDictionaryIds: DicId

Example: WProofreader initialization with a custom dictionary (customDictionaryIds)
<script type="text/javascript" data-wsc-autosearch="true" src="http://svc.webspellchecker.net/spellcheck31/wscbundle/wscbundle.js"></script>

<script>
    window.WEBSPELLCHECKER_CONFIG = {
        serviceId: 'your-service-ID',
        lang: 'en_US',
		customDictionaryIds: 100839
    };
</script>

4.4. Verify if the custom dictionary functionality works correctly:

  • Before trying to test a new custom dictionary, it is strongly recommended to clean your browser cache. 
  • Go to your web page and enter a sentence or a list of words that have been added with a new custom dictionary. The words that are present in your custom dictionary should be considered as correct. Moreover, if you try to misspell any of these words, your should get a correct word as a suggestion for correction in the list of suggestions.

5. Edit custom dictionary

5.1. To edit a custom dictionary, navigate to the Dictionaries section and under your subscription section, select a dictionary you want to edit (Actions –> Edit icon).


5.2. Modify the required fields (e.g. add new words) and click Save.


6. Delete custom dictionary

  • Navigate to the Dictionaries section and select your subscription.  Go to the list of the dictionaries under this subscription. 
  • Select the dictionary you want to delete click Delete icon.
  • Apply the changes made to the service configuration on your web page or web app (see more details in section 4.3).