Versions Compared

Key

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

1. Overview

The 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  All the words added to a custom dictionary will be available for all for all users of a web application within a company.

The custom 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 to the account panel on the webspellchecker.net websitecom website.

Image Modified




Panel

Table of Contents
stylenone




2. Availability

The custom dictionary functionality is

Custom dictionaries are available for all customers who

are holding a Trial or Paid

have either trial or paid subscription to WebSpellChecker Cloud

WebSpellChecker

Services.

Tip

Good to know:

Management of
  • You can manage custom dictionaries in
the
  • WebSpellChecker Cloud version
is performed from
  • using a customer account panel
at net
  • 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
allowed to have multiple
  • possible to create up to N of languages multiplied by 5 custom dictionaries per
a language.There is no specific limit set on the total number of custom dictionaries that can be added to a single subscription. However, there is a limit set to a
  • 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
. It
  • is limited two (2) million symbols including spaces and
commands
  • commas.
  • Any updates to the dictionary are applied within 5-10 minutes.

3.

How to Get Started

Getting started with custom dictionaries

To

It is easy to

get started with the custom dictionary functionality

.

:

Excerpt Include
IN:_include_cloud_login_to_account
IN:_include_cloud_login_to_account
nopaneltrue

Find
  • Locate the Dictionaries section on the main page of your account
. First of all you need to
  • 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

custom dictionary

4.1.

Go

Navigate to the Dictionaries

section and click 

 tab.

Image Added

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

Image Added

Add Custom Dictionaries.

4.

2

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

Save

Create.

Enter
  • Type a dictionary name (the dictionary name should be unique and use only Latin characters or/and digits);
Enter
  • Add or copy/paste the words separated by space or comma that you want to appear in the dictionary.
Note
The maximum allowed size of a single custom dictionary is two million symbols including spaces and commas

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.

Image Removed

  • Choose a state for a custom dictionary. Two values are possible: Enabled or Disabled.
Image Removed

Image Added


Anchor
anchor_apply_changes
anchor_apply_changes
4.

3

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
Image Removed

Image Added

Excerpt
  • 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.
This value you obtained
  • You have already obtained this value on the previous step.

Product

Integration

integration

Custom

Dictionary Parameter

dictionary parameter

SCAYT plugin for CKEditor 4

CKEDITOR.config.SCAYT plugin for Froala Editor

scayt_customDictionaryIds = 'DicId'

WSC plugin for CKEditor 4

CKEDITOR.config.wsc_customDictionaryIds: 'DicId'

WProofreader add-on for RTEs, plugin for CKEditor 5

customDictionaryIds: 'DicId'

WebSpellChecker Proofreader (integration with HTML Editable Controls, WYSIWYG editors)

customDictionaryIds: DicID1, DicID2

Code Block
languagejs
themeEmacs
titleExample:
WSC Proofreader
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 = {
       
enableGrammar:
 
true,
serviceId: 'your-service-ID',
        lang: 'en_US',
		customDictionaryIds: 
100694
'100839'
    };
</script>

4.4. Verify if the

work of

custom dictionary functionality

.

works correctly:

  • Before trying to test
the work of
  • 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
  • to 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,
in a correction box your
  • you should get
a
  • the correct word as a suggestion for correction in the list of suggestions.

5. Edit

Custom Dictionary

custom dictionary

5.1.

Go

To edit a custom dictionary, navigate to the Dictionaries section and

click List of Custom Dictionaries. This page displays the list of all available custom dictionaries. 

Image Removed

5.2. Select the

, under your subscription section, select a dictionary you want to

modify (e.g. add new words) and on the dictionary page click Edit.

edit (Actions –> Edit icon).

Image Added

Image Removed


5.

3

2. Modify the required fields (e.g. add new words)

. As all the changes are ready,

and click Save.

Image Removed

Image Added

6. Delete

Custom Dictionary6.1. Go

custom dictionary

  • Navigate to the Dictionaries section and
click List of Custom Dictionaries. This page displays
  • select your subscription.  Go to the list of
all available custom dictionaries
  • the dictionaries under this subscription
6.2. 6.3.
  • Select the dictionary you want to delete
and on the dictionary page click Delete and confirm your choice.
  • . Click the Delete icon. 
  • Apply the changes made to the service configuration on your web page or web app (see more details
on