README.md
1SCAYT Plugin for CKEditor 4
2=====================
3
4SpellCheckAsYouType (SCAYT) instantly underlines spelling and grammar errors while users type. To correct spelling or grammar error, a user simply needs to right-click the marked word to select from suggested corrections.
5
6
7This plugin brings the multi-language SCAYT functionality into CKEditor 4. It is integrated by default starting with [Standard Package of CKEditor 4](https://ckeditor.com/ckeditor-4/download/). You can find it on the CKEditor 4 toolbar panel under the ABC button (Enable SCAYT).
8
9If your version of CKEditor doesn’t have SCAYT built-in, you can easily add it by following the steps outlined in the Get Started section.
10
11The default version of SCAYT plugin for CKEditor 4 is using the free services of WebSpellChecker. It is provided with a banner ad and has some [limitations](https://docs.webspellchecker.net/display/WebSpellCheckerCloud/Free+and+Paid+WebSpellChecker+Cloud+Services+Comparison+for+CKEditor).
12
13To lift the limitations and get rid of the banner, [obtain a license](https://webspellchecker.com/wsc-scayt-ckeditor4/#pricing). Depending on your needs, you can choose a Cloud-based or Server (self-hosted) solution.
14
15Demo
16------------
17SCAYT plugin for CKEditor 4: https://webspellchecker.com/wsc-scayt-ckeditor4/
18
19Supported Languages
20------------
21
22The SCAYT plugin for CKEditor as a part of the free services supports the next languages for check spelling: American English, British English, Canadian English, Canadian French, Danish, Dutch, Finnish, French, German, Greek, Italian, Norwegian Bokmal, Spanish, Swedish.
23
24There are also additional languages and specialized dictionaries available for a commercial license, you can check the full list [here](https://webspellchecker.com/additional-dictionaries/).
25
26Get Started
27------------
28
291. Clone/copy this repository contents in a new "plugins/scayt" folder in your CKEditor installation.
302. Enable the "scayt" plugin in the CKEditor configuration file (config.js):
31
32 config.extraPlugins = 'scayt';
33
34That's all. SCAYT will appear on the editor toolbar under the ABC button and will be ready to use.
35
36Supported Browsers
37-------
38
39This is the list of officially supported browsers for the SCAYT plugin for CKEditor 4. SCAYT may also work in other browsers and environments but we unable to check all of them and guarantee proper work.
40
41* Chrome (the latest)
42* Firefox (the latest)
43* Safari (the latest)
44* MS Edge (the latest)
45* Internet Explorer 8.0 (limited support)
46* Internet Explorer 9.0+ (close to full support)
47
48Note: All browsers are to be supported for web pages that work in Standards Mode.
49
50Resources
51-------
52
53* Demo: https://webspellchecker.com/wsc-scayt-ckeditor4/
54* Documentation: https://docs.webspellchecker.net/
55* YouTube video “How to Configure CKEditor 4 and SpellCheckAsYouType Plugin”: https://youtu.be/D0ahmVjYBq8
56* Term of Service: https://webspellchecker.com/terms-of-service/
57* CKEditor’s How-Tos for SCAYT: https://ckeditor.com/docs/ckeditor4/latest/guide/dev_howtos_scayt.html
58* CKEditor’s example of SCAYT: https://ckeditor.com/docs/ckeditor4/latest/examples/spellchecker.html
59
60Technical Support or Questions
61-------
62
63In cooperation with the CKEditor team, during the past 10 years we have simplified the installation and built the extensive amount of documentation devoted to SCAYT plugin for CKEditor 4 and less.
64
65If you are experiencing any difficulties with the setup of the plugin, please check the links provided in the Resources section.
66
67Holders of an active subscription to the services or a commercial license have access to professional technical assistance directly from the WebSpellChecker team. [Contact us here](https://webspellchecker.com/contact-us/)!
68
69Reporting Issues
70-------
71
72Please use the [SCAYT plugin for CKEditor 4 GitHub issue page](https://github.com/WebSpellChecker/ckeditor-plugin-scayt/issues) to report bugs and feature requests. We will do our best to reply at our earliest convenience.
73
74License
75-------
76
77This plugin is licensed under the terms of any of the following licenses at your choice: [GPL](http://www.gnu.org/licenses/gpl.html), [LGPL](http://www.gnu.org/licenses/lgpl.html) and [MPL](http://www.mozilla.org/MPL/MPL-1.1.html).
78
79See LICENSE.md for more information.
80
81Developed by [WebSpellChecker](https://webspellchecker.com/) in cooperation with CKSource.
82
){kind=link}