This guide outlines the main steps that you need to follow in order to integrate and configure the WebSpellChecker (WSC) Dialog plugin for CKEditor 4. All the described steps are provided for the Server version of WSC.
1. Initialize CKEditor 4
Before integrating and configuring the WSC plugin, CKEditor should be properly configured in your web application. If you haven't done it yet, please refer to Example CKEditor Setups on the CKEditor documentation pages.
2. Configure WSC Dialog Plugin
The next step is to define necessary WSC Dialog parameters and options in the CKEditor config.js file.
- Specify path to the WSC Dialog script using wsc_customLoaderScript parameter.
config.wsc_customLoaderScript = "http(s)://your_host_name/wscservice/lf/22/js/wsc_fck2plugin.js";
- Define additional WSC parameters (e.g. change default language, adjust dialog view, etc.).
config.wsc_lang = 'de_DE'; config.wsc_height = 800; config.wsc_width = 800;
WSC Dialog API parameters and possible values
Here you can find a list of all available WSC Dialog parameters for CKEditor 4.0+ that can be used for the WSC configuration. Also, you may visit CKEDITOR configuration documentation.
This plugin reached its end-of-life date. The last usage date for the paid customers is December 2021. Read more in our blog post.
wsc_customLoaderScript
Description: | wsc_customLoaderScript parameter specifies a URL to the WSC Dialog script. wsc_customLoaderScript is intended for use only with the Server version of WSC Dialog. |
| Parameter type: | String |
| Default value: | None |
| Possible values: | Path to the wsc_fck2plugin.js script: "/virtual_directory/lf/22/js/wsc_fck2plugin.js" Path for the cloud version: https://svc.webspellchecker.net/spellcheck/lf/22/js/wsc_fck2plugin.js |
Example:
config.wsc_customLoaderScript = "https://your_host_name/virtual_directory/lf/22/js/wsc_fck2plugin.js";
wsc_customerId
Description: | wsc_customerId parameter sets a customer ID for Cloud WSC Dialog. It is required for migration from the free, ad-supported version to paid, ad-free version. wsc_customerId is intended for use only with the Cloud version of WSC Dialog. |
| Parameter type: | String |
| Default value: | A free version of WSC plugin is shipped with already predefined encrypted customer ID value. |
| Possible values: | encrypted-customer-id |
Example:
config.wsc_customerId = 'encrypted-customer-id';
wsc_lang
Description: | wsc_lang parameter sets a language short code of the default language that will be used for spell checking. |
| Parameter type: | String |
| Default value: | en_US (American English) |
| Possible values: |
Example:
config.wsc_lang = 'de_DE';
wsc_customDictionaryIds
Description: | wsc_customDictionaryIds parameter specifies a custom dictionary ID that will be linked with WSC Dialog. |
| Parameter type: | String |
| Default value: | None |
| Possible values: | IDs of custom dictionaries separated with commas (' , '). |
Example:
config.wsc_customDictionaryIds = '1,3001';
wsc_userDictionaryName
Description: | wsc_userDictionaryName parameter predefines a specific user dictionary that will be used with SCAYT. |
| Parameter type: | String |
| Default value: | None |
| Possible values: | Any name of a user dictionary. |
Example:
config.wsc_userDictionaryName = 'user_dictionary_name';
wsc_cmd
Description: | wsc_cmd parameter sets an active tab which should be shown on the dialog opening. |
| Parameter type: | String |
| Default value: | spell |
| Possible values: |
|
Example:
config.wsc_cmd = 'thes';
wsc_height
Description: | wsc_height parameter sets the height in pixels of WSC Dialog. |
| Parameter type: | String |
| Default value: | Content-based |
| Possible values: | Any height size in pixels. |
Example:
config.wsc_height = 800;
wsc_width
Description: | wsc_width parameter sets the width in pixels of WSC Dialog. |
| Parameter type: | String |
| Default value: | 580 |
| Possible values: | Any width size in pixels. |
Example:
config.wsc_width = 800;
wsc_top
Description: | wsc_top parameter sets a top margin value in pixels of WSC Dialog. |
| Parameter type: | String |
| Default value: | Fixed position in the middle of the screen. |
| Possible values: | Any top margin value in pixels. |
Example:
config.wsc_top = 0;
wsc_left
Description: | wsc_left parameter sets a left margin value in pixels of WSC Dialog. |
| Parameter type: | String |
| Default value: | Fixed position in the middle of the screen. |
| Possible values: | Any left margin value in pixels. |
Example:
config.wsc_left = 0;
Can be also useful:
Check a demo page with WSC plugin for CKEditor on our website.
