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.

Custom The 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 Removed

Image Added




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
  • The information about custom dictionaries is encoded in an encrypted customer ID key. If you add a new custom dictionary, or delete an existing one or just change the state of a dictionary from Enabled to Disable or vice versa, it change the information about custom dictionary(ies), and an encrypted customer ID key accordingly.
    • 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:

    Excerpt Include
    IN:_include_cloud_login_to_account
    IN:_include_cloud_login_to_account
    nopaneltrue

    • 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.

    Image Added

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

    Image Added

    4

    • Each custom dictionary is tied to a customer ID of a specific subscription. 

    3. Create Custom Dictionary

    3.1. Sign in to your account panel at the webspellchecker­.net website using your customer ID and password. These credentials were sent to an email address specified during initial subscription to the Cloud Services.

    Image Removed

    3.2. Go to the Dictionaries section and click Add Custom Dictionaries.

    Image Removed

    3

    .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.
  • Choose a state for a custom dictionary. Two values are possible: Enabled or Disabled.

    Image Added


    Anchor
    anchor_apply_changes
    anchor_apply_changes
    4

    Image Removed

    3

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

    Note

    The information about custom dictionaries is encoded in an encrypted customer ID key. If you add a new custom dictionary, or delete an existing one or just change the state of a dictionary from Enabled to Disable or vice versa, it change the information about custom dictionary(ies), and an encrypted customer ID key accordingly. Thus, in order to apply your changes, you are required to obtain the latest version of your encrypted customer ID and update the old key in your configuration with a new one.

    •  Download a new configuration file (config.ini) which contains your regenerated encrypted customer ID key. 
    Tip

    There are several options how you can do it: 

    • Click the configuration link directly from the Dictionary Information page (as shown on the image below).
    • Return to the start page of your account. Find the Downloads section and click Download configuration file.

    Image Removed

    • Update your current encrypted customer ID with a new one in the service configuration on your web page or web app.

    3.5. Verify the work of custom dictionary functionality.

    Note

    Usually it takes up 30 minutes for such changes to go into effect on the WebSpellChecker Cloud servers.

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

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

    Product integration

    Custom dictionary parameter

    SCAYT plugin for CKEditor 4

    scayt_customDictionaryIds = 'DicId'

    WProofreader add-on for RTEs, plugin for CKEditor 5

    customDictionaryIds: 'DicId'

    Code Block
    languagejs
    themeEmacs
    titleExample: 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
    • 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.
    4

    5. Edit

    Custom Dictionary

    custom dictionary

    4

    5.1.

    Sign in to your account section at www­.webspellchecker­.net, using your customer ID and password to login into the account. The following information is provided via email after subscription. 

    4.2. Go to the Dictionaries tab and choose "List of Custom Dictionaries"

    Image Removed

    4.3. Select the 5.3.

    To edit a custom dictionary, navigate to the Dictionaries section and, under your subscription section, select a dictionary you want to edit

    4.4. Click Edit

    Image Removed

    4.5. Change fields you need to edit

    4.6. Click Save button

    5. Delete Custom Dictionary

    5.1. Sign in to your account section at www­.webspellchecker­.net, using your customer ID and password to login into the account. The following information is provided via email after subscription. 

    5.2. Go to the Dictionaries tab and choose "List of Custom Dictionaries"

    Image Removed

    (Actions –> Edit icon).

    Image Added


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

    Image Added

    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
    edit5.4
    • delete. Click
    Delete and confirm that you want to delete the Dictionary

    5.5. Download the updated configuration file

    5.6. Update your encrypted Customer ID in the configuration

    5.7. Clean the browser cache

    6. Custom Dictionary Verification

    6.1. Open any demo page with instance, which contains WSC/SCAYT products

    6.2. Write a new words – they shouldn't underlined with the red line

    6.3. Make mistake in any of them and check the suggestions. Words from the Custom Dictionary are in the drop-down suggestion list.

    Image Removed

    • the Delete icon. 
    • Apply the changes made to the service configuration on your web page or web app (see more details in section 4.3).

    Can be also useful:

    Content by LabelshowLabelsfalsemax2showSpacefalsesorttitlereversetruecqllabel = "custom_dictionary"