This guide outlines the main steps to integrate and configure WProofreader with auto-searching functionality. All the steps described are provided for the Server version of WProofreader.


WProofreader is multilingual proofreading tool for web applications. It enables grammar and spell check combining spelling and grammar suggestions while you type or work with your text in a dedicated dialog. It detects editable fields in focus, be it HTML editable controls or/and WYSIWYG editors, and enables spelling and grammar checking there.

The autoSearch feature enables detecting new editable fields on the page and proofreading the text they contain automatically on hover selection. No additional actions or plugins are required for enabling WProofreader in a specific WYSIWYG editor or HTML editable control. A single configuration applies to almost all editors and controls. Here is the list of WProofreader supported integrations

Step 1. Initialize WProofreader

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

Option A. Initializing using Config Variable

1. Add Config with Options

Define the required options in WEBSPELLCHECKER_CONFIG:

WEBSPELLCHECKER_CONFIG can be added to any location on a web page before or after the wscbundle.js script. However, if you add wscbundle.js asynchronously, this CONFIG must be added before the script.

  • Enable autoSearch functionality using the autoSearch parameter.
  • Specify serviceProtocolserviceHostservicePort and servicePath to access the service.

To configure secure SSL connection between your application and AppServer, follow the steps described on the Enabling SSL Connection with AppServer page.

<script>
	window.WEBSPELLCHECKER_CONFIG = {
		autoSearch: true,
		enableGrammar: true,
        serviceProtocol: 'https',
        serviceHost: 'your_host_name',
        servicePort: '2880',
        servicePath: '/'
   };
</script>

2. Add WProofreader Script

Add the wscbundle.js script on your web page.

<script type="text/javascript" src="http(s)://your_host_name/wscservice/wscbundle/wscbundle.js"></script>

Option B. Initializing using Inline Data Attributes

In general, initialization of WProofreader using inline attributes is a good option if you want to have a single script with the base options. 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  here.

<script
	data-wsc-autosearch="true"
	data-wsc-lang="en_US"
	data-wsc-enableGrammar="true"
	data-wsc-serviceProtocol="https"
	data-wsc-serviceHost="your_host_name"
	data-wsc-servicePort="2880"
	data-wsc-servicePath="/"
	src="https://your_host_name/wscservice/wscbundle/wscbundle.js">
</sctipt>

Consider the following limitation when using inline data attributes for the WProofreader 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).

You can customize the default options using WProofreader API.Step 2. Adjust Default Options

You can check the demos of WProofreader integrations with various rich-text editors on our website.