Dev GuideAPI ReferenceUser Guide
HomeDev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunityDoc feedbackLog In
GitHubNuGetDev CommunityDoc feedback



See also: [Blog post: Configuring Spellchecker](🔗)

## Requirements

  • No additional license fee.

  • An Optimizely Content Management System (CMS) or Optimizely Customized Commerce installation.

  • See [Add-ons platform compatibility](🔗) for package and version information. 

## Installation

  • CMS Versions 7.5 and higher are [installed through NuGet](🔗).

  • CMS Version 7 is installed and updated through one-click installation.

After you install the package, add the following code to _startup.cs_.


## Configuration
This topic describes how to configure dictionaries for the Optimizely SpellChecker for TinyMCE add-on. The add-on comes with a set of predefined dictionaries, and you can add languages.
Note
Episerver Spellchecker for TinyMCE is renamed to Optimizely Spellchecker for TinyMCE.
### Default language dictionaries
The following dictionaries are included with the add-on by default:
  • Danish (da)
  • German (de)
  • English (en-US)
  • Spanish (es)
  • French (fr)
  • Italian (it)
  • Dutch (nl)
  • Norwegian BokmÃ¥l (nb-NO)
  • Norwegian Nynorsk (nn-NO)
  • Polish (pl)
  • Portuguese (pt)
  • Russian (ru)
  • Swedish (sv)
### Adding dictionaries
You can add additional dictionaries to the website. You can download dictionary file sources, for example, from [OpenOffice Extensions](🔗) or [Mozilla Language Tools](🔗). Language packages from these sources are not specifically designed for Spellchecker, but can be extracted and used.
  1. Download the desired language package. Rename the downloaded file to _.zip_ and extract the _.aff_ and _.dic_ files within.
  2. Create a new folder named by language code (for example, **en-GB**) in the add-on folder _\\EPiServer.TinyMCESpellChecker\\Dictionaries\\_. Using this path, you can update the add-on without having to add the dictionaries again.
  3. Paste the extracted _.aff_ and _.dic_ files into the newly created folder.
Important notifications
  • For a dictionary to become available for selection in the spellchecker language list, the language must be **enabled** on the website.
  • The name of the dictionary file should match the language code of the **language branch enabled in Optimizely**. For example, if you enabled **en-GB**, name your dictionary files _en-GB.dic/.aff_.
  • Check which language variations your dictionaries cover. A dictionary named _en.dic_ might cover US English, which in Optimizely is **en-US**. While _no.dic_ might cover the _Norwegian BokmÃ¥l_ variation, which in Optimizely is **nb-NO**. Most downloadable dictionaries include a README containing this type of information.
  • Only place **one dictionary in each language folder** to avoid conflicts. For example, do not place both **en.dic** and **en-US.dic** in the **en** folder.
### Using Spellchecker for specific properties
The Spellchecker for TinyMCE is automatically applied to all XHTMLString properties by default, but you can configure your site to use Spellchecker for one or more properties only. For example, if you want to use Spellchecker only for the MainBody of the ProductPage, follow these steps:
  1. Create a class which implements the `IConfigurableModule` interface.
  2. Implement the class as below:  

## Breaking changes for Spellchecker for TinyMCE 2
Note
Episerver Spellchecker for TinyMCE is renamed to Optimizely Spellchecker for TinyMCE.
The Optimizely Spellchecker for TinyMCE 2 includes the following breaking changes:
  • The NuGet package for Episerver Spellchecker for TinyMCE 2 (_EPiServer.TinyMCESpellChecker.2.x.x_) depends on Episerver TinyMCE 2 (_EPiServer.CMS.TinyMce_ 2.x).
  • The class `SpellCheckerPlugin` is removed.
  • Use the custom Spellchecker’s _plugin.min.js_ file. 
  • Update the class `SpellCheckerRequest` and move it to namespace `EPiServer.TinyMCESpellChecker.Models`.
  • The classes `CheckSpellingResponse` and `SpellSuggestionResponse` have been removed.
  • The **SpellChecker** button is automatically added to TinyMce editor. Previously, this had to be added from the admin view.
The following new interfaces were added:
  • `ISpellCheckerService`
Implement this interface to handle parsing spellchecker requests (the request is in URL encoded format; previously, the request was in JSON format), and getting correct suggestions for a list of misspelled words. The default implementation is `SpellCheckerService`.
  • `ISpellCheckerDictionary`
Implement this interface to handle spell checking and getting correct suggestions for a word. The default implementation is `SpellCheckerDictionary`.