Skip to content

Spellchecker plugin v.2.0

What it does

This plugin adds spellcheck functionality to Xeditor. It uses Hunspell dictionaries and is based on language tools.

Installation

First you have to switch into your project location using the command line.

cd path/to/your/project

Now you should be in the same directory as the package.json file. Then you can install the plugin as follows:

npm install @xeditor/plugin-spellchecker --save --registry https://npm.xeditor.com:4873

Configuration

The demo configuration of the plugin looks like this:

{
    pluginId: 'spellchecker',
    ptype: 'uxxeditorspellchecker',
    spellCheckerURL: '/editor/spellchecker'
}

Differences to version 1.0

In version 1.0, the spellchecker ran on the entire document when the spellcheck button was clicked. With version 2, there is an additional option to only check the visible section in real-time - improving performance.

Updating from v1.0

In order to update the spellchecker plugin from version 1.0 to version 2.0, proceed as follows:

Install new Plugin

  • Open file package.json
  • Locate the spellchecker plugin contained by dependencies
  • Adjust version number: use '~2' instead of currently contained one
  • Run npm install --registry https://npm.xeditor.com:4873

Adjust toolbar buttons

  • remove old spellchecker buttons from your toolbar (external_toolbar.js per default)
  • add new button definitions:
'button:xeditor.spellchecker.configure',
'button:xeditor.spellchecker.check'

API

The API for the plugin can be found here: spellchecker plugin API

Buttons

This plugin exports the following button templates that can be used in your toolbar configuration:

Name Function
button:xeditor.spellchecker.configure Opens spell check language configuration window
button:xeditor.spellchecker.check Toggles spell check

Changelog

v2.0.0

Changes

  • Complete redesign of the Spellchecker
  • Added a feature to check the document live
  • Splitting of a large requests into many small requests to reduce waiting times and solve timeouts