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 auto-searching functionality. All the described steps are provided for the Cloud version of WebSpellChecker Proofreader.

Excerpt Include
IN:_include_wsc_proofreader_overview_tip
IN:_include_wsc_proofreader_overview_tip
nopaneltrue

0. Obtain Service ID

Excerpt Include
IN:_include_wsc_proofreader_cloud_subscribe_step
IN:_include_wsc_proofreader_cloud_subscribe_step
nopaneltrue

1. Initialize WSC Proofreader with 'autoSearch'

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

Option A. Initializing using Variable Config

1. Set Service Path

Excerpt Include
IN:_include_cloud_webspellchecker_proofreader_src_url
IN:_include_cloud_webspellchecker_proofreader_src_url
nopaneltrue

2. Define Configuration of Proofreader with 'autoSearch'

Excerpt Include
IN:_include_wsc_proofreader_cloud_initialization_autosearch
IN:_include_wsc_proofreader_cloud_initialization_autosearch
nopaneltrue

Option B. Initializing using Inline Data Attributes

In general, the initialization of WSC Proofreader using inline attributes is a good option if you want to have a single script with the base options. 

Code Block
languagejs
themeEmacs
<script
   data-wsc-serviceid="your-service-ID"
   data-wsc-autosearch="true"
   data-wsc-lang="en_US"
   data-wsc-enableGrammar="true"
   src="https://svc.webspellchecker.net/spellcheck31/wscbundle/wscbundle.js">
 </script>

In order to define an additional option as an inline data attribute, use 'date-wsc-option_name', e.g. 'data-wsc-lang'. You can find the full list of options available here.

Note

There is a limitation which must be taken into account when using inline data attributes for the WSC Proofreader options. As for now, only options which have boolean or string types can be used as data attributes. The options with array or number type are not supported (e.g. actionItems, suggestionsCount, moreSuggestionsCount).


Info

Check a demo page with WebSpellChecker Proofreader on our website.