Versions Compared

Key

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

This is to provide you with step-by-step instructions that how to migrate from an old deprecated version of SCAYT product (v.2) to a new SCAYT (v.3).

SCAYT 2 is a very old version of the SpellCheckAsYouType product, all the development work including bug fixing, enhancements was stopped a while ago. The WebSpellChecker team decided to develop a new version of the product which based on the modern technologies and approaches.

Right now SCAYT 3, as well as components/plugins based on it, are stabled and being actively developed and maintained. New updates, features and bug fixing are announced in our each major release. 

Thus, we strongly recommend you to consider the migration to a newer version of the SCAYT product in order to have access to the service and continue receiving updates including the latest features and enhancements.


Panel

Table of Contents
stylenone



1. How to migrate from SCAYT 2 to SCAYT 3 plugin for CKEditor

SCAYT 2 product was used on the old versions of CKEditor 4.3.3 and less. The new version of the SCAYT 3 product was launched starting CKEditor 4.4+.

1. Upgrade the version of the CKEditor editor to the latest one available (or at least to the version 4.4+). The latest version of CKEditor plugin can be downloaded from CKEditor website.

2. Specify your encrypted customer ID for the paid SCAYT service in the CKEditor config.js file using the scayt_customerid parameter:

Code Block
languagejs
themeEmacs
config.scayt_customerid = 'encrypted-customer-ID';


Note

You can find your long encrypted customer ID in your previous configuration or you may download it from your account page on the webspellchecker.net website. Login using your Customer ID and password. Then click Download Configuration file.

You can find more information about SCAYT 3 parameters for CKEditor here.

2. How to migrate from SCAYT 2 to SCAYT 3 plugin for TinyMCE

Before to proceed with the migration steps, you need to define the exact version of the TinyMCE editor:

  • Go to Development tools (e.g. F12 in Chrome).
  • Choose the Console tab.
  • Write after ”>”: tinymce.majorVersion + '.'+ tinymce.minorVersion;
  • Click Enter to see the version of the TinyMCE editor.

Depending on the version of TinyMCE editor, please follow the next instructions below:

TinyMCE 3.0 and less

  • Upgrade the version of the TinyMCE editor to the latest one available (or at least to the version 4.0+). The latest version of TinyMCE (4.6.4) can be downloaded from the TinyMCE website.
  • Download SCAYT 3 plugin for TinyMCE.
  • Unpack the downloaded ZIP archive with the SCAYT plugin.
  • Copy the extracted SCAYT folder to the TinyMCE 4 plugins directory (by default: tinymce4\js\tinymce\plugins\). Important: The folder name must be “scayt”.
  • Go further with instructions for TinyMCE 4+.

TinyMCE 4.0+

Excerpt Include
IN:_include_tinymce_scayt
IN:_include_tinymce_scayt
nopaneltrue

Note

You can find your long encrypted customer ID in your previous configuration or you may download it from your account page on the webspellchecker.net website. Login using your Customer ID and password. Then click Download Configuration file.

You can find more information about available parameters on the SCAYT plugin for TinyMCE 4.0+ demo page.

3. How to migrate from SCAYT 2 to SCAYT 3 for Editable Controls

1. Change the SCAYT application URL:

Excerpt Include
IN:_include_cloud_scayt_src_url
IN:_include_cloud_scayt_src_url
nopaneltrue

2. Update SCAYT initialization in controls. Depending on the type of the controls (HTML elements) where the SCAYT functionality is embedded and used, please update your configuration as follows. 

3.1. Contenteditable DIV Element

Warning
titleSCAYT 2:
<div contenteditable sc_dojoType="scayt.ui"> 
This is an exampl of a sentence with two mispelled words. Just type text with misspelling to see how it works.
</div>

Excerpt Include
IN:_include_cloud_scayt_div
IN:_include_cloud_scayt_div
nopaneltrue

3.2. Contenteditable IFRAME Element

Warning
titleSCAYT 2:
<iframe sc_dojoType="scayt.ui" src="editable_doc.html">

Excerpt Include
IN:_include_cloud_scayt_iframe
IN:_include_cloud_scayt_iframe
nopaneltrue

3.3. Contenteditable INPUT Element

Warning
titleSCAYT 2:
<input name="scayt_input" size="50" sc_dojoType="scayt.Input" lang="<language_short_code>" 
value="This is an exampl of a sentence with two mispelled words.">

Excerpt Include
IN:_include_cloud_scayt_input
IN:_include_cloud_scayt_input
nopaneltrue

3.4. Contenteditable TEXTAREA Element

Warning
titleSCAYT 2:
<textarea name="scayt_textarea" sc_dojoType="scayt.Textarea" scaytConfig.customDictionaryIds = [1,3001]; 
lang="<language_short_code>" cols="40" rows="7">
This is an exampl of a sentence with two mispelled words.
</textarea>

Excerpt Include
IN:_include_cloud_scayt_textarea
IN:_include_cloud_scayt_textarea
nopaneltrue

You can find more information about SCAYT 3 parameters for Editable Controls here.