xref: /webtrees/public/ckeditor-4.15.1-custom/plugins/scayt/README.md (revision b43e8d2bb2c20432b6d427f0f5d9a32679a9aa4f)
1*b43e8d2bSGreg RoachSCAYT Plugin for CKEditor 4
2*b43e8d2bSGreg Roach=====================
3*b43e8d2bSGreg Roach
4*b43e8d2bSGreg RoachSpellCheckAsYouType (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*b43e8d2bSGreg Roach![SCAYT Plugin for CKEditor 4 View](https://webspellchecker.com/app/images/scayt_plugin_for_ckeditor4.png)
6*b43e8d2bSGreg Roach
7*b43e8d2bSGreg RoachThis 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*b43e8d2bSGreg Roach
9*b43e8d2bSGreg RoachIf 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*b43e8d2bSGreg Roach
11*b43e8d2bSGreg RoachThe 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*b43e8d2bSGreg Roach
13*b43e8d2bSGreg RoachTo 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*b43e8d2bSGreg Roach
15*b43e8d2bSGreg RoachDemo
16*b43e8d2bSGreg Roach------------
17*b43e8d2bSGreg RoachSCAYT plugin for CKEditor 4: https://webspellchecker.com/wsc-scayt-ckeditor4/
18*b43e8d2bSGreg Roach
19*b43e8d2bSGreg RoachSupported Languages
20*b43e8d2bSGreg Roach------------
21*b43e8d2bSGreg Roach
22*b43e8d2bSGreg RoachThe 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*b43e8d2bSGreg Roach
24*b43e8d2bSGreg RoachThere 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*b43e8d2bSGreg Roach
26*b43e8d2bSGreg RoachGet Started
27*b43e8d2bSGreg Roach------------
28*b43e8d2bSGreg Roach
29*b43e8d2bSGreg Roach1. Clone/copy this repository contents in a new "plugins/scayt" folder in your CKEditor installation.
30*b43e8d2bSGreg Roach2. Enable the "scayt" plugin in the CKEditor configuration file (config.js):
31*b43e8d2bSGreg Roach
32*b43e8d2bSGreg Roach        config.extraPlugins = 'scayt';
33*b43e8d2bSGreg Roach
34*b43e8d2bSGreg RoachThat's all. SCAYT will appear on the editor toolbar under the ABC button and will be ready to use.
35*b43e8d2bSGreg Roach
36*b43e8d2bSGreg RoachSupported Browsers
37*b43e8d2bSGreg Roach-------
38*b43e8d2bSGreg Roach
39*b43e8d2bSGreg RoachThis 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*b43e8d2bSGreg Roach
41*b43e8d2bSGreg Roach* Chrome (the latest)
42*b43e8d2bSGreg Roach* Firefox (the latest)
43*b43e8d2bSGreg Roach* Safari (the latest)
44*b43e8d2bSGreg Roach* MS Edge (the latest)
45*b43e8d2bSGreg Roach* Internet Explorer 8.0 (limited support)
46*b43e8d2bSGreg Roach* Internet Explorer 9.0+ (close to full support)
47*b43e8d2bSGreg Roach
48*b43e8d2bSGreg RoachNote: All browsers are to be supported for web pages that work in Standards Mode.
49*b43e8d2bSGreg Roach
50*b43e8d2bSGreg RoachResources
51*b43e8d2bSGreg Roach-------
52*b43e8d2bSGreg Roach
53*b43e8d2bSGreg Roach* Demo: https://webspellchecker.com/wsc-scayt-ckeditor4/
54*b43e8d2bSGreg Roach* Documentation: https://docs.webspellchecker.net/
55*b43e8d2bSGreg Roach* YouTube video “How to Configure CKEditor 4 and SpellCheckAsYouType Plugin”: https://youtu.be/D0ahmVjYBq8
56*b43e8d2bSGreg Roach* Term of Service: https://webspellchecker.com/terms-of-service/
57*b43e8d2bSGreg Roach* CKEditor’s How-Tos for SCAYT: https://ckeditor.com/docs/ckeditor4/latest/guide/dev_howtos_scayt.html
58*b43e8d2bSGreg Roach* CKEditor’s example of SCAYT: https://ckeditor.com/docs/ckeditor4/latest/examples/spellchecker.html
59*b43e8d2bSGreg Roach
60*b43e8d2bSGreg RoachTechnical Support or Questions
61*b43e8d2bSGreg Roach-------
62*b43e8d2bSGreg Roach
63*b43e8d2bSGreg RoachIn 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*b43e8d2bSGreg Roach
65*b43e8d2bSGreg RoachIf you are experiencing any difficulties with the setup of the plugin, please check the links provided in the Resources section.
66*b43e8d2bSGreg Roach
67*b43e8d2bSGreg RoachHolders 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*b43e8d2bSGreg Roach
69*b43e8d2bSGreg RoachReporting Issues
70*b43e8d2bSGreg Roach-------
71*b43e8d2bSGreg Roach
72*b43e8d2bSGreg RoachPlease 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*b43e8d2bSGreg Roach
74*b43e8d2bSGreg RoachLicense
75*b43e8d2bSGreg Roach-------
76*b43e8d2bSGreg Roach
77*b43e8d2bSGreg RoachThis 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*b43e8d2bSGreg Roach
79*b43e8d2bSGreg RoachSee LICENSE.md for more information.
80*b43e8d2bSGreg Roach
81*b43e8d2bSGreg RoachDeveloped by [WebSpellChecker](https://webspellchecker.com/) in cooperation with CKSource.
82