xref: /webtrees/public/ckeditor-4.15.1-custom/plugins/wsc/README.md (revision e172383b8d1dc462218f743b1e04ca6a5babd14e)
1WebSpellChecker Dialog Plugin for CKEditor 4
2===============================
3
4WebSpellChecker Dialog (WSC Dialog) provides distraction-free proofreading, checking the whole text’s spelling and grammar on-click in a separate pop-up window.
5
6![WSC Dialog Plugin for CKEditor 4 View](https://webspellchecker.com/app/images/wsc_dialog_plugin_for_ckeditor4.png)
7
8This plugin brings the multi-language WSC Dialog 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 (Check Spelling).
9
10If your version of CKEditor doesn’t have WSC Dialog built-in, you can easily add it by following the steps outlined in the Get Started section.
11
12The default version of WSC Dialog 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).
13
14To lift the limitations and get rid of the banner, [obtain a license](https://webspellchecker.com/wsc-dialog-ckeditor4/#pricing). Depending on your needs, you can choose a Cloud-based or Server (self-hosted) solution.
15
16Demo
17------------
18WSC Dialog plugin for CKEditor 4: https://webspellchecker.com/wsc-dialog-ckeditor4/
19
20Supported Languages
21------------
22
23The WSC Dialog 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.
24
25There are also additional languages and specialized dictionaries available for a commercial license, you can check the full list [here](https://webspellchecker.com/additional-dictionaries/).
26
27Get Started
28------------
29
301. Clone/copy this repository contents in a new "plugins/wsc" folder in your CKEditor installation.
312. Enable the "wsc" plugin in the CKEditor configuration file (config.js):
32
33        config.extraPlugins = 'wsc';
34
35That's all. WSC Dialog will appear on the editor toolbar under the ABC button and will be ready to use.
36
37Supported Browsers
38-------
39
40This is the list of officially supported browsers for the WSC Dialog plugin for CKEditor 4. WSC Dialog may also work in other browsers and environments but we unable to check all of them and guarantee proper work.
41
42* Chrome (the latest)
43* Firefox (the latest)
44* Safari (the latest)
45* MS Edge (the latest)
46* Internet Explorer 8.0 (limited support)
47* Internet Explorer 9.0+ (close to full support)
48
49Note: All browsers are to be supported for web pages that work in Standards Mode.
50
51Resources
52-------
53
54* Demo: https://webspellchecker.com/wsc-dialog-ckeditor4/
55* Documentation: https://docs.webspellchecker.net/
56* YouTube video: https://youtu.be/bkVPZ-5T22Q
57* Term of Service: https://webspellchecker.com/terms-of-service/
58
59Technical Support or Questions
60-------
61
62In cooperation with the CKEditor team, during the past 10 years we have simplified the installation and built the extensive amount of documentation devoted to WSC Dialog plugin for CKEditor 4 and less.
63
64If you are experiencing any difficulties with the setup of the plugin, please check the links provided in the Resources section.
65
66Holders 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/)!
67
68Reporting Issues
69-------
70
71Please use the [WSC Dialog plugin for CKEditor 4 GitHub issue page](https://github.com/WebSpellChecker/ckeditor-plugin-wsc/issues) to report bugs and feature requests. We will do our best to reply at our earliest convenience.
72
73License
74-------
75
76This 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).
77
78See LICENSE.md for more information.
79
80Developed by [WebSpellChecker](https://webspellchecker.com/) in cooperation with CKSource.
81