8
0
Quellcode durchsuchen

Docs: Spell checker documentation expanded and corrected. [skip ci]

Anna Tomanek vor 6 Jahren
Ursprung
Commit
0247452160

+ 1 - 1
docs/_snippets/features/wproofreader.html

@@ -8,5 +8,5 @@
 </script>
 <div id="snippet-wproofreader" >
 	<p>Typos hapen. We striving to correct them. Hover on the marked words for instant correction suggestions or click the dialog icon in the bottom right corner to have the whole text proofread at once.</p>
-	<p>Or just paste your own text to get it proofread.</p>
+	<p>You can also paste your own text here to have its spelling and grammar checked.</p>
 </div>

+ 92 - 0
docs/features/spell-checker.md

@@ -0,0 +1,92 @@
+---
+category: features
+---
+
+# Spelling and grammar checking
+
+{@snippet build-classic-source}
+
+<info-box>
+	The spell checker for CKEditor 5 is a commercial solution provided by our partner, [WebSpellChecker](https://webspellchecker.com/), and is in beta version. You can report any issues in its [GitHub repository](https://github.com/WebSpellChecker/wproofreader). The license can be purchased [here](https://ckeditor.com/contact/).
+</info-box>
+
+[WProofreader](https://webspellchecker.com/wsc-proofreader) is the ultimate proofreading tool that combines the functionality of "spell check as you type" and "spell check in a dialog" in a modern UI. Spelling and grammar suggestions are available on hover with no clicking needed.
+
+The distraction-free badge gives you access to proofreader suggestions and settings. If you want to see an overview of all spelling and grammar mistakes, click the "Proofread in dialog" button in the badge.
+
+## Demo
+
+Click in the editor below to enable the spelling and grammar checking. The proofreader badge in the botton right-hand corner shows you the number of mistakes detected. It also gives you access to proofreader settings and suggestions.
+
+Hover an underlined word to display the proofreader suggestions for any of the spelling and grammar mistakes found.
+
+{@snippet features/wproofreader}
+
+## Supported languages
+
+By default the spell checker supports 16 languages: American English, British English, Brazilian Portuguese, Canadian English, Canadian French, Danish, Dutch, Finnish, French, German, Greek, Italian, Norwegian Bokmal, Portuguese, Spanish and Swedish. Grammar checking is available for 14 of them &mdash; there is no grammar checking for Finnish and Norwegian.
+
+There are also over 150 additional languages and specialized dictionaries such as medical and legal available for an additional fee. You can check the full list [here](https://webspellchecker.com/additional-dictionaries/).
+
+## Installation
+
+WProofreader is installed separately from CKEditor 5 and does not need to be combined into an editor build as other features. To use this tool, it is necessary to load the WProofreader script on your page and provide the configuration.
+
+The proofreader can be used either as a [cloud solution](#wproofreader-cloud) or [hosted on your own server](#wproofreader-server).
+
+### WProofreader Cloud
+
+After signing up for a [trial](https://www.webspellchecker.net/signup/hosted-signup.html#webspellchecker-proofreader-trial) or [paid](https://www.webspellchecker.net/signup/hosted-signup.html#webspellchecker-proofreader-paid) version, you will receive your service ID which is used to activate the service.
+
+Add the following configuration to your page:
+
+```html
+<script>
+	window.WEBSPELLCHECKER_CONFIG = {
+		autoSearch: true,
+		enableGrammar: true,
+		serviceId: 'your-service-ID'
+	};
+</script>
+```
+
+And then load the proofreader script:
+
+```html
+<script type="text/javascript" src="https://svc.webspellchecker.net/spellcheck31/wscbundle/wscbundle.js"></script>
+```
+
+Refer to the [official documentation](https://github.com/WebSpellChecker/wproofreader#wproofreader-cloud) for more details about the cloud setup and available configuration options.
+
+### WProofreader Server
+
+After signing up for a [30-day trial](https://webspellchecker.com/free-trial/) version, you will receive access to the WebSpellChecker Server package to install on your own server.
+
+You will need to specify the path to the service on your page:
+
+```html
+<script type="text/javascript" src="http(s)://your_host_name/spellcheck/wscbundle/wscbundle.js"></script>
+```
+
+Then add the following configuration to your page:
+
+```html
+<script>
+	window.WEBSPELLCHECKER_CONFIG = {
+		autoSearch: true,
+		enableGrammar: true,
+		servicePort: '2880',
+		servicePath: '/'
+	};
+</script>
+```
+
+Refer to the [official documentation](https://github.com/WebSpellChecker/wproofreader#wproofreader-server) for more details about the server setup and available configuration options.
+
+## Configuration
+
+WProofreader configuration is set outside the CKEditor 5 configuration. Refer to the [WProofreader API](http://dev.webspellchecker.net/api/wscbundle/) for further information.
+
+## Contribute
+
+You can report issues and request features in the [official WProofreader repository](https://github.com/WebSpellChecker/wproofreader/issues).

+ 0 - 31
docs/features/spell-checking.md

@@ -1,31 +0,0 @@
----
-category: features
----
-
-# Spell checking
-
-{@snippet build-classic-source}
-
-[WebSpellChecker](https://webspellchecker.com/) with [WProofreader](https://webspellchecker.com/wsc-proofreader/#proofreader-ckeditor5) brings support for spell checking in the editor. This product is a multilingual proofreading tool which provides grammar and spellchecking features to the editor.
-
-## Demo
-
-{@snippet features/wproofreader}
-
-## Installation
-
-WProofreader is installed separately from CKEditor5 and cannot be combined into a bundle as other features. To use this tool, it is necessary to provide separate configuration for WProofreader besides CKEditor5.
-
-Example configuration for this feature, when is hosted on the cloud might be found bellow:
-```html
-<script type="text/javascript" src="https://svc.webspellchecker.net/spellcheck31/wscbundle/wscbundle.js"></script>
-<script>
-  window.WEBSPELLCHECKER_CONFIG = {
-    autoSearch: true,
-    enableGrammar: true,
-    serviceId: 'your-service-ID'
-  };
-</script>
-```
-
-More details about installation and configuration options might be found under [this link](https://github.com/WebSpellChecker/wproofreader#get-started).