Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This guide outlines the main steps that you need to follow in order to integrate and configure WebSpellChecker Proofreader with a new WProofreader with the auto-searching functionalitydetecting functionality. All  All the described steps are provided for the Cloud version of WebSpellChecker ProofreaderWProofreader.

Excerpt Include
IN:_include_wsc_proofreader_overview_tip
IN:_include_wsc_proofreader_overview_tip
nopaneltrue

Supported

...

Here is list of most common uses cases of the WSC Proofreader integration in your web app:

  • HTML editable controls such as <input> or <textarea> and elements with contenteditable attribute set to ‘true’ e.g. <div>, <iframe>;
  • Modern WYSIWYG editors such as CKEditor 4, CKEditor 5, TinyMCE, Froala Editor, Kendo UI, Quill, Redactor, Summernote, ProseMirror, Scribe, Trix, etc.

The autoSearch feature will take care of detecting new editable fields on the page and enabling proofreading in them automatically on focus. There are no additional actions or plugins requires for enabling WSC Proofreader in a specific WYSIWYG editor or HTML editable control. A single configuration applies to almost all editors and controls.

...

integrations

Excerpt Include
IN:_include_wsc_proofreader_autosearch_supported_integrations
IN:_include_wsc_proofreader_autosearch_supported_integrations
nopaneltrue

1. Obtain activation key

Excerpt Include
IN:_include_wsc_proofreader_cloud_subscribe_step
IN:_include_wsc_proofreader_cloud_subscribe_step
nopaneltrue

...

2. Initialize

...

WProofreader

There are two approaches for initializing WSC Proofreader WProofreader in your web app: using the the config variable config or inline data attributes.

Option A. Initializing using

...

config variable

1.

...

Add config with options

Excerpt Include
IN:_include_

...

wsc_

...

proofreader_

...

cloud_

...

initialization_

...

autosearch
IN:_include_

...

wsc_

...

proofreader_

...

cloud_

...

initialization_

...

autosearch
nopaneltrue

2.

...

 Add WProofreader script

Excerpt Include
IN:_include_

...

cloud_webspellchecker_proofreader_

...

src_

...

url
IN:_include_cloud_

...

webspellchecker_proofreader_

...

src_

...

url
nopaneltrue

Option B. Initializing using

...

inline data attributes

Excerpt Include
IN:_include_wsc_proofreader_cloud_initialization_autosearch_inline_data_attributes
IN:_include_wsc_proofreader_cloud_initialization_autosearch_inline_data_attributes
nopaneltrue

3. Adjust default options

You can adjust the default options for your needs. Here is a full list of WProofreader API options and their possible values.

Info

You can check the demos of WProofreader integrations with a various rich text editors

Info

Check a demo page with WebSpellChecker Proofreader on our website.