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 Cloud version of WSC.
Good to know:
- WSC Dialog is an integrated spell and grammar checking solution in CKEditor 4. By default the WSC plugin for CKEditor is pointed to the Free WebSpellChecker Cloud Services. The free version with the banner ad and limited functionality is available for free for all CKEditor customers.
- The paid services allows the customers to get rid of the banner ad, lift the usage limitations and get the extra functionality and languages.
- To get started with the trial or paid version of WSC plugin for CKEditor 4, it is required to subscribe to the Cloud WebSpellChecker services. On the subscription, you will receive an email with your encrypted customer ID, an activation key, that is required for the WSC service activation.
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 you encrypted customer ID using the wsc_customerid parameter.
config.wsc_customerId = 'encrypted-customer-ID';
- 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;
Refer to a full list of WSC Dialog API parameters and possible values in WSC Dialog Parameters for CKEditor.
Check a demo page with WSC plugin for CKEditor on our website.
- After all changes are made, it is recommended to clean your browser cache. This is a recommended step, as some of the previous settings can be saved you in your browser cache.
3. Verify Operability
The simplest way to verify operability and correct work of the WSC plugin for CKEditor 4 is to type any text with spelling and grammar mistake, then go to the ABC icon on the CKEditor toolbar and click Check Spelling. A new pop-up should be opened with spelling errors and grammar errors underlines in SpellChecker and Grammar tabs accordingly.
If you are migrating or configuring the Paid version of WSC Dialog for CKEditor 4, upon adding an encrypted customer ID (an activation key) of the paid subscription, the banner ad on the dialog should be removed.
Pic 3.1. The view of WSC Dialog plugin using the Free/Trial WebSpellChecker Cloud Services. |
Pic 3.2. The view of WSC Dialog plugin using the Paid WebSpellChecker Cloud Services. |
